org.ow2.jonas.management.extensions.domain.api
Interface IDomain

All Superinterfaces:

IBaseManagement

All Known Implementing Classes:

DomainManagement, ManagementEntryPoint

public interface IDomain
extends IBaseManagement

This interface provides a description of management operations provided for domain management in a master server.

Author:

Adriana Danes, Oualaa Hani

Method Summary

void	addCluster(String clusterName) Create logical cluster.
void	addServer(String serverName, String serverURL, String userName, String password, String clusterDaemon) Add server in domain.
String[]	getClusterDaemonNames()
String[]	getclusterDaemons()
String	getClusterdaemonState(String clusterDaemonName)
String[]	getClusters()
String[]	getClustersNames()
String	getClusterState(String clusterName)
String	getClusterType(String clusterName) Return the type of a cluster in the current domain.
String	getDomainName() Get the domain name.
String	getServerClusterdaemon(String serverName) Return the cluster daemon of a server in the domain.
String	getServerHost()
String	getServerName() Get the name of the server providing the ManagementEntryEndpoint.
String[]	getServerNames()
String[]	getServerNames(String clusterName)
String	getServerPort()
String[]	getServersNotInCluster(String clusterName) Get the name of the servers in the domain except the ones that are belonging to this cluster.
String	getServerState(String serverName)
boolean	isMaster() Return True if the current server is a master.
boolean	isMaster(String serverName) Return True if the managed server is master.
void	removeServers(String[] serversToRemove) Remove server from domain.
void	startServer(String serverName, boolean standby) Start server.
void	stopServer(String serverName, boolean standby) Stop server.

Methods inherited from interface org.ow2.jonas.management.extensions.base.api.IBaseManagement

getAttribute, getAttributes, getIntegerAttribute, getKeyValue, getKeyValues, getListMbean, getRealmItems, getRealmItems, getServerConnection, getServerConnection, getStringAttribute, getTomcatRealm, getTomcatRealmItems, invoke, isRegistered, setAttribute, setAttribute

Method Detail

getServerName

String getServerName()

Get the name of the server providing the ManagementEntryEndpoint.

Specified by:

getServerName in interface IBaseManagement

Returns:

the local server name.

getDomainName

String getDomainName()

Get the domain name.

Specified by:

getDomainName in interface IBaseManagement

Returns:

the domain name.

getServerHost

String getServerHost()

Returns:

the current server's host.

getServerPort

String getServerPort()

Returns:

the current server's port if the web service activated.

isMaster

boolean isMaster(String serverName)

Return True if the managed server is master.

Parameters:

serverName - managed server name

isMaster

boolean isMaster()

Return True if the current server is a master.

getClusterType

String getClusterType(String clusterName)

Return the type of a cluster in the current domain.

Parameters:

clusterName - the cluster's name

getServerNames

String[] getServerNames()

Returns:

the servers name that are belonging to the domain.

getServerNames

String[] getServerNames(String clusterName)

Parameters:

clusterName - the cluster name

Returns:

the server names that are belonging to a cluster.

getClusters

String[] getClusters()

Returns:

the clusters objectname in the domain.

getclusterDaemons

String[] getclusterDaemons()

Returns:

the clusterdaemons objectname in the domain.

getServerState

String getServerState(String serverName)

Parameters:

serverName - the server's name

Returns:

the state of a server in the domain

getServerClusterdaemon

String getServerClusterdaemon(String serverName)

Return the cluster daemon of a server in the domain.

Parameters:

serverName - the server's name

getClusterState

String getClusterState(String clusterName)

Parameters:

clusterName - the cluster's name

Returns:

the state of a cluster in the domain.

getClusterdaemonState

String getClusterdaemonState(String clusterDaemonName)

Parameters:

clusterdaemonName - the cluster daemon's name.

Returns:

the state of a cluster daemon in the domain.

getClustersNames

String[] getClustersNames()

Returns:

name of clusters in the domain.

getClusterDaemonNames

String[] getClusterDaemonNames()

Returns:

name of clustersDaemon in the domain.

addServer

void addServer(String serverName,
               String serverURL,
               String userName,
               String password,
               String clusterDaemon)

Add server in domain.

Parameters:

serverName. -

serverURL - the URL is a JMX URL.

userName - this parameter is optional.

password - this parameter is optional.

clusterDaemon - this parameter means if the server takes part of a clusterdaemon. It's optional.

removeServers

void removeServers(String[] serversToRemove)

Remove server from domain.

Parameters:

serversToRemove - List of servers to remove.

startServer

void startServer(String serverName,
                 boolean standby)

Start server.

Parameters:

serverName. -

standby - true to activate standby mode.

stopServer

void stopServer(String serverName,
                boolean standby)

Stop server.

Parameters:

serverName - server's name.

standby - true to activate standby mode.

addCluster

void addCluster(String clusterName)

Create logical cluster.

Parameters:

clusterName -

getServersNotInCluster

String[] getServersNotInCluster(String clusterName)

Get the name of the servers in the domain except the ones that are belonging to this cluster.

Parameters:

clusterName - the cluster name

Returns:

name of the servers that can be attached to the cluster