org.ws4d.java.service

Interface LocalService

All Superinterfaces:

Bindable, Service

All Known Implementing Classes:

DefaultService

public interface LocalService
extends Service, Bindable

Service.

Contains the methods to use a service. Does not care about the location of the service. It possible to use local services created inside the own virtual machine or remote services from other machines.

Field Summary

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

NO_PARAMETER

Method Summary

Modifier and Type	Method and Description
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	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()
AuthorizationManager	getAuthorizationManager() Returns the AuthorizationManager for this LocalService.
Iterator	getDescriptionsForPortTypes() Returns an iterator containing all WSDL documents describing this service.
HostedMData	getHosted() Returns the HostedMData of the LocalService.
LocalDevice	getParentDevice() Returns the parent Device of this LocalService.
SubscriptionManager	getSubscriptionManager()
boolean	isRunning() Returns true, if this local service is currently in the running state.
void	pause() Pauses service.
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) Set the serviceId for this local service.
void	start() Starts this service.
void	stop() Stops this service.

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

disconnectAllServiceReferences, getAllEventSources, getAllOperations, getCustomMData, getDescription, getDescriptions, getEprInfos, getEventSource, getEventSources, getOperation, getOperations, getParentDeviceReference, getPortTypeAttribute, getPortTypeAttributes, getPortTypes, getServiceId, getServiceReference, getStatus, hasPortTypeAttributes, isRemote, renew, subscribe, unsubscribe

Methods inherited from interface org.ws4d.java.communication.Bindable

addBinding, addBinding, clearBindings, getCommunicationAutoBindings, getCommunicationBindings, hasCommunicationAutoBindings, hasCommunicationBindings, removeBinding, removeBinding

Method Detail

addOperation

void addOperation(Operation operation)

Add an operation to this service.

Parameters:

operation - operation to add.

addEventSource

void addEventSource(EventSource event)

Add an event to this service.

Parameters:

event - event to add.

start

void start()
    throws java.io.IOException

Starts this service. Registers service within dispatcher.

Throws:

java.io.IOException

pause

void pause()

Pauses service. After calling this, subsequent incoming requests to this service will result in a "ServiceNotAvailable" fault.

stop

void stop()
   throws java.io.IOException

Stops this service. Unregisters service in device service registry.

Throws:

java.io.IOException

isRunning

boolean isRunning()

Returns true, if this local service is currently in the running state. Returns false otherwise.

Returns:

whether this local service is currently running or not

getParentDevice

LocalDevice getParentDevice()

Returns the parent Device of this LocalService.

Returns:

the parent Device of this LocalService.

setParentDevice

void setParentDevice(LocalDevice device)

Sets the parent device for this service.

Every service is assigned to one device.

Parameters:

device - the device which the service should be assigned to.

getDescriptionsForPortTypes

Iterator getDescriptionsForPortTypes()

Returns an iterator containing all WSDL documents describing this service.

Returns:

an iterator containing all WSDL documents describing this service, i.e. those containing port types of the service.

getHosted

HostedMData getHosted()

Returns the HostedMData of the LocalService.

Returns:

hosted

setServiceId

void setServiceId(URI serviceId)

Set the serviceId for this local service.

Parameters:

serviceId -

setCustomMData

void setCustomMData(java.lang.String communicationManagerId,
                    ArrayList customMData)

Set the custom metadata

Parameters:

customMData - String which contains the new custom metadata.

addCustomMData

void addCustomMData(java.lang.String communicationManagerId,
                    UnknownDataContainer container)

See Also:

org.ws4d.java.service.LocalDevice#addCustomMData(UnknownDataContainer)

getAuthorizationManager

AuthorizationManager getAuthorizationManager()

Returns the AuthorizationManager for this LocalService.

Returns:

the AuthorizationManager for this LocalService.

setAuthorizationManager

void setAuthorizationManager(AuthorizationManager authorizationManager)

Set the AuthorizationManager for this LocalService.

Parameters:

authorizationManager -

deviceNewCommunicationBindingAvailable

void deviceNewCommunicationBindingAvailable(CommunicationBinding deviceBinding,
                                            CommunicationManager manager)

deviceCommunicationBindingDestroyed

void deviceCommunicationBindingDestroyed(CommunicationBinding deviceBinding,
                                         CommunicationManager manager)

deviceCommunicationBindingUp

void deviceCommunicationBindingUp(CommunicationBinding deviceBinding,
                                  CommunicationManager manager)

deviceCommunicationBindingDown

void deviceCommunicationBindingDown(CommunicationBinding deviceBinding,
                                    CommunicationManager manager)

deviceStartUpdates

void deviceStartUpdates()

deviceStopUpdates

void deviceStopUpdates()

getSubscriptionManager

SubscriptionManager getSubscriptionManager()