DefaultService (JDPWS 0.11.1-SNAPSHOT API)

java.lang.Object
- org.ws4d.java.service.ServiceCommons
- - org.ws4d.java.service.DefaultService

All Implemented Interfaces:: Bindable, OutgoingDiscoveryInfosProvider, LocalService, Service

public class DefaultService
extends ServiceCommons
implements LocalService, OutgoingDiscoveryInfosProvider

Default implementation of a service.

This class should be used to create a service. A new service should extend the DefaultService class and add operations to the newly created service. It is also possible to use the default implementation.

  
  public class SampleService extends DefaultService {

   private String namespace       = "http://www.namespace.org";

   private URI    serviceId           = new URI(namespace + "/sampleService");

   private QName  serviceType     = new QName("sampleService", namespace);

      public SampleService() {
          super();
      setServiceId(serviceId);

          // add operations...
          addOperation(new getCurrentTime());
      }


   private class GetCurrentTime extends Operation {

      GetCurrentTime() {
          super("GetCurrentTime", serviceType);

          Type stringType = SchemaUtil.TYPE_STRING;
          setOutput(new Element(new QName("Time", namespace), stringType));
          setInputName("input");
      }

      public ParameterValue invokeImpl(ParameterValue parameterValue, CredentialInfo credentialInfo) throws
 InvocationException, CommunicationException {
          ParameterValue paramTimeVal = createOutputValue();
          ParameterValueManagement.setString(paramTimeVal, null, ClockDevice.getCurrentTime(null));
          return paramTimeVal;
      }
  }

 }

A DefaultService will respond to the following request message types:

Get Metadata Message - GetMessage

Subscribe Message - SubscribeMessage
Unsubscribe Message - UnsubscribeMessage
GetStatus Message - GetStatusMessage
Renew Message - RenewMessage

Invoke Message - InvokeMessage

with the appropriate response message types:

Get Metadata Response Message - GetMetadataResponseMessage

Subscribe Response Message - SubscribeResponseMessage
Unsubscribe Response Message - UnsubscribeResponseMessage
GetStatus Response Message - GetStatusResponseMessage
Renew Response Message - RenewResponseMessage

Invoke Response Message - InvokeMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class DefaultService.ServiceMessageListener
- Nested classes/interfaces inherited from class org.ws4d.java.service.ServiceCommons
  ServiceCommons.PortType

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DefaultService.ServiceMessageListener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`BINDING_POSTFIX`
`protected HashMap`	`communicationAutoBindings`
`protected HashMap`	`communicationBindingsDown`
`protected HashMap`	`communicationBindingsUp`
`protected int`	`configurationId` Configuration identifier
`protected static java.lang.String`	`FAULT_MSG_POSTFIX`
`protected HostedMData`	`hosted`
`protected static java.lang.String`	`IN_MSG_POSTFIX`
`protected static java.lang.String`	`OUT_MSG_POSTFIX`
`protected HashMap`	`outgoingDiscoveryInfosDown`
`protected HashMap`	`outgoingDiscoveryInfosUp`
`protected LocalDevice`	`parentDevice`
`protected HashMap`	`resourceURIs`
`protected static byte`	`SERVICE_STATE_REGISTERED`
`protected static byte`	`SERVICE_STATE_RUNNING`
`protected static byte`	`SERVICE_STATE_UNREGISTERED`
`protected ServiceProperties`	`serviceProp`
`protected ServiceReference`	`serviceReference`
`protected byte`	`state`
`protected SubscriptionManager`	`subscriptionManager`
`protected HashMap`	`wsdlURIs`

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
`DefaultService()` Deprecated.
`DefaultService(int configurationId)` Deprecated.
`DefaultService(int configurationId, java.lang.String comManId)` Default service with given configuration identifier.
`DefaultService(java.lang.String comManId)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBinding(CommunicationAutoBinding autoBinding)` Adds the given autoBinding to this `Bindable`.
`void`	`addBinding(CommunicationBinding binding)` Adds the given binding to this `Bindable`.
`void`	`addCustomMData(java.lang.String communicationManagerId, UnknownDataContainer container)`
`void`	`addEventSource(EventSource event)` Add an event to this service.
`void`	`addOperation(Operation operation)` Add an operation to this service.
`void`	`addOutgoingDiscoveryInfo(DiscoveryAutoBinding autoBinding)`
`void`	`addOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info)` Adds the specified outgoing discovery info to this device.
`void`	`addPortType(QName portTypeName)`
`void`	`clearBindings()` Removes all bindings from this `Bindable` instance.
`protected EventSource`	`createEventSource(WSDLOperation wsdlOperation)` Creates a `DefaultEventSource` instance suitable for usage within this service instance.
`protected IncomingMessageListener`	`createListener(CredentialInfo credInfo)`
`protected Operation`	`createOperation(WSDLOperation wsdlOperation)` Creates an `Operation` instance suitable for usage within this service instance.
`void`	`define(URI wsdlUri, CredentialInfo credentialInfo)` Deprecated.
`void`	`define(URI wsdlUri, CredentialInfo credentialInfo, java.lang.String comManId)` Enables dynamic service creation from an existing WSDL description.
`void`	`define(WSDL wsdl)` Enables dynamic service creation from an existing WSDL description.
`protected void`	`deployMetadataResources()`
`protected void`	`deployMetadataResources(Iterator bindings)` Registers all WSDL and XML Schema files to the internal resource server (e.g.
`void`	`deviceCommunicationBindingDestroyed(CommunicationBinding deviceBinding, CommunicationManager manager)`
`void`	`deviceCommunicationBindingDown(CommunicationBinding deviceBinding, CommunicationManager manager)`
`void`	`deviceCommunicationBindingUp(CommunicationBinding deviceBinding, CommunicationManager manager)`
`void`	`deviceNewCommunicationBindingAvailable(CommunicationBinding deviceBinding, CommunicationManager manager)`
`void`	`deviceStartUpdates()`
`void`	`deviceStopUpdates()`
`void`	`disconnectAllServiceReferences(boolean resetServiceRefs)` The method disconnected all ServiceReferences from this service.
`boolean`	`equals(java.lang.Object obj)`
`protected void`	`exclusiveLock()` Creates a exclusive lock for this service.
`Iterator`	`getAllEventSources()` Returns all `EventSource`s of this service.
`Iterator`	`getAllOperations()` Returns all `Operation`s from this service.
`AuthorizationManager`	`getAuthorizationManager()` Returns the `AuthorizationManager` for this LocalService.
`Iterator`	`getCommunicationAutoBindings()` Returns an iterator over all `autoBindings` assigned to this `Bindable` instance.
`Iterator`	`getCommunicationBindings()` Returns an iterator over all `bindings` assigned to this `Bindable` instance.
`int`	`getConfigurationID()` Gets configuration identifier.
`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`	`getDescriptionsForPortTypes()` Returns an iterator containing all WSDL documents describing 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 `EventSource`s matching the given criteria.
`HostedMData`	`getHosted()` Returns the `HostedMData` of the LocalService.
`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 `Operation`s matching the given criteria.
`Set`	`getOutgoingDiscoveryInfos()`
`LocalDevice`	`getParentDevice()` Returns the parent Device of this LocalService.
`DeviceReference`	`getParentDeviceReference(SecurityKey securityKey)` Gets device reference of parent device.
`Iterator`	`getPortTypes()` Gets service port types.
`QNameSet`	`getPortTypesQNameSet()`
`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.
`SubscriptionManager`	`getSubscriptionManager()`
`Iterator`	`getTargetNamespaces()` Returns the namespaces based on the port types for this service.
`boolean`	`hasCommunicationAutoBindings()` Returns `true` only if this instance has at least one `binding` assigned.
`boolean`	`hasCommunicationBindings()` Returns `true` only if this `Bindable` instance has at least one `binding` assigned.
`int`	`hashCode()`
`boolean`	`hasOutgoingDiscoveryInfos()`
`boolean`	`isRemote()` Is the service remote (proxy) or local?
`boolean`	`isRunning()` Returns `true`, if this local service is currently in the running state.
`void`	`pause()` Pauses service.
`protected void`	`recurseLinkedSchemas(Schema schema, CommunicationBinding binding, java.lang.String resourcesBasePath, int depth)`
`protected void`	`recurseLinkedSchemas(Schema schema, CommunicationBinding binding, java.lang.String resourcesBasePath, int depth, DataStructure deployedNamespaces)`
`protected void`	`releaseExclusiveLock()` Releases a exclusive lock for this service.
`protected void`	`releaseSharedLock()` Releases a shared lock for this service.
`boolean`	`removeBinding(CommunicationAutoBinding autoBinding)`
`boolean`	`removeBinding(CommunicationBinding binding)` Removes the specified binding from this `Bindable` instance.
`boolean`	`removeOutgoingDiscoveryInfo(DiscoveryAutoBinding autoBinding)`
`boolean`	`removeOutgoingDiscoveryInfo(OutgoingDiscoveryInfo info)` Removes a previously `added` outgoing discovery info from this device.
`long`	`renew(ClientSubscription subscription, long duration, CredentialInfo credentialInfo)` Renews an existing subscription with a new duration.
`boolean`	`serviceMatches(QNameSet searchTypes)`
`void`	`setAuthorizationManager(AuthorizationManager authorizationManager)` Set the `AuthorizationManager` for this LocalService.
`void`	`setCustomMData(java.lang.String communicationManagerId, ArrayList customMData)` Set the custom metadata
`void`	`setParentDevice(LocalDevice device)` Sets the parent device for this service.
`void`	`setServiceId(URI serviceId)` Sets the service identifier for this service.
`protected void`	`sharedLock()` Creates a shared lock for this service.
`void`	`start()` Starts this service.
`void`	`stop()` Stops this service.
`ClientSubscription`	`subscribe(EventSink sink, java.lang.String clientSubscriptionId, URISet eventActionURIs, long duration, CredentialInfo credentialInfo)` Initializes event receiving from specified event sender.
`protected void`	`undeployMetadataResources()`
`void`	`unsubscribe(ClientSubscription subscription, CredentialInfo credentialInfo)` Unsubscribe specified subscription.

Methods inherited from class org.ws4d.java.service.ServiceCommons
getDescriptions, getEventsInternal, getExistingDescription, getPortTypeAttribute, getPortTypeAttributes, getPortTypesInternal, hasPortTypeAttributes, processWSDLPortType, setPortTypeAttribute, setPortTypeAttributes, 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
getDescriptions, getPortTypeAttribute, getPortTypeAttributes, hasPortTypeAttributes

- Field Detail
  - SERVICE_STATE_UNREGISTERED
```
protected static final byte SERVICE_STATE_UNREGISTERED
```
    See Also:
    
    Constant Field Values
  - SERVICE_STATE_REGISTERED
```
protected static final byte SERVICE_STATE_REGISTERED
```
    See Also:
    
    Constant Field Values
  - SERVICE_STATE_RUNNING
```
protected static final byte SERVICE_STATE_RUNNING
```
    See Also:
    
    Constant Field Values
  - IN_MSG_POSTFIX
```
protected static final java.lang.String IN_MSG_POSTFIX
```
    See Also:
    
    Constant Field Values
  - OUT_MSG_POSTFIX
```
protected static final java.lang.String OUT_MSG_POSTFIX
```
    See Also:
    
    Constant Field Values
  - FAULT_MSG_POSTFIX
```
protected static final java.lang.String FAULT_MSG_POSTFIX
```
    See Also:
    
    Constant Field Values
  - BINDING_POSTFIX
```
protected static final java.lang.String BINDING_POSTFIX
```
    See Also:
    
    Constant Field Values
  - hosted
```
protected final HostedMData hosted
```
  - serviceProp
```
protected final ServiceProperties serviceProp
```
  - wsdlURIs
```
protected final HashMap wsdlURIs
```
  - resourceURIs
```
protected final HashMap resourceURIs
```
  - configurationId
```
protected int configurationId
```
    Configuration identifier
  - serviceReference
```
protected ServiceReference serviceReference
```
  - parentDevice
```
protected LocalDevice parentDevice
```
  - state
```
protected byte state
```
  - subscriptionManager
```
protected SubscriptionManager subscriptionManager
```
  - communicationAutoBindings
```
protected HashMap communicationAutoBindings
```
  - communicationBindingsUp
```
protected HashMap communicationBindingsUp
```
  - communicationBindingsDown
```
protected HashMap communicationBindingsDown
```
  - outgoingDiscoveryInfosUp
```
protected HashMap outgoingDiscoveryInfosUp
```
  - outgoingDiscoveryInfosDown
```
protected HashMap outgoingDiscoveryInfosDown
```
- Constructor Detail
  - DefaultService
```
public DefaultService()
```
    Deprecated.
  - DefaultService
```
public DefaultService(int configurationId)
```
    Deprecated.
  - DefaultService
```
public DefaultService(java.lang.String comManId)
```
  - DefaultService
```
public DefaultService(int configurationId,
                      java.lang.String comManId)
```
    Default service with given configuration identifier.
    
    Creates an default service and tries to load the configuration properties for the service.
    
    Parameters:
    
    configurationId - configuration identifier.
- Method Detail
  - createListener
```
protected IncomingMessageListener createListener(CredentialInfo credInfo)
```
  - hasCommunicationAutoBindings
```
public boolean hasCommunicationAutoBindings()
```
    Description copied from interface: Bindable
    
    Returns true only if this instance has at least one binding assigned. Returns false, if it doesn't have any autoBindings.
    
    Specified by:
    
    hasCommunicationAutoBindings in interface Bindable
    
    Returns:
    
    whether there are any autoBindings assigned to that Bindable instance or not
  - hasCommunicationBindings
```
public boolean hasCommunicationBindings()
```
    Description copied from interface: Bindable
    
    Returns true only if this Bindable instance has at least one binding assigned. Returns false, if it doesn't have any bindings.
    
    Specified by:
    
    hasCommunicationBindings in interface Bindable
    
    Returns:
    
    whether there are any bindings assigned to that Bindable instance or not
  - getCommunicationAutoBindings
```
public Iterator getCommunicationAutoBindings()
```
    Description copied from interface: Bindable
    
    Returns an iterator over all autoBindings assigned to this Bindable instance. This iterator will have no next elements (rather than being ), if the Bindable doesn't have any bindings.
    
    Specified by:
    
    getCommunicationAutoBindings in interface Bindable
    
    Returns:
    
    an iterator over all available bindings
  - getCommunicationBindings
```
public Iterator getCommunicationBindings()
```
    Description copied from interface: Bindable
    
    Returns an iterator over all bindings assigned to this Bindable instance. This iterator will have no next elements (rather than being ), if the Bindable doesn't have any bindings.
    
    Specified by:
    
    getCommunicationBindings in interface Bindable
    
    Returns:
    
    an iterator over all available bindings
  - addBinding
```
public void addBinding(CommunicationAutoBinding autoBinding)
                throws WS4DIllegalStateException
```
    Description copied from interface: Bindable
    
    Adds the given autoBinding to this Bindable. Does nothing if the Bindable already contains the binding.
    
    Specified by:
    
    addBinding in interface Bindable
    
    Throws:
    
    WS4DIllegalStateException - in case this Bindable doesn't currently support modifications (see #supportsBindingChanges())
  - addBinding
```
public void addBinding(CommunicationBinding binding)
                throws WS4DIllegalStateException
```
    Description copied from interface: Bindable
    
    Adds the given binding to this Bindable. Does nothing if the Bindable already contains the binding.
    
    Specified by:
    
    addBinding in interface Bindable
    
    Parameters:
    
    binding - the binding to add
    
    Throws:
    
    WS4DIllegalStateException - in case this Bindable doesn't currently support modifications (see #supportsBindingChanges())
  - removeBinding
```
public boolean removeBinding(CommunicationBinding binding)
                      throws WS4DIllegalStateException
```
    Description copied from interface: Bindable
    
    Removes the specified binding from this Bindable instance. Does nothing, if the Bindable doesn't contain the given binding. Returns true if the binding was removed and false if it didn't exist.
    
    Specified by:
    
    removeBinding in interface Bindable
    
    Parameters:
    
    binding - the binding to remove
    
    Returns:
    
    true if this Bindable instance had the given binding assigned and it was removed successfully, false otherwise
    
    Throws:
    
    WS4DIllegalStateException - in case this Bindable doesn't currently support modifications (see #supportsBindingChanges())
  - removeBinding
```
public boolean removeBinding(CommunicationAutoBinding autoBinding)
                      throws WS4DIllegalStateException
```
    Specified by:
    
    removeBinding in interface Bindable
    
    Throws:
    
    WS4DIllegalStateException
  - clearBindings
```
public void clearBindings()
                   throws WS4DIllegalStateException
```
    Description copied from interface: Bindable
    
    Removes all bindings from this Bindable instance. Does nothing if there are no bindings assigned.
    
    Specified by:
    
    clearBindings in interface Bindable
    
    Throws:
    
    WS4DIllegalStateException - in case this Bindable doesn't support modifications at the current time (see #supportsBindingChanges())
  - serviceMatches
```
public boolean serviceMatches(QNameSet searchTypes)
```
  - start
```
public void start()
           throws java.io.IOException
```
    Description copied from interface: LocalService
    
    Starts this service. Registers service within dispatcher.
    
    Specified by:
    
    start in interface LocalService
    
    Throws:
    
    java.io.IOException
  - stop
```
public void stop()
          throws java.io.IOException
```
    Description copied from interface: LocalService
    
    Stops this service. Unregisters service in device service registry.
    
    Specified by:
    
    stop in interface LocalService
    
    Throws:
    
    java.io.IOException
  - pause
```
public void pause()
```
    Description copied from interface: LocalService
    
    Pauses service. After calling this, subsequent incoming requests to this service will result in a "ServiceNotAvailable" fault.
    
    Specified by:
    
    pause in interface LocalService
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: LocalService
    
    Returns true, if this local service is currently in the running state. Returns false otherwise.
    
    Specified by:
    
    isRunning in interface LocalService
    
    Returns:
    
    whether this local service is currently running or not
  - getServiceReference
```
public ServiceReference getServiceReference(SecurityKey securityKey)
```
    Description copied from interface: Service
    
    Gets the service reference.
    
    Specified by:
    
    getServiceReference in interface Service
    
    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.
    Specified by: disconnectAllServiceReferences in interface Service
  sharedLock protected void sharedLock() Creates a shared lock for this service. If the service has a parent device, the lock is acquired from the device. exclusiveLock protected void exclusiveLock() Creates a exclusive lock for this service. If the service has a parent device, the lock is acquired from the device. releaseSharedLock protected void releaseSharedLock() Releases a shared lock for this service. If the service has a parent device, the lock is released from the device. releaseExclusiveLock protected void releaseExclusiveLock() Releases a exclusive lock for this service. If the service has a parent device, the lock is released from the device. isRemote public boolean isRemote() Description copied from interface: Service Is the service remote (proxy) or local? Specified by: isRemote in interface Service Returns: whether this is a remote service (proxy) or not getServiceId public URI getServiceId() Description copied from interface: Service Gets service id Specified by: getServiceId in interface Service Returns: service id setServiceId public void setServiceId(URI serviceId) Sets the service identifier for this service. The service identifier identifies the service uniquely for the parent device. Specified by: setServiceId in interface LocalService Parameters: serviceId - the service identifier to set. 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 Overrides: getOperation in class ServiceCommons Returns: getAllOperations public Iterator getAllOperations() Description copied from interface: Service Returns all Operations from this service. Specified by: getAllOperations in interface Service Overrides: getAllOperations in class ServiceCommons 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 Overrides: getOperations in class ServiceCommons Returns: getAllEventSources public Iterator getAllEventSources() Description copied from interface: Service Returns all EventSources of this service. Specified by: getAllEventSources in interface Service Overrides: getAllEventSources in class ServiceCommons 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 Overrides: getEventSource in class ServiceCommons 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 Overrides: getEventSources in class ServiceCommons Returns: getCustomMData public UnknownDataContainer[] getCustomMData(java.lang.String communicationManagerId) Description copied from class: ServiceCommons The method returns all custom metadata Specified by: getCustomMData in interface Service Overrides: getCustomMData in class ServiceCommons Returns: UnknownDataContainer[] which contains the custom metadata getHosted public HostedMData getHosted() Description copied from interface: LocalService Returns the HostedMData of the LocalService. Specified by: getHosted in interface LocalService Returns: hosted setCustomMData public void setCustomMData(java.lang.String communicationManagerId, ArrayList customMData) Set the custom metadata Specified by: setCustomMData in interface LocalService Parameters: customMData - String which contains the new custom metadata. addCustomMData public void addCustomMData(java.lang.String communicationManagerId, UnknownDataContainer container) Specified by: addCustomMData in interface LocalService See Also: org.ws4d.java.service.LocalDevice#addCustomMData(UnknownDataContainer) getPortTypesQNameSet public QNameSet getPortTypesQNameSet() getPortTypes public Iterator getPortTypes() Description copied from interface: Service Gets service port types. The port types define the operations the service provides. Specified by: getPortTypes in interface Service Returns: an iterator (read only) of QName. addPortType public void addPortType(QName portTypeName) deployMetadataResources protected void deployMetadataResources() getEprInfos public Iterator getEprInfos() Description copied from interface: Service Returns an iterator of EprInfo. Specified by: getEprInfos in interface Service Returns: an iterator of EprInfo. addOperation public void addOperation(Operation operation) Description copied from interface: LocalService Add an operation to this service. Specified by: addOperation in interface LocalService Parameters: operation - operation to add. getOutgoingDiscoveryInfos public Set getOutgoingDiscoveryInfos() Specified by: getOutgoingDiscoveryInfos in interface OutgoingDiscoveryInfosProvider 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 hasOutgoingDiscoveryInfos public boolean hasOutgoingDiscoveryInfos() addOutgoingDiscoveryInfo public void addOutgoingDiscoveryInfo(DiscoveryAutoBinding autoBinding) removeOutgoingDiscoveryInfo public boolean removeOutgoingDiscoveryInfo(DiscoveryAutoBinding autoBinding) addEventSource public void addEventSource(EventSource event) Description copied from interface: LocalService Add an event to this service. Specified by: addEventSource in interface LocalService Parameters: event - event to add. getConfigurationID public int getConfigurationID() Gets configuration identifier. The configuration identifier is necessary to resolve properties based configuration. Returns: the configuration identifier. getParentDevice public LocalDevice getParentDevice() Description copied from interface: LocalService Returns the parent Device of this LocalService. Specified by: getParentDevice in interface LocalService Returns: the parent Device of this LocalService. setParentDevice public void setParentDevice(LocalDevice device) Sets the parent device for this service. Every service is assigned to one device. Specified by: setParentDevice in interface LocalService Parameters: device - the device which the service should be assigned to. 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. Specified by: getParentDeviceReference in interface Service Returns: device reference of parent device, may be null deployMetadataResources protected void deployMetadataResources(Iterator bindings) Registers all WSDL and XML Schema files to the internal resource server (e.g. HTTP). recurseLinkedSchemas protected void recurseLinkedSchemas(Schema schema, CommunicationBinding binding, java.lang.String resourcesBasePath, int depth) throws java.io.IOException Throws: java.io.IOException recurseLinkedSchemas protected void recurseLinkedSchemas(Schema schema, CommunicationBinding binding, java.lang.String resourcesBasePath, int depth, DataStructure deployedNamespaces) throws java.io.IOException Throws: java.io.IOException undeployMetadataResources protected void undeployMetadataResources() getTargetNamespaces public Iterator getTargetNamespaces() Returns the namespaces based on the port types for this service. Returns: the namespaces based on the port types for this service. getDescriptionsForPortTypes public Iterator getDescriptionsForPortTypes() Description copied from interface: LocalService Returns an iterator containing all WSDL documents describing this service. Specified by: getDescriptionsForPortTypes in interface LocalService Returns: an iterator containing all WSDL documents describing this service, i.e. those containing port types of the service. getDescription public WSDL getDescription(java.lang.String targetNamespace) Returns a WSDL document describing this service by the given namespace. Specified by: getDescription in interface Service Parameters: targetNamespace - the namespace. Returns: the WSDL document describing this service by the given namespace. define public void define(URI wsdlUri, CredentialInfo credentialInfo, java.lang.String comManId) throws java.io.IOException Enables dynamic service creation from an existing WSDL description. This method analyzes the WSDL loaded from wsdlUri and adds all supported port types found to this service. For each supported operation (i.e. either one-way or request-response transmission types), an instance of class OperationStub is created and added, whereas for each event source (aka. notification or solicit-response transmission types) an instance of class DefaultEventSource is added. The actual business logic of imported one-way or request-response operations can be specified on the corresponding OperationStub instance after having obtained it from this service via one of the getOperation(...) methods like this: DefaultService myService = ...; myService.define("http://www.example.org/myService/description.wsdl"); InvokeDelegate myDelegate = ...; Operation myOp = (OperationStub) myService.getOperation("http://www.example.org/MyServicePortType/MyOperation"); myOp.setDelegate(myDelegate); The InvokeDelegate instance above defines the actual code to be executed when the myOperation gets called. Its InvokeDelegate.invokeImpl(Operation, ParameterValue, CredentialInfo) method receives the parameters sent to the operation, as well as the operation instance itself. The latter is useful for implementors who want to share a single InvokeDelegate instance between different operations. Note that the cast to OperationStub above is only safe if the operation being obtained was actually created via a call to this define(URI, CredentialInfo) method - in any other case, e.g. when it was added manually by means of addOperation(Operation), this cast will most likely result in a java.lang.ClassCastException. Parameters: wsdlUri - URI pointing to the location of the WSDL document to define this service from; the URI may have an arbitrary schema (e.g. file, http, https, etc.) as long as there is runtime support available for accessing it within the JMEDS framework, Throws: java.io.IOException - if a failure occurs while attempting to obtain the WSDL from the given URI define public void define(URI wsdlUri, CredentialInfo credentialInfo) throws java.io.IOException Deprecated. Parameters: wsdlUri - credentialInfo - Throws: java.io.IOException define public void define(WSDL wsdl) throws java.io.IOException Enables dynamic service creation from an existing WSDL description. This method analyzes the WSDL loaded from wsdlUri and adds all supported port types found to this service. For each supported operation (i.e. either one-way or request-response transmission types), an instance of class OperationStub is created and added, whereas for each event source (aka. notification or solicit-response transmission types) an instance of class DefaultEventSource is added. The actual business logic of imported one-way or request-response operations can be specified on the corresponding OperationStub instance after having obtained it from this service via one of the getOperation(...) methods like this: DefaultService myService = ...; myService.define("http://www.example.org/myService/description.wsdl"); InvokeDelegate myDelegate = ...; Operation myOp = (OperationStub) myService.getOperation("http://www.example.org/MyServicePortType/MyOperation"); myOp.setDelegate(myDelegate); The InvokeDelegate instance above defines the actual code to be executed when the myOperation gets called. Its InvokeDelegate.invokeImpl(Operation, ParameterValue, CredentialInfo) method receives the parameters sent to the operation, as well as the operation instance itself. The latter is useful for implementors who want to share a single InvokeDelegate instance between different operations. Note that the cast to OperationStub above is only safe if the operation being obtained was actually created via a call to this define(URI, CredentialInfo) method - in any other case, e.g. when it was added manually by means of addOperation(Operation), this cast will most likely result in a java.lang.ClassCastException. Parameters: wsdl - the WSDL object which should be used to define the serivce. Throws: java.io.IOException - if a failure occurs while attempting to obtain the WSDL from the given URI getSubscriptionManager public SubscriptionManager getSubscriptionManager() Specified by: getSubscriptionManager in interface LocalService 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 subscribe public ClientSubscription subscribe(EventSink sink, java.lang.String clientSubscriptionId, URISet eventActionURIs, long duration, CredentialInfo credentialInfo) throws EventingException, CommunicationException Description copied from interface: Service Initializes event receiving from specified event sender. Specified by: subscribe in interface Service Parameters: sink - event sink which will receive the notifications. 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 unsubscribe public void unsubscribe(ClientSubscription subscription, CredentialInfo credentialInfo) throws EventingException, CommunicationException Description copied from interface: Service Unsubscribe specified subscription. Specified by: unsubscribe in interface Service Parameters: subscription - subscription to terminate. Throws: EventingException CommunicationException renew public long renew(ClientSubscription subscription, long duration, CredentialInfo credentialInfo) throws EventingException, CommunicationException Description copied from interface: Service Renews an existing subscription with a new duration. If duration is "0", subscription never terminates. Specified by: renew in interface Service Throws: EventingException CommunicationException getStatus public long getStatus(ClientSubscription subscription, CredentialInfo credentialInfo) throws EventingException, CommunicationException Description copied from interface: Service Returns the duration in milliseconds until expiration of the specified client subscription. Specified by: getStatus in interface Service Returns: status of subscribtion Throws: EventingException CommunicationException getAuthorizationManager public AuthorizationManager getAuthorizationManager() Description copied from interface: LocalService Returns the AuthorizationManager for this LocalService. Specified by: getAuthorizationManager in interface LocalService Returns: the AuthorizationManager for this LocalService. setAuthorizationManager public void setAuthorizationManager(AuthorizationManager authorizationManager) Description copied from interface: LocalService Set the AuthorizationManager for this LocalService. Specified by: setAuthorizationManager in interface LocalService deviceNewCommunicationBindingAvailable public void deviceNewCommunicationBindingAvailable(CommunicationBinding deviceBinding, CommunicationManager manager) Specified by: deviceNewCommunicationBindingAvailable in interface LocalService deviceCommunicationBindingDestroyed public void deviceCommunicationBindingDestroyed(CommunicationBinding deviceBinding, CommunicationManager manager) Specified by: deviceCommunicationBindingDestroyed in interface LocalService deviceCommunicationBindingUp public void deviceCommunicationBindingUp(CommunicationBinding deviceBinding, CommunicationManager manager) Specified by: deviceCommunicationBindingUp in interface LocalService deviceCommunicationBindingDown public void deviceCommunicationBindingDown(CommunicationBinding deviceBinding, CommunicationManager manager) Specified by: deviceCommunicationBindingDown in interface LocalService deviceStartUpdates public void deviceStartUpdates() Specified by: deviceStartUpdates in interface LocalService deviceStopUpdates public void deviceStopUpdates() Specified by: deviceStopUpdates in interface LocalService hashCode public int hashCode() Overrides: hashCode in class ServiceCommons equals public boolean equals(java.lang.Object obj) Overrides: equals in class ServiceCommons

Class DefaultService

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_STATE_UNREGISTERED

SERVICE_STATE_REGISTERED

SERVICE_STATE_RUNNING

IN_MSG_POSTFIX

OUT_MSG_POSTFIX

FAULT_MSG_POSTFIX

BINDING_POSTFIX

hosted

serviceProp

wsdlURIs

resourceURIs

configurationId

serviceReference

parentDevice

state

subscriptionManager

communicationAutoBindings

communicationBindingsUp

communicationBindingsDown

outgoingDiscoveryInfosUp

outgoingDiscoveryInfosDown

Constructor Detail

DefaultService

DefaultService

DefaultService

DefaultService

Method Detail

createListener

hasCommunicationAutoBindings

hasCommunicationBindings

getCommunicationAutoBindings

getCommunicationBindings

addBinding

addBinding

removeBinding

removeBinding

clearBindings

serviceMatches

start

stop

pause

isRunning

getServiceReference

disconnectAllServiceReferences

sharedLock

exclusiveLock

releaseSharedLock

releaseExclusiveLock

isRemote

getServiceId

setServiceId

getOperation

getAllOperations

getOperations

getAllEventSources

getEventSource

getEventSources

getCustomMData

getHosted

setCustomMData

addCustomMData

getPortTypesQNameSet

getPortTypes

addPortType

deployMetadataResources

getEprInfos

addOperation

getOutgoingDiscoveryInfos