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

Fri, 14 Feb 2014 11:13:45 +0100

author
mkos
date
Fri, 14 Feb 2014 11:13:45 +0100
changeset 515
6cd506508147
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8026188: Enhance envelope factory
Summary: Avoiding caching data initialized via TCCL in static context; fix also reviewed by Alexander Fomin
Reviewed-by: ahgross, mgrebac, skoivu

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

mercurial