org.ws4d.java.dispatch

Class DefaultServiceReference

java.lang.Object

org.ws4d.java.dispatch.DefaultServiceReference

All Implemented Interfaces:

EprInfoHandler.EprInfoProvider, ServiceReferenceInternal, Reference, ServiceReference

public class DefaultServiceReference
extends java.lang.Object
implements ServiceReferenceInternal

Class holds service reference.

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap	outgoingDiscoveryInfosDown
protected HashMap	outgoingDiscoveryInfosUp
boolean	suppressGetMetadataIfPossible

Fields inherited from interface org.ws4d.java.service.reference.ServiceReference

SUPPRESS_GET_METADATA_IF_POSSIBLE_DEFAULT

Fields inherited from interface org.ws4d.java.service.reference.Reference

LOCATION_LOCAL, LOCATION_REMOTE, LOCATION_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultServiceReference(DefaultServiceReference oldServiceReference, SecurityKey newSecurityKey)
protected	DefaultServiceReference(EndpointReference epr, SecurityKey securityKey, java.lang.String comManId) Constructor.
protected	DefaultServiceReference(SecurityKey securityKey, HostedMData hosted, ConnectionInfo connectionInfo, java.lang.String comManId) Constructor, used for proxy services.

Method Summary

Modifier and Type	Method and Description
void	addOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info) Adds the specified outgoing discovery info to this device.
void	buildUpService(java.lang.String comManId) Instructs this service reference to asynchronously send a GetMetadata message to the service and create a new proxy, if required.
boolean	containsAllPortTypes(QNameSet newTypes) Returns true only in case this service reference provides all port types listed within argumentportTypes.
void	disconnectFromDevice() Removes the parent device reference from this service reference.
void	dispose()
java.lang.String	getComManId() Returns the ID of the communication protocol to use when communicating with this reference's target over the current preferred transport address.
java.lang.String	getDebugString()
Iterator	getEprInfos() Gets EprInfos.
int	getHostedBlockVersion()
int	getLocation() Returns the location of the device or service, which may be - LOCATION_UNKNOWN, - LOCATION_REMOTE, - LOCATION_LOCAL.
Iterator	getMetadataLocations() Returns an iterator over the set of URI instances pointing at the addresses of the target service's metadata description locations (i.e.
Iterator	getMetadataReferences() Returns an iterator over the set of EndpointReference instances pointing at the locations of the target service's metadata descriptions (i.e.
XAddressInfo	getNextXAddressInfoAfterFailure(URI transportAddress, int syncHostedBlockVersion)
DataStructure	getOutgoingDiscoveryInfos()
EndpointReference	getParentDeviceEndpointReference() Returns the parent device endpoint reference of the device which hosts the service, if the device is known.
int	getPortTypeCount() Returns the number of port types for this service reference.
Iterator	getPortTypes() Gets service port types.
URI	getPreferredXAddress() Returns the preferred transport address for communication with this reference.
EprInfo	getPreferredXAddressInfo()
SecurityKey	getSecurityKey()
Service	getService() Gets present service of reference.
Service	getService(boolean doBuildUp) Gets present service of reference.
URI	getServiceId() Returns the service ID (unique within the scope of its parent device).
Iterator	getWSDLs() Returns an iterator over the set of WSDL instances describing the target service.
boolean	isServiceObjectExisting() Returns whether the service is build up or not.
boolean	isSuppressGetMetadataIfPossible()
Service	rebuildService()
boolean	removeOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info) Removes a previously added outgoing discovery info from this device.
void	reset() Resets this service reference, i.e.
void	setHostedFromService(HostedMData newHosted, ConnectionInfo connectionInfo)
Service	setLocalService(LocalService service) Sets local service, replaces present service.
void	setLocation(int location) Location of service, which this reference is linked to.
void	setMetaDataLocations(URISet metaLocs)
void	setMetadataReferences(EndpointReferenceSet metaRefs) Updates metadata references.
void	setParentDeviceEndpointReference(EndpointReference endpoint) Sets the endpoint reference of the parent device.
void	setSecurityKey(SecurityKey newKey)
void	setSuppressGetMetadataIfPossible(boolean suppressGetMetadataIfPossible) Set suppressGetMetadataIfPossible to decide if a get metadata message to a service should be suppressed if the related hosted block of the parent device contains at least one type and all contained types can be retrieved form the WSDLRepository.
void	setWSDLs(DataStructure wsdls) Updates WSDLs linked to this service
java.lang.String	toString()
void	update(HostedMData newHosted, EndpointReference parentDeviceEndpointReference, ConnectionInfo connectionInfo) Update service references with hosted metadata.

Methods inherited from class java.lang.Object

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

Field Detail

suppressGetMetadataIfPossible

public boolean suppressGetMetadataIfPossible

outgoingDiscoveryInfosUp

protected HashMap outgoingDiscoveryInfosUp

outgoingDiscoveryInfosDown

protected HashMap outgoingDiscoveryInfosDown

Constructor Detail

DefaultServiceReference

protected DefaultServiceReference(SecurityKey securityKey,
                                  HostedMData hosted,
                                  ConnectionInfo connectionInfo,
                                  java.lang.String comManId)

Constructor, used for proxy services.

Parameters:

service -

DefaultServiceReference

protected DefaultServiceReference(EndpointReference epr,
                                  SecurityKey securityKey,
                                  java.lang.String comManId)

Constructor. Unknown location type of service.

Parameters:

epr -

DefaultServiceReference

protected DefaultServiceReference(DefaultServiceReference oldServiceReference,
                                  SecurityKey newSecurityKey)

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface ServiceReference

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSuppressGetMetadataIfPossible

public boolean isSuppressGetMetadataIfPossible()

Specified by:

isSuppressGetMetadataIfPossible in interface ServiceReference

Returns:

suppressGetMetadataIfPossible

See Also:

ServiceReference.setSuppressGetMetadataIfPossible(boolean suppressGetMetadataIfPossible)

setSuppressGetMetadataIfPossible

public void setSuppressGetMetadataIfPossible(boolean suppressGetMetadataIfPossible)

Description copied from interface: ServiceReference

Set suppressGetMetadataIfPossible to decide if a get metadata message to a service should be suppressed if the related hosted block of the parent device contains at least one type and all contained types can be retrieved form the WSDLRepository.

Specified by:

setSuppressGetMetadataIfPossible in interface ServiceReference

getService

public Service getService()
                   throws CommunicationException

Description copied from interface: ServiceReference

Gets present service of reference. If the service is remote and its proxy not built up, the proxy may be built by an existing WSDL within the DescriptionRepository or by sending a get metadata message.

Specified by:

getService in interface ServiceReference

Returns:

service The present service of this reference. The returned service may change.

Throws:

CommunicationException - This exception is thrown if the remote service doesn't answer to the get metadata message, which tries to receive the necessary data to build up the service. The timeout value can be configured in the DispatchingProperties via the method DispatchingProperties.setResponseWaitTime(int).

addOutgoingDiscoveryInfo

public void addOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info)

Adds the specified outgoing discovery info to this device. The domain will be used for sending discovery messages (hellos and byes).

Parameters:

info - the new protocol domain to add to this device

removeOutgoingDiscoveryInfo

public boolean removeOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info)

Removes a previously added outgoing discovery info from this device.

Parameters:

info - the output domain to remove

getService

public Service getService(boolean doBuildUp)
                   throws CommunicationException

Description copied from interface: ServiceReferenceInternal

Gets present service of reference. If the service is remote and its proxy not built up, the proxy may be built by an existing WSDL within the DescriptionRepository or by sending a get metadata message.

Specified by:

getService in interface ServiceReferenceInternal

Parameters:

doBuildUp - If false and service does not exist, service will not be build up. In this case, returned service is null

Returns:

service The present service of this reference. The returned service may change.

Throws:

CommunicationException - This exception is thrown if the remote service doesn't answer to the get metadata message, which tries to receive the necessary data to build up the service. The timeout value can be configured in the DispatchingProperties via the method DispatchingProperties.setResponseWaitTime(int).

buildUpService

public void buildUpService(java.lang.String comManId)

Instructs this service reference to asynchronously send a GetMetadata message to the service and create a new proxy, if required. The new proxy service is than announced asynchronously via ServiceListener.serviceCreated(ServiceReference, Service) method.

Note that in order to reduce network traffic a GetMetadata message will actually be sent only if it is detected that the service within this device reference instance is not up to date anymore.

setLocalService

public Service setLocalService(LocalService service)

Description copied from interface: ServiceReferenceInternal

Sets local service, replaces present service. Used to set local services.

Specified by:

setLocalService in interface ServiceReferenceInternal

Parameters:

service - replacement service.

Returns:

replaced service.

rebuildService

public Service rebuildService()
                       throws CommunicationException

Throws:

CommunicationException

reset

public void reset()

Description copied from interface: ServiceReference

Resets this service reference, i.e. makes it loose all internal state information but the endpoint references of the service.

Specified by:

reset in interface ServiceReference

update

public void update(HostedMData newHosted,
                   EndpointReference parentDeviceEndpointReference,
                   ConnectionInfo connectionInfo)

Update service references with hosted metadata. If new metadata lacks of previous transmitted port types, the associated service is removed. If new metadata includes new port types, service is updated.

Specified by:

update in interface ServiceReferenceInternal

Parameters:

newHosted - the new hosted metadata

parentDeviceEndpointReference -

connectionInfo -

disconnectFromDevice

public void disconnectFromDevice()

Description copied from interface: ServiceReferenceInternal

Removes the parent device reference from this service reference.

Specified by:

disconnectFromDevice in interface ServiceReferenceInternal

getPortTypes

public Iterator getPortTypes()

Description copied from interface: ServiceReference

Gets service port types. The port types define the operations the service provides.

Specified by:

getPortTypes in interface ServiceReference

Returns:

an iterator (read only) of QName.

getPortTypeCount

public int getPortTypeCount()

Description copied from interface: ServiceReference

Returns the number of port types for this service reference.

Specified by:

getPortTypeCount in interface ServiceReference

Returns:

the number of port types

containsAllPortTypes

public boolean containsAllPortTypes(QNameSet newTypes)

Description copied from interface: ServiceReference

Returns true only in case this service reference provides all port types listed within argumentportTypes.

Specified by:

containsAllPortTypes in interface ServiceReference

Parameters:

newTypes - the port types to check this service reference for

Returns:

true if all port types are provided by this service reference, false otherwise

getLocation

public int getLocation()

Description copied from interface: Reference

Returns the location of the device or service, which may be - LOCATION_UNKNOWN, - LOCATION_REMOTE, - LOCATION_LOCAL.

Specified by:

getLocation in interface Reference

Returns:

the location of the device or service

setLocation

public void setLocation(int location)

Location of service, which this reference is linked to. Allowed values:

Reference.LOCATION_LOCAL, Reference.LOCATION_REMOTE or Reference.LOCATION_UNKNOWN

Specified by:

setLocation in interface ServiceReferenceInternal

Parameters:

location - Reference.LOCATION_LOCAL, Reference.LOCATION_REMOTE or Reference.LOCATION_UNKNOWN.

getEprInfos

public Iterator getEprInfos()

Description copied from interface: ServiceReference

Gets EprInfos. In DPWS the address contained in an endpoint reference is a transport address.

Specified by:

getEprInfos in interface EprInfoHandler.EprInfoProvider

Specified by:

getEprInfos in interface ServiceReference

Returns:

epr infos.

getSecurityKey

public SecurityKey getSecurityKey()

Specified by:

getSecurityKey in interface ServiceReference

setSecurityKey

public void setSecurityKey(SecurityKey newKey)

Specified by:

setSecurityKey in interface ServiceReference

getOutgoingDiscoveryInfos

public DataStructure getOutgoingDiscoveryInfos()

Specified by:

getOutgoingDiscoveryInfos in interface EprInfoHandler.EprInfoProvider

getServiceId

public URI getServiceId()

Description copied from interface: ServiceReference

Returns the service ID (unique within the scope of its parent device).

Specified by:

getServiceId in interface ServiceReference

Returns:

the service ID

getMetadataReferences

public Iterator getMetadataReferences()

Returns an iterator over the set of EndpointReference instances pointing at the locations of the target service's metadata descriptions (i.e. usually its WSDL files).

Specified by:

getMetadataReferences in interface ServiceReference

Returns:

an iterator over EndpointReferences to the service's metadata

setMetadataReferences

public void setMetadataReferences(EndpointReferenceSet metaRefs)

Description copied from interface: ServiceReferenceInternal

Updates metadata references.

Specified by:

setMetadataReferences in interface ServiceReferenceInternal

getMetadataLocations

public Iterator getMetadataLocations()

Returns an iterator over the set of URI instances pointing at the addresses of the target service's metadata description locations (i.e. usually its WSDL files).

Specified by:

getMetadataLocations in interface ServiceReference

Returns:

an iterator over URIs to the service's metadata

getWSDLs

public Iterator getWSDLs()

Returns an iterator over the set of WSDL instances describing the target service.

Specified by:

getWSDLs in interface ServiceReference

Returns:

an iterator over WSDLs containing the service's metadata

setWSDLs

public void setWSDLs(DataStructure wsdls)

Description copied from interface: ServiceReferenceInternal

Updates WSDLs linked to this service

Specified by:

setWSDLs in interface ServiceReferenceInternal

getPreferredXAddress

public URI getPreferredXAddress()
                         throws CommunicationException

Description copied from interface: Reference

Returns the preferred transport address for communication with this reference.

Specified by:

getPreferredXAddress in interface Reference

Returns:

the preferred transport address for this reference

Throws:

CommunicationException - if no suitable transport address can be detected

getComManId

public java.lang.String getComManId()

Description copied from interface: Reference

Returns the ID of the communication protocol to use when communicating with this reference's target over the current preferred transport address. Will return the framework-wide default communication ID, if no preferred transport address has been explicitly set.

Specified by:

getComManId in interface Reference

Returns:

the ID of the protocol to communicate over with the target of this reference

getParentDeviceEndpointReference

public EndpointReference getParentDeviceEndpointReference()

Description copied from interface: ServiceReference

Returns the parent device endpoint reference of the device which hosts the service, if the device is known.

Specified by:

getParentDeviceEndpointReference in interface ServiceReference

Returns:

The endpoint reference of the device which hosts the service.

setParentDeviceEndpointReference

public void setParentDeviceEndpointReference(EndpointReference endpoint)

Description copied from interface: ServiceReferenceInternal

Sets the endpoint reference of the parent device.

Specified by:

setParentDeviceEndpointReference in interface ServiceReferenceInternal

Parameters:

endpoint - the endpoint reference to set

isServiceObjectExisting

public boolean isServiceObjectExisting()

Description copied from interface: ServiceReference

Returns whether the service is build up or not.

Specified by:

isServiceObjectExisting in interface ServiceReference

Returns:

true, if service object exists.

setHostedFromService

public void setHostedFromService(HostedMData newHosted,
                                 ConnectionInfo connectionInfo)

setMetaDataLocations

public void setMetaDataLocations(URISet metaLocs)

Specified by:

setMetaDataLocations in interface ServiceReferenceInternal

getNextXAddressInfoAfterFailure

public XAddressInfo getNextXAddressInfoAfterFailure(URI transportAddress,
                                                    int syncHostedBlockVersion)
                                             throws CommunicationException

Specified by:

getNextXAddressInfoAfterFailure in interface ServiceReferenceInternal

Throws:

CommunicationException

getHostedBlockVersion

public int getHostedBlockVersion()

Specified by:

getHostedBlockVersion in interface ServiceReferenceInternal

getPreferredXAddressInfo

public EprInfo getPreferredXAddressInfo()
                                 throws CommunicationException

Specified by:

getPreferredXAddressInfo in interface ServiceReferenceInternal

Throws:

CommunicationException

getDebugString

public java.lang.String getDebugString()

Specified by:

getDebugString in interface EprInfoHandler.EprInfoProvider