org.ws4d.java.dispatch

Interface ServiceReferenceInternal

All Superinterfaces:

EprInfoHandler.EprInfoProvider, Reference, ServiceReference

All Known Implementing Classes:

DefaultServiceReference

public interface ServiceReferenceInternal
extends ServiceReference, EprInfoHandler.EprInfoProvider

Interface covers the methods used internally to manage service references.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	disconnectFromDevice() Removes the parent device reference from this service reference.
int	getHostedBlockVersion()
XAddressInfo	getNextXAddressInfoAfterFailure(URI transportAddress, int syncHostedBlockVersion)
EprInfo	getPreferredXAddressInfo()
Service	getService(boolean doBuildUp) Gets present service of reference.
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	setWSDLs(DataStructure wsdls) Updates WSDLs linked to this service
void	update(HostedMData newHostedBlock, EndpointReference parentDeviceEndpointReference, ConnectionInfo connectionInfo) Update service references with hosted metadata.

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

containsAllPortTypes, dispose, getEprInfos, getMetadataLocations, getMetadataReferences, getParentDeviceEndpointReference, getPortTypeCount, getPortTypes, getSecurityKey, getService, getServiceId, getWSDLs, isServiceObjectExisting, isSuppressGetMetadataIfPossible, reset, setSecurityKey, setSuppressGetMetadataIfPossible

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

getComManId, getLocation, getPreferredXAddress

Methods inherited from interface org.ws4d.java.dispatch.EprInfoHandler.EprInfoProvider

getDebugString, getEprInfos, getOutgoingDiscoveryInfos

Method Detail

getService

Service getService(boolean doBuildUp)
            throws CommunicationException

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.

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).

setLocalService

Service setLocalService(LocalService service)

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

Parameters:

service - replacement service.

Returns:

replaced service.

update

void update(HostedMData newHostedBlock,
            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.

Parameters:

newHostedBlock - the hosted metadata.

parentDeviceEndpointReference - the endpoint reference of the parent device.

connectionInfo - the connection info.

disconnectFromDevice

void disconnectFromDevice()

Removes the parent device reference from this service reference.

setParentDeviceEndpointReference

void setParentDeviceEndpointReference(EndpointReference endpoint)

Sets the endpoint reference of the parent device.

Parameters:

endpoint - the endpoint reference of the parent to set.

setLocation

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

Parameters:

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

setMetaDataLocations

void setMetaDataLocations(URISet metaLocs)

Parameters:

metaLocs -

setMetadataReferences

void setMetadataReferences(EndpointReferenceSet metaRefs)

Updates metadata references.

Parameters:

metaRefs -

setWSDLs

void setWSDLs(DataStructure wsdls)

Updates WSDLs linked to this service

Parameters:

wsdls -

getPreferredXAddressInfo

EprInfo getPreferredXAddressInfo()
                          throws CommunicationException

Throws:

CommunicationException

getNextXAddressInfoAfterFailure

XAddressInfo getNextXAddressInfoAfterFailure(URI transportAddress,
                                             int syncHostedBlockVersion)
                                      throws CommunicationException

Throws:

CommunicationException

getHostedBlockVersion

int getHostedBlockVersion()