org.switchyard

Interface ServiceDomain

public interface ServiceDomain

A ServiceDomain represents a collection of services with a shared set of resources, configuration, and policy definitions. The ServiceDomain interface is used by software components to provide and/or consume services. These software components include protocol gateways, service containers, translation engines, adapters, orchestration and routing engines.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceDomain	addEventObserver(EventObserver observer, Class<? extends EventObject> eventType) Add an EventObserver for the specified event type.
void	destroy() Cleans up all resources associated with a ServiceDomain instance including the transformer/validator/service registry and exchange bus.
EventPublisher	getEventPublisher() Returns the EventPublisher for this domain, which can be used to notify event observers of activity.
QName	getName() Name of the ServiceDomain.
Map<String,Object>	getProperties() Shared properties/POJOs for this service domain.
Object	getProperty(String name) Returns the value of the specified domain property.
ServiceReference	getServiceReference(QName serviceName) Fetches a registered service reference for the specified name.
List<Service>	getServices() Return the list of services.
List<Service>	getServices(QName serviceName) Get the list of services for the specified service name.
ServiceSecurity	getServiceSecurity(String name) Gets a ServiceSecurity by name.
TransformerRegistry	getTransformerRegistry() Returns a reference to the transformer registry for this domain.
ValidatorRegistry	getValidatorRegistry() Returns a reference to the validator registry for this domain.
void	init() Initialize the service domain.
Service	registerService(QName serviceName, ServiceInterface contract, ExchangeHandler handler) Register a service with the domain.
Service	registerService(QName serviceName, ServiceInterface contract, ExchangeHandler handler, ServiceMetadata metadata) Register a service with the domain.
ServiceReference	registerServiceReference(QName serviceName, ServiceInterface metadata) Register a service reference with the domain.
ServiceReference	registerServiceReference(QName serviceName, ServiceInterface contract, ExchangeHandler handler) Register a service reference with the domain.
ServiceReference	registerServiceReference(QName serviceName, ServiceInterface contract, ExchangeHandler handler, ServiceMetadata metadata) Register a service reference with the domain.
void	removeObserver(EventObserver observer) Remove all event registrations for a given EventObserver instance.
void	removeObserverForEvent(EventObserver observer, Class<? extends EventObject> event) Remove an EventObserver from a specific event type.
ServiceDomain	setProperty(String name, Object value) Sets the specified property on this domain.

Method Detail

init

void init()

Initialize the service domain. This method exists to allow additional properties and resources to be associated with the service domain before it is started.

getName

QName getName()

Name of the ServiceDomain. This is unique within a runtime.

Returns:

name name of the ServiceDomain.

registerService

Service registerService(QName serviceName,
                      ServiceInterface contract,
                      ExchangeHandler handler)

Register a service with the domain.

Parameters:

serviceName - the name of the service

handler - the handler to use to process exchanges directed at this service

contract - service interface details

Returns:

the registered service

registerService

Service registerService(QName serviceName,
                      ServiceInterface contract,
                      ExchangeHandler handler,
                      ServiceMetadata metadata)

Register a service with the domain.

Parameters:

serviceName - the name of the service

handler - the handler to use to process exchanges directed at this service

contract - service interface details

metadata - runtime metadata associated with the service

Returns:

the registered service

registerServiceReference

ServiceReference registerServiceReference(QName serviceName,
                                        ServiceInterface metadata)

Register a service reference with the domain.

Parameters:

serviceName - the name of the reference

metadata - service consumer contract

Returns:

a reference to the registered service that can be used to unregister when required

registerServiceReference

ServiceReference registerServiceReference(QName serviceName,
                                        ServiceInterface contract,
                                        ExchangeHandler handler)

Register a service reference with the domain.

Parameters:

serviceName - the name of the reference

contract - service consumer contract

handler - the handler to use to process replies from the service

Returns:

a reference to the registered service that can be used to unregister when required

registerServiceReference

ServiceReference registerServiceReference(QName serviceName,
                                        ServiceInterface contract,
                                        ExchangeHandler handler,
                                        ServiceMetadata metadata)

Register a service reference with the domain.

Parameters:

serviceName - the name of the reference

contract - service consumer contract

handler - the handler to use to process replies from the service

metadata - runtime metadata associated with the service

Returns:

a reference to the registered service that can be used to unregister when required

getServiceReference

ServiceReference getServiceReference(QName serviceName)

Fetches a registered service reference for the specified name.

Parameters:

serviceName - name of the service reference

Returns:

registered service reference, or null if no references have been registered with the specified name.

getServices

List<Service> getServices()

Return the list of services.

Returns:

services

getServices

List<Service> getServices(QName serviceName)

Get the list of services for the specified service name.

Parameters:

serviceName - service name

Returns:

services

getTransformerRegistry

TransformerRegistry getTransformerRegistry()

Returns a reference to the transformer registry for this domain.

Returns:

transformer registry instance

getValidatorRegistry

ValidatorRegistry getValidatorRegistry()

Returns a reference to the validator registry for this domain.

Returns:

validator registry instance

addEventObserver

ServiceDomain addEventObserver(EventObserver observer,
                             Class<? extends EventObject> eventType)

Add an EventObserver for the specified event type. A single instance of EventObserver can be registered to receive multiple event types.

Parameters:

observer - the event observer to add

eventType - the event type to receive notifications on

Returns:

a reference to this ServiceDomain for chaining multiple addEventObserver() calls

removeObserver

void removeObserver(EventObserver observer)

Remove all event registrations for a given EventObserver instance.

Parameters:

observer - the observer to unregister

removeObserverForEvent

void removeObserverForEvent(EventObserver observer,
                          Class<? extends EventObject> event)

Remove an EventObserver from a specific event type.

Parameters:

observer - the EventObserver to unregister

event - the event to unregister

getEventPublisher

EventPublisher getEventPublisher()

Returns the EventPublisher for this domain, which can be used to notify event observers of activity.

Returns:

event publisher

getServiceSecurity

ServiceSecurity getServiceSecurity(String name)

Gets a ServiceSecurity by name.

Parameters:

name - the name

Returns:

the ServiceSecurity

setProperty

ServiceDomain setProperty(String name,
                        Object value)

Sets the specified property on this domain.

Parameters:

name - property name

value - property value

Returns:

this ServiceDomain instance

getProperty

Object getProperty(String name)

Returns the value of the specified domain property.

Parameters:

name - property name

Returns:

the value associated with this property, or null if no such property exists.

getProperties

Map<String,Object> getProperties()

Shared properties/POJOs for this service domain. The returned map does not permit updates to domain properties. The setProperty() method should be used for setting/updating properties

Returns:

unmodifiable map of all domain properties

destroy

void destroy()

Cleans up all resources associated with a ServiceDomain instance including the transformer/validator/service registry and exchange bus. ServiceDomain instances can not be used after they are destroyed.