Package org.springframework.data.gemfire.config.annotation

Annotation Interface EnablePdx

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Import(PdxConfiguration.class) public @interface EnablePdx
The EnablePdx annotation marks a Spring @Configuration annotated Class to enable the Apache Geode PDX features and functionality in this peer cache, cluster member or cache client application.
Since:
1.9.0
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    diskStoreName
    Configures the disk store that is used for PDX meta data.
    boolean
    ignoreUnreadFields
    Configures whether pdx ignores fields that were unread during deserialization.
    Class<?>[]
    includeDomainTypes
    When using the Spring Data Geode's (SDG) MappingPdxSerializer most application domain types are included for Apache Geode PDX serialization, by default.
    boolean
    persistent
    Configures whether the type metadata for PDX objects is persisted to disk.
    boolean
    readSerialized
    Configures the object preference to PdxInstance type or Object.
    String
    serializerBeanName
    Configures the PDX serializer to be used by the cache to serialize object data.

  • Element Details

    • diskStoreName

      String diskStoreName
      Configures the disk store that is used for PDX meta data. Use the spring.data.gemfire.pdx.disk-store-name property in application.properties.
      Default:
      ""

    • ignoreUnreadFields

      boolean ignoreUnreadFields
      Configures whether pdx ignores fields that were unread during deserialization. Default is false. Use the spring.data.gemfire.pdx.ignore-unread-fields property in application.properties.
      Default:
      false

    • includeDomainTypes

      Class<?>[] includeDomainTypes
      When using the Spring Data Geode's (SDG) MappingPdxSerializer most application domain types are included for Apache Geode PDX serialization, by default. However, certain types are excluded by SDG's MappingPdxSerializer, such as java.*, javax.*, com.gemstone.*, org.apache.geode.* and org.springframework.* types. This allows the default behavior to be overridden when and where necessary.
      Returns:
      an array of types to be handled by the MappingPdxSerializer, possibly overriding the excluded types by default.
      Default:
      {}

    • persistent

      boolean persistent
      Configures whether the type metadata for PDX objects is persisted to disk. Default is false. Use the spring.data.gemfire.pdx.persistent property in application.properties.
      Default:
      false

    • readSerialized

      boolean readSerialized
      Configures the object preference to PdxInstance type or Object. Default is false. Use the spring.data.gemfire.pdx.read-serialized property in application.properties.
      Default:
      false

    • serializerBeanName

      String serializerBeanName
      Configures the PDX serializer to be used by the cache to serialize object data. Use the spring.data.gemfire.pdx.serializer-bean-name property in application.properties.
      Default:
      ""