Package org.objectweb.joram.client.jms.admin

Class JoramAdmin

java.lang.Object

org.objectweb.joram.client.jms.admin.JoramAdmin

All Implemented Interfaces:

AdminItf, JoramAdminMBean

public class JoramAdmin
extends Object
implements AdminItf, JoramAdminMBean

JoramAdmin is the implementation of the interface JoramAdminMBean. It must only be used to allow administration through JMX.

See Also:

AdminModule, AdminWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected String	JMXBaseName
static org.objectweb.util.monolog.api.Logger	logger
AdminWrapper	wrapper

Constructor Summary

Constructors

Constructor	Description
JoramAdmin(Connection cnx)	Creates a MBean to administer Joram using the default basename for JMX registering (JoramAdmin(Connection, String)).
JoramAdmin(Connection cnx, String base)	Creates a MBean to administer Joram using the given basename for JMX registering.

Method Summary

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.
Destination	createQueue(int serverId, String name)	Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
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 the underlying JORAM server, (re)binds the corresponding Queue instance.
Destination	createTopic(int serverId, String name)	Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
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, (re)binds the corresponding Topic instance.
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 given JORAM server.
User	createUser(String name, String password, int serverId, String identityClass)	Creates or retrieves a user on the underlying JORAM server.
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 AMQP 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.
String	deleteJMSPBridgeConnection(int serverId, String names, boolean async)	Deprecated.
static JoramAdmin	doCreate(AbstractConnectionFactory cf, String name, String password, String identityClass)	Opens a connection dedicated to administering with the Joram server which parameters are wrapped by a given ConnectionFactory.
org.objectweb.joram.shared.admin.AdminReply	doRequest(org.objectweb.joram.shared.admin.AdminRequest request)	Method actually sending an AdminRequest instance to the platform and getting an AdminReply instance.
void	executeXMLAdmin(String path)	This method execute the XML script file that the pathname is given in parameter.
void	executeXMLAdmin(String cfgDir, String cfgFileName)	This method execute the XML script file that the location is given in parameter.
void	exit()	Closes the administration connection and unregister the MBean.
void	exportRepositoryToFile(String exportDir, 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)
void	getAllDestinations(int serverId)	This method creates and registers MBeans for all the destinations of the selected server.
void	getAllUsers(int serverId)	This method creates and registers MBeans for all the users of the selected server.
String	getConfiguration()	Returns the current servers configuration (equivalent to the a3servers.xml file).
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 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()	This method creates and registers MBeans for all the destinations on the local server.
Destination[]	getDestinations(int serverId)	This method creates and registers MBeans for all the destinations of the selected 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	getJMXBaseName()
void	getLocalDestinations()	This method creates and registers MBeans for all the destinations on 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.
void	getLocalUsers()	This method creates and registers MBeans for all the users on the local server.
Server[]	getServers()	Returns the list of the platform's servers' descriptions.
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 the specified server.
long	getTimeOutToAbortRequest()	Gets the maximum time a command has to complete before it is canceled.
User[]	getUsers()	This method creates and registers MBeans for all the users on the local server.
User[]	getUsers(int serverId)	This method creates and registers MBeans for all the users of the selected 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)
boolean	isClosed()	Returns true if the underlying requestor is closed.
org.objectweb.joram.shared.admin.AdminReply	processAdmin(String targetId, int command, Properties prop)	The method send the admin JMS message on JORAM server (AdminTopic).
void	queueCreate(int serverId, String name)	Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
void	queueCreate(String name)	Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
void	registerMBean(String base)
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)	Specifies how much time a command has to complete before If the command does not complete within the specified time, it is canceled and an exception is generated.
void	stopServer()	Stops the platform local server.
void	stopServer(int serverId)	Stops a given server of the platform.
void	topicCreate(int serverId, String name)	Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
void	topicCreate(String name)	Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
void	unregisterMBean()
void	userCreate(String name, String password)	Creates or retrieves a user on the underlying JORAM server.
void	userCreate(String name, String password, int serverId)	Creates or retrieves a user on the given JORAM server.
void	userCreate(String name, String password, int serverId, String identityClass)	Creates or retrieves a user on the underlying JORAM server.
void	userCreate(String name, String password, String identityClass)	Creates or retrieves a user on the underlying JORAM server.
private Destination	wrapDestination(Destination destination)
private Destination[]	wrapDestinations(Destination[] destinations)
private User	wrapUser(User user)
private User[]	wrapUsers(User[] users)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static org.objectweb.util.monolog.api.Logger logger

wrapper

public AdminWrapper wrapper

JMXBaseName

protected transient String JMXBaseName

Constructor Detail

JoramAdmin

public JoramAdmin(Connection cnx)
           throws ConnectException,
                  AdminException,
                  JMSException

Creates a MBean to administer Joram using the default basename for JMX registering (JoramAdmin(Connection, String)). 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

See Also:

AdminWrapper(Connection)

JoramAdmin

public JoramAdmin(Connection cnx,
                  String base)
           throws ConnectException,
                  AdminException,
                  JMSException

Creates a MBean to administer Joram using the given basename for JMX registering. Be careful, if the connection is not started this method will failed with a ConnectException.

Parameters:

cnx - A valid connection to the Joram server.

base - the basename for registering the MBean.

Throws:

JMSException - A problem occurs during initialization.

ConnectException

AdminException

See Also:

AdminWrapper(Connection)

Method Detail

exit

public void exit()

Closes the administration connection and unregister the MBean.

Specified by:

exit in interface JoramAdminMBean

close

public void close()

Description copied from interface: AdminItf

Closes the underlying requestor.

Specified by:

close in interface AdminItf

isClosed

public boolean isClosed()

Description copied from interface: AdminItf

Returns true if the underlying requestor is closed.

Specified by:

isClosed in interface AdminItf

Returns:

true if the underlying requestor is closed.

setTimeOutToAbortRequest

public void setTimeOutToAbortRequest(long timeOut)
                              throws ConnectException

Specifies how much time a command has to complete before If the command does not complete within the specified time, it is canceled and an exception is generated.

Be careful, the value can be changed prior to the connection only using the AdminRequestor.REQUEST_TIMEOUT_PROP property.

Specified by:

setTimeOutToAbortRequest in interface AdminItf

Specified by:

setTimeOutToAbortRequest in interface JoramAdminMBean

Parameters:

timeOut - the maximum time before a command is canceled.

Throws:

ConnectException - if the connection is not established.

getTimeOutToAbortRequest

public long getTimeOutToAbortRequest()
                              throws ConnectException

Gets the maximum time a command has to complete before it is canceled.

Specified by:

getTimeOutToAbortRequest in interface AdminItf

Specified by:

getTimeOutToAbortRequest in interface JoramAdminMBean

Returns:

the maximum time before a command is canceled

Throws:

ConnectException - if the connection is not established.

stopServer

public void stopServer()
                throws ConnectException,
                       AdminException

Stops the platform local server.

Specified by:

stopServer in interface AdminItf

Specified by:

stopServer in interface JoramAdminMBean

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

See Also:

stopServer(int)

stopServer

public 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

Specified by:

stopServer in interface JoramAdminMBean

Parameters:

serverId - Identifier of the server to stop.

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

addServer

public 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

Specified by:

addServer in interface JoramAdminMBean

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:

AdminItf.addServer(int, String, String, int, String, String[], String[])

addServer

public void addServer(int sid,
                      String host,
                      String domain,
                      int port,
                      String server,
                      String[] services,
                      String[] args)
               throws ConnectException,
                      AdminException

Description copied from interface: AdminItf

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 void removeServer(int sid)
                  throws ConnectException,
                         AdminException

Removes a server from the platform.

Specified by:

removeServer in interface AdminItf

Specified by:

removeServer in interface JoramAdminMBean

Parameters:

sid - Id of the removed server

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

addDomain

public 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

Specified by:

addDomain in interface JoramAdminMBean

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 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

Specified by:

addDomain in interface JoramAdminMBean

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 void removeDomain(String domain)
                  throws ConnectException,
                         AdminException

Removes a domain from the platform.

Specified by:

removeDomain in interface AdminItf

Specified by:

removeDomain in interface JoramAdminMBean

Parameters:

domain - Name of the domain to remove

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

getConfiguration

public String getConfiguration()
                        throws ConnectException,
                               AdminException

Returns the current servers configuration (equivalent to the a3servers.xml file).

Specified by:

getConfiguration in interface AdminItf

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

getServersIds

public int[] getServersIds()
                    throws ConnectException,
                           AdminException

Returns the list of the platform's servers' identifiers.

Specified by:

getServersIds in interface AdminItf

Specified by:

getServersIds in interface JoramAdminMBean

Returns:

An array containing the list of server's identifiers.

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getServersIds(String)

getServersIds

public 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

Specified by:

getServersIds in interface JoramAdminMBean

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.

getServers

public Server[] getServers()
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

Returns the list of the platform's servers' descriptions.

Specified by:

getServers in interface AdminItf

Returns:

An array containing the description of all servers.

Throws:

ConnectException

AdminException

See Also:

AdminItf.getServers(String)

getServers

public Server[] getServers(String domain)
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

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 the corresponding servers.

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

getDomainNames

public 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

Specified by:

getDomainNames in interface JoramAdminMBean

Parameters:

serverId - Unique identifier of the server.

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

getDefaultDMQId

public 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

Specified by:

getDefaultDMQId in interface JoramAdminMBean

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 String getDefaultDMQId(int serverId)
                       throws 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.

Specified by:

getDefaultDMQId in interface AdminItf

Specified by:

getDefaultDMQId in interface JoramAdminMBean

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 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

Specified by:

setDefaultDMQId in interface JoramAdminMBean

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 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

Specified by:

setDefaultDMQId in interface JoramAdminMBean

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 Queue getDefaultDMQ()
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

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:

AdminItf.getDefaultDMQ(int)

getDefaultDMQ

public Queue getDefaultDMQ(int serverId)
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

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 void setDefaultDMQ(Queue dmq)
                   throws ConnectException,
                          AdminException

Description copied from interface: AdminItf

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:

AdminItf.setDefaultDMQ(int, Queue)

setDefaultDMQ

public void setDefaultDMQ(int serverId,
                          Queue dmq)
                   throws ConnectException,
                          AdminException

Description copied from interface: AdminItf

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.

setDefaultThreshold

public 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

Specified by:

setDefaultThreshold in interface JoramAdminMBean

Parameters:

threshold - The threshold value to be set.

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

setDefaultThreshold(int, int)

setDefaultThreshold

public 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

Specified by:

setDefaultThreshold in interface JoramAdminMBean

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.

getDefaultThreshold

public int getDefaultThreshold()
                        throws ConnectException,
                               AdminException

Returns the default threshold value for the local server, -1 if not set.

Specified by:

getDefaultThreshold in interface AdminItf

Specified by:

getDefaultThreshold in interface JoramAdminMBean

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 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

Specified by:

getDefaultThreshold in interface JoramAdminMBean

Returns:

The default threshold value for the local server, -1 if not set.

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

getLocalDestinations

public void getLocalDestinations()
                          throws ConnectException,
                                 AdminException

This method creates and registers MBeans for all the destinations on the local server.

Specified by:

getLocalDestinations in interface JoramAdminMBean

Throws:

ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations(int)

getDestinations

public Destination[] getDestinations()
                              throws ConnectException,
                                     AdminException

This method creates and registers MBeans for all the destinations on the local server.

Specified by:

getDestinations in interface AdminItf

Returns:

the destinations tab

Throws:

ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations(int)

getAllDestinations

public void getAllDestinations(int serverId)
                        throws ConnectException,
                               AdminException

This method creates and registers MBeans for all the destinations of the selected server.

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

Specified by:

getAllDestinations in interface JoramAdminMBean

Throws:

ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations()

getDestinations

public Destination[] getDestinations(int serverId)
                              throws ConnectException,
                                     AdminException

This method creates and registers MBeans for all the destinations of the selected 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:

the destinations tab

Throws:

ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations()

wrapDestinations

private final Destination[] wrapDestinations(Destination[] destinations)

createQueue

public Destination createQueue(String name)
                        throws AdminException,
                               ConnectException

Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.

Specified by:

createQueue in interface AdminItf

Parameters:

name - The name of the queue.

Returns:

the destination

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

createQueue(int, String)

createQueue

public Destination createQueue(int serverId,
                               String name)
                        throws AdminException,
                               ConnectException

Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.

Specified by:

createQueue in interface AdminItf

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the queue.

Returns:

the destination

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

AdminItf.createQueue(int, String, String, Properties)

createQueue

public Destination createQueue(int serverId,
                               String name,
                               String className,
                               Properties prop)
                        throws ConnectException,
                               AdminException

Description copied from interface: AdminItf

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, (re)binds the corresponding Topic instance.

Specified by:

createTopic in interface AdminItf

Parameters:

name - The name of the topic.

Returns:

the destination

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

createTopic(int, String)

createTopic

public Destination createTopic(int serverId,
                               String name)
                        throws AdminException,
                               ConnectException

Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.

Specified by:

createTopic in interface AdminItf

Parameters:

serverId - The identifier of the server where deploying the topic.

name - The name of the topic.

Returns:

the destination

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

AdminItf.createTopic(int, String, String, Properties)

createTopic

public Destination createTopic(int serverId,
                               String name,
                               String className,
                               Properties prop)
                        throws ConnectException,
                               AdminException

Description copied from interface: AdminItf

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.

wrapDestination

private final Destination wrapDestination(Destination destination)

getUsers

public User[] getUsers()
                throws ConnectException,
                       AdminException

This method creates and registers MBeans for all the users on the local server.

Specified by:

getUsers in interface AdminItf

Returns:

the users tab

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getUsers(int)

getUsers

public User[] getUsers(int serverId)
                throws ConnectException,
                       AdminException

This method creates and registers MBeans for all the users of the selected 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:

the users tab

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

wrapUsers

private final User[] wrapUsers(User[] users)

createUser

public User createUser(String name,
                       String password)
                throws AdminException,
                       ConnectException

Creates or retrieves a user on the underlying JORAM server.

Specified by:

createUser in interface AdminItf

Parameters:

name - The login name of the user.

password - The password of the user.

Returns:

the user

Throws:

AdminException - If the creation fails.

ConnectException - If the connection 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 - The login name of the user.

password - The password of the user.

identityClass - The identity class used for authentication.

Returns:

the user

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

See Also:

createUser(String, String, int, String)

createUser

public User createUser(String name,
                       String password,
                       int serverId)
                throws AdminException,
                       ConnectException

Creates or retrieves a user on the given JORAM server.

Specified by:

createUser in interface AdminItf

Parameters:

name - The login name of the user.

password - The password of the user.

serverId - The unique identifier of the Joram server.

Returns:

the user

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

See Also:

createUser(String, String, int, String)

createUser

public User createUser(String name,
                       String password,
                       int serverId,
                       String identityClass)
                throws ConnectException,
                       AdminException

Creates or retrieves a user on the underlying JORAM server.

Specified by:

createUser in interface AdminItf

Parameters:

name - The login name of the user.

password - The password of the user.

serverId - The unique identifier of the Joram server.

identityClass - The identity class used for authentication.

Returns:

the user

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

createUser

public User createUser(String name,
                       String password,
                       int serverId,
                       String identityClassName,
                       Properties prop)
                throws ConnectException,
                       AdminException

Description copied from interface: AdminItf

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.

wrapUser

private final User wrapUser(User user)

getJMXBaseName

public String getJMXBaseName()

registerMBean

public void registerMBean(String base)

unregisterMBean

public void unregisterMBean()

doCreate

public static JoramAdmin doCreate(AbstractConnectionFactory cf,
                                  String name,
                                  String password,
                                  String identityClass)
                           throws ConnectException,
                                  AdminException

Opens a connection dedicated to administering with the Joram server which parameters are wrapped by a given ConnectionFactory.

Parameters:

cf - The Joram's ConnectionFactory to use for connecting.

name - Administrator's name.

password - Administrator's password.

identityClass - identity class name.

Throws:

ConnectException - If connecting fails.

AdminException - If the administrator identification is incorrect.

executeXMLAdmin

public void executeXMLAdmin(String cfgDir,
                            String cfgFileName)
                     throws 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.

Specified by:

executeXMLAdmin in interface JoramAdminMBean

Parameters:

cfgDir - The directory containing the file.

cfgFileName - The script filename.

Throws:

Exception

executeXMLAdmin

public void executeXMLAdmin(String path)
                     throws 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.

Specified by:

executeXMLAdmin in interface JoramAdminMBean

Parameters:

path - The script pathname.

Throws:

Exception

exportRepositoryToFile

public void exportRepositoryToFile(String exportDir,
                                   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)

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

Specified by:

exportRepositoryToFile in interface JoramAdminMBean

Parameters:

exportDir - target directory where the export file will be put

exportFilename - filename of the export file

Throws:

AdminException - if an error occurs

processAdmin

public org.objectweb.joram.shared.admin.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

Specified by:

processAdmin in interface JoramAdminMBean

Parameters:

targetId - agent Id target.

command - the command to execute.

prop - the properties.

Returns:

the reply.

Throws:

AdminException

ConnectException - If the connection fails.

queueCreate

public void queueCreate(String name)
                 throws AdminException,
                        ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.

Specified by:

queueCreate in interface JoramAdminMBean

Parameters:

name - The name of the queue.

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

JoramAdminMBean.queueCreate(int, String)

queueCreate

public void queueCreate(int serverId,
                        String name)
                 throws AdminException,
                        ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.

Specified by:

queueCreate in interface JoramAdminMBean

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the queue.

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

topicCreate

public void topicCreate(String name)
                 throws AdminException,
                        ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.

Specified by:

topicCreate in interface JoramAdminMBean

Parameters:

name - The name of the topic.

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

See Also:

JoramAdminMBean.topicCreate(int, String)

topicCreate

public void topicCreate(int serverId,
                        String name)
                 throws AdminException,
                        ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.

Specified by:

topicCreate in interface JoramAdminMBean

Parameters:

serverId - The identifier of the server where deploying the topic.

name - The name of the topic.

Throws:

AdminException - If the creation fails.

ConnectException - if the connection is closed or broken

getLocalUsers

public void getLocalUsers()
                   throws ConnectException,
                          AdminException

Description copied from interface: JoramAdminMBean

This method creates and registers MBeans for all the users on the local server.

Specified by:

getLocalUsers in interface JoramAdminMBean

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

JoramAdminMBean.getAllUsers(int)

getAllUsers

public void getAllUsers(int serverId)
                 throws ConnectException,
                        AdminException

Description copied from interface: JoramAdminMBean

This method creates and registers MBeans for all the users of the selected server.

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

Specified by:

getAllUsers in interface JoramAdminMBean

Parameters:

serverId - Unique identifier of the given server.

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

userCreate

public void userCreate(String name,
                       String password)
                throws AdminException,
                       ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a user on the underlying JORAM server.

Specified by:

userCreate in interface JoramAdminMBean

Parameters:

name - The login name of the user.

password - The password of the user.

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

See Also:

JoramAdminMBean.userCreate(String, String, int, String)

userCreate

public void userCreate(String name,
                       String password,
                       String identityClass)
                throws AdminException,
                       ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a user on the underlying JORAM server.

Specified by:

userCreate in interface JoramAdminMBean

Parameters:

name - The login name of the user.

password - The password of the user.

identityClass - The identity class used for authentication.

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

See Also:

JoramAdminMBean.userCreate(String, String, int, String)

userCreate

public void userCreate(String name,
                       String password,
                       int serverId)
                throws AdminException,
                       ConnectException

Description copied from interface: JoramAdminMBean

Creates or retrieves a user on the given JORAM server.

Specified by:

userCreate in interface JoramAdminMBean

Parameters:

name - The login name of the user.

password - The password of the user.

serverId - The unique identifier of the Joram server.

Throws:

AdminException - If the creation fails.

ConnectException - If the connection fails.

See Also:

JoramAdminMBean.userCreate(String, String, int, String)

userCreate

public void userCreate(String name,
                       String password,
                       int serverId,
                       String identityClass)
                throws ConnectException,
                       AdminException

Description copied from interface: JoramAdminMBean

Creates or retrieves a user on the underlying JORAM server.

Specified by:

userCreate in interface JoramAdminMBean

Parameters:

name - The login name of the user.

password - The password of the user.

serverId - The unique identifier of the Joram server.

identityClass - The identity class used for authentication.

Throws:

ConnectException - If the connection fails.

AdminException - If the creation fails.

getStatistics

public Hashtable getStatistics()
                        throws ConnectException,
                               AdminException

Description copied from interface: AdminItf

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:

AdminItf.getStatistics(int)

getStatistics

public Hashtable getStatistics(int serverId)
                        throws ConnectException,
                               AdminException

Description copied from interface: AdminItf

Returns statistics for the 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 Hashtable getJMXAttribute(String attname)
                          throws ConnectException,
                                 AdminException

Description copied from interface: AdminItf

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:

AdminItf.getStatistics(int)

getJMXAttribute

public Hashtable getJMXAttribute(int serverId,
                                 String attname)
                          throws ConnectException,
                                 AdminException

Description copied from interface: AdminItf

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.

getServersNames

public String[] getServersNames()
                         throws ConnectException,
                                AdminException

Description copied from interface: AdminItf

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:

AdminItf.getServers(String)

getServersNames

public String[] getServersNames(String domain)
                         throws ConnectException,
                                AdminException

Description copied from interface: AdminItf

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.

getLocalServer

public Server getLocalServer()
                      throws ConnectException,
                             AdminException

Description copied from interface: AdminItf

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 int getLocalServerId()
                     throws ConnectException,
                            AdminException

Description copied from interface: AdminItf

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:

AdminItf.getLocalServer()

getLocalHost

public String getLocalHost()
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

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:

AdminItf.getLocalServer()

getLocalName

public String getLocalName()
                    throws ConnectException,
                           AdminException

Description copied from interface: AdminItf

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:

AdminItf.getLocalServer()

doRequest

public org.objectweb.joram.shared.admin.AdminReply doRequest(org.objectweb.joram.shared.admin.AdminRequest request)
                                                      throws AdminException,
                                                             ConnectException

Description copied from interface: AdminItf

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:

AdminException - If the platform's reply is invalid, or if the request failed.

ConnectException - If the connection to the platform fails.

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

Description copied from interface: AdminItf

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.

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

Throws:

ConnectException

AdminException

addAMQPBridgeConnection

public String addAMQPBridgeConnection(int serverId,
                                      String urls)
                               throws ConnectException,
                                      AdminException

Description copied from interface: AdminItf

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

Description copied from interface: AdminItf

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

Description copied from interface: AdminItf

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

Description copied from interface: AdminItf

Removes the live connection to the specified AMQP 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

deleteJMSBridgeConnection

public String deleteJMSBridgeConnection(int serverId,
                                        String names,
                                        boolean async)
                                 throws ConnectException,
                                        AdminException

Description copied from interface: AdminItf

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)
                                  throws ConnectException,
                                         AdminException

Deprecated.

Description copied from interface: AdminItf

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

deleteJMSPBridgeConnection

public String deleteJMSPBridgeConnection(int serverId,
                                         String names,
                                         boolean async)
                                  throws ConnectException,
                                         AdminException

Deprecated.

Description copied from interface: AdminItf

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