org.da.protoframework.model.core

Class Service<D extends ServiceDefinition>

java.lang.Object

org.da.protoframework.model.core.Service<D>

Type Parameters:

D - the associated ServiceDefinition type

public abstract class Service<D extends ServiceDefinition>
extends java.lang.Object

Represent a Service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<ModuleKey,ServiceInstance<?,?>>	attachedProviders The Map of attached providers.
protected D	def The Service definition.
protected boolean	isSetup True if the Service has been setUp.
protected boolean	modeExecutor True if the executor mode is used to send services.

Constructor Summary

Constructors

Constructor and Description
Service(D def) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addProvider(ServiceInstance<?,?> serviceImpl) Add a Service instance provider to the Service.
void	addSubscriber(ServiceInstance<?,?> serviceImpl) Add a Service instance subscriber to the Service.
boolean	attach(Module module) Attach a module to the modules providers.
boolean	attachProvider(ServiceInstance<?,?> service) Attach a Service instance provider.
boolean	detach(Module module) Detach a module from the modules providers.
boolean	detachProvider(ServiceInstance<?,?> service) Detach a Service instance provider.
void	error(ServiceInstance<?,?> instance, char errorType) Notify an error for the execution of the Service.
java.util.Map<ModuleKey,ServiceInstance<?,?>>	getAttachedProviders() Return the Service instance attached provider.
D	getDefinition() Return the Service Definition.
long	getID() Return the Service ID.
NamespaceKey	getKey() Return the Service key.
java.lang.String	getName() Return the Service name.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getProviders() Return the Service instance providers.
long	getRequestID() Return the Service request ID if the Service maintains a request ID.
short	getServiceInvocationMode() Return the service invocation mode.
ServiceInstance<?,?>	getSubscriber(ModuleIDKey key) Return a Service instance subscriber.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getSubscribers() Return the Service subscribers.
boolean	hasRequestID() Return true if the Service maintains a request ID.
boolean	isCopyingDatas() Return true if the datas of the service must be copied before being sent.
boolean	isSetup() Return true if the Service is setUp.
void	notified(char type, int count, char invokeType) Be notified of the execution of the Service.
void	send(ServiceInstance<?,?> instance, char invokeType) Send the Service datas.
void	send(ServiceInstance<?,?> instance, int count, char invokeType) Send the Service datas.
void	setUp() Setup the Service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

def

protected D extends ServiceDefinition def

The Service definition.

isSetup

protected boolean isSetup

True if the Service has been setUp.

attachedProviders

protected final java.util.Map<ModuleKey,ServiceInstance<?,?>> attachedProviders

The Map of attached providers.

modeExecutor

protected boolean modeExecutor

True if the executor mode is used to send services.

See Also:

ServiceInvocationMode

Constructor Detail

Service

public Service(D def)

Constructor.

Parameters:

def - the Service definition.

Method Detail

getKey

public NamespaceKey getKey()

Return the Service key.

Returns:

the Service key

getName

public java.lang.String getName()

Return the Service name.

Returns:

the Service name

getID

public long getID()

Return the Service ID.

Returns:

the Service ID

getDefinition

public D getDefinition()

Return the Service Definition.

Returns:

the Service Definition

getServiceInvocationMode

public short getServiceInvocationMode()

Return the service invocation mode.

Returns:

the service invocation mode

See Also:

ServiceInvocationMode

detachProvider

public boolean detachProvider(ServiceInstance<?,?> service)

Detach a Service instance provider.

Parameters:

service - the provider

Returns:

true if the ServiceInstance could be detached

attachProvider

public boolean attachProvider(ServiceInstance<?,?> service)

Attach a Service instance provider.

Parameters:

service - the provider

Returns:

true if the ServiceInstance could be attached

getAttachedProviders

public java.util.Map<ModuleKey,ServiceInstance<?,?>> getAttachedProviders()

Return the Service instance attached provider.

Returns:

the provider

addProvider

public void addProvider(ServiceInstance<?,?> serviceImpl)

Add a Service instance provider to the Service.

Parameters:

serviceImpl - the Service instance provider

getProviders

public java.util.Map<ModuleIDKey,ServiceInstance<?,?>> getProviders()

Return the Service instance providers.

Returns:

the providers

addSubscriber

public void addSubscriber(ServiceInstance<?,?> serviceImpl)

Add a Service instance subscriber to the Service.

Parameters:

serviceImpl - the Service instance subscriber

getSubscriber

public ServiceInstance<?,?> getSubscriber(ModuleIDKey key)

Return a Service instance subscriber.

Parameters:

key - the subscriber ModuleIDKey

Returns:

the subscriber

getSubscribers

public java.util.Map<ModuleIDKey,ServiceInstance<?,?>> getSubscribers()

Return the Service subscribers.

Returns:

the subscribers

hasRequestID

public boolean hasRequestID()

Return true if the Service maintains a request ID.

Returns:

true if the Service maintains a request ID

isCopyingDatas

public boolean isCopyingDatas()

Return true if the datas of the service must be copied before being sent.

Returns:

true if the datas of the service must be copied before being sent

getRequestID

public long getRequestID()

Return the Service request ID if the Service maintains a request ID.

Returns:

the Service request ID if the Service maintains a request ID

detach

public boolean detach(Module module)

Detach a module from the modules providers.

Parameters:

module - the Module

Returns:

true if the Module could be detached from the providers list

attach

public boolean attach(Module module)

Attach a module to the modules providers.

Parameters:

module - the Module

Returns:

true if the Module could be attached to the providers list

error

public void error(ServiceInstance<?,?> instance,
                  char errorType)

Notify an error for the execution of the Service.

Parameters:

instance - the Service instance

errorType - the error type

send

public void send(ServiceInstance<?,?> instance,
                 char invokeType)

Send the Service datas.

Parameters:

instance - the Service instance

invokeType - the invocation type

send

public void send(ServiceInstance<?,?> instance,
                 int count,
                 char invokeType)

Send the Service datas.

Parameters:

instance - the Service instance

count - the invocation count

invokeType - the invocation type

notified

public void notified(char type,
                     int count,
                     char invokeType)

Be notified of the execution of the Service.

Parameters:

type - the notification type

count - the invocation count

invokeType - the invocation type

setUp

public void setUp()

Setup the Service.

isSetup

public boolean isSetup()

Return true if the Service is setUp.

Returns:

true if the Service is setUp