org.ow2.petals.kernel.ws.api
Interface TopologyService

public interface TopologyService

Get information from topology

Author:

chamerling - eBM WebSourcing, Charles Casadei - eBM WebSourcing

Method Summary

void	addContainerInformation(ContainerInformation addedContainer, java.lang.String subdomainName) Add a new container onto the list of registered containers.
void	addSubdomain(java.lang.String name, java.lang.String description, SubdomainInformation.SubdomainMode subdomainMode, boolean networkTimeSynchronized) Add a subdomain to the topology, without adding any containers.
void	addSubdomainWithContainers(SubdomainInformation subdomain) Add a subdomain to the topology with a potentially a whole set of containers.
java.util.List<ContainerInformation>	getAllContainerInformation() Get the information for all the known containers
java.util.List<ContainerInformation>	getAllPeerContainerInformationForLocalSubdomain() Returns a list with the configurations of all the known containers of the local subdomain, if it uses a flooding policy.
java.util.List<ContainerInformation>	getAllSlaveContainerInformationForLocalSubdomain() Returns a list with the configurations of all the known slaves in the local subdomain.
ContainerInformation	getContainerInformation(java.lang.String containerName) Get the container information for a given container
DomainInformation	getDomainInformation() Retrieve all the domain-related informations
JndiInformation	getJndiInformation() Get the information on the global JNDI.
java.util.List<ContainerInformation>	getMasterContainerInformation() Returns a list with the master container configuration for the local subdomain.
SubdomainInformation	getSubdomainByName(java.lang.String subdomainName) Get the subdomain with the given name
void	removeContainerInformation(java.lang.String containerName)
void	removeSubdomain(java.lang.String subdomainName)

Method Detail

getJndiInformation

JndiInformation getJndiInformation()
                                   throws PEtALSWebServiceException

Get the information on the global JNDI.

Returns:

Throws:

PEtALSWebServiceException

getDomainInformation

DomainInformation getDomainInformation()
                                       throws PEtALSWebServiceException

Retrieve all the domain-related informations

Returns:

Throws:

PEtALSWebServiceException

addSubdomain

void addSubdomain(java.lang.String name,
                  java.lang.String description,
                  SubdomainInformation.SubdomainMode subdomainMode,
                  boolean networkTimeSynchronized)
                  throws PEtALSWebServiceException

Add a subdomain to the topology, without adding any containers.

Parameters:

name -

description -

subdomainMode -

networkTimeSynchronized -

Throws:

PEtALSWebServiceException

addSubdomainWithContainers

void addSubdomainWithContainers(SubdomainInformation subdomain)
                                throws PEtALSWebServiceException

Add a subdomain to the topology with a potentially a whole set of containers.

Parameters:

subdomain -

Throws:

PEtALSWebServiceException

getSubdomainByName

SubdomainInformation getSubdomainByName(java.lang.String subdomainName)
                                        throws PEtALSWebServiceException

Get the subdomain with the given name

Parameters:

subdomainName -

Returns:

Throws:

PEtALSWebServiceException

removeSubdomain

void removeSubdomain(java.lang.String subdomainName)
                     throws PEtALSWebServiceException

Throws:

PEtALSWebServiceException

addContainerInformation

void addContainerInformation(ContainerInformation addedContainer,
                             java.lang.String subdomainName)
                             throws PEtALSWebServiceException

Add a new container onto the list of registered containers.

Parameters:

newContainer -

Throws:

PEtALSWebServiceException

getAllContainerInformation

java.util.List<ContainerInformation> getAllContainerInformation()
                                                                throws PEtALSWebServiceException

Get the information for all the known containers

Returns:

Throws:

PEtALSWebServiceException

getMasterContainerInformation

java.util.List<ContainerInformation> getMasterContainerInformation()
                                                                   throws PEtALSWebServiceException

Returns a list with the master container configuration for the local subdomain. An empty list is returned if the local subdomain uses anything but a master-slave policy.

Returns:

Throws:

PEtALSWebServiceException

getAllSlaveContainerInformationForLocalSubdomain

java.util.List<ContainerInformation> getAllSlaveContainerInformationForLocalSubdomain()
                                                                                      throws PEtALSWebServiceException

Returns a list with the configurations of all the known slaves in the local subdomain. An empty list is returned if the local subdomain uses anything but a master-slave policy.

Returns:

Throws:

PEtALSWebServiceException

getAllPeerContainerInformationForLocalSubdomain

java.util.List<ContainerInformation> getAllPeerContainerInformationForLocalSubdomain()
                                                                                     throws PEtALSWebServiceException

Returns a list with the configurations of all the known containers of the local subdomain, if it uses a flooding policy. An empty list is returned if the localsubdomain uses anything but a flooding policy

Returns:

Throws:

PEtALSWebServiceException

getContainerInformation

ContainerInformation getContainerInformation(java.lang.String containerName)
                                             throws PEtALSWebServiceException

Get the container information for a given container

Parameters:

containerId -

Returns:

Throws:

PEtALSWebServiceException - if the containerId is not know in the petals topology

removeContainerInformation

void removeContainerInformation(java.lang.String containerName)
                                throws PEtALSWebServiceException

Throws:

PEtALSWebServiceException