org.jboss.system
Interface ServiceControllerMBean

All Known Implementing Classes:

ServiceController

public interface ServiceControllerMBean

ServiceController MBean interface.

See Also:

Service

Field Summary

static javax.management.ObjectName

OBJECT_NAME The default ObjectName

Method Summary

void	create(javax.management.ObjectName serviceName) Create a service
void	create(javax.management.ObjectName serviceName, Collection depends) Create a service with given dependencies
void	destroy(javax.management.ObjectName serviceName) Destroy the indicated service
ServiceContext	getServiceContext(javax.management.ObjectName serviceName) Lookup the ServiceContext for the given serviceName
List	install(Element config, javax.management.ObjectName loaderName) Deploy the beans; deploy means "instantiate and configure" so the MBean is created in the MBeanServer.
String	listConfiguration(javax.management.ObjectName[] objectNames) Gets the Configuration attribute of the ServiceController object
List	listDeployed() Lists the ServiceContexts of deployed mbeans
List	listDeployedNames() lists ObjectNames of deployed mbeans deployed through serviceController.
List	listIncompletelyDeployed() The listIncompletelyDeployed method returns the service contexts for the mbeans whose status is not CREATED, RUNNING, STOPPED or DESTROYED.
void	register(javax.management.ObjectName serviceName) Register the mbean against the microkernel with no dependencies.
void	register(javax.management.ObjectName serviceName, Collection depends) Register the mbean against the microkernel with dependencies.
void	remove(javax.management.ObjectName objectName) This MBean is going bye bye
void	restart(javax.management.ObjectName serviceName) Stops and restarts the indicated service
void	setServiceBinding(ServiceBinding serviceBinding) Plugin a ServiceBinding policy
void	shutdown() Describe shutdown method here.
void	start(javax.management.ObjectName serviceName) Starts the indicated service
void	stop(javax.management.ObjectName serviceName) Stop the indicated service
void	validateDeploymentState(DeploymentInfo di, DeploymentState state) Go through the mbeans of the DeploymentInfo and validate that they are in a state at least equal to that of the argument state

Field Detail

OBJECT_NAME

static final javax.management.ObjectName OBJECT_NAME

The default ObjectName

Method Detail

setServiceBinding

void setServiceBinding(ServiceBinding serviceBinding)

Plugin a ServiceBinding policy

Parameters:

serviceBinding - policy

listDeployed

List listDeployed()

Lists the ServiceContexts of deployed mbeans

Returns:

the list of ServiceContexts for mbeans deployed through ServiceController.

listIncompletelyDeployed

List listIncompletelyDeployed()

The listIncompletelyDeployed method returns the service contexts for the mbeans whose status is not CREATED, RUNNING, STOPPED or DESTROYED. An MBean that has reached one of the above states has its dependencies resolved.

Returns:

a List

listDeployedNames

List listDeployedNames()

lists ObjectNames of deployed mbeans deployed through serviceController.

Returns:

a list of ObjectNames of deployed mbeans.

listConfiguration

String listConfiguration(javax.management.ObjectName[] objectNames)
                         throws Exception

Gets the Configuration attribute of the ServiceController object

Parameters:

objectNames - Description of Parameter

Returns:

The Configuration value

Throws:

Exception - Description of Exception

validateDeploymentState

void validateDeploymentState(DeploymentInfo di,
                             DeploymentState state)

Go through the mbeans of the DeploymentInfo and validate that they are in a state at least equal to that of the argument state

install

List install(Element config,
             javax.management.ObjectName loaderName)
             throws DeploymentException

Deploy the beans; deploy means "instantiate and configure" so the MBean is created in the MBeanServer. You must call "create" and "start" separately on the MBean to affect the service lifecycle deploy doesn't bother with service lifecycle only MBean instanciation/registration/configuration.

Parameters:

config -

loaderName -

Returns:

Description of the Returned Value

Throws:

DeploymentException

register

void register(javax.management.ObjectName serviceName)
              throws Exception

Register the mbean against the microkernel with no dependencies.

Throws:

Exception

See Also:

register(ObjectName, java.util.Collection)

register

void register(javax.management.ObjectName serviceName,
              Collection depends)
              throws Exception

Register the mbean against the microkernel with dependencies.

Throws:

Exception

create

void create(javax.management.ObjectName serviceName)
            throws Exception

Create a service

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

create

void create(javax.management.ObjectName serviceName,
            Collection depends)
            throws Exception

Create a service with given dependencies

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

start

void start(javax.management.ObjectName serviceName)
           throws Exception

Starts the indicated service

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

restart

void restart(javax.management.ObjectName serviceName)
             throws Exception

Stops and restarts the indicated service

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

stop

void stop(javax.management.ObjectName serviceName)
          throws Exception

Stop the indicated service

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

destroy

void destroy(javax.management.ObjectName serviceName)
             throws Exception

Destroy the indicated service

Parameters:

serviceName - Description of Parameter

Throws:

Exception - Description of Exception

remove

void remove(javax.management.ObjectName objectName)
            throws Exception

This MBean is going bye bye

Parameters:

objectName - Description of Parameter

Throws:

Exception - Description of Exception

shutdown

void shutdown()

Describe shutdown method here.

getServiceContext

ServiceContext getServiceContext(javax.management.ObjectName serviceName)

Lookup the ServiceContext for the given serviceName