001 /*
002 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.xml.ws;
027
028 import java.util.Map;
029
030 /** The <code>BindingProvider</code> interface provides access to the
031 * protocol binding and associated context objects for request and
032 * response message processing.
033 *
034 * @since JAX-WS 2.0
035 *
036 * @see javax.xml.ws.Binding
037 **/
038 public interface BindingProvider {
039 /** Standard property: User name for authentication.
040 * <p>Type: java.lang.String
041 **/
042 public static final String USERNAME_PROPERTY = "javax.xml.ws.security.auth.username";
043
044 /** Standard property: Password for authentication.
045 * <p>Type: java.lang.String
046 **/
047 public static final String PASSWORD_PROPERTY = "javax.xml.ws.security.auth.password";
048
049 /** Standard property: Target service endpoint address. The
050 * URI scheme for the endpoint address specification must
051 * correspond to the protocol/transport binding for the
052 * binding in use.
053 * <p>Type: java.lang.String
054 **/
055 public static final String ENDPOINT_ADDRESS_PROPERTY = "javax.xml.ws.service.endpoint.address";
056
057 /** Standard property: This boolean property is used by a service
058 * client to indicate whether or not it wants to participate in
059 * a session with a service endpoint. If this property is set to
060 * true, the service client indicates that it wants the session
061 * to be maintained. If set to false, the session is not maintained.
062 * The default value for this property is false.
063 * <p>Type: java.lang.Boolean
064 **/
065 public static final String SESSION_MAINTAIN_PROPERTY = "javax.xml.ws.session.maintain";
066
067 /** Standard property for SOAPAction. This boolean property
068 * indicates whether or not SOAPAction is to be used. The
069 * default value of this property is false indicating that
070 * the SOAPAction is not used.
071 * <p>Type: <code>java.lang.Boolean</code>
072 **/
073 public static final String SOAPACTION_USE_PROPERTY = "javax.xml.ws.soap.http.soapaction.use";
074
075 /** Standard property for SOAPAction. Indicates the SOAPAction
076 * URI if the <code>javax.xml.ws.soap.http.soapaction.use</code>
077 * property is set to <code>true</code>.
078 * <p>Type: <code>java.lang.String</code>
079 **/
080 public static final String SOAPACTION_URI_PROPERTY = "javax.xml.ws.soap.http.soapaction.uri";
081
082 /** Get the context that is used to initialize the message context
083 * for request messages.
084 *
085 * Modifications to the request context do not affect the message context of
086 * either synchronous or asynchronous operations that have already been
087 * started.
088 *
089 * @return The context that is used in processing request messages.
090 **/
091 Map<String, Object> getRequestContext();
092
093 /** Get the context that resulted from processing a response message.
094 *
095 * The returned context is for the most recently completed synchronous
096 * operation. Subsequent synchronous operation invocations overwrite the
097 * response context. Asynchronous operations return their response context
098 * via the Response interface.
099 *
100 * @return The context that resulted from processing the latest
101 * response messages.
102 **/
103 Map<String, Object> getResponseContext();
104
105 /** Get the Binding for this binding provider.
106 *
107 * @return The Binding for this binding provider.
108 **/
109 Binding getBinding();
110 }
|