|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.client.jms.admin.PlatformAdmin
Constructor Summary | |
PlatformAdmin()
|
|
PlatformAdmin(java.lang.String hostName,
int port,
java.lang.String name,
java.lang.String password,
int cnxTimer)
|
|
PlatformAdmin(java.lang.String hostName,
int port,
java.lang.String name,
java.lang.String password,
int cnxTimer,
java.lang.String reliableClass)
|
|
PlatformAdmin(java.lang.String name,
java.lang.String password)
|
|
PlatformAdmin(javax.jms.TopicConnectionFactory cnxFact,
java.lang.String name,
java.lang.String password)
|
Method Summary | |
void |
addDomain(java.lang.String domainName,
int sid,
int port)
Adds a domain to the platform. |
void |
addServer(int sid,
java.lang.String hostName,
java.lang.String domainName,
int port,
java.lang.String serverName)
Adds a server to the platform. |
void |
collocatedConnect(java.lang.String name,
java.lang.String password)
Opens a connection with the collocated JORAM server. |
void |
connect(java.lang.String hostName,
int port,
java.lang.String name,
java.lang.String password,
int cnxTimer,
java.lang.String reliableClass)
Opens a TCP connection with the Joram server running on a given host and listening to a given port. |
void |
connect(java.lang.String name,
java.lang.String password,
int cnxTimer)
Opens a TCP connection with the Joram server running on the default "locahost" host and listening to the default 16010 port. |
void |
connect(javax.jms.TopicConnectionFactory cnxFact,
java.lang.String name,
java.lang.String password)
Opens a connection dedicated to administering with the Joram server which parameters are wrapped by a given TopicConnectionFactory . |
void |
disconnect()
Closes the administration connection. |
void |
exit()
Closes the administration connection and unregister the MBean. |
java.lang.String |
getConfiguration()
Returns the current servers configuration (a3servers.xml). |
int |
getDefaultThreshold()
Returns the default threshold value for the local server, -1 if not set. |
int |
getDefaultThreshold(int serverId)
Returns the default threshold value for a given server, -1 if not set. |
java.lang.String[] |
getDomainNames(int serverId)
Returns the list of the domain names that contains the specified server. |
java.lang.String |
getLocalHost()
Returns the host name of the server the module is connected to. |
int |
getLocalPort()
Returns the port number of the server the module is connected to. |
int |
getLocalServerId()
Returns the identifier of the server the module is connected to. |
java.util.List |
getServersIds()
Returns the list of the platform's servers' identifiers. |
java.util.List |
getServersIds(java.lang.String domainName)
Returns the list of the servers' identifiers that belong to the specified domain |
void |
removeDomain(java.lang.String domainName)
Removes a domain from the platform. |
void |
removeServer(int sid)
Removes a server from the platform. |
void |
setDefaultThreshold(int threshold)
Sets a given value as the default threshold for the local server (-1 for unsetting previous value). |
void |
setDefaultThreshold(int serverId,
int threshold)
Sets a given value as the default threshold for a given server (-1 for unsetting previous value). |
void |
stopServer()
Stops the platform local server. |
void |
stopServer(int serverId)
Stops a given server of the platform. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PlatformAdmin() throws java.net.ConnectException, AdminException
public PlatformAdmin(java.lang.String hostName, int port, java.lang.String name, java.lang.String password, int cnxTimer, java.lang.String reliableClass) throws java.net.UnknownHostException, java.net.ConnectException, AdminException
public PlatformAdmin(java.lang.String hostName, int port, java.lang.String name, java.lang.String password, int cnxTimer) throws java.net.UnknownHostException, java.net.ConnectException, AdminException
public PlatformAdmin(java.lang.String name, java.lang.String password) throws java.net.ConnectException, AdminException
public PlatformAdmin(javax.jms.TopicConnectionFactory cnxFact, java.lang.String name, java.lang.String password) throws java.net.ConnectException, AdminException
Method Detail |
public void connect(javax.jms.TopicConnectionFactory cnxFact, java.lang.String name, java.lang.String password) throws java.net.ConnectException, AdminException
TopicConnectionFactory
.
connect
in interface PlatformAdminMBean
cnxFact
- The TopicConnectionFactory to use for connecting.name
- Administrator's name.password
- Administrator's password.
java.net.ConnectException
- If connecting fails.
AdminException
- If the administrator identification is
incorrect.public void connect(java.lang.String hostName, int port, java.lang.String name, java.lang.String password, int cnxTimer, java.lang.String reliableClass) throws java.net.UnknownHostException, java.net.ConnectException, AdminException
connect
in interface PlatformAdminMBean
port
- The number of the port the server is listening to.name
- Administrator's name.password
- Administrator's password.cnxTimer
- Timer in seconds during which connecting to the server
is attempted.reliableClass
- Reliable class name.
java.net.UnknownHostException
- If the host is invalid.
java.net.ConnectException
- If connecting fails.
AdminException
- If the administrator identification is
incorrect.public void connect(java.lang.String name, java.lang.String password, int cnxTimer) throws java.net.ConnectException, AdminException
connect
in interface PlatformAdminMBean
name
- Administrator's name.password
- Administrator's password.cnxTimer
- Timer in seconds during which connecting to the server
is attempted.
java.net.UnknownHostException
- Never thrown.
java.net.ConnectException
- If connecting fails.
AdminException
- If the administrator identification is
incorrect.public void collocatedConnect(java.lang.String name, java.lang.String password) throws java.net.ConnectException, AdminException
collocatedConnect
in interface PlatformAdminMBean
name
- Administrator's name.password
- Administrator's password.
java.net.ConnectException
- If connecting fails.
AdminException
- If the administrator identification is
incorrect.public void disconnect()
disconnect
in interface PlatformAdminMBean
public void exit()
exit
in interface PlatformAdminMBean
public void stopServer(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
stopServer
in interface PlatformAdminMBean
serverId
- Identifier of the server to stop.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public void stopServer() throws java.net.ConnectException, AdminException
stopServer
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.public void addServer(int sid, java.lang.String hostName, java.lang.String domainName, int port, java.lang.String serverName) throws java.net.ConnectException, AdminException
addServer
in interface PlatformAdminMBean
hostName
- Address of the host where the added server is starteddomainName
- Name of the domain where the server is addedport
- Listening port of the server in the specified domainserverName
- Name of the added server
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public void removeServer(int sid) throws java.net.ConnectException, AdminException
removeServer
in interface PlatformAdminMBean
sid
- Id of the removed server
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public void addDomain(java.lang.String domainName, int sid, int port) throws java.net.ConnectException, AdminException
addDomain
in interface PlatformAdminMBean
domainName
- Name of the added domainsid
- Id of the router server that
gives access to the added domainport
- Listening port in the added domain of the
router server
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public void removeDomain(java.lang.String domainName) throws java.net.ConnectException, AdminException
removeDomain
in interface PlatformAdminMBean
domainName
- Name of the added domain
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public java.lang.String getConfiguration() throws java.net.ConnectException, AdminException
getConfiguration
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public java.util.List getServersIds()
getServersIds
in interface PlatformAdminMBean
public java.util.List getServersIds(java.lang.String domainName) throws java.net.ConnectException, AdminException
getServersIds
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.public java.lang.String[] getDomainNames(int serverId) throws java.net.ConnectException, AdminException
getDomainNames
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.public void setDefaultThreshold(int serverId, int threshold) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
setDefaultThreshold
in interface PlatformAdminMBean
serverId
- The identifier of the server.threshold
- The threshold value to be set.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public void setDefaultThreshold(int threshold) throws java.net.ConnectException, AdminException
setDefaultThreshold
in interface PlatformAdminMBean
threshold
- The threshold value to be set.
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.public int getDefaultThreshold(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
getDefaultThreshold
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.public int getDefaultThreshold() throws java.net.ConnectException, AdminException
getDefaultThreshold
in interface PlatformAdminMBean
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.public int getLocalServerId() throws java.net.ConnectException
getLocalServerId
in interface PlatformAdminMBean
java.net.ConnectException
- If the admin connection is not established.public java.lang.String getLocalHost() throws java.net.ConnectException
getLocalHost
in interface PlatformAdminMBean
java.net.ConnectException
- If the admin connection is not established.public int getLocalPort() throws java.net.ConnectException
getLocalPort
in interface PlatformAdminMBean
java.net.ConnectException
- If the admin connection is not established.
|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |