org.ws4d.java.service

Class DefaultService.ServiceMessageListener

java.lang.Object

org.ws4d.java.communication.listener.DefaultIncomingMessageListener

org.ws4d.java.service.DefaultService.ServiceMessageListener

All Implemented Interfaces:

IncomingMessageListener

Enclosing class:

DefaultService

protected class DefaultService.ServiceMessageListener
extends DefaultIncomingMessageListener

Field Summary

Fields inherited from class org.ws4d.java.communication.listener.DefaultIncomingMessageListener

credentialInfo

Constructor Summary

Constructors

Constructor and Description
ServiceMessageListener(CredentialInfo credentialInfo)

Method Summary

Modifier and Type	Method and Description
EventSource	getEvent(java.lang.String action)
OperationDescription	getOperation(java.lang.String actionName) Returns an operation for a given wsa:Action.
GetMetadataResponseMessage	handle(GetMetadataMessage getMetadata, ConnectionInfo connectionInfo) Receives an incoming get metadata message.
GetStatusResponseMessage	handle(GetStatusMessage getStatus, ConnectionInfo connectionInfo) Receives an incoming get-status message (WS-Eventing).
InvokeMessage	handle(InvokeMessage invokeRequest, ConnectionInfo connectionInfo) Receives an incoming invoke request.
RenewResponseMessage	handle(RenewMessage renew, ConnectionInfo connectionInfo) Receives an incoming renew message (WS-Eventing).
SubscribeResponseMessage	handle(SubscribeMessage subscribe, boolean useReferenceParameterMode, ConnectionInfo connectionInfo) Receives an incoming subscribe message.
UnsubscribeResponseMessage	handle(UnsubscribeMessage unsubscribe, ConnectionInfo connectionInfo) Receives an incoming unsubscribe message (WS-Eventing).

Methods inherited from class org.ws4d.java.communication.listener.DefaultIncomingMessageListener

getCredentialInfo, handle, handle, handle, handle, handle, handle

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceMessageListener

public ServiceMessageListener(CredentialInfo credentialInfo)

Method Detail

handle

public GetMetadataResponseMessage handle(GetMetadataMessage getMetadata,
                                         ConnectionInfo connectionInfo)
                                  throws SOAPException,
                                         AuthorizationException

Description copied from interface: IncomingMessageListener

Receives an incoming get metadata message. Must return a valid GetMetadataResponseMessage if processing the get metadata request succeeded. Must throw a SOAPException describing the failure otherwise.

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

getMetadata - the incoming request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

the response to the issued getMetadata request

Throws:

SOAPException - if processing the incoming metadata request fails, e.g. because this instance can not handle get metadata messages or the request includes unexpected content, etc.

AuthorizationException

handle

public SubscribeResponseMessage handle(SubscribeMessage subscribe,
                                       boolean useReferenceParameterMode,
                                       ConnectionInfo connectionInfo)
                                throws SOAPException

Description copied from interface: IncomingMessageListener

Receives an incoming subscribe message. Returns a suitable SubscribeResponseMessage or throws a SOAPException if processing the incoming request fails for any reason.

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

subscribe - the incoming subscribe request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

a valid response to the incoming subscribe request

Throws:

SOAPException - if processing the subscribe request fails for any reason, e.g. when this endpoint can not handle subscribe requests, or the request's content is malformed, etc.

handle

public GetStatusResponseMessage handle(GetStatusMessage getStatus,
                                       ConnectionInfo connectionInfo)
                                throws SOAPException

Description copied from interface: IncomingMessageListener

Receives an incoming get-status message (WS-Eventing). Returns a suitable GetStatusResponseMessage or throws a SOAPException if processing the incoming request fails for some reason.

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

getStatus - the incoming get-status request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

a valid response to the incoming get-status request

Throws:

SOAPException - if processing the get-status request fails for some reason, e.g. when this endpoint cannot handle get-status requests, or the request's content is malformed, etc.

handle

public RenewResponseMessage handle(RenewMessage renew,
                                   ConnectionInfo connectionInfo)
                            throws SOAPException

Description copied from interface: IncomingMessageListener

Receives an incoming renew message (WS-Eventing). Returns a suitable RenewResponseMessage or throws a SOAPException if processing the incoming request fails for any reason.

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

renew - the incoming renew request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

a valid response to the incoming renew request

Throws:

SOAPException - if processing the renew request fails for some reason, e.g. when this endpoint cannot handle renew requests, or the request's content is malformed, etc.

handle

public UnsubscribeResponseMessage handle(UnsubscribeMessage unsubscribe,
                                         ConnectionInfo connectionInfo)
                                  throws SOAPException

Description copied from interface: IncomingMessageListener

Receives an incoming unsubscribe message (WS-Eventing). Returns a suitable UnsubscribeResponseMessage or throws a SOAPException if processing the incoming request fails for any reason.

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

unsubscribe - the incoming unsubscribe request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

a valid response to the incoming unsubscribe request

Throws:

SOAPException - if processing the unsubscribe request fails for some reason, e.g. when this endpoint can not handle unsubscribe requests, or the request's content is malformed, etc.

handle

public InvokeMessage handle(InvokeMessage invokeRequest,
                            ConnectionInfo connectionInfo)
                     throws SOAPException

Description copied from interface: IncomingMessageListener

Receives an incoming invoke request. The returned value depends on the type of the web service operation the request belongs to (one-way vs. request-response). For a one-way operation, this method must return null, whereas for a request-response operation, the returned InvokeMessage must contain a suitable response to the incoming request.

This method may throw a SOAPException under two distinct circumstances:

• the web service operation to which the incoming request belongs declares one or more faults: in such a case, the thrown SOAPException is expected to correspond to either one of those declared faults
• processing the invoke request fails for any other reason, e.g. malformed content or this IncomingMessageListener instance being unable to handle invoke requests: then, the SOAPException must describe the exact failure reason in a way independent from the actual declaration of the involved web service operation

Specified by:

handle in interface IncomingMessageListener

Overrides:

handle in class DefaultIncomingMessageListener

Parameters:

invokeRequest - the incoming invoke request to process

connectionInfo - protocol (aka. technology) specific data associated with the incoming message, e.g. source and target addresses or other transport-related information

Returns:

either null for a one-way operation, or a response to the incoming request

Throws:

SOAPException - either because processing the invoke request failed with an user-defined failure reason (i.e. a fault declared by the concerned web service operation) or because of a more generic error such as this instance being unable to process incoming invoke requests, or malformed request content, etc.

getOperation

public OperationDescription getOperation(java.lang.String actionName)

Description copied from interface: IncomingMessageListener

Returns an operation for a given wsa:Action.

Important

The result can be null for an implementation which does not use an operation at all.

Specified by:

getOperation in interface IncomingMessageListener

Overrides:

getOperation in class DefaultIncomingMessageListener

Parameters:

actionName - the wsa:Action which should be used to retrieve the operation.

Returns:

the operation.

getEvent

public EventSource getEvent(java.lang.String action)

Specified by:

getEvent in interface IncomingMessageListener

Overrides:

getEvent in class DefaultIncomingMessageListener