Joram 5.2.4

org.objectweb.joram.client.jms.admin
Interface JoramAdminMBean

All Known Implementing Classes:
JoramAdmin

public interface JoramAdminMBean


Method Summary
 void addDomain(java.lang.String domain, int sid, int port)
          Adds a domain to the platform.
 void addDomain(java.lang.String domain, java.lang.String network, int sid, int port)
          Adds a domain to the platform using a specific network component.
 void addServer(int sid, java.lang.String host, java.lang.String domain, int port, java.lang.String server)
          Adds a server to the platform.
 void addServer(int sid, java.lang.String host, java.lang.String domain, int port, java.lang.String server, java.lang.String[] services, java.lang.String[] args)
          Adds a server to the platform.
 Destination createQueue(int serverId, java.lang.String name)
           
 Destination createQueue(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop)
           
 Destination createQueue(java.lang.String name)
           
 Destination createTopic(int serverId, java.lang.String name)
           
 Destination createTopic(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop)
           
 Destination createTopic(java.lang.String name)
           
 User createUser(java.lang.String name, java.lang.String password)
           
 User createUser(java.lang.String name, java.lang.String password, int serverId)
           
 User createUser(java.lang.String name, java.lang.String password, int serverId, java.lang.String identityClass)
           
 User createUser(java.lang.String name, java.lang.String password, java.lang.String identityClass)
           
 boolean executeXMLAdmin(java.lang.String path)
          This method execute the XML script file that the pathname is given in parameter.
 boolean executeXMLAdmin(java.lang.String cfgDir, java.lang.String cfgFileName)
          This method execute the XML script file that the location is given in parameter.
 void exportRepositoryToFile(java.lang.String exportDir, java.lang.String exportFilename)
          Export the repository content to an XML file - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)
 java.lang.String getConfiguration()
          Returns the current servers configuration (equivalent to the a3servers.xml file).
 java.lang.String getDefaultDMQId()
          Returns the unique identifier of the default dead message queue for the local server, null if not set.
 java.lang.String getDefaultDMQId(int serverId)
          Returns the unique identifier of the default dead message queue for the local server, null if not set.
 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.
 Destination[] getDestinations()
           
 Destination[] getDestinations(int serverId)
           
 java.lang.String[] getDomainNames(int serverId)
          Returns the list of the domain names that contains the specified server.
 int[] getServersIds()
          Returns the list of the platform's servers' identifiers.
 int[] getServersIds(java.lang.String domain)
          Returns the list of the servers' identifiers that belong to the specified domain
 long getTimeOutToAbortRequest()
           
 User[] getUsers()
           
 User[] getUsers(int serverId)
           
 void removeDomain(java.lang.String domain)
          Removes a domain from the platform.
 void removeServer(int sid)
          Removes a server from the platform.
 void setDefaultDMQId(int serverId, java.lang.String dmqId)
          Sets a given dead message queue as the default DMQ for a given server (null for unsetting previous DMQ).
 void setDefaultDMQId(java.lang.String dmqId)
          Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
 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 setTimeOutToAbortRequest(long timeOut)
           
 void stopServer()
          Stops the platform local server.
 void stopServer(int serverId)
          Stops a given server of the platform.
 

Method Detail

setTimeOutToAbortRequest

void setTimeOutToAbortRequest(long timeOut)
                              throws java.net.ConnectException
Throws:
java.net.ConnectException

getTimeOutToAbortRequest

long getTimeOutToAbortRequest()
                              throws java.net.ConnectException
Throws:
java.net.ConnectException

stopServer

void stopServer()
                throws java.net.ConnectException,
                       AdminException
Stops the platform local server.

Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.
See Also:
stopServer(int)

stopServer

void stopServer(int serverId)
                throws java.net.ConnectException,
                       AdminException
Stops a given server of the platform.

The request fails if the target server does not belong to the platform.

Parameters:
serverId - Identifier of the server to stop.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

addServer

void addServer(int sid,
               java.lang.String host,
               java.lang.String domain,
               int port,
               java.lang.String server)
               throws java.net.ConnectException,
                      AdminException
Adds a server to the platform.

The server is configured without any service.

Parameters:
serverId - Id of the added server
host - Address of the host where the added server is started
domain - Name of the domain where the server is added
port - Listening port of the server in the specified domain
server - Name of the added server
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.
See Also:
addServer(int, String, String, int, String, String[], String[])

addServer

void addServer(int sid,
               java.lang.String host,
               java.lang.String domain,
               int port,
               java.lang.String server,
               java.lang.String[] services,
               java.lang.String[] args)
               throws java.net.ConnectException,
                      AdminException
Adds a server to the platform.

Parameters:
serverId - Id of the added server
host - Address of the host where the added server is started
domain - Name of the domain where the server is added
port - Listening port of the server in the specified domain
server - Name of the added server
services - Names of the service to start within the server
args - Services' arguments
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

removeServer

void removeServer(int sid)
                  throws java.net.ConnectException,
                         AdminException
Removes a server from the platform.

Parameters:
sid - Id of the removed server
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

addDomain

void addDomain(java.lang.String domain,
               int sid,
               int port)
               throws java.net.ConnectException,
                      AdminException
Adds a domain to the platform.

The domain will use the default network component "Simplenetwork".

Parameters:
domain - Name of the added domain.
sid - Id of the router server that gives access to the added domain.
port - Listening port in the added domain of the router server.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

addDomain

void addDomain(java.lang.String domain,
               java.lang.String network,
               int sid,
               int port)
               throws java.net.ConnectException,
                      AdminException
Adds a domain to the platform using a specific network component.

Parameters:
domain - Name of the added domain.
network - Classname of the network component to use.
sid - Id of the router server that gives access to the added domain.
port - Listening port in the added domain of the router server.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

removeDomain

void removeDomain(java.lang.String domain)
                  throws java.net.ConnectException,
                         AdminException
Removes a domain from the platform.

Parameters:
domain - Name of the domain to remove
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

getConfiguration

java.lang.String getConfiguration()
                                  throws java.net.ConnectException,
                                         AdminException
Returns the current servers configuration (equivalent to the a3servers.xml file).

Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

getServersIds

int[] getServersIds()
                    throws java.net.ConnectException,
                           AdminException
Returns the list of the platform's servers' identifiers.

Returns:
An array containing the list of server's identifiers.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
#getServers(String)

getServersIds

int[] getServersIds(java.lang.String domain)
                    throws java.net.ConnectException,
                           AdminException
Returns the list of the servers' identifiers that belong to the specified domain

Parameters:
domain - Name of the domain.
Returns:
An array containing the list of server's identifiers of the specified domain.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.

getDomainNames

java.lang.String[] getDomainNames(int serverId)
                                  throws java.net.ConnectException,
                                         AdminException
Returns the list of the domain names that contains the specified server.

Parameters:
serverId - Unique identifier of the server.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.

getDefaultDMQId

java.lang.String getDefaultDMQId(int serverId)
                                 throws java.net.ConnectException,
                                        AdminException
Returns the unique identifier of the default dead message queue for the local server, null if not set.

The request fails if the target server does not belong to the platform.

Parameters:
serverId - Unique identifier of the server.
Returns:
The unique identifier of the default dead message queue for the local server, null if not set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

setDefaultDMQId

void setDefaultDMQId(int serverId,
                     java.lang.String dmqId)
                     throws java.net.ConnectException,
                            AdminException
Sets a given dead message queue as the default DMQ for a given server (null for unsetting previous DMQ).

The request fails if the target server does not belong to the platform.

Parameters:
serverId - The identifier of the server.
dmqId - The dmqId (AgentId) to be set as the default one.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

setDefaultDMQId

void setDefaultDMQId(java.lang.String dmqId)
                     throws java.net.ConnectException,
                            AdminException
Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).

Parameters:
dmqId - The dmqId (AgentId) to be set as the default one.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
setDefaultDMQId(int, String)

getDefaultDMQId

java.lang.String getDefaultDMQId()
                                 throws java.net.ConnectException,
                                        AdminException
Returns the unique identifier of the default dead message queue for the local server, null if not set.

Returns:
The unique identifier of the default dead message queue for the local server, null if not set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
getDefaultDMQId(int)

setDefaultThreshold

void setDefaultThreshold(int serverId,
                         int threshold)
                         throws java.net.ConnectException,
                                AdminException
Sets a given value as the default threshold for a given server (-1 for unsetting previous value).

The request fails if the target server does not belong to the platform.

Parameters:
serverId - The identifier of the server.
threshold - The threshold value to be set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

setDefaultThreshold

void setDefaultThreshold(int threshold)
                         throws java.net.ConnectException,
                                AdminException
Sets a given value as the default threshold for the local server (-1 for unsetting previous value).

Parameters:
threshold - The threshold value to be set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
setDefaultThreshold(int, int)

getDefaultThreshold

int getDefaultThreshold(int serverId)
                        throws java.net.ConnectException,
                               AdminException
Returns the default threshold value for a given server, -1 if not set.

The request fails if the target server does not belong to the platform.

Returns:
The default threshold value for the local server, -1 if not set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

getDefaultThreshold

int getDefaultThreshold()
                        throws java.net.ConnectException,
                               AdminException
Returns the default threshold value for the local server, -1 if not set.

Returns:
The default threshold value for the local server, -1 if not set.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
getDefaultThreshold(int)

getDestinations

Destination[] getDestinations(int serverId)
                              throws java.net.ConnectException,
                                     AdminException
Throws:
java.net.ConnectException
AdminException

getDestinations

Destination[] getDestinations()
                              throws java.net.ConnectException,
                                     AdminException
Throws:
java.net.ConnectException
AdminException

createQueue

Destination createQueue(java.lang.String name)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

createQueue

Destination createQueue(int serverId,
                        java.lang.String name)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

createQueue

Destination createQueue(int serverId,
                        java.lang.String name,
                        java.lang.String className,
                        java.util.Properties prop)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

createTopic

Destination createTopic(java.lang.String name)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

createTopic

Destination createTopic(int serverId,
                        java.lang.String name)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

createTopic

Destination createTopic(int serverId,
                        java.lang.String name,
                        java.lang.String className,
                        java.util.Properties prop)
                        throws java.net.ConnectException,
                               AdminException
Throws:
java.net.ConnectException
AdminException

getUsers

User[] getUsers(int serverId)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

getUsers

User[] getUsers()
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

createUser

User createUser(java.lang.String name,
                java.lang.String password)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

createUser

User createUser(java.lang.String name,
                java.lang.String password,
                int serverId)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

createUser

User createUser(java.lang.String name,
                java.lang.String password,
                int serverId,
                java.lang.String identityClass)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

createUser

User createUser(java.lang.String name,
                java.lang.String password,
                java.lang.String identityClass)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

exportRepositoryToFile

void exportRepositoryToFile(java.lang.String exportDir,
                            java.lang.String exportFilename)
                            throws AdminException
Export the repository content to an XML file - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)

Parameters:
exportDir - target directory where the export file will be put
exportFilename - filename of the export file
Throws:
AdminException - if an error occurs

executeXMLAdmin

boolean executeXMLAdmin(java.lang.String cfgDir,
                        java.lang.String cfgFileName)
                        throws java.lang.Exception
This method execute the XML script file that the location is given in parameter.

Be careful, currently this method use the static administration connection through the AdminModule Class.

Parameters:
cfgDir - The directory containing the file.
cfgFileName - The script filename.
Returns:
Throws:
java.lang.Exception

executeXMLAdmin

boolean executeXMLAdmin(java.lang.String path)
                        throws java.lang.Exception
This method execute the XML script file that the pathname is given in parameter.

Be careful, currently this method use the static administration connection through the AdminModule Class.

Parameters:
path - The script pathname.
Throws:
java.lang.Exception

Joram 5.2.4

Copyright © 2000 - 2009 Scalagent D.T. - All rights reserved