org.ws4d.java.service

Class ProxyService

java.lang.Object

org.ws4d.java.service.ServiceCommons

org.ws4d.java.service.ProxyService

All Implemented Interfaces:

Service

public class ProxyService
extends ServiceCommons

Proxy class of a service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProxyService.ProxyServiceCallback

Nested classes/interfaces inherited from class org.ws4d.java.service.ServiceCommons

ServiceCommons.PortType

Field Summary

Fields inherited from class org.ws4d.java.service.ServiceCommons

customMData, events, operations, portTypes, wsdls

Fields inherited from interface org.ws4d.java.service.Service

NO_PARAMETER

Constructor Summary

Constructors

Constructor and Description
ProxyService(ServiceReferenceInternal serviceReference, HashMap customMData, java.lang.String comManId)

Method Summary

Modifier and Type	Method and Description
void	appendPortTypes(QNameSet portTypes, CredentialInfo credentialInfo, java.lang.String comManId)
protected ProxyService.ProxyServiceCallback	createCallbackHandler(XAddressInfo xaddrInfo, Operation op, ClientSubscription subscription) Added by SSch in order to allow extension.
protected EventSource	createEventSource(WSDLOperation wsdlOperation) Creates a DefaultEventSource instance suitable for usage within this service instance.
protected Operation	createOperation(WSDLOperation wsdlOperation) Creates an Operation instance suitable for usage within this service instance.
void	disconnectAllServiceReferences(boolean resetServiceRefs) The method disconnected all ServiceReferences from this service.
protected ParameterValue	dispatchInvoke(InvokeMessage msg, Operation op, ParameterValue parameterValue, CredentialInfo credentialInfo)
protected ParameterValue	dispatchInvoke(InvokeMessage msg, Operation op, ParameterValue parameterValue, ProxyService.ProxyServiceCallback handler, CredentialInfo credentialInfo)
protected ParameterValue	dispatchInvoke(Operation op, ParameterValue parameterValue, CredentialInfo credentialInfo)
java.lang.String	getComManId()
WSDL	getDescription(java.lang.String targetNamespace) Returns a WSDL document describing this service by the given namespace.
Iterator	getEprInfos() Returns an iterator of EprInfo.
DeviceReference	getParentDeviceReference(SecurityKey securityKey) Gets device reference of parent device.
int	getPortTypeCount()
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.
protected void	initialize(ServiceReferenceInternal serviceReference, java.lang.String comManId) Must be called after construction of ProxyService without ServiceReference as parameter.
boolean	isRemote() Is the service remote (proxy) or local?
protected void	prepareWSDLOnServiceLevel(WSDL wsdl)
long	renew(ClientSubscription subscription, long duration, CredentialInfo credentialInfo) Renews an existing subscription with new duration.
protected void	setCustomMData(HashMap customMData) Set the custom metadata
ClientSubscription	subscribe(EventSink sink, java.lang.String clientSubscriptionId, URISet filterURIs, long duration, CredentialInfo credentialInfo) Initializes event receiving from specified event sender.
void	unsubscribe(ClientSubscription subscription, CredentialInfo credentialInfo) Unsubscribes from specified subscription.

Methods inherited from class org.ws4d.java.service.ServiceCommons

equals, getAllEventSources, getAllOperations, getCustomMData, getDescriptions, getEventsInternal, getEventSource, getEventSources, getExistingDescription, getOperation, getOperations, getPortTypeAttribute, getPortTypeAttributes, getPortTypesInternal, hashCode, hasPortTypeAttributes, processWSDLPortType, setPortTypeAttribute, setPortTypeAttributes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProxyService

public ProxyService(ServiceReferenceInternal serviceReference,
                    HashMap customMData,
                    java.lang.String comManId)
             throws MissingMetadataException

Parameters:

serviceReference -

Throws:

MissingMetadataException - in case no service description metadata (i.e. WSDL) was found for at least one of the service's port types

Method Detail

initialize

protected void initialize(ServiceReferenceInternal serviceReference,
                          java.lang.String comManId)
                   throws java.lang.InstantiationException,
                          MissingMetadataException

Must be called after construction of ProxyService without ServiceReference as parameter.

Parameters:

serviceReference -

Throws:

java.lang.InstantiationException

MissingMetadataException

getServiceReference

public ServiceReference getServiceReference(SecurityKey securityKey)

Description copied from interface: Service

Gets the service reference.

Returns:

service reference

disconnectAllServiceReferences

public void disconnectAllServiceReferences(boolean resetServiceRefs)

Description copied from interface: Service

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

getParentDeviceReference

public DeviceReference getParentDeviceReference(SecurityKey securityKey)

Description copied from interface: Service

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

isRemote

public boolean isRemote()

Description copied from interface: Service

Is the service remote (proxy) or local?

Returns:

whether this is a remote service (proxy) or not

getServiceId

public URI getServiceId()

Description copied from interface: Service

Gets service id

Returns:

service id

getEprInfos

public Iterator getEprInfos()

Description copied from interface: Service

Returns an iterator of EprInfo.

Returns:

an iterator of EprInfo.

getPortTypes

public Iterator getPortTypes()

Description copied from interface: Service

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

Returns:

an iterator (read only) of QName.

getPortTypeCount

public int getPortTypeCount()

appendPortTypes

public void appendPortTypes(QNameSet portTypes,
                            CredentialInfo credentialInfo,
                            java.lang.String comManId)
                     throws MissingMetadataException

Parameters:

portTypes - new port types to add to this proxy service

Throws:

MissingMetadataException - if no metadata (WSDL) is found for at least one of the specified portTypes

subscribe

public ClientSubscription subscribe(EventSink sink,
                                    java.lang.String clientSubscriptionId,
                                    URISet filterURIs,
                                    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 -

filterURIs - set of action URIs to subscribe to.

duration - duration in milliseconds of subscription. If 0 no expiration of subscription.

Returns:

subscription id (wse:identifier)

Throws:

EventingException

CommunicationException

java.io.IOException

createCallbackHandler

protected ProxyService.ProxyServiceCallback createCallbackHandler(XAddressInfo xaddrInfo,
                                                                  Operation op,
                                                                  ClientSubscription subscription)

Added by SSch in order to allow extension.

Parameters:

object -

Returns:

unsubscribe

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

Unsubscribes from specified subscription.

Parameters:

subscription - subscription to terminate.

Throws:

EventingException

CommunicationException

java.io.IOException

renew

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

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

Parameters:

subscription -

duration -

Returns:

either the actual subscription duration as reported by the service or0 if the subscription doesn't expire at all

Throws:

EventingException

CommunicationException

java.io.IOException

getStatus

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

Description copied from interface: Service

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

Returns:

status of subscribtion

Throws:

EventingException

CommunicationException

java.io.IOException

getDescription

public WSDL getDescription(java.lang.String targetNamespace)

Description copied from interface: Service

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.

prepareWSDLOnServiceLevel

protected void prepareWSDLOnServiceLevel(WSDL wsdl)

Parameters:

wsdl -

createOperation

protected Operation createOperation(WSDLOperation wsdlOperation)

Description copied from class: ServiceCommons

Creates an Operation instance suitable for usage within this service instance. This method is only called from within ServiceCommons.processWSDLPortType(WSDLPortType) and should not be used in other contexts.

Specified by:

createOperation in class ServiceCommons

Parameters:

wsdlOperation - the WSDL operation describing the operation to create

Returns:

the operation to add

createEventSource

protected EventSource createEventSource(WSDLOperation wsdlOperation)

Description copied from class: ServiceCommons

Creates a DefaultEventSource instance suitable for usage within this service instance. This method is only called from within ServiceCommons.processWSDLPortType(WSDLPortType) and should not be used in other contexts.

Specified by:

createEventSource in class ServiceCommons

Parameters:

wsdlOperation - the WSDL operation describing the event source to create

Returns:

the event source to add

dispatchInvoke

protected ParameterValue dispatchInvoke(Operation op,
                                        ParameterValue parameterValue,
                                        CredentialInfo credentialInfo)
                                 throws InvocationException,
                                        CommunicationException

Throws:

InvocationException

CommunicationException

setCustomMData

protected void setCustomMData(HashMap customMData)

Set the custom metadata

Parameters:

customMData - String which contains the new custom metadata.

dispatchInvoke

protected ParameterValue dispatchInvoke(InvokeMessage msg,
                                        Operation op,
                                        ParameterValue parameterValue,
                                        CredentialInfo credentialInfo)
                                 throws InvocationException,
                                        CommunicationException

Throws:

InvocationException

CommunicationException

dispatchInvoke

protected ParameterValue dispatchInvoke(InvokeMessage msg,
                                        Operation op,
                                        ParameterValue parameterValue,
                                        ProxyService.ProxyServiceCallback handler,
                                        CredentialInfo credentialInfo)
                                 throws InvocationException,
                                        CommunicationException

Throws:

InvocationException

CommunicationException

getComManId

public java.lang.String getComManId()