org.ow2.petals.microkernel.api.admin
Interface PetalsAdminServiceMBean

All Known Subinterfaces:
PetalsAdminInterface

public interface PetalsAdminServiceMBean

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 - EBM WebSourcing, Roland Naudin - EBM WebSourcing

Method Summary
 boolean ping()
          Ping if the server is ready to process messages in the domain
 Properties retrieveServerProperties()
           Retrieve all the properties of the server local configuration (ie. the content of 'server.properties' or equivalent, including: the configured properties and un.
 Set<Map<String,String>> retrieveTopology(String securityPassPhrase)
          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

retrieveServerProperties

Properties retrieveServerProperties()

Retrieve all the properties of the server local configuration (ie. the content of 'server.properties' or equivalent, including:


retrieveTopology

Set<Map<String,String>> retrieveTopology(String securityPassPhrase)
                                         throws org.ow2.petals.basisapi.exception.PetalsException
Retrieve the collection of containers, sub-domains and domain configurations.

Parameters:
securityPassPhrase - Passphrase needed to return sensible information. If null, empty or not matching the one of the container on which the connection is established, no sensible information will be returned.
Returns:
a Set of containers, sub-domains and domain configurations in key/value form
Throws:
org.ow2.petals.basisapi.exception.PetalsException

ping

boolean ping()
Ping if the server is ready to process messages in the domain


shutdownContainer

void shutdownContainer()
                       throws 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:
Exception

stopContainer

void stopContainer()
                   throws 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:
Exception


Copyright © 2005-2015 Linagora. All Rights Reserved.