org.ws4d.java.service

Interface Service

All Known Subinterfaces:

LocalService

All Known Implementing Classes:

DefaultService, ProxyService, ServiceCommons

public interface Service

Interface of service classes representing "DPWS Hosted Services"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_PARAMETER to use with getOperation/s and getEventSource/s

Method Summary

Modifier and Type	Method and Description
void	disconnectAllServiceReferences(boolean resetServiceRefs) The method disconnected all ServiceReferences from this service.
Iterator	getAllEventSources() Returns all EventSources of this service.
Iterator	getAllOperations() Returns all Operations from this service.
UnknownDataContainer[]	getCustomMData(java.lang.String communicationManagerId) The method returns all custom metadata
WSDL	getDescription(java.lang.String targetNamespace) Returns a WSDL document describing this service by the given namespace.
Iterator	getDescriptions() Returns an iterator over all WSDLs directly attached to this service.
Iterator	getEprInfos() Returns an iterator of EprInfo.
EventSource	getEventSource(QName portType, java.lang.String eventName, java.lang.String inputName, java.lang.String outputName) Returns the first EventSource matching the given criteria.
Iterator	getEventSources(QName portType, java.lang.String eventName, java.lang.String inputName, java.lang.String outputName) Returns all EventSources matching the given criteria.
Operation	getOperation(QName portType, java.lang.String opName, java.lang.String inputName, java.lang.String outputName) Returns the first Operation matching the given criteria.
Iterator	getOperations(QName portType, java.lang.String opName, java.lang.String inputName, java.lang.String outputName) Returns all Operations matching the given criteria.
DeviceReference	getParentDeviceReference(SecurityKey securityKey) Gets device reference of parent device.
CustomAttributeValue	getPortTypeAttribute(QName portTypeName, QName attributeName) Returns the value of the port type attribute with the given name for the port type with the specified unique portTypeName or with null if this attribute is not available (or if its value is explicitly set to null).
HashMap	getPortTypeAttributes(QName portTypeName) Returns all port type attributes explicitly set on this service instance for the port type with the given unique portTypeName.
Iterator	getPortTypes() Gets service port types.
URI	getServiceId() Gets service id
ServiceReference	getServiceReference(SecurityKey securityKey) Gets the service reference.
long	getStatus(ClientSubscription subscription, CredentialInfo credentialInfo) Returns the duration in milliseconds until expiration of the specified client subscription.
boolean	hasPortTypeAttributes(QName portTypeName) Returns true only if this service instance has at least one port type attribute set for the port type with the specified unique portTypeName.
boolean	isRemote() Is the service remote (proxy) or local?
long	renew(ClientSubscription subscription, long duration, CredentialInfo credentialInfo) Renews an existing subscription with a new duration.
ClientSubscription	subscribe(EventSink sink, java.lang.String clientSubscriptionId, URISet eventActionURIs, long duration, CredentialInfo credentialInfo) Initializes event receiving from specified event sender.
void	unsubscribe(ClientSubscription subscription, CredentialInfo credentialInfo) Unsubscribe specified subscription.

Field Detail

NO_PARAMETER

static final java.lang.String NO_PARAMETER

to use with getOperation/s and getEventSource/s

See Also:

Constant Field Values

Method Detail

getServiceId

URI getServiceId()

Gets service id

Returns:

service id

getEprInfos

Iterator getEprInfos()

Returns an iterator of EprInfo.

Returns:

an iterator of EprInfo.

getPortTypes

Iterator getPortTypes()

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

Returns:

an iterator (read only) of QName.

getServiceReference

ServiceReference getServiceReference(SecurityKey securityKey)

Gets the service reference.

Returns:

service reference

getParentDeviceReference

DeviceReference getParentDeviceReference(SecurityKey securityKey)

Gets device reference of parent device. This method may return null in case this service doesn't reside on a device or its underlying device is not known at this time.

Returns:

device reference of parent device, may be null

getOperation

Operation getOperation(QName portType,
                       java.lang.String opName,
                       java.lang.String inputName,
                       java.lang.String outputName)

Returns the first Operation matching the given criteria. Use the constant Service.SERVICE_NO_PARAMETER to indicate that the operation has explicitly no input or output parameter (it could be a one-way message or something similar). Supplying null as a parameter makes the method ignore it (matches all).

Parameters:

portType -

opName -

inputName -

outputName -

Returns:

getAllOperations

Iterator getAllOperations()

Returns all Operations from this service.

Returns:

getAllEventSources

Iterator getAllEventSources()

Returns all EventSources of this service.

getOperations

Iterator getOperations(QName portType,
                       java.lang.String opName,
                       java.lang.String inputName,
                       java.lang.String outputName)

Returns all Operations matching the given criteria. Use the constant Service.SERVICE_NO_PARAMETER to indicate that the operation has explicitly no input or output parameter (it could be a one-way message or something similar). Supplying null as a parameter makes the method ignores the parameter (matches all).

Parameters:

portType -

opName -

inputName -

outputName -

Returns:

getEventSource

EventSource getEventSource(QName portType,
                           java.lang.String eventName,
                           java.lang.String inputName,
                           java.lang.String outputName)

Returns the first EventSource matching the given criteria. Use the constant Service.SERVICE_NO_PARAMETER to indicate that the operation has explicitly no input or output parameter (it could be a one-way message or something similar). Supplying null as a parameter makes the method ignore it (matches all).

Parameters:

portType -

eventName -

inputName -

outputName -

Returns:

getEventSources

Iterator getEventSources(QName portType,
                         java.lang.String eventName,
                         java.lang.String inputName,
                         java.lang.String outputName)

Returns all EventSources matching the given criteria. Use the constant Service.SERVICE_NO_PARAMETER to indicate that the operation has explicitly no input or output parameter (it could be a one-way message or something similar). Supplying null as a parameter makes the method ignore it (matches all).

Parameters:

portType -

opName -

inputName -

outputName -

Returns:

isRemote

boolean isRemote()

Is the service remote (proxy) or local?

Returns:

whether this is a remote service (proxy) or not

subscribe

ClientSubscription subscribe(EventSink sink,
                             java.lang.String clientSubscriptionId,
                             URISet eventActionURIs,
                             long duration,
                             CredentialInfo credentialInfo)
                      throws EventingException,
                             java.io.IOException,
                             CommunicationException

Initializes event receiving from specified event sender.

Parameters:

sink - event sink which will receive the notifications.

clientSubscriptionId -

eventActionURIs - a set of action URIs to subscribe to

duration - duration in millis of subscription. If 0, subscription does not expire.

Returns:

subscription id (wse:identifier)

Throws:

EventingException

CommunicationException

java.io.IOException

unsubscribe

void unsubscribe(ClientSubscription subscription,
                 CredentialInfo credentialInfo)
          throws EventingException,
                 java.io.IOException,
                 CommunicationException

Unsubscribe specified subscription.

Parameters:

subscription - subscription to terminate.

Throws:

EventingException

CommunicationException

java.io.IOException

renew

long renew(ClientSubscription subscription,
           long duration,
           CredentialInfo credentialInfo)
    throws EventingException,
           java.io.IOException,
           CommunicationException

Renews an existing subscription with a new duration. If duration is "0", subscription never terminates.

Parameters:

subscription -

duration -

Throws:

EventingException

CommunicationException

java.io.IOException

getStatus

long getStatus(ClientSubscription subscription,
               CredentialInfo credentialInfo)
        throws EventingException,
               java.io.IOException,
               CommunicationException

Returns the duration in milliseconds until expiration of the specified client subscription.

Parameters:

subscription -

Returns:

status of subscribtion

Throws:

EventingException

CommunicationException

java.io.IOException

getDescriptions

Iterator getDescriptions()

Returns an iterator over all WSDLs directly attached to this service.

Returns:

an iterator over all WSDLs directly attached to this service

getDescription

WSDL getDescription(java.lang.String targetNamespace)

Returns a WSDL document describing this service by the given namespace. This method makes a recursive search within all WSDLs directly attached to that service.

Parameters:

targetNamespace - the namespace.

Returns:

the WSDL document describing this service by the given namespace.

getPortTypeAttribute

CustomAttributeValue getPortTypeAttribute(QName portTypeName,
                                          QName attributeName)

Returns the value of the port type attribute with the given name for the port type with the specified unique portTypeName or with null if this attribute is not available (or if its value is explicitly set to null).

This method throws a java.lang.IllegalArgumentException if a port type with the given portTypeName is not found within this service instance.

Parameters:

portTypeName - the unique name of the port type within the scope of this service instance, see getPortTypes()

attributeName - the name of the port type attribute to query the value of

Returns:

the value for the named port type attribute or null

Throws:

java.lang.IllegalArgumentException - if no port type with the given portTypeName is found

getPortTypeAttributes

HashMap getPortTypeAttributes(QName portTypeName)

Returns all port type attributes explicitly set on this service instance for the port type with the given unique portTypeName. Note that depending on the actual implementation the returned reference may point at the 'life map', i .e. the actual storage for the port type attributes. Thus, modifications to that map should be performed with care and keeping this in mind.

This method throws a java.lang.IllegalArgumentException if a port type with the given portTypeName is not found within this instance.

Parameters:

portTypeName - the unique name of the port type within the scope of this instance, see getPortTypes()

Returns:

all already set port type attributes

Throws:

java.lang.IllegalArgumentException - if no port type with the given portTypeName is found

hasPortTypeAttributes

boolean hasPortTypeAttributes(QName portTypeName)

Returns true only if this service instance has at least one port type attribute set for the port type with the specified unique portTypeName. Returns false in any other case, including when there is no port type with the given portTypeName.

Parameters:

portTypeName - the unique name of the port type within the scope of this service instance, see getPortTypes()

Returns:

true only if there is at least one port type attribute set for the named port type within this service instance

getCustomMData

UnknownDataContainer[] getCustomMData(java.lang.String communicationManagerId)

The method returns all custom metadata

Returns:

UnknownDataContainer[] which contains the custom metadata

disconnectAllServiceReferences

void disconnectAllServiceReferences(boolean resetServiceRefs)

The method disconnected all ServiceReferences from this service. If reseServiceRefs is true all service references will be reseted.

Parameters:

resetServiceRefs -