Java example source code file (BindingProvider.java)

This example Java source code file (BindingProvider.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

binding, bindingprovider, endpoint_address_property, endpointreference, map, object, password_property, session_maintain_property, soapaction_uri_property, soapaction_use_property, string, username_property, util

The BindingProvider.java Java example source code

/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.ws;

import java.util.Map;
import javax.xml.ws.wsaddressing.W3CEndpointReference;

/**
 * The <code>BindingProvider interface provides access to the
 * protocol binding and associated context objects for request and
 * response message processing.
 *
 * @since JAX-WS 2.0
 *
 * @see javax.xml.ws.Binding
 **/
public interface BindingProvider {
    /**
     * Standard property: User name for authentication.
     * <p>Type: java.lang.String
     **/
    public static final String USERNAME_PROPERTY =
            "javax.xml.ws.security.auth.username";

    /**
     * Standard property: Password for authentication.
     * <p>Type: java.lang.String
     **/
    public static final String PASSWORD_PROPERTY =
            "javax.xml.ws.security.auth.password";

    /**
     * Standard property: Target service endpoint address. The
     * URI scheme for the endpoint address specification MUST
     * correspond to the protocol/transport binding for the
     * binding in use.
     * <p>Type: java.lang.String
     **/
    public static final String ENDPOINT_ADDRESS_PROPERTY =
            "javax.xml.ws.service.endpoint.address";

    /**
     * Standard property: This boolean property is used by a service
     * client to indicate whether or not it wants to participate in
     * a session with a service endpoint. If this property is set to
     * <code>true, the service client indicates that it wants the session
     * to be maintained. If set to <code>false, the session is not maintained.
     * The default value for this property is <code>false.
     * <p>Type: java.lang.Boolean
     **/
    public static final String SESSION_MAINTAIN_PROPERTY =
            "javax.xml.ws.session.maintain";

    /**
     * Standard property for SOAPAction. This boolean property
     * indicates whether or not the value of the
     * <code>javax.xml.ws.soap.http.soapaction.uri property
     * is used for the value of the SOAPAction. The
     * default value of this property is <code>false indicating
     * that the
     * <code>javax.xml.ws.soap.http.soapaction.uri property
     * is not used for the value of the SOAPAction, however,
     * if WS-Addressing is enabled, the default value is
     * <code>true.
     *
     * <p>Type: java.lang.Boolean
     **/
    public static final String SOAPACTION_USE_PROPERTY =
            "javax.xml.ws.soap.http.soapaction.use";

    /**
     * Standard property for SOAPAction. Indicates the SOAPAction
     * URI if the <code>javax.xml.ws.soap.http.soapaction.use
     * property is set to <code>true. If WS-Addressing
     * is enabled, this value will also be used for the value of the
     * WS-Addressing Action header.  If this property is not set,
     * the default SOAPAction and WS-Addressing Action will be sent.
     *
     * <p>Type: java.lang.String
     **/
    public static final String SOAPACTION_URI_PROPERTY =
            "javax.xml.ws.soap.http.soapaction.uri";

    /**
     * Get the context that is used to initialize the message context
     * for request messages.
     *
     * Modifications to the request context do not affect the message context of
     * either synchronous or asynchronous operations that have already been
     * started.
     *
     * @return The context that is used in processing request messages.
     **/
    Map<String, Object> getRequestContext();

    /**
     * Get the context that resulted from processing a response message.
     *
     * The returned context is for the most recently completed synchronous
     * operation. Subsequent synchronous operation invocations overwrite the
     * response context. Asynchronous operations return their response context
     * via the Response interface.
     *
     * @return The context that resulted from processing the latest
     * response messages.
     **/
    Map<String, Object> getResponseContext();

    /**
     * Get the Binding for this binding provider.
     *
     * @return The Binding for this binding provider.
     **/
    Binding getBinding();



    /**
     * Returns the <code>EndpointReference associated with
     * this <code>BindingProvider instance.
     * <p>
     * If the Binding for this <code>bindingProvider is
     * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
     * <code>W3CEndpointReference MUST be returned.
     *
     * @return EndpointReference of the target endpoint associated with this
     * <code>BindingProvider instance.
     *
     * @throws java.lang.UnsupportedOperationException If this
     * <code>BindingProvider uses the XML/HTTP binding.
     *
     * @see W3CEndpointReference
     *
     * @since JAX-WS 2.1
     */
    public EndpointReference getEndpointReference();


    /**
     * Returns the <code>EndpointReference associated with
     * this <code>BindingProvider instance.  The instance
     * returned will be of type <code>clazz.
     *
     * @param clazz Specifies the type of <code>EndpointReference
     * that MUST be returned.

     * @return EndpointReference of the target endpoint associated with this
     * <code>BindingProvider instance. MUST be of type
     * <code>clazz.

     * @throws WebServiceException If the Class <code>clazz
     * is not supported by this implementation.
     * @throws java.lang.UnsupportedOperationException If this
     * <code>BindingProvider uses the XML/HTTP binding.
     *
     * @since JAX-WS 2.1
     */
    public <T extends EndpointReference> T getEndpointReference(Class clazz);
}