org.jboss.msc.service.management

Interface ServiceContainerMXBean

public interface ServiceContainerMXBean

The service container management bean interface.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
String	dumpServiceDetails(String serviceName) Dump all details of a service.
void	dumpServices() Dump the container state to the console.
void	dumpServicesByStatus(String status) Dump the services, whose status matches the passed status to the console
String	dumpServicesToGraphDescription() Dump the container state to a string suitable for rendering in GraphViz or compatible tools.
String	dumpServicesToString() Dump the container state to a big string.
String	dumpServicesToStringByStatus(String status) Dump the services, whose status matches the passed status, state to a big string.
ServiceStatus	getServiceStatus(String name) Get the status of one service.
List<String>	queryServiceNames() Get a list of service names in this container.
List<ServiceStatus>	queryServiceStatuses() Get a list of service statuses in this container.
void	setServiceMode(String name, String mode) Change the mode of a service.

Method Detail

getServiceStatus

ServiceStatus getServiceStatus(String name)

Get the status of one service.

Parameters:

name - the service name

Returns:

the status

queryServiceNames

List<String> queryServiceNames()

Get a list of service names in this container.

Returns:

the list of names

queryServiceStatuses

List<ServiceStatus> queryServiceStatuses()

Get a list of service statuses in this container.

Returns:

the list of statuses

setServiceMode

void setServiceMode(String name,
                    String mode)

Change the mode of a service.

Parameters:

name - the service name

mode - the new mode

dumpServices

void dumpServices()

Dump the container state to the console.

dumpServicesToString

String dumpServicesToString()

Dump the container state to a big string. The string has no particular standard format and may change over time; this method is simply a convenience.

Returns:

the container state, as a string

dumpServicesToGraphDescription

String dumpServicesToGraphDescription()

Dump the container state to a string suitable for rendering in GraphViz or compatible tools.

Returns:

the container state graph

dumpServiceDetails

String dumpServiceDetails(String serviceName)

Dump all details of a service.

Parameters:

serviceName - the name of the service to examine

Returns:

the details, as a string

dumpServicesByStatus

void dumpServicesByStatus(String status)

Dump the services, whose status matches the passed status to the console

Parameters:

status - The status of the services that we are interested in

dumpServicesToStringByStatus

String dumpServicesToStringByStatus(String status)

Dump the services, whose status matches the passed status, state to a big string. The string has no particular standard format and may change over time; this method is simply a convenience.

Parameters:

status - The status of the services that we are interested in

Returns:

Returns the string representation of the services whose status matches the passed status