org.diirt.service

Class ServiceDescription

java.lang.Object

org.diirt.service.ServiceDescription

Direct Known Subclasses:

ExecServiceDescription, JDBCServiceDescription, RPCServiceDescription

public class ServiceDescription
extends Object

A utility class to gather all the elements that define the service.

This class is not thread-safe and is meant to be used right before the creation of Service objects.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ServiceDescription(String name, String description) Creates a new service description with the given name and description, both of which are mandatory attributes of the service.

Method Summary

Modifier and Type	Method and Description
ServiceDescription	addServiceMethod(ServiceMethodDescription serviceMethodDescription) Adds the given method to this service description.
Service	createService() Creates a service with the given description.
Map<String,ServiceMethod>	createServiceMethods() Creates the service method instances that belongs to this service.
ServiceDescription	executorService(ExecutorService executor) Determines the executor to be used by the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDescription

public ServiceDescription(String name,
                          String description)

Creates a new service description with the given name and description, both of which are mandatory attributes of the service.

Parameters:

name - the service name, can't be null

description - the service description; can't be null

Method Detail

addServiceMethod

public ServiceDescription addServiceMethod(ServiceMethodDescription serviceMethodDescription)

Adds the given method to this service description. The name of the given service method must be unique to the service (i.e. can't match the name of an already added service method).

Parameters:

serviceMethodDescription - a service method description, can't be null

Returns:

this description

executorService

public ServiceDescription executorService(ExecutorService executor)

Determines the executor to be used by the service. The executor can't be changed once set.

The executor is used for wrapping synchronous calls into asynchronous calls.

Parameters:

executor - an executor service, can't be null

Returns:

this description

createServiceMethods

public final Map<String,ServiceMethod> createServiceMethods()

Creates the service method instances that belongs to this service.

Returns:

the new service methods indexed by method name

createService

public Service createService()

Creates a service with the given description.

A client may override this to return their service implementation.

Returns:

a service based off of this description state