Package org.somda.sdc.dpws.soap.wsdiscovery

Class WsDiscoveryTargetServiceInterceptor

java.lang.Object

org.somda.sdc.dpws.soap.wsdiscovery.WsDiscoveryTargetServiceInterceptor

All Implemented Interfaces:

Interceptor, WsDiscoveryTargetService

public class WsDiscoveryTargetServiceInterceptor
extends Object
implements WsDiscoveryTargetService

Default implementation of the WsDiscoveryTargetService.

Method Summary

Modifier and Type	Method	Description
EndpointReferenceType	getEndpointReference()
MatchBy	getMatchBy()	Thread-safe function to get the MatchBy rule.
com.google.common.primitives.UnsignedInteger	getMetadataVersion()	Thread-safe function to get the metadata version.
List<String>	getScopes()	Thread-safe function to get the list of scope URIs.
List<QName>	getTypes()	Thread-safe function to get the list of QNames.
List<String>	getXAddrs()	Thread-safe function to get the list of XAddr URIs.
com.google.common.primitives.UnsignedInteger	incMetadataVersionAndGet()	Increments the metadata version and retrieves the new value.
com.google.common.primitives.UnsignedInteger	incMetadataVersionIfModifiedAndGet()	Increments the metadata version and retrieve the new value if the metadata has changed, returns previous version otherwise.
void	sendBye()	Blocking function to send out a Bye message.
com.google.common.primitives.UnsignedInteger	sendHello()	Blocking function to send out a Hello message.
com.google.common.primitives.UnsignedInteger	sendHello(boolean forceNewMetadataVersion)	Blocking function to send out a Hello message.
void	setMatchBy(MatchBy matchBy)	Thread-safe function to set the MatchBy rule.
void	setMetadataModified()	Thread-safe function to explicitly set the target service metadata to be modified (thread-safe).
void	setScopes(List<String> uris)	Thread-safe function to set the list of scope URIs.
void	setTypes(List<QName> qNames)	Thread-safe function to set the list of QNames.
void	setXAddrs(List<String> xAddrs)	Thread-safe function to set the list of XAddr URIs.

Methods inherited from class java.lang.Object

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

Method Detail

getEndpointReference

public EndpointReferenceType getEndpointReference()

Specified by:

getEndpointReference in interface WsDiscoveryTargetService

setTypes

public void setTypes(List<QName> qNames)

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to set the list of QNames.

Specified by:

setTypes in interface WsDiscoveryTargetService

Parameters:

qNames - the list of QNames to set.

getTypes

public List<QName> getTypes()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to get the list of QNames.

Specified by:

getTypes in interface WsDiscoveryTargetService

Returns:

the list of QNames.

setScopes

public void setScopes(List<String> uris)

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to set the list of scope URIs.

Specified by:

setScopes in interface WsDiscoveryTargetService

Parameters:

uris - the list of scope URIs to set.

getScopes

public List<String> getScopes()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to get the list of scope URIs.

Specified by:

getScopes in interface WsDiscoveryTargetService

Returns:

the list of scope URIs.

setXAddrs

public void setXAddrs(List<String> xAddrs)

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to set the list of XAddr URIs.

Specified by:

setXAddrs in interface WsDiscoveryTargetService

Parameters:

xAddrs - the list of XAddr URIs.

getXAddrs

public List<String> getXAddrs()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to get the list of XAddr URIs.

Specified by:

getXAddrs in interface WsDiscoveryTargetService

Returns:

the list of XAddr URIs.

setMatchBy

public void setMatchBy(MatchBy matchBy)

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to set the MatchBy rule.

Specified by:

setMatchBy in interface WsDiscoveryTargetService

Parameters:

matchBy - the MatchBy rule to set.

getMatchBy

public MatchBy getMatchBy()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to get the MatchBy rule.

Specified by:

getMatchBy in interface WsDiscoveryTargetService

Returns:

the MatchBy rule.

setMetadataModified

public void setMetadataModified()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to explicitly set the target service metadata to be modified (thread-safe).

This is useful if the metadata change does not belong to, e.g., Types and Scopes.

Specified by:

setMetadataModified in interface WsDiscoveryTargetService

getMetadataVersion

public com.google.common.primitives.UnsignedInteger getMetadataVersion()

Description copied from interface: WsDiscoveryTargetService

Thread-safe function to get the metadata version.

Specified by:

getMetadataVersion in interface WsDiscoveryTargetService

Returns:

the metadata version.

sendHello

public com.google.common.primitives.UnsignedInteger sendHello()
                                                       throws MarshallingException,
                                                              TransportException,
                                                              InterceptorException

Description copied from interface: WsDiscoveryTargetService

Blocking function to send out a Hello message.

This is a shorthand function to WsDiscoveryTargetService.sendHello(boolean).

Specified by:

sendHello in interface WsDiscoveryTargetService

Returns:

the metadata version that has been attached to the Hello message.

Throws:

MarshallingException - if marshalling the Hello message fails.

TransportException - if there is any problem on the transport layer.

InterceptorException - if one of the interceptors pops up with an error.

sendHello

public com.google.common.primitives.UnsignedInteger sendHello(boolean forceNewMetadataVersion)
                                                       throws MarshallingException,
                                                              TransportException,
                                                              InterceptorException

Description copied from interface: WsDiscoveryTargetService

Blocking function to send out a Hello message.

Specified by:

sendHello in interface WsDiscoveryTargetService

Parameters:

forceNewMetadataVersion - set to true to force incrementing the metadata version, or false to not do so.

Returns:

the metadata version that has been attached to the Hello message.

Throws:

MarshallingException - if marshalling the Hello message fails.

TransportException - if there is any problem on the transport layer.

InterceptorException - if one of the interceptors pops up with an error.

sendBye

public void sendBye()
             throws MarshallingException,
                    TransportException,
                    InterceptorException

Description copied from interface: WsDiscoveryTargetService

Blocking function to send out a Bye message.

Specified by:

sendBye in interface WsDiscoveryTargetService

Throws:

MarshallingException - if marshalling the Bye message fails.

TransportException - if there is any problem on the transport layer.

InterceptorException - if one of the interceptors pops up with an error.

incMetadataVersionAndGet

public com.google.common.primitives.UnsignedInteger incMetadataVersionAndGet()

Increments the metadata version and retrieves the new value.

Returns:

new metadata version

incMetadataVersionIfModifiedAndGet

public com.google.common.primitives.UnsignedInteger incMetadataVersionIfModifiedAndGet()

Increments the metadata version and retrieve the new value if the metadata has changed, returns previous version otherwise.

Returns:

metadata version