Module org.glassfish.jaxb.runtime
Package com.sun.xml.bind.api

Class JAXBRIContext

  • Direct Known Subclasses:
    JAXBContextImpl
    public abstract class JAXBRIContext
extends javax.xml.bind.JAXBContext
    JAXBContext enhanced with JAXB RI specific functionalities.

    Subject to change without notice.

    Since:
    2.0 EA1
    Author:
    Kohsuke Kawaguchi ([email protected])

    • Field Detail

      • DEFAULT_NAMESPACE_REMAP

        public static final String DEFAULT_NAMESPACE_REMAP
        The property that you can specify to JAXBContext.newInstance(java.lang.String) to reassign the default namespace URI to something else at the runtime.

        The value of the property is String, and it is used as the namespace URI that succeeds the default namespace URI.

        Since:
        2.0 EA1
        See Also:
        Constant Field Values

      • TYPE_REFERENCES

        public static final String TYPE_REFERENCES
        The property that you can specify to JAXBContext.newInstance(java.lang.String) to put additional JAXB type references into the JAXBContext.

        The value of the property is Collection<TypeReference>. Those TypeReferences can then be used to create Bridges.

        This mechanism allows additional element declarations that were not a part of the schema into the created JAXBContext.

        Since:
        2.0 EA1
        See Also:
        Constant Field Values

      • CANONICALIZATION_SUPPORT

        public static final String CANONICALIZATION_SUPPORT
        The property that you can specify to JAXBContext.newInstance(java.lang.String) and Marshaller.setProperty(String, Object) to enable the c14n marshalling support in the JAXBContext. Boolean
        Since:
        2.0 EA2
        See Also:
        Constant Field Values

      • TREAT_EVERYTHING_NILLABLE

        public static final String TREAT_EVERYTHING_NILLABLE
        The property that you can specify to JAXBContext.newInstance(java.lang.String) to allow unmarshaller to honor xsi:nil anywhere, even if they are not specifically allowed by the schema. Boolean
        Since:
        2.1.3
        See Also:
        Constant Field Values

      • ANNOTATION_READER

        public static final String ANNOTATION_READER
        The property that you can specify to JAXBContext.newInstance(java.lang.String) to use alternative RuntimeAnnotationReader implementation.
        Since:
        2.1 EA2

      • ENABLE_XOP

        public static final String ENABLE_XOP
        Marshaller/Unmarshaller property to enable XOP processing.
        Since:
        2.0 EA2
        See Also:
        Constant Field Values

      • SUBCLASS_REPLACEMENTS

        public static final String SUBCLASS_REPLACEMENTS
        The property that you can specify to JAXBContext.newInstance(java.lang.String) to specify specific classes that replace the reference to generic classes.

        See the release notes for more details about this feature.

        Since:
        2.1 EA2
        See Also:
        Constant Field Values

      • XMLACCESSORFACTORY_SUPPORT

        public static final String XMLACCESSORFACTORY_SUPPORT
        The property that you can specify to JAXBContext.newInstance(java.lang.String) enable support of XmlAccessorFactory annotation in the JAXBContext.
        Since:
        2.1 EA2
        See Also:
        Constant Field Values

      • RETAIN_REFERENCE_TO_INFO

        public static final String RETAIN_REFERENCE_TO_INFO
        Retains references to PropertyInfos. Boolean
        Since:
        2.1.10
        See Also:
        Constant Field Values

      • SUPRESS_ACCESSOR_WARNINGS

        public static final String SUPRESS_ACCESSOR_WARNINGS
        Supress security warnings when trying to access fields through reflection. Boolean
        Since:
        2.1.14, 2.2.2
        See Also:
        Constant Field Values

      • IMPROVED_XSI_TYPE_HANDLING

        public static final String IMPROVED_XSI_TYPE_HANDLING
        Improves handling of xsi:type used on leaf properties. Boolean
        Since:
        2.2.3
        See Also:
        Constant Field Values

      • DISABLE_XML_SECURITY

        public static final String DISABLE_XML_SECURITY
        If true XML security features when parsing XML documents will be disabled. The default value is false. Boolean
        Since:
        2.2.6
        See Also:
        Constant Field Values

      • BACKUP_WITH_PARENT_NAMESPACE

        public static final String BACKUP_WITH_PARENT_NAMESPACE
        If true and element namespace is not specified, namespace of parent element will be used. The default value is false. Boolean
        Since:
        2.3.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • JAXBRIContext

        protected JAXBRIContext()

    • Method Detail

      • newInstance

        public static JAXBRIContext newInstance​(@NotNull
                                        Class[] classes,
                                        @Nullable
                                        Collection<TypeReference> typeRefs,
                                        @Nullable
                                        Map<Class,​Class> subclassReplacements,
                                        @Nullable
                                        String defaultNamespaceRemap,
                                        boolean c14nSupport,
                                        @Nullable
                                        RuntimeAnnotationReader ar)
                                 throws javax.xml.bind.JAXBException
        Creates a new JAXBRIContext.

        JAXBContext.newInstance() methods may return other JAXB providers that are not compatible with the JAX-RPC RI. This method guarantees that the JAX-WS RI will finds the JAXB RI.

        Parameters:
        classes - Classes to be bound. See JAXBContext.newInstance(Class[]) for the meaning.
        typeRefs - See TYPE_REFERENCES for the meaning of this parameter. Can be null.
        subclassReplacements - See SUBCLASS_REPLACEMENTS for the meaning of this parameter. Can be null.
        defaultNamespaceRemap - See DEFAULT_NAMESPACE_REMAP for the meaning of this parameter. Can be null (and should be null for ordinary use of JAXB.)
        c14nSupport - See CANONICALIZATION_SUPPORT for the meaning of this parameter.
        ar - See ANNOTATION_READER for the meaning of this parameter. Can be null.
        Throws:
        javax.xml.bind.JAXBException
        Since:
        JAXB 2.1 EA2

      • newInstance

        public static JAXBRIContext newInstance​(@NotNull
                                        Class[] classes,
                                        @Nullable
                                        Collection<TypeReference> typeRefs,
                                        @Nullable
                                        Map<Class,​Class> subclassReplacements,
                                        @Nullable
                                        String defaultNamespaceRemap,
                                        boolean c14nSupport,
                                        @Nullable
                                        RuntimeAnnotationReader ar,
                                        boolean xmlAccessorFactorySupport,
                                        boolean allNillable,
                                        boolean retainPropertyInfo,
                                        boolean supressAccessorWarnings)
                                 throws javax.xml.bind.JAXBException
        Creates a new JAXBRIContext.

        JAXBContext.newInstance() methods may return other JAXB providers that are not compatible with the JAX-RPC RI. This method guarantees that the JAX-WS RI will finds the JAXB RI.

        Parameters:
        classes - Classes to be bound. See JAXBContext.newInstance(Class[]) for the meaning.
        typeRefs - See TYPE_REFERENCES for the meaning of this parameter. Can be null.
        subclassReplacements - See SUBCLASS_REPLACEMENTS for the meaning of this parameter. Can be null.
        defaultNamespaceRemap - See DEFAULT_NAMESPACE_REMAP for the meaning of this parameter. Can be null (and should be null for ordinary use of JAXB.)
        c14nSupport - See CANONICALIZATION_SUPPORT for the meaning of this parameter.
        ar - See ANNOTATION_READER for the meaning of this parameter. Can be null.
        xmlAccessorFactorySupport - See XMLACCESSORFACTORY_SUPPORT for the meaning of this parameter.
        allNillable - See TREAT_EVERYTHING_NILLABLE for the meaning of this parameter.
        retainPropertyInfo - See RETAIN_REFERENCE_TO_INFO for the meaning of this parameter.
        supressAccessorWarnings - See SUPRESS_ACCESSOR_WARNINGS for the meaning of this parameter.
        Throws:
        javax.xml.bind.JAXBException

      • newInstance

        public static JAXBRIContext newInstance​(@NotNull
                                        Class[] classes,
                                        @Nullable
                                        Collection<TypeReference> typeRefs,
                                        @Nullable
                                        String defaultNamespaceRemap,
                                        boolean c14nSupport)
                                 throws javax.xml.bind.JAXBException
        Deprecated.
        Compatibility with older versions.
        Throws:
        javax.xml.bind.JAXBException

      • hasSwaRef

        public abstract boolean hasSwaRef()
        Returns true if this context includes a class that has XmlAttachmentRef.
        Since:
        2.1

      • getElementName

        @Nullable
public abstract QName getElementName​(@NotNull
                                     Object o)
                              throws javax.xml.bind.JAXBException
        If the given object is bound to an element in XML by JAXB, returns the element name.
        Returns:
        null if the object is not bound to an element.
        Throws:
        javax.xml.bind.JAXBException - if the object is not known to this context.
        Since:
        2.0 EA1

      • getElementName

        @Nullable
public abstract QName getElementName​(@NotNull
                                     Class o)
                              throws javax.xml.bind.JAXBException
        Allows to retrieve the element name based on Class.
        Parameters:
        o -
        Returns:
        Throws:
        javax.xml.bind.JAXBException
        Since:
        2.1.10

      • createBridgeContext

        @NotNull
public abstract BridgeContext createBridgeContext()
        Creates a new BridgeContext instance.
        Returns:
        always a valid non-null instance.
        Since:
        2.0 EA1

      • getElementPropertyAccessor

        public abstract <B,​V> RawAccessor<B,​V> getElementPropertyAccessor​(Class<B> wrapperBean,
                                                                              String nsUri,
                                                                              String localName)
                                                                       throws javax.xml.bind.JAXBException
        Gets a RawAccessor for the specified element property of the specified wrapper bean class.

        This method is designed to assist the JAX-RPC RI fill in a wrapper bean (in the doc/lit/wrap mode.) In the said mode, a wrapper bean is supposed to only have properties that match elements, and for each element that appear in the content model there's one property.

        Therefore, this method takes a wrapper bean and a tag name that identifies a property on the given wrapper bean, then returns a RawAccessor that allows the caller to set/get a value from the property of the bean.

        This method is not designed for a performance. The caller is expected to cache the result.

        Type Parameters:
        B - type of the wrapper bean
        V - type of the property of the bean
        Returns:
        always return non-null valid accessor object.
        Throws:
        javax.xml.bind.JAXBException - if the specified wrapper bean is not bound by JAXB, or if it doesn't have an element property of the given name.
        Since:
        2.0 EA1

      • getKnownNamespaceURIs

        @NotNull
public abstract List<String> getKnownNamespaceURIs()
        Gets the namespace URIs statically known to this JAXBContext.

        When JAXB is used to marshal into sub-trees, it declares these namespace URIs at each top-level element that it marshals. To avoid repeated namespace declarations at sub-elements, the application may declare those namespaces at a higher level.

        Returns:
        always non-null.
        Since:
        2.0 EA2

      • generateSchema

        public abstract void generateSchema​(@NotNull
                                    javax.xml.bind.SchemaOutputResolver outputResolver)
                             throws IOException
        Generates the schema documents from the model.

        The caller can use the additionalElementDecls parameter to add element declarations to the generate schema. For example, if the JAX-RPC passes in the following entry: {foo}bar -> DeclaredType for java.lang.String then JAXB generates the following element declaration (in the schema document for the namespace "foo")" <xs:element name="bar" type="xs:string" /> This can be used for generating schema components necessary for WSDL.

        Overrides:
        generateSchema in class javax.xml.bind.JAXBContext
        Parameters:
        outputResolver - this object controls the output to which schemas will be sent.
        Throws:
        IOException - if SchemaOutputResolver throws an IOException.

      • getBuildId

        @NotNull
public abstract String getBuildId()
        Gets the build information of the JAXB runtime.
        Returns:
        may be null, if the runtime is loaded by a class loader that doesn't support the access to the manifest informatino.

      • generateEpisode

        public abstract void generateEpisode​(Result output)
        Generates the episode file that represents the binding known to this JAXBContext, so that XJC can later do separate compilation.

        Episode file is really just a JAXB customization file, except that currently we use the RI-specific SCD to refer to schema components.

        Parameters:
        output - This receives the generated episode file.
        Since:
        2.1

      • getRuntimeTypeInfoSet

        public abstract RuntimeTypeInfoSet getRuntimeTypeInfoSet()
        Allows you to access the runtime model information of the JAXB XML/Java binding.

        This is useful for doing a deeper integration with the JAXB RI. For more information about the model, see https://jaxb2-reflection.dev.java.net/

        Since:
        2.1.10

      • mangleNameToVariableName

        @NotNull
public static String mangleNameToVariableName​(@NotNull
                                              String localName)
        Computes a Java identifier from a local name.

        This method faithfully implements the name mangling rule as specified in the JAXB spec.

        In JAXB, a collision with a Java reserved word (such as "return") never happens. Accordingly, this method may return an identifier that collides with reserved words.

        Use JJavaName.isJavaIdentifier(String) to check for such collision.

        Returns:
        Typically, this method returns "nameLikeThis".

      • mangleNameToClassName

        @NotNull
public static String mangleNameToClassName​(@NotNull
                                           String localName)
        Computes a Java class name from a local name.

        This method faithfully implements the name mangling rule as specified in the JAXB spec.

        Returns:
        Typically, this method returns "NameLikeThis".

      • mangleNameToPropertyName

        @NotNull
public static String mangleNameToPropertyName​(@NotNull
                                              String localName)
        Computes a Java class name from a local name.

        This method faithfully implements the name mangling rule as specified in the JAXB spec. This method works like mangleNameToClassName(String) except that it looks for "getClass" and returns something else.

        Returns:
        Typically, this method returns "NameLikeThis".

      • getBaseType

        @Nullable
public static Type getBaseType​(@NotNull
                               Type type,
                               @NotNull
                               Class baseType)
        Gets the parameterization of the given base type.

        For example, given the following 

        
 interface Foo<T> extends List<List<T>> {}
 interface Bar extends Foo<String> {}
        This method works like this: 
        
 getBaseClass( Bar, List ) = List<List<String>
 getBaseClass( Bar, Foo  ) = Foo<String>
 getBaseClass( Foo<? extends Number>, Collection ) = Collection<List<? extends Number>>
 getBaseClass( ArrayList<? extends BigInteger>, List ) = List<? extends BigInteger>
        Parameters:
        type - The type that derives from baseType
        baseType - The class whose parameterization we are interested in.
        Returns:
        The use of baseType in type. or null if the type is not assignable to the base type.
        Since:
        2.0 FCS