org.ow2.petals.microkernel.api.communication.topology
Interface TopologyService

All Superinterfaces:
org.ow2.petals.clientserverapi.topology.TopologyService, TopologyServiceMBean

public interface TopologyService
extends TopologyServiceMBean

Author:
Roland NAUDIN - EBM WebSourcing, Christophe Hamerling - EBM WebSourcing

Method Summary
 void addContainerConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration addedContainer)
          Add the given container to the topology
 void addSubdomainConfiguration(SubDomainConfiguration addedSubdomain)
          Add a subdomain to the local topology.
 org.ow2.petals.clientserverapi.configuration.ContainerConfiguration getContainerConfiguration(String containerName)
          Get the container configuration of the given container name.
 Set<org.ow2.petals.clientserverapi.configuration.ContainerConfiguration> getContainersConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration.ContainerState state)
          Get all the containers where the state is the same than the given one.
 Set<org.ow2.petals.clientserverapi.configuration.ContainerConfiguration> getContainersConfigurationsForLocalSubdomain()
           
 DomainConfiguration getDomainConfiguration()
          Get the domain configuration.
 Set<SubDomainConfiguration> getSubDomainsConfiguration()
          Get all the sub-domain configurations.
 boolean hasValidLocalContainerDynamicTopologyConfiguration()
           
 boolean isContainerStarted(String containerName)
          Test if the container is started.
 void registerLocalContainerOnMaster()
           
 void removeContainerConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration removedContainer)
          Remove container configuration.
 void removeSubdomainConfiguration(String removedSubdomainName)
          Remove subdomain configuration.
 void setContainerState(String containerName, org.ow2.petals.clientserverapi.configuration.ContainerConfiguration.ContainerState state)
          Set the given state to the give container.
 void validateDynamicTopology()
          Validate the dynamic topology.
 
Methods inherited from interface org.ow2.petals.clientserverapi.topology.TopologyService
addContainerConfiguration, addContainerConfiguration
 

Method Detail

hasValidLocalContainerDynamicTopologyConfiguration

boolean hasValidLocalContainerDynamicTopologyConfiguration()

addContainerConfiguration

void addContainerConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration addedContainer)
                               throws org.ow2.petals.clientserverapi.topology.exception.AddContainerException
Add the given container to the topology

Parameters:
addedContainer - the container to add to the current topology
Throws:
org.ow2.petals.clientserverapi.topology.exception.AddContainerException - Failed to add the container to the current topology

addSubdomainConfiguration

void addSubdomainConfiguration(SubDomainConfiguration addedSubdomain)
                               throws AddSubDomainException
Add a subdomain to the local topology.

Parameters:
addedSudomain -
Throws:
AddSubDomainException

getContainerConfiguration

org.ow2.petals.clientserverapi.configuration.ContainerConfiguration getContainerConfiguration(String containerName)
Get the container configuration of the given container name.

Parameters:
containerName - The name of the targeted container
Returns:
The container configuration

getContainersConfiguration

Set<org.ow2.petals.clientserverapi.configuration.ContainerConfiguration> getContainersConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration.ContainerState state)
Get all the containers where the state is the same than the given one. If the state is null, get all the containers...

Parameters:
object -
Returns:

getContainersConfigurationsForLocalSubdomain

Set<org.ow2.petals.clientserverapi.configuration.ContainerConfiguration> getContainersConfigurationsForLocalSubdomain()

getDomainConfiguration

DomainConfiguration getDomainConfiguration()
Get the domain configuration.

Returns:
the domain configuration

getSubDomainsConfiguration

Set<SubDomainConfiguration> getSubDomainsConfiguration()
Get all the sub-domain configurations.

Returns:
a set of ContainerConfiguration

isContainerStarted

boolean isContainerStarted(String containerName)
Test if the container is started.

Parameters:
containerName -
Returns:

registerLocalContainerOnMaster

void registerLocalContainerOnMaster()
                                    throws org.ow2.petals.clientserverapi.topology.exception.TopologyServiceException
Throws:
org.ow2.petals.clientserverapi.topology.exception.TopologyServiceException

removeContainerConfiguration

void removeContainerConfiguration(org.ow2.petals.clientserverapi.configuration.ContainerConfiguration removedContainer)
                                  throws RemoveContainerException
Remove container configuration.

Parameters:
removedContainer -
Throws:
RemoveContainerException

removeSubdomainConfiguration

void removeSubdomainConfiguration(String removedSubdomainName)
                                  throws RemoveSubDomainException
Remove subdomain configuration.

Parameters:
removedSubdomain -
Throws:
RemoveSubDomainException

setContainerState

void setContainerState(String containerName,
                       org.ow2.petals.clientserverapi.configuration.ContainerConfiguration.ContainerState state)
Set the given state to the give container.

Parameters:
containerName -
state - The ContainerConfiguration.ContainerState

validateDynamicTopology

void validateDynamicTopology()
                             throws org.ow2.petals.clientserverapi.topology.exception.TopologyServiceException
Validate the dynamic topology.

Throws:
org.ow2.petals.clientserverapi.topology.exception.TopologyServiceException


Copyright © 2005-2015 Linagora. All Rights Reserved.