com.ibm.are.service
Interface Service

All Superinterfaces:
com.ibm.are.core.Element
All Known Subinterfaces:
AutoStartSingletonService, SingletonService
All Known Implementing Classes:
BaseService, BaseSingletonService, LoggingService

public interface Service
extends com.ibm.are.core.Element

The Service interface represents the basic operations and features that must be implemented for a class to be considered a service by the Application Runtime Expert. Any class that implements the Service interface can be automatically detected and instantiated by the Application Runtime Expert. Any service can receive input arguments via the services.xml configuration file. This support is built into the runtime and can be used without writing any additional code.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Method Summary
 void start(java.util.List startArgs)
          Starts the service.
 void stop(java.util.List stopArgs)
          Stops the service.
 
Methods inherited from interface com.ibm.are.core.Element
getCommonName, getDescription, getElementData, getVersion, setElementData
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values
Method Detail

start

void start(java.util.List startArgs)
Starts the service. The runtime will only invoke this method once per instance of a service, but there is nothing in the runtime that would prevent others from invoking a service's start() method multiple times. If a service cannot support multiple invocations of start(), then the service must put code in place to prevent this from occurring or to detect the condition and take the appropriate action.

Parameters:
startArgs - Start arguments. Currently the runtime does not pass any arguments upon starting a service, so this list will always be empty.

stop

void stop(java.util.List stopArgs)
Stops the service. The runtime will only invoke this method once per instance of a service, but there is nothing in the runtime that would prevent others from invoking a service's stop() method multiple times. If a service cannot support multiple invocations of stop(), then the service must put code in place to prevent this from occurring or to detect the condition and take the appropriate action.

Parameters:
stopArgs - Stop arguments. Currently the runtime does not pass any arguments upon stopping a service, so this list will always be empty.