aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.developer;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.xml.internal.bind.api.JAXBRIContext;
aoqi@0: import com.sun.xml.internal.bind.api.TypeReference;
aoqi@0: import com.sun.xml.internal.ws.api.model.SEIModel;
aoqi@0: 
aoqi@0: import javax.xml.bind.JAXBContext;
aoqi@0: import javax.xml.bind.JAXBException;
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Factory to create {@link JAXBContext}.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * JAX-WS uses JAXB to perform databinding when you use the service endpoint interface, and normally
aoqi@0:  * the JAX-WS RI drives JAXB and creates a necessary {@link JAXBContext} automatically.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This annotation is a JAX-WS RI vendor-specific feature, which lets applications create {@link JAXBRIContext}
aoqi@0:  * (which is the JAXB RI's {@link JAXBContext} implementation.)
aoqi@0:  * Combined with the JAXB RI vendor extensions defined in {@link JAXBRIContext}, appliation can use this to
aoqi@0:  * fine-tune how the databinding happens, such as by adding more classes to the binding context,
aoqi@0:  * by controlling the namespace mappings, and so on.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Applications should either use {@link UsesJAXBContextFeature} or {@link UsesJAXBContext} to instruct
aoqi@0:  * the JAX-WS runtime to use a custom factory.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @since 2.1.5
aoqi@0:  */
aoqi@0: public interface JAXBContextFactory {
aoqi@0:     /**
aoqi@0:      * Called by the JAX-WS runtime to create a {@link JAXBRIContext} for the given SEI.
aoqi@0:      *
aoqi@0:      * @param sei
aoqi@0:      *      The {@link SEIModel} object being constructed. This object provides you access to
aoqi@0:      *      what SEI is being processed, and therefore useful if you are writing a generic
aoqi@0:      *      {@link JAXBContextFactory} that can work with arbitrary SEI classes.
aoqi@0:      *
aoqi@0:      * @param classesToBind
aoqi@0:      *      List of classes that needs to be bound by JAXB. This value is computed according to
aoqi@0:      *      the JAX-WS spec and given to you.
aoqi@0:      *
aoqi@0:      *      The calling JAX-WS runtime expects the returned {@link JAXBRIContext} to be capable of
aoqi@0:      *      handling all these classes, but you can add more (which is more common), or remove some
aoqi@0:      *      (if you know what you are doing.)
aoqi@0:      *
aoqi@0:      *      The callee is free to mutate this list.
aoqi@0:      *
aoqi@0:      * @param typeReferences
aoqi@0:      *      List of {@link TypeReference}s, which is also a part of the input to the JAXB RI to control
aoqi@0:      *      how the databinding happens. Most likely this will be just a pass-through to the
aoqi@0:      *      {@link JAXBRIContext#newInstance} method.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      A non-null valid {@link JAXBRIContext} object.
aoqi@0:      *
aoqi@0:      * @throws JAXBException
aoqi@0:      *      If the callee encounters a fatal problem and wants to abort the JAX-WS runtime processing
aoqi@0:      *      of the given SEI, throw a {@link JAXBException}. This will cause the port instantiation
aoqi@0:      *      to fail (if on client), or the application deployment to fail (if on server.)
aoqi@0:      */
aoqi@0:     @NotNull JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List<Class> classesToBind, @NotNull List<TypeReference> typeReferences) throws JAXBException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The default implementation that creates {@link JAXBRIContext} according to the standard behavior.
aoqi@0:      */
aoqi@0:     public static final JAXBContextFactory DEFAULT = new JAXBContextFactory() {
aoqi@0:         @NotNull
aoqi@0:         public JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List<Class> classesToBind, @NotNull List<TypeReference> typeReferences) throws JAXBException {
aoqi@0:             return JAXBRIContext.newInstance(classesToBind.toArray(new Class[classesToBind.size()]),
aoqi@0:                     typeReferences, null, sei.getTargetNamespace(), false, null);
aoqi@0:         }
aoqi@0:     };
aoqi@0: }