org.ws4d.java.service

Class ServiceCommons

java.lang.Object

org.ws4d.java.service.ServiceCommons

All Implemented Interfaces:

Service

Direct Known Subclasses:

DefaultService, ProxyService

public abstract class ServiceCommons
extends java.lang.Object
implements Service

Class represents the common part of a proxy/local service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceCommons.PortType

Field Summary

Fields

Modifier and Type	Field and Description
HashMap	customMData
protected HashMap	events
protected HashMap	operations
protected HashMap	portTypes
protected HashMap	wsdls

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

NO_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceCommons()

Method Summary

Modifier and Type	Method and Description
protected abstract EventSource	createEventSource(WSDLOperation wsdlOperation) Creates a DefaultEventSource instance suitable for usage within this service instance.
protected abstract Operation	createOperation(WSDLOperation wsdlOperation) Creates an Operation instance suitable for usage within this service instance.
boolean	equals(java.lang.Object obj)
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
Iterator	getDescriptions() Returns an iterator over all WSDLs directly attached to this service.
protected HashMap	getEventsInternal()
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.
protected WSDL	getExistingDescription(java.lang.String targetNamespace)
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.
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.
protected HashMap	getPortTypesInternal()
int	hashCode()
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.
protected void	processWSDLPortType(WSDLPortType portType)
void	setPortTypeAttribute(QName portTypeName, QName attributeName, CustomAttributeValue value) Sets the value of the port type attribute with the specified name of the port type with the given unique portTypeName.
void	setPortTypeAttributes(QName portTypeName, HashMap attributes) Sets all port type attributes of the port type with unique portTypeName at once to those contained within argument attributes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

disconnectAllServiceReferences, getDescription, getEprInfos, getParentDeviceReference, getPortTypes, getServiceId, getServiceReference, getStatus, isRemote, renew, subscribe, unsubscribe

Field Detail

portTypes

protected final HashMap portTypes

operations

protected final HashMap operations

events

protected final HashMap events

wsdls

protected final HashMap wsdls

customMData

public HashMap customMData

Constructor Detail

ServiceCommons

protected ServiceCommons()

Method Detail

getPortTypesInternal

protected HashMap getPortTypesInternal()

getEventsInternal

protected HashMap getEventsInternal()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOperation

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

Description copied from interface: Service

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

Specified by:

getOperation in interface Service

Returns:

getAllOperations

public Iterator getAllOperations()

Description copied from interface: Service

Returns all Operations from this service.

Specified by:

getAllOperations in interface Service

Returns:

getOperations

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

Description copied from interface: Service

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

Specified by:

getOperations in interface Service

Returns:

getAllEventSources

public Iterator getAllEventSources()

Description copied from interface: Service

Returns all EventSources of this service.

Specified by:

getAllEventSources in interface Service

getEventSource

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

Description copied from interface: Service

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

Specified by:

getEventSource in interface Service

Returns:

getEventSources

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

Description copied from interface: Service

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

Specified by:

getEventSources in interface Service

Returns:

getPortTypeAttribute

public CustomAttributeValue getPortTypeAttribute(QName portTypeName,
                                                 QName attributeName)

Description copied from interface: Service

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.

Specified by:

getPortTypeAttribute in interface Service

Parameters:

portTypeName - the unique name of the port type within the scope of this service instance, see Service.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

setPortTypeAttribute

public void setPortTypeAttribute(QName portTypeName,
                                 QName attributeName,
                                 CustomAttributeValue value)

Sets the value of the port type attribute with the specified name of the port type with the given unique portTypeName. Throws a java.lang.IllegalArgumentException in case there is no port type with the given portTypeName within this service instance or if name is null.

Parameters:

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

attributeName - the name of the port type attribute to set, must not be null

value - the value to set the named port type attribute to (may be null

Throws:

java.lang.IllegalArgumentException - if there is no port type with the given portTypeName within this service instance or if name is null

getPortTypeAttributes

public HashMap getPortTypeAttributes(QName portTypeName)

Description copied from interface: Service

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.

Specified by:

getPortTypeAttributes in interface Service

Parameters:

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

Returns:

all already set port type attributes

setPortTypeAttributes

public void setPortTypeAttributes(QName portTypeName,
                                  HashMap attributes)

Sets all port type attributes of the port type with unique portTypeName at once to those contained within argument attributes. Note that depending on the actual implementation, it is possible that the map attributes points at may be used for the actual internal storage of the port type attributes (i.e. without copying it). That is why, after passing it to this method, modifications to this map should be made with care. This method throws a java.lang.IllegalArgumentException in case attributes is null.

Parameters:

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

attributes - the new port type attributes to set

Throws:

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

hasPortTypeAttributes

public boolean hasPortTypeAttributes(QName portTypeName)

Description copied from interface: Service

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.

Specified by:

hasPortTypeAttributes in interface Service

Parameters:

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

Returns:

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

getCustomMData

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

The method returns all custom metadata

Specified by:

getCustomMData in interface Service

Returns:

UnknownDataContainer[] which contains the custom metadata

processWSDLPortType

protected void processWSDLPortType(WSDLPortType portType)

createOperation

protected abstract Operation createOperation(WSDLOperation wsdlOperation)

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

Parameters:

wsdlOperation - the WSDL operation describing the operation to create

Returns:

the operation to add

createEventSource

protected abstract EventSource createEventSource(WSDLOperation wsdlOperation)

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

Parameters:

wsdlOperation - the WSDL operation describing the event source to create

Returns:

the event source to add

getDescriptions

public Iterator getDescriptions()

Description copied from interface: Service

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

Specified by:

getDescriptions in interface Service

Returns:

an iterator over all WSDLs directly attached to this service

getExistingDescription

protected WSDL getExistingDescription(java.lang.String targetNamespace)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object