com.metamatrix.platform.service.api
Interface ServiceInterface

All Known Subinterfaces:

AuthorizationServiceInterface, ConfigurationServiceInterface, ConnectorServiceInterface, MembershipServiceInterface, QueryServiceInterface, SessionServiceInterface

All Known Implementing Classes:

AbstractService, AuthorizationServiceImpl, ConfigurationServiceImpl, ConnectorService, MembershipServiceImpl, QueryService, SessionServiceImpl

public interface ServiceInterface

Field Summary

static int

WAIT_TO_DIE_TIME Time to wait for queues to clear before giving up (1 min)

Method Summary

void	checkState()
void	die()
void	dieNow()
java.util.Collection<ConnectionPoolStats>	getConnectionPoolStats() Returns a list of ConnectionPoolStat objects for the specific ConnectorBinding service If there are no ConnectionPoolStats, null is returned.
int	getCurrentState()
java.lang.String	getHostname() Determine which host the service instance is running on.
ServiceID	getID()
java.lang.Throwable	getInitException()
java.lang.String	getProcessName() Get process name on which this service is running on
java.util.Properties	getProperties() Retreive the properties object used to initialize the service.
java.util.Collection	getQueueStatistics() Returns a list of QueueStats objects that represent the queues in this service.
WorkerPoolStats	getQueueStatistics(java.lang.String name) Returns a QueueStats object that represent the queue in this service.
ServiceData	getServiceData()
java.lang.String	getServiceType() Get service type
java.util.Date	getStartTime() Get the time that the service was initialized.
java.util.Date	getStateChangeTime()
void	init(ServiceID id, DeployedComponentID deployedComponentID, java.util.Properties props, ClientServiceRegistry listenerRegistry, ClassLoaderManager clManager) Instruct the service to initialize and begin processing.The service must notify any lifecycle listeners of its initialization using the unique service instance name returned.
boolean	isAlive() Determine if the service is alive and well.
void	setInitException(java.lang.Throwable t) There are reflective based calls on this
void	updateState(int state) There are reflective based calls on this

Field Detail

WAIT_TO_DIE_TIME

static final int WAIT_TO_DIE_TIME

Time to wait for queues to clear before giving up (1 min)

See Also:

Constant Field Values

Method Detail

init

void init(ServiceID id,
          DeployedComponentID deployedComponentID,
          java.util.Properties props,
          ClientServiceRegistry listenerRegistry,
          ClassLoaderManager clManager)

Instruct the service to initialize and begin processing.The service must notify any lifecycle listeners of its initialization using the unique service instance name returned.

Parameters:

deployedComponentID - Unique identifier of this deployed component.

clManager -

die

void die()

dieNow

void dieNow()

checkState

void checkState()

getProperties

java.util.Properties getProperties()

Retreive the properties object used to initialize the service.

getStartTime

java.util.Date getStartTime()

Get the time that the service was initialized.

getHostname

java.lang.String getHostname()

Determine which host the service instance is running on.

Returns:

Host the service is running on

getProcessName

java.lang.String getProcessName()

Get process name on which this service is running on

Returns:

isAlive

boolean isAlive()

Determine if the service is alive and well.

getServiceType

java.lang.String getServiceType()

Get service type

getCurrentState

int getCurrentState()

getStateChangeTime

java.util.Date getStateChangeTime()

getID

ServiceID getID()

getQueueStatistics

java.util.Collection getQueueStatistics()

Returns a list of QueueStats objects that represent the queues in this service. If there are no queues, null is returned.

getQueueStatistics

WorkerPoolStats getQueueStatistics(java.lang.String name)

Returns a QueueStats object that represent the queue in this service. If there is no queue with the given name, null is returned.

getConnectionPoolStats

java.util.Collection<ConnectionPoolStats> getConnectionPoolStats()

Returns a list of ConnectionPoolStat objects for the specific ConnectorBinding service If there are no ConnectionPoolStats, null is returned.

setInitException

void setInitException(java.lang.Throwable t)

There are reflective based calls on this

getInitException

java.lang.Throwable getInitException()

updateState

void updateState(int state)

There are reflective based calls on this

getServiceData

ServiceData getServiceData()