• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/developer/JAXBContextFactory.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/developer/JAXBContextFactory.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 368

0989ad8c0860

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.ws.developer;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.NotNull;
aoqi@0	29	import com.sun.xml.internal.bind.api.JAXBRIContext;
aoqi@0	30	import com.sun.xml.internal.bind.api.TypeReference;
aoqi@0	31	import com.sun.xml.internal.ws.api.model.SEIModel;
aoqi@0	32
aoqi@0	33	import javax.xml.bind.JAXBContext;
aoqi@0	34	import javax.xml.bind.JAXBException;
aoqi@0	35	import java.util.List;
aoqi@0	36
aoqi@0	37	/**
aoqi@0	38	* Factory to create {@link JAXBContext}.
aoqi@0	39	*
aoqi@0	40	* <p>
aoqi@0	41	* JAX-WS uses JAXB to perform databinding when you use the service endpoint interface, and normally
aoqi@0	42	* the JAX-WS RI drives JAXB and creates a necessary {@link JAXBContext} automatically.
aoqi@0	43	*
aoqi@0	44	* <p>
aoqi@0	45	* This annotation is a JAX-WS RI vendor-specific feature, which lets applications create {@link JAXBRIContext}
aoqi@0	46	* (which is the JAXB RI's {@link JAXBContext} implementation.)
aoqi@0	47	* Combined with the JAXB RI vendor extensions defined in {@link JAXBRIContext}, appliation can use this to
aoqi@0	48	* fine-tune how the databinding happens, such as by adding more classes to the binding context,
aoqi@0	49	* by controlling the namespace mappings, and so on.
aoqi@0	50	*
aoqi@0	51	* <p>
aoqi@0	52	* Applications should either use {@link UsesJAXBContextFeature} or {@link UsesJAXBContext} to instruct
aoqi@0	53	* the JAX-WS runtime to use a custom factory.
aoqi@0	54	*
aoqi@0	55	* @author Kohsuke Kawaguchi
aoqi@0	56	* @since 2.1.5
aoqi@0	57	*/
aoqi@0	58	public interface JAXBContextFactory {
aoqi@0	59	/**
aoqi@0	60	* Called by the JAX-WS runtime to create a {@link JAXBRIContext} for the given SEI.
aoqi@0	61	*
aoqi@0	62	* @param sei
aoqi@0	63	* The {@link SEIModel} object being constructed. This object provides you access to
aoqi@0	64	* what SEI is being processed, and therefore useful if you are writing a generic
aoqi@0	65	* {@link JAXBContextFactory} that can work with arbitrary SEI classes.
aoqi@0	66	*
aoqi@0	67	* @param classesToBind
aoqi@0	68	* List of classes that needs to be bound by JAXB. This value is computed according to
aoqi@0	69	* the JAX-WS spec and given to you.
aoqi@0	70	*
aoqi@0	71	* The calling JAX-WS runtime expects the returned {@link JAXBRIContext} to be capable of
aoqi@0	72	* handling all these classes, but you can add more (which is more common), or remove some
aoqi@0	73	* (if you know what you are doing.)
aoqi@0	74	*
aoqi@0	75	* The callee is free to mutate this list.
aoqi@0	76	*
aoqi@0	77	* @param typeReferences
aoqi@0	78	* List of {@link TypeReference}s, which is also a part of the input to the JAXB RI to control
aoqi@0	79	* how the databinding happens. Most likely this will be just a pass-through to the
aoqi@0	80	* {@link JAXBRIContext#newInstance} method.
aoqi@0	81	*
aoqi@0	82	* @return
aoqi@0	83	* A non-null valid {@link JAXBRIContext} object.
aoqi@0	84	*
aoqi@0	85	* @throws JAXBException
aoqi@0	86	* If the callee encounters a fatal problem and wants to abort the JAX-WS runtime processing
aoqi@0	87	* of the given SEI, throw a {@link JAXBException}. This will cause the port instantiation
aoqi@0	88	* to fail (if on client), or the application deployment to fail (if on server.)
aoqi@0	89	*/
aoqi@0	90	@NotNull JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List<Class> classesToBind, @NotNull List<TypeReference> typeReferences) throws JAXBException;
aoqi@0	91
aoqi@0	92	/**
aoqi@0	93	* The default implementation that creates {@link JAXBRIContext} according to the standard behavior.
aoqi@0	94	*/
aoqi@0	95	public static final JAXBContextFactory DEFAULT = new JAXBContextFactory() {
aoqi@0	96	@NotNull
aoqi@0	97	public JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List<Class> classesToBind, @NotNull List<TypeReference> typeReferences) throws JAXBException {
aoqi@0	98	return JAXBRIContext.newInstance(classesToBind.toArray(new Class[classesToBind.size()]),
aoqi@0	99	typeReferences, null, sei.getTargetNamespace(), false, null);
aoqi@0	100	}
aoqi@0	101	};
aoqi@0	102	}