com.sun.xml.ws.developer.WSBindingProvider Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.developer;
import com.sun.istack.NotNull;
import com.sun.xml.ws.api.ComponentRegistry;
import com.sun.xml.ws.api.message.Header;
import com.sun.xml.ws.api.message.Headers;
import com.sun.xml.ws.api.addressing.WSEndpointReference;
import com.sun.xml.ws.api.client.WSPortInfo;
import javax.xml.bind.JAXBContext;
import javax.xml.namespace.QName;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.Service.Mode;
import java.util.List;
import java.io.Closeable;
import org.glassfish.gmbal.ManagedObjectManager;
/**
* {@link BindingProvider} with JAX-WS RI's extension methods.
*
* @author Kohsuke Kawaguchi
* @author Jitendra Kotamraju
* @since 2.1EA3
*/
public interface WSBindingProvider extends BindingProvider, Closeable, ComponentRegistry {
/**
* Sets the out-bound headers to be added to messages sent from
* this {@link BindingProvider}.
*
*
* Calling this method would discard any out-bound headers
* that were previously set.
*
*
* A new {@link Header} object can be created by using
* one of the methods on {@link Headers}.
*
* @param headers
* The headers to be added to the future request messages.
* To clear the outbound headers, pass in either null
* or empty list.
* @throws IllegalArgumentException
* if the list contains null item.
*/
void setOutboundHeaders(List headers);
/**
* Sets the out-bound headers to be added to messages sent from
* this {@link BindingProvider}.
*
*
* Works like {@link #setOutboundHeaders(List)} except
* that it accepts a var arg array.
*
* @param headers
* Can be null or empty.
*/
void setOutboundHeaders(Header... headers);
/**
* Sets the out-bound headers to be added to messages sent from
* this {@link BindingProvider}.
*
*
* Each object must be a JAXB-bound object that is understood
* by the {@link JAXBContext} object known by this {@link WSBindingProvider}
* (that is, if this is a {@link Dispatch} with JAXB, then
* {@link JAXBContext} given to {@link Service#createDispatch(QName,JAXBContext,Mode)}
* and if this is a typed proxy, then {@link JAXBContext}
* implicitly created by the JAX-WS RI.)
*
* @param headers
* Can be null or empty.
* @throws UnsupportedOperationException
* If this {@link WSBindingProvider} is a {@link Dispatch}
* that does not use JAXB.
*/
void setOutboundHeaders(Object... headers);
List getInboundHeaders();
/**
* Sets the endpoint address for all the invocations that happen
* from {@link BindingProvider}. Instead of doing the following
*
*
* ((BindingProvider)proxy).getRequestContext().put(
* BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "...")
*
* you could do this:
*
*
* ((WSBindingProvider)proxy).setAddress("...");
*
* @param address Address of the service
*/
void setAddress(String address);
/**
* Similar to {link BindingProvider#getEndpointReference(}, but returns WSEndpointReference that has more
* convenience methods
*
* @return WSEndpointReference of the target servcie endpoint
*
* @since JAX-WS 2.2
*/
WSEndpointReference getWSEndpointReference();
/**
*
* @return WSPortInfo object that captures the port information for which the stub is created.
* @since JAX-WS 2.2
*/
WSPortInfo getPortInfo();
/**
* Get the ManagedObjectManager for this provider.
*/
public @NotNull ManagedObjectManager getManagedObjectManager();
}