Module org.eclipse.persistence.moxy
Package org.eclipse.persistence.jaxb

Class JAXBContextProperties

  • public class JAXBContextProperties
extends Object
    These are properties that may be passed in to create a JAXBContext: 
     Map properties = new HashMap<String, Object>(1);
 properties.put();
 JAXBContext jc = JAXBContext.newInstance(new Class[] {Foo.class}, properties);
    Since:
    2.4.0

    • Field Detail

      • JSON_ATTRIBUTE_PREFIX

        public static final String JSON_ATTRIBUTE_PREFIX
        ` The name of the property used to specify a value that will be prepended to all keys that are mapped to an XML attribute. By default there is no attribute prefix. There is no effect when media type is "application/xml". When this property is specified at the JAXBContext level all instances of Marshaller and Unmarshaller will default to this attribute prefix.
        Since:
        2.4
        See Also:
        MarshallerProperties.JSON_ATTRIBUTE_PREFIX, UnmarshallerProperties.JSON_ATTRIBUTE_PREFIX, Constant Field Values

      • JSON_INCLUDE_ROOT

        public static final String JSON_INCLUDE_ROOT
        The name of the property used to specify in the root node should be included in the message (default is true). There is no effect when media type is "application/xml". When this property is specified at the JAXBContext level all instances of Marshaller and Unmarshaller will default to this setting.
        Since:
        2.4
        See Also:
        JSON_INCLUDE_ROOT, UnmarshallerProperties.JSON_INCLUDE_ROOT, Constant Field Values

      • MEDIA_TYPE

        public static final String MEDIA_TYPE
        The name of the property used to specify the type of binding to be performed. When this property is specified at the JAXBContext level all instances of Marshaller and Unmarshaller will default to this media type. Supported values are:
        • MediaType.APPLICATION_XML (default)
        • MediaType.APPLICATION_JSON
        • "application/xml"
        • "application/json"
        Since:
        2.4
        See Also:
        MarshallerProperties.MEDIA_TYPE, UnmarshallerProperties.MEDIA_TYPE, MediaType, Constant Field Values

      • NAMESPACE_PREFIX_MAPPER

        public static final String NAMESPACE_PREFIX_MAPPER
        The Constant NAMESPACE_PREFIX_MAPPER. Provides a means to customize the namespace prefixes used while marshalling to XML. Used for both marshal and unmarshal when mediaType is set to "application/json". Value is either a Map of URIs to prefixes, or an implementation of org.eclipse.persistence.oxm.NamespacePrefixMapper.
        Since:
        2.4
        See Also:
        NamespacePrefixMapper, Constant Field Values

      • SESSION_EVENT_LISTENER

        public static final String SESSION_EVENT_LISTENER
        The name of the property used to specify a SessionEventListener that can be used to customize the metadata before or after it has been initialized. Value is either an implementation of org.eclipse.persistence.sessions.SessionEventListener or a List<org.eclipse.persistence.sessions.SessionEventListener>.
        Since:
        2.4
        See Also:
        SessionEventListener, Constant Field Values

      • OXM_METADATA_SOURCE

        public static final String OXM_METADATA_SOURCE
        The name of the property used to specify one or more EclipseLink OXM metadata sources. The metadata source can be one of the following:
        • java.io.File
        • java.io.InputStream
        • java.io.Reader
        • java.lang.String
        • java.net.URL
        • javax.xml.stream.XMLEventReader
        • javax.xml.stream.XMLStreamReader
        • javax.xml.transform.Source
        • org.eclipse.persistence.jaxb.metadata.MetadataSource
        • org.w3c.dom.Node
        • org.xml.sax.InputSource
        To specify multiple metadata sources, the following can be used:
        • java.util.Map
        • java.util.List<Object>
        Since:
        2.4, replaces JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY
        See Also:
        Constant Field Values

      • DEFAULT_TARGET_NAMESPACE

        public static final String DEFAULT_TARGET_NAMESPACE
        The name of the property used to specify a default target namespace.
        Since:
        2.4, replaces JAXBContextFactory.DEFAULT_TARGET_NAMESPACE_KEY
        See Also:
        Constant Field Values

      • ANNOTATION_HELPER

        public static final String ANNOTATION_HELPER
        The name of the property used to specify an AnnotationHelper instance. An AnnotationHelper is responsible for returning Annotations from AnnotatedElements.
        Since:
        2.4, replaces JAXBContextFactory.ANNOTATION_HELPER_KEY
        See Also:
        AnnotationHelper, Annotation, AnnotatedElement, Constant Field Values

      • XML_ACCESSOR_FACTORY_SUPPORT

        public static final String XML_ACCESSOR_FACTORY_SUPPORT
        The name of the boolean property used to enable custom XmlAccessorFactories.
        Since:
        2.4.2
        See Also:
        "com.sun.xml.bind.XmlAccessorFactory", Constant Field Values

      • OBJECT_GRAPH

        public static final String OBJECT_GRAPH
        The name of the property used to specify an ObjectGraph instance or name of an ObjectGraph to be used on Unmarshallers and Marshallers created by the context.
        See Also:
        Constant Field Values

      • JSON_WRAPPER_AS_ARRAY_NAME

        public static final String JSON_WRAPPER_AS_ARRAY_NAME
        The Constant JSON_WRAPPER_AS_ARRAY_NAME. If true the grouping element will be used as the JSON key. There is no effect when media type is "application/xml". When this property is specified at the JAXBContext level all instances of Marshaller and Unmarshaller will default to this.

        Example

        Given the following class:

         @XmlAccessorType(XmlAccessType.FIELD)
 public class Customer {

     @XmlElementWrapper(name="phone-numbers")
     @XmlElement(name="phone-number")
     private List<PhoneNumber> phoneNumbers;

 }

        If the property is set to false (the default) the JSON output will be:

         {
     "phone-numbers" : {
         "phone-number" : [ {
             ...
         }, {
             ...
         }]
     }
 }

        And if the property is set to true, then the JSON output will be:

         {
     "phone-numbers" : [ {
         ...
     }, {
         ...
     }]
 }
        Since:
        2.4.2
        See Also:
        MarshallerProperties.JSON_WRAPPER_AS_ARRAY_NAME, UnmarshallerProperties.JSON_WRAPPER_AS_ARRAY_NAME, Constant Field Values

      • JSON_TYPE_ATTRIBUTE_NAME

        public static final String JSON_TYPE_ATTRIBUTE_NAME
        Override default type property name for JSON as MOXy type discriminator. Settings from binding file have higher priority.

        Example

        Given the following property

         conf.put(JAXBContextProperties.JSON_TYPE_ATTRIBUTE_NAME, "mytype");

        If the property is set the JSON output will be:

         ...
 {
      "mytype": "phone",
      "contactId": 3,
      "number": "987654321"
 }
 ...

        for following object model

         @XmlSeeAlso({Address.class, Phone.class})
 public class Contact {

      public int contactId;
      ...
 
         public class Phone extends Contact{

      public String number;
      ...

        If the property is not set (default value) the JSON output will be:

         ...
 {
      "type": "phone",
      "contactId": 3,
      "number": "987654321"
 }
 ...
        Unmarshaller will use it as type discriminator to select right child class.
        Since:
        2.7.4
        See Also:
        MarshallerProperties.JSON_TYPE_ATTRIBUTE_NAME, UnmarshallerProperties.JSON_TYPE_ATTRIBUTE_NAME, Constant Field Values

      • UNMARSHALLING_CASE_INSENSITIVE

        public static final String UNMARSHALLING_CASE_INSENSITIVE
        If set to Boolean.TRUE, JAXBUnmarshaller will match XML Elements and XML Attributes to Java fields case insensitively.

        Example

        Given the following class:

         @XmlAccessorType(XmlAccessType.FIELD)
 public class Customer {

     @XmlElement
     private String name;
     @XmlAttribute
     private int id;

 }

        If the property is set to true, the following XML object will match the class and will be unmarshaled.

         <customer iD="007">
   <nAMe>cafeBabe</nAMe>
 </customer>

        By default, case-insensitive unmarshalling is turned off.

        The property must be passed to the JAXBContextFactory, when creating JAXBContext. It will affect only unmarshaller created from that context.

        Specifying this flag may impose a slight performance penalty.

        Since:
        2.6.0
        See Also:
        EclipseLink Forum, Bug 331241., UnmarshallerProperties.UNMARSHALLING_CASE_INSENSITIVE, Constant Field Values

      • BEAN_VALIDATION_FACETS

        public static final String BEAN_VALIDATION_FACETS
        Enables or disables generation of XML Facets during schemagen process. Allowed values are Boolean.TRUE or Boolean.FALSE, effectively stating that facets (based on the BV annotations) will be generated, or that the BV annotations processing will be skipped during schemagen with no facets being generated, respectively. Default value is false, i.e. facets are not generated by default.
        Since:
        2.6
        See Also:
        Constant Field Values

      • MOXY_LOG_PAYLOAD

        public static final String MOXY_LOG_PAYLOAD
        Property for logging Entities content during marshalling/unmarshalling operation in MOXy. It calls toString() method from entity. This is to make maintenance easier and to allow for debugging to check marshalled/unmarshalled content. Use it carefully. It can produce high amount of data in the log files. Usage: set to Boolean.TRUE to enable payload logging, set to Boolean.FALSE to disable it. It can be set via system property with name "eclipselink.logging.payload.moxy" too. By default it is disabled.
        Since:
        3.0
        See Also:
        MarshallerProperties.MOXY_LOG_PAYLOAD, UnmarshallerProperties.MOXY_LOG_PAYLOAD, Constant Field Values

    • Constructor Detail

      • JAXBContextProperties

        public JAXBContextProperties()