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

All Known Implementing Classes:

JoramAdmin

public interface JoramAdminMBean

MBean interface for JoramAdmin.

Method Summary

void	addDomain(java.lang.String domain, int sid, int port) Adds a domain to the platform.
void	addDomain(java.lang.String domain, java.lang.String network, int sid, int port) Adds a domain to the platform using a specific network component.
void	addServer(int sid, java.lang.String host, java.lang.String domain, int port, java.lang.String server) Adds a server to the platform.
void	createQueue(int serverId, java.lang.String name) Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
void	createQueue(java.lang.String name) Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
void	createTopic(int serverId, java.lang.String name) Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
void	createTopic(java.lang.String name) Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
void	createUser(java.lang.String name, java.lang.String password) Creates or retrieves a user on the underlying JORAM server.
void	createUser(java.lang.String name, java.lang.String password, int serverId) Creates or retrieves a user on the given JORAM server.
void	createUser(java.lang.String name, java.lang.String password, int serverId, java.lang.String identityClass) Creates or retrieves a user on the underlying JORAM server.
void	createUser(java.lang.String name, java.lang.String password, java.lang.String identityClass) Creates or retrieves a user on the underlying JORAM server.
void	executeXMLAdmin(java.lang.String path) This method execute the XML script file that the pathname is given in parameter.
void	executeXMLAdmin(java.lang.String cfgDir, java.lang.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(java.lang.String exportDir, java.lang.String exportFilename) Export the repository content to an XML file - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)
java.lang.String	getConfiguration() Returns the current servers configuration (equivalent to the a3servers.xml file).
java.lang.String	getDefaultDMQId() Returns the unique identifier of the default dead message queue for the local server, null if not set.
java.lang.String	getDefaultDMQId(int serverId) Returns the unique identifier of the default dead message queue for the local server, null if not set.
int	getDefaultThreshold() Returns the default threshold value for the local server, -1 if not set.
int	getDefaultThreshold(int serverId) Returns the default threshold value for a given server, -1 if not set.
void	getDestinations() Returns the list of all destinations that exist on the local server.
void	getDestinations(int serverId) Returns the list of all destinations that exist on the given server.
java.lang.String[]	getDomainNames(int serverId) Returns the list of the domain names that contains the specified server.
int[]	getServersIds() Returns the list of the platform's servers' identifiers.
int[]	getServersIds(java.lang.String domain) Returns the list of the servers' identifiers that belong to the specified domain
long	getTimeOutToAbortRequest() Gets the maximum time a command has to complete before it is canceled.
void	getUsers() Returns the list of all users that exist on the local server.
void	getUsers(int serverId) Returns the list of all users that exist on a given server.
void	removeDomain(java.lang.String domain) Removes a domain from the platform.
void	removeServer(int sid) Removes a server from the platform.
void	setDefaultDMQId(int serverId, java.lang.String dmqId) Sets a given dead message queue as the default DMQ for a given server (null for unsetting previous DMQ).
void	setDefaultDMQId(java.lang.String dmqId) Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).
void	setDefaultThreshold(int threshold) Sets a given value as the default threshold for the local server (-1 for unsetting previous value).
void	setDefaultThreshold(int serverId, int threshold) Sets a given value as the default threshold for a given server (-1 for unsetting previous value).
void	setTimeOutToAbortRequest(long timeOut) 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.

Method Detail

exit

void exit()

Closes the administration connection and unregister the MBean.

setTimeOutToAbortRequest

void setTimeOutToAbortRequest(long timeOut)
                              throws java.net.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.

Parameters:

timeOut - the maximum time before a command is canceled.

Throws:

java.net.ConnectException - A problem occurs during connection.

getTimeOutToAbortRequest

long getTimeOutToAbortRequest()
                              throws java.net.ConnectException

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

Returns:

the maximum time before a command is canceled

Throws:

java.net.ConnectException - A problem occurs during connection.

stopServer

void stopServer()
                throws java.net.ConnectException,
                       AdminException

Stops the platform local server.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

See Also:

stopServer(int)

stopServer

void stopServer(int serverId)
                throws java.net.ConnectException,
                       AdminException

Stops a given server of the platform.

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

Parameters:

serverId - Identifier of the server to stop.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

addServer

void addServer(int sid,
               java.lang.String host,
               java.lang.String domain,
               int port,
               java.lang.String server)
               throws java.net.ConnectException,
                      AdminException

Adds a server to the platform.

The server is configured without any service.

Parameters:

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:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

See Also:

#addServer(int, String, String, int, String, String[], String[])

removeServer

void removeServer(int sid)
                  throws java.net.ConnectException,
                         AdminException

Removes a server from the platform.

Parameters:

sid - Id of the removed server

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

addDomain

void addDomain(java.lang.String domain,
               int sid,
               int port)
               throws java.net.ConnectException,
                      AdminException

Adds a domain to the platform.

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

Parameters:

domain - Name of the added domain.

sid - Id of the router server that gives access to the added domain.

port - Listening port in the added domain of the router server.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

addDomain

void addDomain(java.lang.String domain,
               java.lang.String network,
               int sid,
               int port)
               throws java.net.ConnectException,
                      AdminException

Adds a domain to the platform using a specific network component.

Parameters:

domain - Name of the added domain.

network - Classname of the network component to use.

sid - Id of the router server that gives access to the added domain.

port - Listening port in the added domain of the router server.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

removeDomain

void removeDomain(java.lang.String domain)
                  throws java.net.ConnectException,
                         AdminException

Removes a domain from the platform.

Parameters:

domain - Name of the domain to remove

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

getConfiguration

java.lang.String getConfiguration()
                                  throws java.net.ConnectException,
                                         AdminException

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

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

getServersIds

int[] getServersIds()
                    throws java.net.ConnectException,
                           AdminException

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

Returns:

An array containing the list of server's identifiers.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getServersIds(String)

getServersIds

int[] getServersIds(java.lang.String domain)
                    throws java.net.ConnectException,
                           AdminException

Returns the list of the servers' identifiers that belong to the specified domain

Parameters:

domain - Name of the domain.

Returns:

An array containing the list of server's identifiers of the specified domain.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

getDomainNames

java.lang.String[] getDomainNames(int serverId)
                                  throws java.net.ConnectException,
                                         AdminException

Returns the list of the domain names that contains the specified server.

Parameters:

serverId - Unique identifier of the server.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

getDefaultDMQId

java.lang.String getDefaultDMQId(int serverId)
                                 throws java.net.ConnectException,
                                        AdminException

Returns the unique identifier of the default dead message queue for the local server, null if not set.

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

Parameters:

serverId - Unique identifier of the server.

Returns:

The unique identifier of the default dead message queue for the local server, null if not set.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

setDefaultDMQId

void setDefaultDMQId(int serverId,
                     java.lang.String dmqId)
                     throws java.net.ConnectException,
                            AdminException

Sets a given dead message queue as the default DMQ for a given server (null for unsetting previous DMQ).

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

Parameters:

serverId - The identifier of the server.

dmqId - The dmqId (AgentId) to be set as the default one.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

setDefaultDMQId

void setDefaultDMQId(java.lang.String dmqId)
                     throws java.net.ConnectException,
                            AdminException

Sets a given dead message queue as the default DMQ for the local server (null for unsetting previous DMQ).

Parameters:

dmqId - The dmqId (AgentId) to be set as the default one.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

setDefaultDMQId(int, String)

getDefaultDMQId

java.lang.String getDefaultDMQId()
                                 throws java.net.ConnectException,
                                        AdminException

Returns the unique identifier of the default dead message queue for the local server, null if not set.

Returns:

The unique identifier of the default dead message queue for the local server, null if not set.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getDefaultDMQId(int)

setDefaultThreshold

void setDefaultThreshold(int serverId,
                         int threshold)
                         throws java.net.ConnectException,
                                AdminException

Sets a given value as the default threshold for a given server (-1 for unsetting previous value).

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

Parameters:

serverId - The identifier of the server.

threshold - The threshold value to be set.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

setDefaultThreshold

void setDefaultThreshold(int threshold)
                         throws java.net.ConnectException,
                                AdminException

Sets a given value as the default threshold for the local server (-1 for unsetting previous value).

Parameters:

threshold - The threshold value to be set.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

setDefaultThreshold(int, int)

getDefaultThreshold

int getDefaultThreshold(int serverId)
                        throws java.net.ConnectException,
                               AdminException

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

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

Returns:

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

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

getDefaultThreshold

int getDefaultThreshold()
                        throws java.net.ConnectException,
                               AdminException

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

Returns:

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

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getDefaultThreshold(int)

getDestinations

void getDestinations()
                     throws java.net.ConnectException,
                            AdminException

Returns the list of all destinations that exist on the local server. This method creates and registers MBeans for all the destinations of the selected servers.

Throws:

java.net.ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations(int)

getDestinations

void getDestinations(int serverId)
                     throws java.net.ConnectException,
                            AdminException

Returns the list of all destinations that exist on the given server. This method creates and registers MBeans for all the destinations of the selected servers.

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

Throws:

java.net.ConnectException - If the connection is closed or broken.

AdminException - Never thrown.

See Also:

getDestinations(int)

createQueue

void createQueue(java.lang.String name)
                 throws AdminException,
                        java.net.ConnectException

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

Parameters:

name - The name of the queue.

Throws:

AdminException - If the creation fails.

java.net.ConnectException - if the connection is closed or broken

See Also:

#createQueue(int, String, String, Properties)

createQueue

void createQueue(int serverId,
                 java.lang.String name)
                 throws AdminException,
                        java.net.ConnectException

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

Parameters:

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

name - The name of the queue.

Throws:

AdminException - If the creation fails.

java.net.ConnectException - if the connection is closed or broken

See Also:

#createQueue(int, String, String, Properties)

createTopic

void createTopic(java.lang.String name)
                 throws AdminException,
                        java.net.ConnectException

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

Parameters:

name - The name of the topic.

Throws:

AdminException - If the creation fails.

java.net.ConnectException - if the connection is closed or broken

See Also:

#createTopic(int, String, String, Properties)

createTopic

void createTopic(int serverId,
                 java.lang.String name)
                 throws AdminException,
                        java.net.ConnectException

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

Parameters:

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

name - The name of the topic.

Throws:

AdminException - If the creation fails.

java.net.ConnectException - if the connection is closed or broken

See Also:

#createTopic(int, String, String, Properties)

getUsers

void getUsers()
              throws java.net.ConnectException,
                     AdminException

Returns the list of all users that exist on the local server. This method creates and registers MBeans for all the users of the selected servers.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - Never thrown.

See Also:

getUsers(int)

getUsers

void getUsers(int serverId)
              throws java.net.ConnectException,
                     AdminException

Returns the list of all users that exist on a given server. This method creates and registers MBeans for all the users of the selected servers.

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

Parameters:

serverId - Unique identifier of the given server.

Throws:

java.net.ConnectException - If the connection fails.

AdminException - If the request fails.

createUser

void createUser(java.lang.String name,
                java.lang.String password)
                throws AdminException,
                       java.net.ConnectException

Creates or retrieves a user on the underlying JORAM server.

Parameters:

name - The login name of the user.

password - The password of the user.

Throws:

AdminException - If the creation fails.

java.net.ConnectException - If the connection fails.

See Also:

createUser(String, String, int, String)

createUser

void createUser(java.lang.String name,
                java.lang.String password,
                java.lang.String identityClass)
                throws AdminException,
                       java.net.ConnectException

Creates or retrieves a user on the underlying JORAM server.

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.

java.net.ConnectException - If the connection fails.

See Also:

createUser(String, String, int, String)

createUser

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

Creates or retrieves a user on the given JORAM server.

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.

java.net.ConnectException - If the connection fails.

See Also:

createUser(String, String, int, String)

createUser

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

Creates or retrieves a user on the underlying JORAM server.

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:

AdminException - If the creation fails.

java.net.ConnectException - If the connection fails.

exportRepositoryToFile

void exportRepositoryToFile(java.lang.String exportDir,
                            java.lang.String exportFilename)
                            throws AdminException

Export the repository content to an XML file - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)

Parameters:

exportDir - target directory where the export file will be put

exportFilename - filename of the export file

Throws:

AdminException - if an error occurs

executeXMLAdmin

void executeXMLAdmin(java.lang.String cfgDir,
                     java.lang.String cfgFileName)
                     throws java.lang.Exception

This method execute the XML script file that the location is given in parameter.

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

Parameters:

cfgDir - The directory containing the file.

cfgFileName - The script filename.

Throws:

java.lang.Exception

executeXMLAdmin

void executeXMLAdmin(java.lang.String path)
                     throws java.lang.Exception

This method execute the XML script file that the pathname is given in parameter.

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

Parameters:

path - The script pathname.

Throws:

java.lang.Exception