org.ow2.petals.kernel.admin
Interface PetalsAdminServiceMBean

All Superinterfaces:

org.ow2.petals.jmx.api.IPetalsAdminService

All Known Subinterfaces:

PetalsAdminInterface

All Known Implementing Classes:

PetalsAdminServiceImpl

public interface PetalsAdminServiceMBean
extends org.ow2.petals.jmx.api.IPetalsAdminService

This class is a manager of JMX server. It is used to get a connection to a JMX Server on a distant container.

Author:

ddesjardins, rnaudin - eBMWebsourcing

Nested Class Summary

Nested classes/interfaces inherited from interface org.ow2.petals.jmx.api.IPetalsAdminService

org.ow2.petals.jmx.api.IPetalsAdminService.Container, org.ow2.petals.jmx.api.IPetalsAdminService.ContainerStates, org.ow2.petals.jmx.api.IPetalsAdminService.Domain, org.ow2.petals.jmx.api.IPetalsAdminService.EntityStates, org.ow2.petals.jmx.api.IPetalsAdminService.SubDomain, org.ow2.petals.jmx.api.IPetalsAdminService.Topology

Method Summary

boolean	ping() Ping if the server is ready to process messages in the domain
java.util.Set<java.util.Map<java.lang.String,java.lang.String>>	retrieveTopology() Retrieve the collection of containers, sub-domains and domain configurations.
void	shutdownContainer() Unload the container from the Petals global environment.
void	stopContainer() Stop the container.

Method Detail

retrieveTopology

java.util.Set<java.util.Map<java.lang.String,java.lang.String>> retrieveTopology()
                                                                                 throws org.ow2.petals.kernel.api.server.PetalsException

Retrieve the collection of containers, sub-domains and domain configurations.

Returns:

a Set of containers, sub-domains and domain configurations in key/value form

Throws:

org.ow2.petals.kernel.api.server.PetalsException

ping

boolean ping()

Ping if the server is ready to process messages in the domain

shutdownContainer

void shutdownContainer()
                       throws java.lang.Exception

Unload the container from the Petals global environment. All ServiceAssemblies, Components and Share Libraries are stopped, shutdown, and uninstalled. All registered Endpoints are deactivated. Then the container is removed from the domain.

Throws:

java.lang.Exception

stopContainer

void stopContainer()
                   throws java.lang.Exception

Stop the container. The container is still visible in the Petals global environment, but marked as 'stopped'. The registered Endpoints are still visible,too.

Throws:

java.lang.Exception