org.picketlink.trust.jbossws

Class PicketLinkDispatch

java.lang.Object

org.picketlink.trust.jbossws.PicketLinkDispatch

All Implemented Interfaces:

BindingProvider, Dispatch<Source>

public class PicketLinkDispatch
extends Object
implements Dispatch<Source>

A concrete implementation of Dispatch that can be used as an alternative to the underlying JAXWS implementation.

This is used by setting the module option "overrideDispatch" to true in the JBWSTokenIssuingLoginModule

Since:

May 10, 2011

Author:

Anil.Saldhana@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PicketLinkDispatch.PLMessageContext

Field Summary

Fields inherited from interface javax.xml.ws.BindingProvider

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
PicketLinkDispatch(Dispatch parent, String endpoint)

Method Summary

Modifier and Type	Method and Description
Binding	getBinding() Get the Binding for this binding provider.
EndpointReference	getEndpointReference() Returns the EndpointReference associated with this BindingProvider instance.
<T extends EndpointReference> T	getEndpointReference(Class<T> clazz) Returns the EndpointReference associated with this BindingProvider instance.
Map<String,Object>	getRequestContext() Get the context that is used to initialize the message context for request messages.
Map<String,Object>	getResponseContext() Get the context that resulted from processing a response message.
Source	invoke(Source requestMessage) Invoke a service operation synchronously.
Response<Source>	invokeAsync(Source msg) Invoke a service operation asynchronously.
Future<?>	invokeAsync(Source msg, AsyncHandler<Source> handler) Invoke a service operation asynchronously.
void	invokeOneWay(Source msg) Invokes a service operation using the one-way interaction mode.
void	setSSLSocketFactory(SSLSocketFactory ssl)
void	setUseWSSE(boolean val)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PicketLinkDispatch

public PicketLinkDispatch(Dispatch parent,
                          String endpoint)

Method Detail

setUseWSSE

public void setUseWSSE(boolean val)

setSSLSocketFactory

public void setSSLSocketFactory(SSLSocketFactory ssl)

getRequestContext

public Map<String,Object> getRequestContext()

Description copied from interface: BindingProvider

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.

Specified by:

getRequestContext in interface BindingProvider

Returns:

The context that is used in processing request messages.

getResponseContext

public Map<String,Object> getResponseContext()

Description copied from interface: BindingProvider

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.

Specified by:

getResponseContext in interface BindingProvider

Returns:

The context that resulted from processing the latest response messages.

getBinding

public Binding getBinding()

Description copied from interface: BindingProvider

Get the Binding for this binding provider.

Specified by:

getBinding in interface BindingProvider

Returns:

The Binding for this binding provider.

getEndpointReference

public EndpointReference getEndpointReference()

Description copied from interface: BindingProvider

Returns the EndpointReference associated with this BindingProvider instance.

If the Binding for this bindingProvider is either SOAP1.1/HTTP or SOAP1.2/HTTP, then a W3CEndpointReference MUST be returned.

Specified by:

getEndpointReference in interface BindingProvider

Returns:

EndpointReference of the target endpoint associated with this BindingProvider instance.

See Also:

W3CEndpointReference

getEndpointReference

public <T extends EndpointReference> T getEndpointReference(Class<T> clazz)

Description copied from interface: BindingProvider

Returns the EndpointReference associated with this BindingProvider instance. The instance returned will be of type clazz.

Specified by:

getEndpointReference in interface BindingProvider

Parameters:

clazz - Specifies the type of EndpointReference that MUST be returned.

Returns:

EndpointReference of the target endpoint associated with this BindingProvider instance. MUST be of type clazz.

invoke

public Source invoke(Source requestMessage)

Description copied from interface: Dispatch

Invoke a service operation synchronously. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

Specified by:

invoke in interface Dispatch<Source>

Parameters:

requestMessage - An object that will form the message or payload of the message used to invoke the operation.

Returns:

The response message or message payload to the operation invocation.

invokeAsync

public Response<Source> invokeAsync(Source msg)

Description copied from interface: Dispatch

Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are obtained by polling the returned Response.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

Specified by:

invokeAsync in interface Dispatch<Source>

Parameters:

msg - An object that will form the message or payload of the message used to invoke the operation.

Returns:

The response message or message payload to the operation invocation.

invokeAsync

public Future<?> invokeAsync(Source msg,
                             AsyncHandler<Source> handler)

Description copied from interface: Dispatch

Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are communicated to the client via the passed in handler.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

Specified by:

invokeAsync in interface Dispatch<Source>

Parameters:

msg - An object that will form the message or payload of the message used to invoke the operation.

handler - The handler object that will receive the response to the operation invocation.

Returns:

A Future object that may be used to check the status of the operation invocation. This object MUST NOT be used to try to obtain the results of the operation - the object returned from Future<?>.get() is implementation dependent and any use of it will result in non-portable behaviour.

invokeOneWay

public void invokeOneWay(Source msg)

Description copied from interface: Dispatch

Invokes a service operation using the one-way interaction mode. The operation invocation is logically non-blocking, subject to the capabilities of the underlying protocol, no results are returned. When the protocol in use is SOAP/HTTP, this method MUST block until an HTTP response code has been received or an error occurs.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

Specified by:

invokeOneWay in interface Dispatch<Source>

Parameters:

msg - An object that will form the message or payload of the message used to invoke the operation.