All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.spi.db.BindingContext Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.xml.ws.spi.db;

import java.io.IOException;
import java.util.Collection;
import java.util.List;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.SchemaOutputResolver;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAttachmentRef;
import javax.xml.namespace.QName;
import javax.xml.transform.Result;

import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
//import com.sun.xml.bind.api.BridgeContext;
//import com.sun.xml.bind.v2.model.annotation.RuntimeAnnotationReader;
//import com.sun.xml.bind.v2.model.runtime.RuntimeTypeInfoSet;

/**
 * {@link JAXBContext} enhanced with JAXB RI specific functionalities.
 *
 * 

* Subject to change without notice. * * @since 2.0 EA1 * @author * Kohsuke Kawaguchi ([email protected]) * * @author [email protected] */ public interface BindingContext { //following are found in JAXBContext used by jaxws abstract public Marshaller createMarshaller() throws JAXBException; abstract public Unmarshaller createUnmarshaller() throws JAXBException; abstract public JAXBContext getJAXBContext(); abstract public Object newWrapperInstace(Class wrapperType) throws InstantiationException, IllegalAccessException; /** * Returns true if this context includes a class * that has {@link XmlAttachmentRef}. * * @since 2.1 */ public abstract boolean hasSwaRef(); /** * If the given object is bound to an element in XML by JAXB, * returns the element name. * * @return null * if the object is not bound to an element. * @throws JAXBException * if the object is not known to this context. * * @since 2.0 EA1 */ public abstract @Nullable QName getElementName(@NotNull Object o) throws JAXBException; /** * Allows to retrieve the element name based on Class. * @param o * @return * @throws javax.xml.bind.JAXBException * @since 2.1.10 */ public abstract @Nullable QName getElementName(@NotNull Class o) throws JAXBException; /** * Creates a mini-marshaller/unmarshaller that can process a {@link TypeInfo}. * * @return * null if the specified reference is not given to {@link BindingContext#newInstance}. * * @since 2.0 EA1 */ public abstract XMLBridge createBridge(@NotNull TypeInfo ref); public abstract XMLBridge createFragmentBridge(); /** * Creates a new {@link BridgeContext} instance. * * @return * always a valid non-null instance. * * @since 2.0 EA1 */ // public abstract @NotNull BridgeContext createBridgeContext(); /** * Gets a {@link PropertyAccessor} 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 {@link PropertyAccessor} 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. * * @param * type of the wrapper bean * @param * type of the property of the bean * @return * always return non-null valid accessor object. * @throws 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 */ public abstract PropertyAccessor getElementPropertyAccessor( Class wrapperBean, String nsUri, String localName ) throws JAXBException; /** * Gets the namespace URIs statically known to this {@link 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. * * @return * always non-null. * * @since 2.0 EA2 */ public abstract @NotNull List getKnownNamespaceURIs(); /** * 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. * * @param outputResolver * this object controls the output to which schemas * will be sent. * * @throws IOException * if {@link SchemaOutputResolver} throws an {@link IOException}. */ public abstract void generateSchema(@NotNull SchemaOutputResolver outputResolver) throws IOException; /** * Returns the name of the XML Type bound to the * specified Java type. * * @param tr * must not be null. This must be one of the {@link TypeInfo}s specified * in the {@link BindingContext#newInstance} method. * * @throws IllegalArgumentException * if the parameter is null or not a part of the {@link TypeInfo}s specified * in the {@link BindingContext#newInstance} method. * * @return null * if the referenced type is an anonymous and therefore doesn't have a name. */ public abstract QName getTypeName(@NotNull TypeInfo tr); /** * Gets the build information of the JAXB runtime. * * @return * may be null, if the runtime is loaded by a class loader that doesn't support * the access to the manifest informatino. */ public abstract @NotNull String getBuildId(); /** * Generates the episode file that represents the binding known to this {@link 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. * * @param output * This receives the generated episode file. * * @since 2.1 */ // public abstract void generateEpisode(Result output); /** * 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 */ // public abstract RuntimeTypeInfoSet getRuntimeTypeInfoSet(); /** * The property that you can specify to {@link JAXBContext#newInstance} * to reassign the default namespace URI to something else at the runtime. * *

* The value of the property is {@link String}, and it is used as the namespace URI * that succeeds the default namespace URI. * * @since 2.0 EA1 */ public static final String DEFAULT_NAMESPACE_REMAP = "com.sun.xml.bind.defaultNamespaceRemap"; /** * The property that you can specify to {@link JAXBContext#newInstance} * to put additional JAXB type references into the {@link JAXBContext}. * *

* The value of the property is {@link Collection}<{@link TypeInfo}>. * Those {@link TypeInfo}s can then be used to create {@link XMLBridge}s. * *

* This mechanism allows additional element declarations that were not a part of * the schema into the created {@link JAXBContext}. * * @since 2.0 EA1 */ public static final String TYPE_REFERENCES = "com.sun.xml.bind.typeReferences"; /** * The property that you can specify to {@link JAXBContext#newInstance} * and {@link Marshaller#setProperty(String, Object)} * to enable the c14n marshalling support in the {@link JAXBContext}. * * @see C14nSupport_ArchitectureDocument * @since 2.0 EA2 */ public static final String CANONICALIZATION_SUPPORT = "com.sun.xml.bind.c14n"; /** * The property that you can specify to {@link JAXBContext#newInstance} * to allow unmarshaller to honor xsi:nil anywhere, even if they are * not specifically allowed by the schema. * * @since 2.1.3 */ public static final String TREAT_EVERYTHING_NILLABLE = "com.sun.xml.bind.treatEverythingNillable"; /** * The property that you can specify to {@link JAXBContext#newInstance} * to use alternative {@link RuntimeAnnotationReader} implementation. * * @since 2.1 EA2 */ // public static final String ANNOTATION_READER = RuntimeAnnotationReader.class.getName(); /** * Marshaller/Unmarshaller property to enable XOP processing. * * @since 2.0 EA2 */ public static final String ENABLE_XOP = "com.sun.xml.bind.XOP"; /** * The property that you can specify to {@link JAXBContext#newInstance} * 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 */ public static final String SUBCLASS_REPLACEMENTS = "com.sun.xml.bind.subclassReplacements"; /** * The property that you can specify to {@link JAXBContext#newInstance} * enable support of XmlAccessorFactory annotation in the {@link JAXBContext}. * * @since 2.1 EA2 */ public static final String XMLACCESSORFACTORY_SUPPORT = "com.sun.xml.bind.XmlAccessorFactory"; /** * Retains references to PropertyInfos. * * @since 2.1.10 */ public static final String RETAIN_REFERENCE_TO_INFO = "retainReferenceToInfo"; }