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

com.sun.xml.ws.api.pipe.Stubs Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2019 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.api.pipe;

import com.sun.istack.Nullable;
import com.sun.xml.ws.api.WSBinding;
import com.sun.xml.ws.api.WSService;
import com.sun.xml.ws.api.client.WSPortInfo;
import com.sun.xml.ws.api.addressing.WSEndpointReference;
import com.sun.xml.ws.api.message.Message;
import com.sun.xml.ws.api.message.Packet;
import com.sun.xml.ws.api.model.SEIModel;
import com.sun.xml.ws.binding.BindingImpl;
import com.sun.xml.ws.client.WSServiceDelegate;
import com.sun.xml.ws.client.dispatch.DataSourceDispatch;
import com.sun.xml.ws.client.dispatch.DispatchImpl;
import com.sun.xml.ws.client.dispatch.JAXBDispatch;
import com.sun.xml.ws.client.dispatch.MessageDispatch;
import com.sun.xml.ws.client.dispatch.PacketDispatch;
import com.sun.xml.ws.client.sei.SEIStub;
import com.sun.xml.ws.developer.WSBindingProvider;
import com.sun.xml.ws.model.SOAPSEIModel;

import javax.activation.DataSource;
import javax.xml.bind.JAXBContext;
import javax.xml.namespace.QName;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.Source;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.Service.Mode;
import javax.xml.ws.WebServiceException;
import java.lang.reflect.Proxy;

/**
 * Factory methods of various stubs.
 *
 * 

* This class provides various methods to create "stub"s, * which are the component that turns a method invocation * into a {@link Message} and back into a return value. * *

* This class is meant to serve as the API from JAX-WS to * Tango, so that they don't have hard-code dependency on * our implementation classes. * * *

Common Parameters and Their Meanings

* *

Pipe next

*

* Stubs turn a method invocation into a {@link Pipe#process(com.sun.xml.ws.api.message.Packet)} invocation, * and this pipe passed in as the {@code next} parameter will receive a {@link Message} * from newly created stub. All the methods taking Tube <<next>> parameter are deprecated. JAX-WS Runtime takes care of * creating the tubeline when the {@code next} parameter is not passed. This gives flexibility for the JAX-WS Runtime * to pass extra information during the tube line creation via {@link ClientTubeAssemblerContext}. * *

WSPortInfo portInfo

*

Gives information about the port for which the "stub" being created. Such information includes Port QName, * target endpoint address, and bindingId etc. * *

BindingImpl binding

*

* Stubs implement {@link BindingProvider}, and its {@link BindingProvider#getBinding()} * will return this {@code binding} object. Stubs often also use this information * to decide which SOAP version a {@link Message} should be created in. * *

{@link WSService} service

*

* This object represents a {@link Service} that owns the newly created stub. * For example, asynchronous method invocation will use {@link Service#getExecutor()}. * *

{@link WSEndpointReference} epr

*

* If you want the created {@link Dispatch} to talk to the given EPR, specify the parameter. * Otherwise leave it {@code null}. Note that the addressing needs to be enabled separately * for this to take effect. * * @author Kohsuke Kawaguchi * @author Kathy Walsh */ public abstract class Stubs { private Stubs() {} // no instanciation please /** * Creates a new {@link Dispatch} stub for {@link SOAPMessage}. * * This is short-cut of calling *

     * createDispatch(port,owner,binding,SOAPMessage.class,mode,next);
     * 
*/ @Deprecated public static Dispatch createSAAJDispatch(QName portName, WSService owner, WSBinding binding, Service.Mode mode, Tube next, @Nullable WSEndpointReference epr) { DispatchImpl.checkValidSOAPMessageDispatch(binding, mode); return new com.sun.xml.ws.client.dispatch.SOAPMessageDispatch(portName, mode, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub for {@link SOAPMessage}. * * This is short-cut of calling *
     * createDispatch(port,owner,binding,SOAPMessage.class,mode,next);
     * 
*/ public static Dispatch createSAAJDispatch(WSPortInfo portInfo, WSBinding binding, Service.Mode mode, @Nullable WSEndpointReference epr) { DispatchImpl.checkValidSOAPMessageDispatch(binding, mode); return new com.sun.xml.ws.client.dispatch.SOAPMessageDispatch(portInfo, mode, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub for {@link DataSource}. * * This is short-cut of calling *
     * createDispatch(port,owner,binding,DataSource.class,mode,next);
     * 
*/ @Deprecated public static Dispatch createDataSourceDispatch(QName portName, WSService owner, WSBinding binding, Service.Mode mode, Tube next, @Nullable WSEndpointReference epr) { DispatchImpl.checkValidDataSourceDispatch(binding, mode); return new DataSourceDispatch(portName, mode, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub for {@link DataSource}. * * This is short-cut of calling *
     * createDispatch(port,owner,binding,DataSource.class,mode,next);
     * 
*/ public static Dispatch createDataSourceDispatch(WSPortInfo portInfo, WSBinding binding, Service.Mode mode,@Nullable WSEndpointReference epr) { DispatchImpl.checkValidDataSourceDispatch(binding, mode); return new DataSourceDispatch(portInfo, mode, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub for {@link Source}. * * This is short-cut of calling *
     * createDispatch(port,owner,binding,Source.class,mode,next);
     * 
*/ @Deprecated public static Dispatch createSourceDispatch(QName portName, WSService owner, WSBinding binding, Service.Mode mode, Tube next, @Nullable WSEndpointReference epr) { return DispatchImpl.createSourceDispatch(portName, mode, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub for {@link Source}. * * This is short-cut of calling *
     * createDispatch(port,owner,binding,Source.class,mode,next);
     * 
*/ public static Dispatch createSourceDispatch(WSPortInfo portInfo, WSBinding binding, Service.Mode mode, @Nullable WSEndpointReference epr) { return DispatchImpl.createSourceDispatch(portInfo, mode, (BindingImpl)binding, epr); } /** * Creates a new {@link Dispatch} stub that connects to the given pipe. * * @param portName * see {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param owner * see common parameters * @param binding * see common parameters * @param clazz * Type of the {@link Dispatch} to be created. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param mode * The mode of the dispatch. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param next * see common parameters * @param epr * see common parameters * TODO: are these parameters making sense? */ @SuppressWarnings("unchecked") public static Dispatch createDispatch(QName portName, WSService owner, WSBinding binding, Class clazz, Service.Mode mode, Tube next, @Nullable WSEndpointReference epr) { if (clazz == SOAPMessage.class) { return (Dispatch) createSAAJDispatch(portName, owner, binding, mode, next, epr); } else if (clazz == Source.class) { return (Dispatch) createSourceDispatch(portName, owner, binding, mode, next, epr); } else if (clazz == DataSource.class) { return (Dispatch) createDataSourceDispatch(portName, owner, binding, mode, next, epr); } else if (clazz == Message.class) { if(mode==Mode.MESSAGE) return (Dispatch) createMessageDispatch(portName, owner, binding, next, epr); else throw new WebServiceException(mode+" not supported with Dispatch"); } else if (clazz == Packet.class) { return (Dispatch) createPacketDispatch(portName, owner, binding, next, epr); } else throw new WebServiceException("Unknown class type " + clazz.getName()); } /** * Creates a new {@link Dispatch} stub that connects to the given pipe. * * @param portInfo * see common parameters * @param owner * see common parameters * @param binding * see common parameters * @param clazz * Type of the {@link Dispatch} to be created. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param mode * The mode of the dispatch. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param epr * see common parameters * TODO: are these parameters making sense? */ public static Dispatch createDispatch(WSPortInfo portInfo, WSService owner, WSBinding binding, Class clazz, Service.Mode mode, @Nullable WSEndpointReference epr) { if (clazz == SOAPMessage.class) { return (Dispatch) createSAAJDispatch(portInfo, binding, mode, epr); } else if (clazz == Source.class) { return (Dispatch) createSourceDispatch(portInfo, binding, mode, epr); } else if (clazz == DataSource.class) { return (Dispatch) createDataSourceDispatch(portInfo, binding, mode, epr); } else if (clazz == Message.class) { if(mode==Mode.MESSAGE) return (Dispatch) createMessageDispatch(portInfo, binding, epr); else throw new WebServiceException(mode+" not supported with Dispatch"); } else if (clazz == Packet.class) { if(mode==Mode.MESSAGE) return (Dispatch) createPacketDispatch(portInfo, binding, epr); else throw new WebServiceException(mode+" not supported with Dispatch"); } else throw new WebServiceException("Unknown class type " + clazz.getName()); } /** * Creates a new JAXB-based {@link Dispatch} stub that connects to the given pipe. * * @param portName * see {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param owner * see common parameters * @param binding * see common parameters * @param jaxbContext * {@link JAXBContext} used to convert between objects and XML. * @param mode * The mode of the dispatch. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param next * see common parameters * @param epr * see common parameters */ @Deprecated public static Dispatch createJAXBDispatch( QName portName, WSService owner, WSBinding binding, JAXBContext jaxbContext, Service.Mode mode, Tube next, @Nullable WSEndpointReference epr) { return new JAXBDispatch(portName, jaxbContext, mode, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new JAXB-based {@link Dispatch} stub that connects to the given pipe. * * @param portInfo see common parameters * @param binding see common parameters * @param jaxbContext {@link JAXBContext} used to convert between objects and XML. * @param mode The mode of the dispatch. * See {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param epr see common parameters */ public static Dispatch createJAXBDispatch( WSPortInfo portInfo, WSBinding binding, JAXBContext jaxbContext, Service.Mode mode, @Nullable WSEndpointReference epr) { return new JAXBDispatch(portInfo, jaxbContext, mode, (BindingImpl) binding, epr); } /** * Creates a new {@link Message}-based {@link Dispatch} stub that connects to the given pipe. * The returned dispatch is always {@link Mode#MESSAGE}. * * @param portName * see {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param owner * see common parameters * @param binding * see common parameters * @param next * see common parameters * @param epr * see common parameters */ @Deprecated public static Dispatch createMessageDispatch( QName portName, WSService owner, WSBinding binding, Tube next, @Nullable WSEndpointReference epr) { return new MessageDispatch(portName, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new {@link Message}-based {@link Dispatch} stub that connects to the given pipe. * The returned dispatch is always {@link Mode#MESSAGE}. * * @param portInfo * see common parameters * @param binding * see common parameters * @param epr * see common parameters */ public static Dispatch createMessageDispatch( WSPortInfo portInfo, WSBinding binding, @Nullable WSEndpointReference epr) { return new MessageDispatch(portInfo, (BindingImpl)binding, epr); } /** * Creates a new {@link Packet}-based {@link Dispatch} stub that connects to the given pipe. * * @param portName * see {@link Service#createDispatch(QName, Class, Service.Mode)}. * @param owner * see common parameters * @param binding * see common parameters * @param next * see common parameters * @param epr * see common parameters */ public static Dispatch createPacketDispatch( QName portName, WSService owner, WSBinding binding, Tube next, @Nullable WSEndpointReference epr) { return new PacketDispatch(portName, (WSServiceDelegate)owner, next, (BindingImpl)binding, epr); } /** * Creates a new {@link Message}-based {@link Dispatch} stub that connects to the given pipe. * The returned dispatch is always {@link Mode#MESSAGE}. * * @param portInfo * see common parameters * @param binding * see common parameters * @param epr * see common parameters */ public static Dispatch createPacketDispatch( WSPortInfo portInfo, WSBinding binding, @Nullable WSEndpointReference epr) { return new PacketDispatch(portInfo, (BindingImpl)binding, epr); } /** * Creates a new strongly-typed proxy object that implements a given port interface. * * @param service * see common parameters * @param binding * see common parameters * @param model * This model shall represent a port interface. * TODO: can model be constructed from portInterface and binding? * Find out and update. * @param portInterface * The port interface that has operations as Java methods. * @param next * see common parameters * @param epr * see common parameters */ public T createPortProxy( WSService service, WSBinding binding, SEIModel model, Class portInterface, Tube next, @Nullable WSEndpointReference epr ) { SEIStub ps = new SEIStub((WSServiceDelegate)service,(BindingImpl)binding, (SOAPSEIModel)model, next, epr); return portInterface.cast( Proxy.newProxyInstance( portInterface.getClassLoader(), new Class[]{portInterface, WSBindingProvider.class}, ps )); } /** * Creates a new strongly-typed proxy object that implements a given port interface. * * @param portInfo * see common parameters * @param binding * see common parameters * @param model * This model shall represent a port interface. * TODO: can model be constructed from portInterface and binding? * Find out and update. * @param portInterface * The port interface that has operations as Java methods. * @param epr * see common parameters */ public T createPortProxy( WSPortInfo portInfo, WSBinding binding, SEIModel model, Class portInterface, @Nullable WSEndpointReference epr ) { SEIStub ps = new SEIStub(portInfo, (BindingImpl)binding, (SOAPSEIModel)model, epr); return portInterface.cast( Proxy.newProxyInstance( portInterface.getClassLoader(), new Class[]{portInterface, WSBindingProvider.class}, ps )); } }