java.lang.Object
- org.objectweb.joram.client.jms.admin.AdminWrapper

All Implemented Interfaces:

AdminItf
```
public class AdminWrapper
extends Object
implements AdminItf
```
The AdminWrapper class allows to set an administrator connection to a given JORAM server, and provides administration and monitoring methods at a server/platform level.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADM_NAME_PROPERTY`
`private static boolean`	`DEBUG`
`static String`	`DEFAULT_ADM_NAME`
`private static Logger`	`logger`
`private AdminRequestor`	`requestor`	The requestor for sending the synchronous requests.
`private Server`	`server`	The description of the server the module is connected to.

Constructor Summary

Constructors
Constructor Description

AdminWrapper(Connection cnx)
Creates an administration wrapper for a Joram server.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`abortRequest()`
`String`	`addAMQPBridgeConnection(int serverId, String urls)`	Adds an AMQP server and starts a live connection with it, accessible via the url provided.
`void`	`addDomain(String domain, int sid, int port)`	Adds a domain to the platform.
`void`	`addDomain(String domain, String network, int sid, int port)`	Adds a domain to the platform using a specific network component.
`String`	`addJMSBridgeConnection(int serverId, String urls)`	Adds a JMS server and starts a live connection with it, accessible via the url provided.
`void`	`addServer(int sid, String host, String domain, int port, String server)`	Adds a server to the platform.
`void`	`addServer(int sid, String host, String domain, int port, String server, String[] services, String[] args)`	Adds a server to the platform.
`void`	`close()`	Closes the underlying requestor.
`Queue`	`createDeadMQueue(int serverId, String name)`	Deprecated. No longer needed, any queue can be used as DMQ.
`private Identity`	`createIdentity(String user, String passwd, String identityClassName)`	Create a user Identity.
`Destination`	`createQueue(int serverId, String name)`	Creates or retrieves a queue destination on a given JORAM server.
`Destination`	`createQueue(int serverId, String name, String className, Properties prop)`	Creates or retrieves a queue destination on a given JORAM server.
`Destination`	`createQueue(String name)`	Creates or retrieves a queue destination on a given JORAM server.
`Destination`	`createTopic(int serverId, String name)`	Creates or retrieves a topic destination on a given JORAM server.
`Destination`	`createTopic(int serverId, String name, String className, Properties prop)`	Creates or retrieves a topic destination on a given JORAM server.
`Destination`	`createTopic(String name)`	Creates or retrieves a topic destination on the underlying JORAM server.
`User`	`createUser(String name, String password)`	Creates or retrieves a user on the underlying JORAM server.
`User`	`createUser(String name, String password, int serverId)`	Creates or retrieves a user on the underlying JORAM server.
`User`	`createUser(String name, String password, int serverId, String identityClassName)`	Admin method creating a user for a given server and instantiating the corresponding `User` object.
`User`	`createUser(String name, String password, int serverId, String identityClassName, Properties prop)`	Admin method creating a user for a given server and instantiating the corresponding `User` object.
`User`	`createUser(String name, String password, String identityClass)`	Creates or retrieves a user on the underlying JORAM server.
`String`	`deleteAMQPBridgeConnection(int serverId, String names)`	Removes the live connection to the specified AMQP server.
`String`	`deleteJMSBridgeConnection(int serverId, String names)`	Removes the live connection to the specified JMS server.
`String`	`deleteJMSBridgeConnection(int serverId, String names, boolean async)`	Removes the live connection to the specified JMS server.
`String`	`deleteJMSPBridgeConnection(int serverId, String names)`	Deprecated. Use deleteJMSBridgeConnection instead.
`String`	`deleteJMSPBridgeConnection(int serverId, String names, boolean async)`	Deprecated. Use deleteJMSBridgeConnection instead.
`AdminReply`	`doRequest(AdminRequest request)`	Method actually sending an `AdminRequest` instance to the platform and getting an `AdminReply` instance.
`String`	`getConfiguration()`	Returns the current servers configuration (a3servers.xml).
`Queue`	`getDefaultDMQ()`	Returns the default dead message queue for the local server, null if not set.
`Queue`	`getDefaultDMQ(int serverId)`	Returns the default dead message queue for a given server, null if not set.
`String`	`getDefaultDMQId()`	Returns the unique identifier of the default dead message queue for the local server, null if not set.
`String`	`getDefaultDMQId(int serverId)`	Returns the unique identifier of the default dead message queue for a given 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()`	Returns the list of all destinations that exist on the local server.
`Destination[]`	`getDestinations(int serverId)`	Returns the list of all destinations that exist on a given server.
`String[]`	`getDomainNames(int serverId)`	Returns the list of the domain names that contains the specified server.
`Hashtable`	`getJMXAttribute(int serverId, String attname)`	Returns JMX attribute value for the specified server.
`Hashtable`	`getJMXAttribute(String attname)`	Returns JMX attribute value for the local server.
`String`	`getLocalHost()`	Returns the host name of the server the module is connected to.
`String`	`getLocalName()`	Returns the name of the server the module is connected to.
`Server`	`getLocalServer()`	Returns the information about the current server: unique identifier, symbolic name and hostname.
`int`	`getLocalServerId()`	Returns the identifier of the server the module is connected to.
`Server[]`	`getServers()`	Returns the list of the platform's servers' identifiers.
`Server[]`	`getServers(String domain)`	Returns the list of the servers' that belong to the specified domain.
`int[]`	`getServersIds()`	Returns the list of the platform's servers' identifiers.
`int[]`	`getServersIds(String domain)`	Returns the list of the servers' identifiers that belong to the specified domain
`String[]`	`getServersNames()`	Returns the list of the platform's servers' names.
`String[]`	`getServersNames(String domain)`	Returns the list of the servers' names that belong to the specified domain
`Hashtable`	`getStatistics()`	Returns statistics for the local server.
`Hashtable`	`getStatistics(int serverId)`	Returns statistics for the specified server.
`long`	`getTimeOutToAbortRequest()`	Returns the maximum time in ms before aborting request.
`User[]`	`getUsers()`	Returns the list of all users that exist on the local server.
`User[]`	`getUsers(int serverId)`	Returns the list of all users that exist on a given server.
`String`	`invokeStaticServerMethod(int serverId, String className, String methodName, Class<?>[] parameterTypes, Object[] args)`	Invokes the specified static method with the specified parameters on the chosen server.
`String`	`invokeStaticServerMethod(int serverId, String className, String methodName, Class<?>[] parameterTypes, Object[] args, boolean async)`	Invokes the specified static method with the specified parameters on the chosen server.
`boolean`	`isClosed()`	Returns true if the underlying requestor is closed.
`AdminReply`	`processAdmin(String targetId, int command, Properties prop)`	The method send the admin JMS message on JORAM server (AdminTopic).
`void`	`removeDomain(String domain)`	Removes a domain from the platform.
`void`	`removeServer(int sid)`	Removes a server from the platform.
`void`	`setDefaultDMQ(int serverId, Queue dmq)`	Sets a given dead message queue as the default DMQ for a given server (`null` for unsetting previous DMQ).
`void`	`setDefaultDMQ(Queue dmq)`	Sets a given dead message queue as the default DMQ for the local server (`null` for unsetting previous DMQ).
`void`	`setDefaultDMQId(int serverId, String dmqId)`	Sets a given dead message queue as the default DMQ for a given server (`null` for unsetting previous DMQ).
`void`	`setDefaultDMQId(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)`	Set the maximum time in ms before aborting request.
`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

- Field Detail
  - logger
```
private static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - server
```
private Server server
```
    The description of the server the module is connected to.
  - requestor
```
private AdminRequestor requestor
```
    The requestor for sending the synchronous requests.
  - ADM_NAME_PROPERTY
```
public static final String ADM_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ADM_NAME
```
public static final String DEFAULT_ADM_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AdminWrapper
```
public AdminWrapper(Connection cnx)
             throws JMSException,
                    ConnectException,
                    AdminException
```
    Creates an administration wrapper for a Joram server. Be careful, if the connection is not started this method will failed with a ConnectException.
    
    Parameters:
    
    cnx - A valid connection to the Joram server.
    
    Throws:
    
    JMSException - A problem occurs during initialization.
    
    ConnectException
    
    AdminException
- Method Detail
  - setTimeOutToAbortRequest
```
public final void setTimeOutToAbortRequest(long timeOut)
                                    throws ConnectException
```
    Set the maximum time in ms before aborting request.
    
    Specified by:
    
    setTimeOutToAbortRequest in interface AdminItf
    
    Parameters:
    
    timeOut - the maximum time in ms before aborting request.
    
    Throws:
    
    ConnectException - if the connection is not established.
  - getTimeOutToAbortRequest
```
public final long getTimeOutToAbortRequest()
                                    throws ConnectException
```
    Returns the maximum time in ms before aborting request.
    
    Specified by:
    
    getTimeOutToAbortRequest in interface AdminItf
    
    Returns:
    
    the maximum time in ms before aborting request.
    
    Throws:
    
    ConnectException - if the connection is not established.
  - close
```
public void close()
```
    Closes the underlying requestor.
    
    Specified by:
    
    close in interface AdminItf
  - isClosed
```
public boolean isClosed()
```
    Returns true if the underlying requestor is closed.
    
    Specified by:
    
    isClosed in interface AdminItf
    
    Returns:
    
    true if the underlying requestor is closed.
  - stopServer
```
public final void stopServer()
                      throws ConnectException,
                             AdminException
```
    Stops the platform local server.
    
    Specified by:
    
    stopServer in interface AdminItf
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    stopServer(int)
  - stopServer
```
public final void stopServer(int serverId)
                      throws ConnectException,
                             AdminException
```
    Stops a given server of the platform.
    The request fails if the target server does not belong to the platform.
    
    Specified by:
    
    stopServer in interface AdminItf
    
    Parameters:
    
    serverId - Identifier of the server to stop.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - addServer
```
public final void addServer(int sid,
                            String host,
                            String domain,
                            int port,
                            String server)
                     throws ConnectException,
                            AdminException
```
    Adds a server to the platform.
    The server is configured without any service.
    
    Specified by:
    
    addServer in interface AdminItf
    
    Parameters:
    
    sid - 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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    addServer(int, String, String, int, String, String[], String[])
  - addServer
```
public final void addServer(int sid,
                            String host,
                            String domain,
                            int port,
                            String server,
                            String[] services,
                            String[] args)
                     throws ConnectException,
                            AdminException
```
    Adds a server to the platform.
    
    Specified by:
    
    addServer in interface AdminItf
    
    Parameters:
    
    sid - 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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - removeServer
```
public final void removeServer(int sid)
                        throws ConnectException,
                               AdminException
```
    Removes a server from the platform.
    
    Specified by:
    
    removeServer in interface AdminItf
    
    Parameters:
    
    sid - Id of the removed server
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - addDomain
```
public final void addDomain(String domain,
                            int sid,
                            int port)
                     throws ConnectException,
                            AdminException
```
    Adds a domain to the platform.
    The domain will use the default network component "SimpleNetwork".
    
    Specified by:
    
    addDomain in interface AdminItf
    
    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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - addDomain
```
public final void addDomain(String domain,
                            String network,
                            int sid,
                            int port)
                     throws ConnectException,
                            AdminException
```
    Adds a domain to the platform using a specific network component.
    
    Specified by:
    
    addDomain in interface AdminItf
    
    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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - removeDomain
```
public final void removeDomain(String domain)
                        throws ConnectException,
                               AdminException
```
    Removes a domain from the platform.
    
    Specified by:
    
    removeDomain in interface AdminItf
    
    Parameters:
    
    domain - Name of the domain to remove
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getConfiguration
```
public final String getConfiguration()
                              throws ConnectException,
                                     AdminException
```
    Returns the current servers configuration (a3servers.xml).
    
    Specified by:
    
    getConfiguration in interface AdminItf
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getStatistics
```
public final Hashtable getStatistics()
                              throws ConnectException,
                                     AdminException
```
    Returns statistics for the local server.
    
    Specified by:
    
    getStatistics in interface AdminItf
    
    Returns:
    
    statistics for the local server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getStatistics(int)
  - getStatistics
```
public final Hashtable getStatistics(int serverId)
                              throws ConnectException,
                                     AdminException
```
    Returns statistics for the specified server.
    The request fails if the target server does not belong to the platform.
    
    Specified by:
    
    getStatistics in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Returns:
    
    the statistics for the the specified server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getJMXAttribute
```
public final Hashtable getJMXAttribute(String attname)
                                throws ConnectException,
                                       AdminException
```
    Returns JMX attribute value for the local server.
    
    Specified by:
    
    getJMXAttribute in interface AdminItf
    
    Returns:
    
    Corresponding JMX attribute value for the local server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getStatistics(int)
  - getJMXAttribute
```
public final Hashtable getJMXAttribute(int serverId,
                                       String attname)
                                throws ConnectException,
                                       AdminException
```
    Returns JMX attribute value for the specified server.
    The request fails if the target server does not belong to the platform.
    
    Specified by:
    
    getJMXAttribute in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Returns:
    
    the statistics for the the specified server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getDefaultDMQId
```
public final String getDefaultDMQId()
                             throws ConnectException,
                                    AdminException
```
    Returns the unique identifier of the default dead message queue for the local server, null if not set.
    
    Specified by:
    
    getDefaultDMQId in interface AdminItf
    
    Returns:
    
    The unique identifier of the default dead message queue for the local server, null if not set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getDefaultDMQId(int)
  - getDefaultDMQId
```
public final String getDefaultDMQId(int serverId)
                             throws ConnectException,
                                    AdminException
```
    Returns the unique identifier of 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.
    
    Specified by:
    
    getDefaultDMQId in interface AdminItf
    
    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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - setDefaultDMQId
```
public final void setDefaultDMQId(String dmqId)
                           throws ConnectException,
                                  AdminException
```
    Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
    
    Specified by:
    
    setDefaultDMQId in interface AdminItf
    
    Parameters:
    
    dmqId - The dmqId (AgentId) to be set as the default one.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    setDefaultDMQId(int, String)
  - setDefaultDMQId
```
public final void setDefaultDMQId(int serverId,
                                  String dmqId)
                           throws 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.
    
    Specified by:
    
    setDefaultDMQId in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server.
    
    dmqId - The dmqId (AgentId) to be set as the default one.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getDefaultDMQ
```
public final Queue getDefaultDMQ()
                          throws ConnectException,
                                 AdminException
```
    Returns the default dead message queue for the local server, null if not set.
    
    Specified by:
    
    getDefaultDMQ in interface AdminItf
    
    Returns:
    
    The default dead message queue for the local server, null if not set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getDefaultDMQ(int)
  - getDefaultDMQ
```
public final Queue getDefaultDMQ(int serverId)
                          throws ConnectException,
                                 AdminException
```
    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.
    
    Specified by:
    
    getDefaultDMQ in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Returns:
    
    The default dead message queue for the local server, null if not set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - setDefaultDMQ
```
public final void setDefaultDMQ(Queue dmq)
                         throws ConnectException,
                                AdminException
```
    Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
    
    Specified by:
    
    setDefaultDMQ in interface AdminItf
    
    Parameters:
    
    dmq - The dmq to be set as the default one.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    setDefaultDMQ(int, Queue)
  - setDefaultDMQ
```
public final void setDefaultDMQ(int serverId,
                                Queue dmq)
                         throws 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.
    
    Specified by:
    
    setDefaultDMQ in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server.
    
    dmq - The dmq to be set as the default one.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getDefaultThreshold
```
public final int getDefaultThreshold()
                              throws ConnectException,
                                     AdminException
```
    Returns the default threshold value for the local server, -1 if not set.
    
    Specified by:
    
    getDefaultThreshold in interface AdminItf
    
    Returns:
    
    The default threshold value for the local server, -1 if not set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getDefaultThreshold(int)
  - getDefaultThreshold
```
public final int getDefaultThreshold(int serverId)
                              throws 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.
    
    Specified by:
    
    getDefaultThreshold in interface AdminItf
    
    Returns:
    
    The default threshold value for the local server, -1 if not set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - setDefaultThreshold
```
public final void setDefaultThreshold(int threshold)
                               throws ConnectException,
                                      AdminException
```
    Sets a given value as the default threshold for the local server (-1 for unsetting previous value).
    
    Specified by:
    
    setDefaultThreshold in interface AdminItf
    
    Parameters:
    
    threshold - The threshold value to be set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    setDefaultThreshold(int, int)
  - setDefaultThreshold
```
public final void setDefaultThreshold(int serverId,
                                      int threshold)
                               throws 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.
    
    Specified by:
    
    setDefaultThreshold in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server.
    
    threshold - The threshold value to be set.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getServersIds
```
public final int[] getServersIds()
                          throws ConnectException,
                                 AdminException
```
    Returns the list of the platform's servers' identifiers.
    
    Specified by:
    
    getServersIds in interface AdminItf
    
    Returns:
    
    An array containing the list of server's identifiers.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getServers(String)
  - getServersIds
```
public final int[] getServersIds(String domain)
                          throws ConnectException,
                                 AdminException
```
    Returns the list of the servers' identifiers that belong to the specified domain
    
    Specified by:
    
    getServersIds in interface AdminItf
    
    Parameters:
    
    domain - Name of the domain.
    
    Returns:
    
    An array containing the list of server's identifiers of the specified domain.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
  - getServersNames
```
public final String[] getServersNames()
                               throws ConnectException,
                                      AdminException
```
    Returns the list of the platform's servers' names.
    
    Specified by:
    
    getServersNames in interface AdminItf
    
    Returns:
    
    An array containing the list of server's names.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getServers(String)
  - getServersNames
```
public final String[] getServersNames(String domain)
                               throws ConnectException,
                                      AdminException
```
    Returns the list of the servers' names that belong to the specified domain
    
    Specified by:
    
    getServersNames in interface AdminItf
    
    Parameters:
    
    domain - Name of the domain.
    
    Returns:
    
    An array containing the list of server's names of the specified domain.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
  - getServers
```
public final Server[] getServers()
                          throws ConnectException,
                                 AdminException
```
    Returns the list of the platform's servers' identifiers.
    
    Specified by:
    
    getServers in interface AdminItf
    
    Returns:
    
    An array containing the description of all servers.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    See Also:
    
    getServers(String)
  - getServers
```
public final Server[] getServers(String domain)
                          throws ConnectException,
                                 AdminException
```
    Returns the list of the servers' that belong to the specified domain.
    
    Specified by:
    
    getServers in interface AdminItf
    
    Parameters:
    
    domain - Name of the domain.
    
    Returns:
    
    An array containing the description of all servers.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
  - getDomainNames
```
public final String[] getDomainNames(int serverId)
                              throws ConnectException,
                                     AdminException
```
    Returns the list of the domain names that contains the specified server.
    
    Specified by:
    
    getDomainNames in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
  - getDestinations
```
public final Destination[] getDestinations()
                                    throws ConnectException,
                                           AdminException
```
    Returns the list of all destinations that exist on the local server.
    
    Specified by:
    
    getDestinations in interface AdminItf
    
    Returns:
    
    An array containing all destinations defined on the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - Never thrown.
    
    See Also:
    
    getDestinations(int)
  - getDestinations
```
public final Destination[] getDestinations(int serverId)
                                    throws ConnectException,
                                           AdminException
```
    Returns the list of all destinations that exist on a given server.
    The request fails if the target server does not belong to the platform.
    
    Specified by:
    
    getDestinations in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Returns:
    
    An array containing all destinations defined on the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
  - createQueue
```
public Destination createQueue(String name)
                        throws AdminException,
                               ConnectException
```
    Creates or retrieves a queue destination on a given JORAM server.
    
    Specified by:
    
    createQueue in interface AdminItf
    
    Parameters:
    
    name - The name of the queue.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
    
    See Also:
    
    createQueue(int, String, String, Properties)
  - createQueue
```
public Destination createQueue(int serverId,
                               String name)
                        throws AdminException,
                               ConnectException
```
    Creates or retrieves a queue destination on a given JORAM server.
    
    Specified by:
    
    createQueue in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server where deploying the topic.
    
    name - The name of the queue.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
    
    See Also:
    
    createQueue(int, String, String, Properties)
  - createQueue
```
public Destination createQueue(int serverId,
                               String name,
                               String className,
                               Properties prop)
                        throws ConnectException,
                               AdminException
```
    Creates or retrieves a queue destination on a given JORAM server.
    First a destination with the specified name is searched on the given server, if it does not exist it is created.
    The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
    
    Specified by:
    
    createQueue in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server where deploying the queue.
    
    name - The name of the queue.
    
    className - The queue class name.
    
    prop - The queue properties.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
  - createTopic
```
public Destination createTopic(String name)
                        throws AdminException,
                               ConnectException
```
    Creates or retrieves a topic destination on the underlying JORAM server.
    
    Specified by:
    
    createTopic in interface AdminItf
    
    Parameters:
    
    name - The name of the topic.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
    
    See Also:
    
    createTopic(int, String, String, Properties)
  - createTopic
```
public Destination createTopic(int serverId,
                               String name)
                        throws AdminException,
                               ConnectException
```
    Creates or retrieves a topic destination on a given JORAM server.
    
    Specified by:
    
    createTopic in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server where deploying the topic.
    
    name - The name of the topic.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
    
    See Also:
    
    createTopic(int, String, String, Properties)
  - createTopic
```
public Destination createTopic(int serverId,
                               String name,
                               String className,
                               Properties prop)
                        throws ConnectException,
                               AdminException
```
    Creates or retrieves a topic destination on a given JORAM server.
    First a destination with the specified name is searched on the given server, if it does not exist it is created.
    The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
    
    Specified by:
    
    createTopic in interface AdminItf
    
    Parameters:
    
    serverId - The identifier of the server where deploying the topic.
    
    name - The name of the topic.
    
    className - The topic class name.
    
    prop - The topic properties.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
  - createDeadMQueue
```
public Queue createDeadMQueue(int serverId,
                              String name)
                       throws ConnectException,
                              AdminException
```
    Deprecated.
    No longer needed, any queue can be used as DMQ.
    
    Creates or retrieves a DeadMessageQueue destination on a given JORAM server.
    First a destination with the specified name is searched on the given server, if it does not exist it is created.
    The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
    
    Parameters:
    
    serverId - The identifier of the server where deploying the topic.
    
    name - The name of the queue.
    
    Throws:
    
    ConnectException - If the admin connection is closed or broken.
    
    AdminException - If the request fails.
  - getUsers
```
public final User[] getUsers()
                      throws ConnectException,
                             AdminException
```
    Returns the list of all users that exist on the local server.
    
    Specified by:
    
    getUsers in interface AdminItf
    
    Returns:
    
    An array containing all users defined on the local server, or null if none exist.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getUsers(int)
  - getUsers
```
public final User[] getUsers(int serverId)
                      throws ConnectException,
                             AdminException
```
    Returns the list of all users that exist on a given server.
    The request fails if the target server does not belong to the platform.
    
    Specified by:
    
    getUsers in interface AdminItf
    
    Parameters:
    
    serverId - Unique identifier of the given server.
    
    Returns:
    
    An array containing all users defined on the local server, or null if none exist.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - createUser
```
public User createUser(String name,
                       String password)
                throws ConnectException,
                       AdminException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface AdminItf
    
    Parameters:
    
    name - Name of the user.
    
    password - Password of the user.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    createUser(String, String, int, String)
  - createUser
```
public User createUser(String name,
                       String password,
                       int serverId)
                throws ConnectException,
                       AdminException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface AdminItf
    
    Parameters:
    
    name - Name of the user.
    
    password - Password of the user.
    
    serverId - The identifier of the user's server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    createUser(String, String, int, String)
  - createUser
```
public User createUser(String name,
                       String password,
                       String identityClass)
                throws AdminException,
                       ConnectException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface AdminItf
    
    Parameters:
    
    name - Name of the user.
    
    password - Password of the user.
    
    identityClass - Classname for authentication, by default SimpleIdentity for user/password.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    createUser(String, String, int, String)
  - createUser
```
public User createUser(String name,
                       String password,
                       int serverId,
                       String identityClassName)
                throws ConnectException,
                       AdminException
```
    Admin method creating a user for a given server and instantiating the corresponding User object.
    If the user has already been set on this server, the method simply returns the corresponding User object. Its fails if the target server does not belong to the platform, or if a proxy could not be deployed server side for a new user.
    
    Specified by:
    
    createUser in interface AdminItf
    
    Parameters:
    
    name - Name of the user.
    
    password - Password of the user.
    
    serverId - The identifier of the user's server.
    
    identityClassName - By default user/password for SimpleIdentity.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - createUser
```
public User createUser(String name,
                       String password,
                       int serverId,
                       String identityClassName,
                       Properties prop)
                throws ConnectException,
                       AdminException
```
    Admin method creating a user for a given server and instantiating the corresponding User object.
    If the user has already been set on this server, the method simply returns the corresponding User object. Its fails if the target server does not belong to the platform, or if a proxy could not be deployed server side for a new user.
    
    Specified by:
    
    createUser in interface AdminItf
    
    Parameters:
    
    name - Name of the user.
    
    password - Password of the user.
    
    serverId - The identifier of the user's server.
    
    identityClassName - By default user/password for SimpleIdentity.
    
    prop - properties
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - createIdentity
```
private Identity createIdentity(String user,
                                String passwd,
                                String identityClassName)
                         throws AdminException
```
    Create a user Identity.
    
    Parameters:
    
    user - Name of the user.
    
    passwd - Password of the user.
    
    identityClassName - identity class name (simple, jaas).
    
    Returns:
    
    identity user Identity.
    
    Throws:
    
    AdminException
  - getLocalServer
```
public final Server getLocalServer()
                            throws ConnectException,
                                   AdminException
```
    Returns the information about the current server: unique identifier, symbolic name and hostname.
    
    Specified by:
    
    getLocalServer in interface AdminItf
    
    Returns:
    
    The description of the server.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getLocalServerId
```
public final int getLocalServerId()
                           throws ConnectException,
                                  AdminException
```
    Returns the identifier of the server the module is connected to.
    
    Specified by:
    
    getLocalServerId in interface AdminItf
    
    Throws:
    
    ConnectException - If the admin connection is not established.
    
    AdminException - If the request fails.
    
    See Also:
    
    getLocalServer()
  - getLocalHost
```
public final String getLocalHost()
                          throws ConnectException,
                                 AdminException
```
    Returns the host name of the server the module is connected to.
    
    Specified by:
    
    getLocalHost in interface AdminItf
    
    Throws:
    
    ConnectException - If the admin connection is not established.
    
    AdminException - If the request fails.
    
    See Also:
    
    getLocalServer()
  - getLocalName
```
public final String getLocalName()
                          throws ConnectException,
                                 AdminException
```
    Returns the name of the server the module is connected to.
    
    Specified by:
    
    getLocalName in interface AdminItf
    
    Throws:
    
    ConnectException - If the admin connection is not established.
    
    AdminException - If the request fails.
    
    See Also:
    
    getLocalServer()
  - processAdmin
```
public AdminReply processAdmin(String targetId,
                               int command,
                               Properties prop)
                        throws ConnectException,
                               AdminException
```
    The method send the admin JMS message on JORAM server (AdminTopic).
    
    Specified by:
    
    processAdmin in interface AdminItf
    
    Parameters:
    
    targetId - agent Id target.
    
    command - the command to execute.
    
    prop - the properties.
    
    Returns:
    
    the reply.
    
    Throws:
    
    AdminException
    
    ConnectException - If the connection fails.
  - doRequest
```
public AdminReply doRequest(AdminRequest request)
                     throws AdminException,
                            ConnectException
```
    Method actually sending an AdminRequest instance to the platform and getting an AdminReply instance.
    
    Specified by:
    
    doRequest in interface AdminItf
    
    Parameters:
    
    request - the administration request to send
    
    Returns:
    
    the reply message
    
    Throws:
    
    ConnectException - If the connection to the platform fails.
    
    AdminException - If the platform's reply is invalid, or if the request failed.
  - abortRequest
```
public void abortRequest()
                  throws ConnectException
```
    Specified by:
    
    abortRequest in interface AdminItf
    
    Throws:
    
    ConnectException
  - invokeStaticServerMethod
```
public String invokeStaticServerMethod(int serverId,
                                       String className,
                                       String methodName,
                                       Class<?>[] parameterTypes,
                                       Object[] args)
                                throws ConnectException,
                                       AdminException
```
    Invokes the specified static method with the specified parameters on the chosen server. The parameters types of the invoked method must be java primitive types, the java objects wrapping them or String type. The method is invoked synchronously by the server and the result is returned.
    
    Specified by:
    
    invokeStaticServerMethod in interface AdminItf
    
    Parameters:
    
    serverId - the identifier of the server.
    
    className - the name of the class holding the static method
    
    methodName - the name of the invoked method
    
    parameterTypes - the list of parameters
    
    args - the arguments used for the method call
    
    Returns:
    
    the result of the invoked method after applying the toString method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - invokeStaticServerMethod
```
public String invokeStaticServerMethod(int serverId,
                                       String className,
                                       String methodName,
                                       Class<?>[] parameterTypes,
                                       Object[] args,
                                       boolean async)
                                throws ConnectException,
                                       AdminException
```
    Invokes the specified static method with the specified parameters on the chosen server. The parameters types of the invoked method must be java primitive types, the java objects wrapping them or String type. The method can be invoked either asynchronously or not by the server depending of the parameter async.
    
    Parameters:
    
    serverId - the identifier of the server.
    
    className - the name of the class holding the static method
    
    methodName - the name of the invoked method
    
    parameterTypes - the list of parameters
    
    args - the arguments used for the method call
    
    async - if true the method is invoked asynchronously by the server and the result is lost.
    
    Returns:
    
    the result of the invoked method after applying the toString method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - addAMQPBridgeConnection
```
public String addAMQPBridgeConnection(int serverId,
                                      String urls)
                               throws ConnectException,
                                      AdminException
```
    Adds an AMQP server and starts a live connection with it, accessible via the url provided. A server is uniquely identified by the given name. Adding an existing server won't do anything.
    
    Specified by:
    
    addAMQPBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    urls - the amqp url list identifying the servers separate by space, for example: "amqp://user:pass@localhost:5672/?name=serv1 amqp://user:pass@localhost:5678/?name=serv2"
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - deleteAMQPBridgeConnection
```
public String deleteAMQPBridgeConnection(int serverId,
                                         String names)
                                  throws ConnectException,
                                         AdminException
```
    Removes the live connection to the specified AMQP server.
    
    Specified by:
    
    deleteAMQPBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    names - the name identifying the server or list of name separate by space
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - addJMSBridgeConnection
```
public String addJMSBridgeConnection(int serverId,
                                     String urls)
                              throws ConnectException,
                                     AdminException
```
    Adds a JMS server and starts a live connection with it, accessible via the url provided. A server is uniquely identified by the given name. Adding an existing server won't do anything.
    
    Specified by:
    
    addJMSBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    urls - the jms url list identifying the servers separate by space, for example: "jndi_url/?name=cnx1&cf=cfName&jndiFactoryClass=com.xxx.yyy&user=user1&pass=pass1&clientID=clientID"
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - deleteJMSBridgeConnection
```
public String deleteJMSBridgeConnection(int serverId,
                                        String names)
                                 throws ConnectException,
                                        AdminException
```
    Removes the live connection to the specified JMS server.
    
    Specified by:
    
    deleteJMSBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    names - the name identifying the server or list of name separate by space
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - deleteJMSPBridgeConnection
```
public String deleteJMSPBridgeConnection(int serverId,
                                         String names)
                                  throws ConnectException,
                                         AdminException
```
    Deprecated.
    Use deleteJMSBridgeConnection instead.
    
    Removes the live connection to the specified JMS server (Use deleteJMSBridgeConnection instead).
    
    Specified by:
    
    deleteJMSPBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    names - the name identifying the server or list of name separate by space
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - deleteJMSBridgeConnection
```
public String deleteJMSBridgeConnection(int serverId,
                                        String names,
                                        boolean async)
                                 throws ConnectException,
                                        AdminException
```
    Removes the live connection to the specified JMS server.
    
    Specified by:
    
    deleteJMSBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    names - the name identifying the server or list of name separate by space
    
    async - invoke asynchronously
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails
  - deleteJMSPBridgeConnection
```
public String deleteJMSPBridgeConnection(int serverId,
                                         String names,
                                         boolean async)
                                  throws ConnectException,
                                         AdminException
```
    Deprecated.
    Use deleteJMSBridgeConnection instead.
    
    Removes the live connection to the specified JMS server (Use deleteJMSBridgeConnection instead).
    
    Specified by:
    
    deleteJMSPBridgeConnection in interface AdminItf
    
    Parameters:
    
    serverId - the serverId
    
    names - the name identifying the server or list of name separate by space
    
    async - invoke asynchronously
    
    Returns:
    
    the result of the method
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the invocation can't be done or fails

Class AdminWrapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

DEBUG

server

requestor

ADM_NAME_PROPERTY

DEFAULT_ADM_NAME

Constructor Detail

AdminWrapper

Method Detail

setTimeOutToAbortRequest

getTimeOutToAbortRequest

close

isClosed

stopServer

stopServer

addServer

addServer

removeServer

addDomain

addDomain

removeDomain

getConfiguration

getStatistics

getStatistics

getJMXAttribute

getJMXAttribute

getDefaultDMQId

getDefaultDMQId

setDefaultDMQId

setDefaultDMQId

getDefaultDMQ

getDefaultDMQ

setDefaultDMQ

setDefaultDMQ

getDefaultThreshold

getDefaultThreshold

setDefaultThreshold

setDefaultThreshold

getServersIds

getServersIds

getServersNames

getServersNames

getServers

getServers

getDomainNames

getDestinations

getDestinations

createQueue

createQueue

createQueue

createTopic

createTopic

createTopic

createDeadMQueue

getUsers

getUsers

createUser

createUser

createUser

createUser

createUser

createIdentity

getLocalServer

getLocalServerId

getLocalHost

getLocalName

processAdmin

doRequest

abortRequest

invokeStaticServerMethod

invokeStaticServerMethod

addAMQPBridgeConnection

deleteAMQPBridgeConnection

addJMSBridgeConnection