Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/BindingProvider.java@f453f4eaf8b4 (annotated)
src/share/jaxws_classes/javax/xml/ws/BindingProvider.java
Tue, 07 Nov 2017 18:54:04 -0800
- author
- asaha
- date
- Tue, 07 Nov 2017 18:54:04 -0800
- changeset 1528
- f453f4eaf8b4
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
Added tag jdk8u162-b06 for changeset 6095742f8034
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.ws; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.Map; |
| aoqi@0 | 29 | import javax.xml.ws.wsaddressing.W3CEndpointReference; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * The <code>BindingProvider</code> interface provides access to the |
| aoqi@0 | 33 | * protocol binding and associated context objects for request and |
| aoqi@0 | 34 | * response message processing. |
| aoqi@0 | 35 | * |
| aoqi@0 | 36 | * @since JAX-WS 2.0 |
| aoqi@0 | 37 | * |
| aoqi@0 | 38 | * @see javax.xml.ws.Binding |
| aoqi@0 | 39 | **/ |
| aoqi@0 | 40 | public interface BindingProvider { |
| aoqi@0 | 41 | /** |
| aoqi@0 | 42 | * Standard property: User name for authentication. |
| aoqi@0 | 43 | * <p>Type: <code>java.lang.String</code> |
| aoqi@0 | 44 | **/ |
| aoqi@0 | 45 | public static final String USERNAME_PROPERTY = |
| aoqi@0 | 46 | "javax.xml.ws.security.auth.username"; |
| aoqi@0 | 47 | |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Standard property: Password for authentication. |
| aoqi@0 | 50 | * <p>Type: <code>java.lang.String</code> |
| aoqi@0 | 51 | **/ |
| aoqi@0 | 52 | public static final String PASSWORD_PROPERTY = |
| aoqi@0 | 53 | "javax.xml.ws.security.auth.password"; |
| aoqi@0 | 54 | |
| aoqi@0 | 55 | /** |
| aoqi@0 | 56 | * Standard property: Target service endpoint address. The |
| aoqi@0 | 57 | * URI scheme for the endpoint address specification MUST |
| aoqi@0 | 58 | * correspond to the protocol/transport binding for the |
| aoqi@0 | 59 | * binding in use. |
| aoqi@0 | 60 | * <p>Type: <code>java.lang.String</code> |
| aoqi@0 | 61 | **/ |
| aoqi@0 | 62 | public static final String ENDPOINT_ADDRESS_PROPERTY = |
| aoqi@0 | 63 | "javax.xml.ws.service.endpoint.address"; |
| aoqi@0 | 64 | |
| aoqi@0 | 65 | /** |
| aoqi@0 | 66 | * Standard property: This boolean property is used by a service |
| aoqi@0 | 67 | * client to indicate whether or not it wants to participate in |
| aoqi@0 | 68 | * a session with a service endpoint. If this property is set to |
| aoqi@0 | 69 | * <code>true</code>, the service client indicates that it wants the session |
| aoqi@0 | 70 | * to be maintained. If set to <code>false</code>, the session is not maintained. |
| aoqi@0 | 71 | * The default value for this property is <code>false</code>. |
| aoqi@0 | 72 | * <p>Type: <code>java.lang.Boolean</code> |
| aoqi@0 | 73 | **/ |
| aoqi@0 | 74 | public static final String SESSION_MAINTAIN_PROPERTY = |
| aoqi@0 | 75 | "javax.xml.ws.session.maintain"; |
| aoqi@0 | 76 | |
| aoqi@0 | 77 | /** |
| aoqi@0 | 78 | * Standard property for SOAPAction. This boolean property |
| aoqi@0 | 79 | * indicates whether or not the value of the |
| aoqi@0 | 80 | * <code>javax.xml.ws.soap.http.soapaction.uri</code> property |
| aoqi@0 | 81 | * is used for the value of the SOAPAction. The |
| aoqi@0 | 82 | * default value of this property is <code>false</code> indicating |
| aoqi@0 | 83 | * that the |
| aoqi@0 | 84 | * <code>javax.xml.ws.soap.http.soapaction.uri</code> property |
| aoqi@0 | 85 | * is not used for the value of the SOAPAction, however, |
| aoqi@0 | 86 | * if WS-Addressing is enabled, the default value is |
| aoqi@0 | 87 | * <code>true</code>. |
| aoqi@0 | 88 | * |
| aoqi@0 | 89 | * <p>Type: <code>java.lang.Boolean</code> |
| aoqi@0 | 90 | **/ |
| aoqi@0 | 91 | public static final String SOAPACTION_USE_PROPERTY = |
| aoqi@0 | 92 | "javax.xml.ws.soap.http.soapaction.use"; |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | /** |
| aoqi@0 | 95 | * Standard property for SOAPAction. Indicates the SOAPAction |
| aoqi@0 | 96 | * URI if the <code>javax.xml.ws.soap.http.soapaction.use</code> |
| aoqi@0 | 97 | * property is set to <code>true</code>. If WS-Addressing |
| aoqi@0 | 98 | * is enabled, this value will also be used for the value of the |
| aoqi@0 | 99 | * WS-Addressing Action header. If this property is not set, |
| aoqi@0 | 100 | * the default SOAPAction and WS-Addressing Action will be sent. |
| aoqi@0 | 101 | * |
| aoqi@0 | 102 | * <p>Type: <code>java.lang.String</code> |
| aoqi@0 | 103 | **/ |
| aoqi@0 | 104 | public static final String SOAPACTION_URI_PROPERTY = |
| aoqi@0 | 105 | "javax.xml.ws.soap.http.soapaction.uri"; |
| aoqi@0 | 106 | |
| aoqi@0 | 107 | /** |
| aoqi@0 | 108 | * Get the context that is used to initialize the message context |
| aoqi@0 | 109 | * for request messages. |
| aoqi@0 | 110 | * |
| aoqi@0 | 111 | * Modifications to the request context do not affect the message context of |
| aoqi@0 | 112 | * either synchronous or asynchronous operations that have already been |
| aoqi@0 | 113 | * started. |
| aoqi@0 | 114 | * |
| aoqi@0 | 115 | * @return The context that is used in processing request messages. |
| aoqi@0 | 116 | **/ |
| aoqi@0 | 117 | Map<String, Object> getRequestContext(); |
| aoqi@0 | 118 | |
| aoqi@0 | 119 | /** |
| aoqi@0 | 120 | * Get the context that resulted from processing a response message. |
| aoqi@0 | 121 | * |
| aoqi@0 | 122 | * The returned context is for the most recently completed synchronous |
| aoqi@0 | 123 | * operation. Subsequent synchronous operation invocations overwrite the |
| aoqi@0 | 124 | * response context. Asynchronous operations return their response context |
| aoqi@0 | 125 | * via the Response interface. |
| aoqi@0 | 126 | * |
| aoqi@0 | 127 | * @return The context that resulted from processing the latest |
| aoqi@0 | 128 | * response messages. |
| aoqi@0 | 129 | **/ |
| aoqi@0 | 130 | Map<String, Object> getResponseContext(); |
| aoqi@0 | 131 | |
| aoqi@0 | 132 | /** |
| aoqi@0 | 133 | * Get the Binding for this binding provider. |
| aoqi@0 | 134 | * |
| aoqi@0 | 135 | * @return The Binding for this binding provider. |
| aoqi@0 | 136 | **/ |
| aoqi@0 | 137 | Binding getBinding(); |
| aoqi@0 | 138 | |
| aoqi@0 | 139 | |
| aoqi@0 | 140 | |
| aoqi@0 | 141 | /** |
| aoqi@0 | 142 | * Returns the <code>EndpointReference</code> associated with |
| aoqi@0 | 143 | * this <code>BindingProvider</code> instance. |
| aoqi@0 | 144 | * <p> |
| aoqi@0 | 145 | * If the Binding for this <code>bindingProvider</code> is |
| aoqi@0 | 146 | * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a |
| aoqi@0 | 147 | * <code>W3CEndpointReference</code> MUST be returned. |
| aoqi@0 | 148 | * |
| aoqi@0 | 149 | * @return EndpointReference of the target endpoint associated with this |
| aoqi@0 | 150 | * <code>BindingProvider</code> instance. |
| aoqi@0 | 151 | * |
| aoqi@0 | 152 | * @throws java.lang.UnsupportedOperationException If this |
| aoqi@0 | 153 | * <code>BindingProvider</code> uses the XML/HTTP binding. |
| aoqi@0 | 154 | * |
| aoqi@0 | 155 | * @see W3CEndpointReference |
| aoqi@0 | 156 | * |
| aoqi@0 | 157 | * @since JAX-WS 2.1 |
| aoqi@0 | 158 | */ |
| aoqi@0 | 159 | public EndpointReference getEndpointReference(); |
| aoqi@0 | 160 | |
| aoqi@0 | 161 | |
| aoqi@0 | 162 | /** |
| aoqi@0 | 163 | * Returns the <code>EndpointReference</code> associated with |
| aoqi@0 | 164 | * this <code>BindingProvider</code> instance. The instance |
| aoqi@0 | 165 | * returned will be of type <code>clazz</code>. |
| aoqi@0 | 166 | * |
| aoqi@0 | 167 | * @param clazz Specifies the type of <code>EndpointReference</code> |
| aoqi@0 | 168 | * that MUST be returned. |
| aoqi@0 | 169 | |
| aoqi@0 | 170 | * @return EndpointReference of the target endpoint associated with this |
| aoqi@0 | 171 | * <code>BindingProvider</code> instance. MUST be of type |
| aoqi@0 | 172 | * <code>clazz</code>. |
| aoqi@0 | 173 | |
| aoqi@0 | 174 | * @throws WebServiceException If the Class <code>clazz</code> |
| aoqi@0 | 175 | * is not supported by this implementation. |
| aoqi@0 | 176 | * @throws java.lang.UnsupportedOperationException If this |
| aoqi@0 | 177 | * <code>BindingProvider</code> uses the XML/HTTP binding. |
| aoqi@0 | 178 | * |
| aoqi@0 | 179 | * @since JAX-WS 2.1 |
| aoqi@0 | 180 | */ |
| aoqi@0 | 181 | public <T extends EndpointReference> T getEndpointReference(Class<T> clazz); |
| aoqi@0 | 182 | } |
