42.3. Working with Contexts in a Consumer Implementation
BindingProviderinstance holds context information in two separate contexts:
- Request ContextThe request context enables you to set properties that affect outbound messages. Request context properties are applied to a specific port instance and, once set, the properties affect every subsequent operation invocation made on the port, until such time as a property is explicitly cleared. For example, you might use a request context property to set a connection timeout or to initialize data for sending in a header.
- Response ContextThe response context enables you to read the property values set by the response to the last operation invocation made from the current thread. Response context properties are reset after every operation invocation. For example, you might access a response context property to read header information received from the last inbound message.
Obtaining a context
BindingProviderinterface has two methods for obtaining a context:
getRequestContext()method, shown in Example 42.7, “The
getRequestContext()Method”, returns the request context as a
Mapobject. The returned
Mapobject can be used to directly manipulate the contents of the context.
Example 42.7. The
Map<String, Object> getRequestContext();
getResponseContext(), shown in Example 42.8, “The
getResponseContext()Method”, returns the response context as a
Mapobject. The returned
Mapobject's contents reflect the state of the response context's contents from the most recent successful request on a remote service made in the current thread.
Example 42.8. The
Map<String, Object> getResponseContext();
BindingProviderobject can be obtained by casting a proxy object. The contexts obtained from the
BindingProviderobject are only valid for operations invoked on the proxy object used to create it.
Example 42.9. Getting a Consumer's Request Context
// Proxy widgetProxy obtained previously BindingProvider bp = (BindingProvider)widgetProxy; Map<String, Object> requestContext = bp.getRequestContext();
Reading a property from a context
java.util.Map<String, Object>objects. The map has keys that are String objects and values that contain arbitrary objects. Use
java.util.Map.get()to access an entry in the map of response context properties.
Example 42.10. Reading a Response Context Property
// Invoke an operation. port.SomeOperation(); // Read response context property. java.util.Map<String, Object> responseContext = ((javax.xml.ws.BindingProvider)port).getResponseContext(); PropertyType propValue = (PropertyType) responseContext.get(ContextPropertyName);
Setting properties in a context
java.util.Map<String, Object>objects. The map has keys that are String objects and values that are arbitrary objects. To set a property in a context use the
Example 42.11. Setting a Request Context Property
// Set request context property. java.util.Map<String, Object> requestContext = ((javax.xml.ws.BindingProvider)port).getRequestContext(); requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/widgets"); // Invoke an operation. port.SomeOperation();
Table 42.2. Consumer Context Properties
|Specifies the address of the target service. The value is stored as a |
|Specifies the username used for HTTP basic authentication. The value is stored as a |
|Specifies the password used for HTTP basic authentication. The value is stored as a |
|Specifies if the client wants to maintain session information. The value is stored as a |
|Specifies the WS-Addressing information used by the consumer to contact the desired service provider. The value is stored as a |
|Contains the JMS headers for the message. For more information see Section 42.4, “Working with JMS Message Properties”.|
[a] This property is overridden by the username defined in the HTTP security settings.
[b] This property is overridden by the password defined in the HTTP security settings.
[c] The Apache CXF ignores this property.