Static Public Member Functions | |
| static void | main (String[] args) |
| static void | connect (javax.jms.TopicConnectionFactory cnxFact, String name, String password) throws ConnectException, AdminException |
| static void | connect (String hostName, int port, String name, String password, int cnxTimer) throws UnknownHostException, ConnectException, AdminException |
| static void | connect (String hostName, int port, String name, String password, int cnxTimer, String reliableClass) throws UnknownHostException, ConnectException, AdminException |
| static void | connect (String name, String password, int cnxTimer) throws UnknownHostException, ConnectException, AdminException |
| static void | connect (String name, String password, int cnxTimer, String reliableClass) throws UnknownHostException, ConnectException, AdminException |
| static void | collocatedConnect (String name, String password) throws ConnectException, AdminException |
| static void | disconnect () |
| static void | stopServer (int serverId) throws ConnectException, AdminException |
| static void | stopServer () throws ConnectException, AdminException |
| static void | addServer (int sid, String hostName, String domainName, int port, String serverName) throws ConnectException, AdminException |
| static void | addServer (int sid, String hostName, String domainName, int port, String serverName, String[] serviceNames, String[] serviceArgs) throws ConnectException, AdminException |
| static void | removeServer (int sid) throws ConnectException, AdminException |
| static void | addDomain (String domainName, int sid, int port) throws ConnectException, AdminException |
| static void | addDomain (String domainName, String network, int sid, int port) throws ConnectException, AdminException |
| static void | removeDomain (String domainName) throws ConnectException, AdminException |
| static String | getConfiguration () throws ConnectException, AdminException |
| static void | setDefaultDMQ (int serverId, DeadMQueue dmq) throws ConnectException, AdminException |
| static void | setDefaultDMQId (int serverId, String dmqId) throws ConnectException, AdminException |
| static void | setDefaultDMQ (DeadMQueue dmq) throws ConnectException, AdminException |
| static void | setDefaultDMQId (String dmqId) throws ConnectException, AdminException |
| static void | setDefaultThreshold (int serverId, int threshold) throws ConnectException, AdminException |
| static void | setDefaultThreshold (int threshold) throws ConnectException, AdminException |
| static List | getServersIds () throws ConnectException, AdminException |
| static List | getServersIds (String domainName) throws ConnectException, AdminException |
| static Server[] | getServers () throws ConnectException, AdminException |
| static Server[] | getServers (String domainName) throws ConnectException, AdminException |
| static Server | getLocalServer () throws ConnectException, AdminException |
| static String[] | getDomainNames (int serverId) throws ConnectException, AdminException |
| static DeadMQueue | getDefaultDMQ (int serverId) throws ConnectException, AdminException |
| static DeadMQueue | getDefaultDMQ () throws ConnectException, AdminException |
| static String | getDefaultDMQId () throws ConnectException, AdminException |
| static String | getDefaultDMQId (int serverId) throws ConnectException, AdminException |
| static int | getDefaultThreshold (int serverId) throws ConnectException, AdminException |
| static int | getDefaultThreshold () throws ConnectException, AdminException |
| static List | getDestinations (int serverId) throws ConnectException, AdminException |
| static List | getDestinations () throws ConnectException, AdminException |
| static List | getDestinations (int serverId, long delay) throws ConnectException, AdminException |
| static List | getUsers (int serverId) throws ConnectException, AdminException |
| static List | getUsers (int serverId, long delay) throws ConnectException, AdminException |
| static List | getUsers () throws ConnectException, AdminException |
| static int | getLocalServerId () throws ConnectException |
| static String | getLocalHost () throws ConnectException |
| static int | getLocalPort () throws ConnectException |
| static AdminReply | doRequest (AdminRequest request) throws AdminException, ConnectException |
| static AdminReply | doRequest (AdminRequest request, long timeout) throws AdminException, ConnectException |
| static void | abortRequest () throws JMSException |
| static boolean | executeXMLAdmin (String cfgDir, String cfgFileName) throws Exception |
| static boolean | executeXMLAdmin (String path) throws Exception |
| static boolean | executeAdmin (Reader reader) throws Exception |
| static void | setHa (boolean isHa) |
Static Public Attributes | |
| static final String | ADM_NAME_PROPERTY = "JoramAdminXML" |
| static final String | DEFAULT_ADM_NAME = "default" |
| static final String | REQUEST_TIMEOUT_PROP |
| static final long | DEFAULT_REQUEST_TIMEOUT = 120000 |
Static Protected Attributes | |
| static String | localHost |
| static int | localPort |
| static AdminReply | reply |
AdminModule class allows to set an administrator connection to a given JORAM server, and provides administration and monitoring methods at a server/platform level.
Definition at line 84 of file AdminModule.java.
| static void org.objectweb.joram.client.jms.admin.AdminModule.main | ( | String[] | args | ) | [static] |
This method execute the XML script file that the path is given in parameter.
Definition at line 127 of file AdminModule.java.
| static void org.objectweb.joram.client.jms.admin.AdminModule.connect | ( | javax.jms.TopicConnectionFactory | cnxFact, | |
| String | name, | |||
| String | password | |||
| ) | throws ConnectException, AdminException [static] |
Opens a connection dedicated to administering with the Joram server which parameters are wrapped by a given TopicConnectionFactory.
| cnxFact | The TopicConnectionFactory to use for connecting. | |
| name | Administrator's name. | |
| password | Administrator's password. |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 148 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.localHost, and org.objectweb.joram.client.jms.admin.AdminModule.localPort.
Referenced by org.objectweb.joram.client.jms.admin.AdminModule.collocatedConnect(), and org.objectweb.joram.client.jms.admin.AdminModule.connect().
| static void org.objectweb.joram.client.jms.admin.AdminModule.connect | ( | String | hostName, | |
| int | port, | |||
| String | name, | |||
| String | password, | |||
| int | cnxTimer | |||
| ) | throws UnknownHostException, ConnectException, AdminException [static] |
Opens a TCP connection with the Joram server running on a given host and listening to a given port.
| host | The name or IP address of the host the server is running on. | |
| 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. |
| UnknownHostException | If the host is invalid. | |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 204 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.connect().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.connect | ( | String | hostName, | |
| int | port, | |||
| String | name, | |||
| String | password, | |||
| int | cnxTimer, | |||
| String | reliableClass | |||
| ) | throws UnknownHostException, ConnectException, AdminException [static] |
Opens a TCP connection with the Joram server running on a given host and listening to a given port.
| host | The name or IP address of the host the server is running on. | |
| 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. |
| UnknownHostException | If the host is invalid. | |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 231 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.connect().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.connect | ( | String | name, | |
| String | password, | |||
| int | cnxTimer | |||
| ) | throws UnknownHostException, ConnectException, AdminException [static] |
Opens a TCP connection with the Joram server running on the default "locahost" host and listening to the default 16010 port.
| name | Administrator's name. | |
| password | Administrator's password. | |
| cnxTimer | Timer in seconds during which connecting to the server is attempted. |
| UnknownHostException | Never thrown. | |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 268 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.connect().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.connect | ( | String | name, | |
| String | password, | |||
| int | cnxTimer, | |||
| String | reliableClass | |||
| ) | throws UnknownHostException, ConnectException, AdminException [static] |
Opens a TCP connection with the Joram server running on the default "locahost" host and listening to the default 16010 port.
| name | Administrator's name. | |
| password | Administrator's password. | |
| cnxTimer | Timer in seconds during which connecting to the server is attempted. | |
| reliableClass | Reliable class name. |
| UnknownHostException | Never thrown. | |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 288 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.connect().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.collocatedConnect | ( | String | name, | |
| String | password | |||
| ) | throws ConnectException, AdminException [static] |
Opens a connection with the collocated JORAM server.
| name | Administrator's name. | |
| password | Administrator's password. |
| ConnectException | If connecting fails. | |
| AdminException | If the administrator identification is incorrect. |
Definition at line 306 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.connect().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.disconnect | ( | ) | [static] |
Closes the administration connection.
Definition at line 317 of file AdminModule.java.
| static void org.objectweb.joram.client.jms.admin.AdminModule.stopServer | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Stops a given server of the platform.
The request fails if the target server does not belong to the platform.
| serverId | Identifier of the server to stop. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 337 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.stopServer | ( | ) | throws ConnectException, AdminException [static] |
Stops the platform local server.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 358 of file AdminModule.java.
| static void org.objectweb.joram.client.jms.admin.AdminModule.addServer | ( | int | sid, | |
| String | hostName, | |||
| String | domainName, | |||
| int | port, | |||
| String | serverName | |||
| ) | throws ConnectException, AdminException [static] |
Adds a server to the platform.
| serverId | Id of the added server | |
| hostName | Address of the host where the added server is started | |
| domainName | Name of the domain where the server is added | |
| port | Listening port of the server in the specified domain | |
| serverName | Name of the added server |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 374 of file AdminModule.java.
| static void org.objectweb.joram.client.jms.admin.AdminModule.addServer | ( | int | sid, | |
| String | hostName, | |||
| String | domainName, | |||
| int | port, | |||
| String | serverName, | |||
| String[] | serviceNames, | |||
| String[] | serviceArgs | |||
| ) | throws ConnectException, AdminException [static] |
Adds a server to the platform.
| serverId | Id of the added server | |
| hostName | Address of the host where the added server is started | |
| domainName | Name of the domain where the server is added | |
| port | Listening port of the server in the specified domain | |
| serverName | Name of the added server | |
| serviceNames | Names of the service to start within the server | |
| args | Services' arguments |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 399 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.removeServer | ( | int | sid | ) | throws ConnectException, AdminException [static] |
Removes a server from the platform.
| sid | Id of the removed server |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 436 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.addDomain | ( | String | domainName, | |
| int | sid, | |||
| int | port | |||
| ) | throws ConnectException, AdminException [static] |
Adds a domain to the platform.
| domainName | 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. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 451 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.addDomain | ( | String | domainName, | |
| String | network, | |||
| int | sid, | |||
| int | port | |||
| ) | throws ConnectException, AdminException [static] |
Adds a domain to the platform using a specific network component.
| domainName | 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. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 472 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.removeDomain | ( | String | domainName | ) | throws ConnectException, AdminException [static] |
Removes a domain from the platform.
| domainName | Name of the added domain |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 492 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Here is the call graph for this function:
| static String org.objectweb.joram.client.jms.admin.AdminModule.getConfiguration | ( | ) | throws ConnectException, AdminException [static] |
Returns the current servers configuration (a3servers.xml).
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 504 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.shared.admin.AdminReply.getInfo().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQ | ( | int | serverId, | |
| DeadMQueue | dmq | |||
| ) | throws ConnectException, AdminException [static] |
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.
| serverId | The identifier of the server. | |
| dmq | The dmq to be set as the default one. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 521 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Referenced by org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQ().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQId | ( | int | serverId, | |
| String | dmqId | |||
| ) | throws ConnectException, AdminException [static] |
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.
| serverId | The identifier of the server. | |
| dmqId | The dmqId (AgentId) to be set as the default one. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 540 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Referenced by org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQId().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQ | ( | DeadMQueue | dmq | ) | throws ConnectException, AdminException [static] |
Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
| dmq | The dmq to be set as the default one. |
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 554 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQ().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQId | ( | String | dmqId | ) | throws ConnectException, AdminException [static] |
Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
| dmqId | The dmqId (AgentId) to be set as the default one. |
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 568 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.setDefaultDMQId().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultThreshold | ( | int | serverId, | |
| int | threshold | |||
| ) | throws ConnectException, AdminException [static] |
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.
| serverId | The identifier of the server. | |
| threshold | The threshold value to be set. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 585 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest().
Referenced by org.objectweb.joram.client.jms.admin.AdminModule.setDefaultThreshold().
Here is the call graph for this function:
| static void org.objectweb.joram.client.jms.admin.AdminModule.setDefaultThreshold | ( | int | threshold | ) | throws ConnectException, AdminException [static] |
Sets a given value as the default threshold for the local server (-1 for unsetting previous value).
| threshold | The threshold value to be set. |
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 600 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.setDefaultThreshold().
Here is the call graph for this function:
| static List org.objectweb.joram.client.jms.admin.AdminModule.getServersIds | ( | ) | throws ConnectException, AdminException [static] |
Returns the list of the platform's servers' identifiers.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 612 of file AdminModule.java.
| static List org.objectweb.joram.client.jms.admin.AdminModule.getServersIds | ( | String | domainName | ) | throws ConnectException, AdminException [static] |
Returns the list of the servers' identifiers that belong to the specified domain
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 624 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static String [] org.objectweb.joram.client.jms.admin.AdminModule.getDomainNames | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Returns the list of the domain names that contains the specified server.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 681 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static DeadMQueue org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQ | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Returns the default dead message queue for a given server, null if not set.
The request fails if the target server does not belong to the platform.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 699 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQId(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static DeadMQueue org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQ | ( | ) | throws ConnectException, AdminException [static] |
Returns the default dead message queue for the local server, null if not set.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 715 of file AdminModule.java.
| static String org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQId | ( | ) | throws ConnectException, AdminException [static] |
Returns the default dead message queue for the local server, null if not set.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 727 of file AdminModule.java.
Referenced by org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQ().
| static String org.objectweb.joram.client.jms.admin.AdminModule.getDefaultDMQId | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Returns the default dead message queue for a given server, null if not set.
The request fails if the target server does not belong to the platform.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 741 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static int org.objectweb.joram.client.jms.admin.AdminModule.getDefaultThreshold | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
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.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 761 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static int org.objectweb.joram.client.jms.admin.AdminModule.getDefaultThreshold | ( | ) | throws ConnectException, AdminException [static] |
Returns the default threshold value for the local server, -1 if not set.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Definition at line 780 of file AdminModule.java.
| static List org.objectweb.joram.client.jms.admin.AdminModule.getDestinations | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Returns the list of all destinations that exist on a given server, or an empty list if none exist.
The request fails if the target server does not belong to the platform.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 795 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static List org.objectweb.joram.client.jms.admin.AdminModule.getDestinations | ( | ) | throws ConnectException, AdminException [static] |
Returns the list of all destinations that exist on the local server, or an empty list if none exist.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | Never thrown. |
Definition at line 820 of file AdminModule.java.
| static List org.objectweb.joram.client.jms.admin.AdminModule.getDestinations | ( | int | serverId, | |
| long | delay | |||
| ) | throws ConnectException, AdminException [static] |
Returns the list of all destinations that exist on a given server, or an empty list if none exist. The request is abort after delay.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 833 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static List org.objectweb.joram.client.jms.admin.AdminModule.getUsers | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Returns the list of all users that exist on a given server, or an empty list if none exist.
The request fails if the target server does not belong to the platform.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 860 of file AdminModule.java.
References org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.reply.
Here is the call graph for this function:
| static List org.objectweb.joram.client.jms.admin.AdminModule.getUsers | ( | int | serverId, | |
| long | delay | |||
| ) |