com.sun.xml.ws.developer.JAXBContextFactory Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.developer;
import com.sun.istack.NotNull;
import org.glassfish.jaxb.runtime.api.JAXBRIContext;
import org.glassfish.jaxb.runtime.api.TypeReference;
import com.sun.xml.ws.api.model.SEIModel;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;
import java.util.List;
/**
* Factory to create {@link JAXBContext}.
*
*
* JAX-WS uses JAXB to perform databinding when you use the service endpoint interface, and normally
* the JAX-WS RI drives JAXB and creates a necessary {@link JAXBContext} automatically.
*
*
* This annotation is a JAX-WS RI vendor-specific feature, which lets applications create {@link JAXBRIContext}
* (which is the JAXB RI's {@link JAXBContext} implementation.)
* Combined with the JAXB RI vendor extensions defined in {@link JAXBRIContext}, appliation can use this to
* fine-tune how the databinding happens, such as by adding more classes to the binding context,
* by controlling the namespace mappings, and so on.
*
*
* Applications should either use {@link UsesJAXBContextFeature} or {@link UsesJAXBContext} to instruct
* the JAX-WS runtime to use a custom factory.
*
* @author Kohsuke Kawaguchi
* @since 2.1.5
*/
public interface JAXBContextFactory {
/**
* Called by the JAX-WS runtime to create a {@link JAXBRIContext} for the given SEI.
*
* @param sei
* The {@link SEIModel} object being constructed. This object provides you access to
* what SEI is being processed, and therefore useful if you are writing a generic
* {@link JAXBContextFactory} that can work with arbitrary SEI classes.
*
* @param classesToBind
* List of classes that needs to be bound by JAXB. This value is computed according to
* the JAX-WS spec and given to you.
*
* The calling JAX-WS runtime expects the returned {@link JAXBRIContext} to be capable of
* handling all these classes, but you can add more (which is more common), or remove some
* (if you know what you are doing.)
*
* The callee is free to mutate this list.
*
* @param typeReferences
* List of {@link TypeReference}s, which is also a part of the input to the JAXB RI to control
* how the databinding happens. Most likely this will be just a pass-through to the
* {@link JAXBRIContext#newInstance} method.
*
* @return
* A non-null valid {@link JAXBRIContext} object.
*
* @throws JAXBException
* If the callee encounters a fatal problem and wants to abort the JAX-WS runtime processing
* of the given SEI, throw a {@link JAXBException}. This will cause the port instantiation
* to fail (if on client), or the application deployment to fail (if on server.)
*/
@NotNull JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List classesToBind, @NotNull List typeReferences) throws JAXBException;
/**
* The default implementation that creates {@link JAXBRIContext} according to the standard behavior.
*/
public static final JAXBContextFactory DEFAULT = new JAXBContextFactory() {
@NotNull
public JAXBRIContext createJAXBContext(@NotNull SEIModel sei, @NotNull List classesToBind, @NotNull List typeReferences) throws JAXBException {
return JAXBRIContext.newInstance(classesToBind.toArray(new Class[classesToBind.size()]),
typeReferences, null, sei.getTargetNamespace(), false, null);
}
};
}