|
Joram 5.3.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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()
This method creates and registers MBeans for all the destinations on the local server. |
void |
getDestinations(int serverId)
This method creates and registers MBeans for all the destinations of the selected 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()
This method creates and registers MBeans for all the users on the local server. |
void |
getUsers(int serverId)
This method creates and registers MBeans for all the users of the selected 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 |
---|
void exit()
void setTimeOutToAbortRequest(long timeOut) throws java.net.ConnectException
timeOut
- the maximum time before a command is canceled.
java.net.ConnectException
- A problem occurs during connection.long getTimeOutToAbortRequest() throws java.net.ConnectException
java.net.ConnectException
- A problem occurs during connection.void stopServer() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.stopServer(int)
void stopServer(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- Identifier of the server to stop.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void addServer(int sid, java.lang.String host, java.lang.String domain, int port, java.lang.String server) throws java.net.ConnectException, AdminException
The server is configured without any service.
sid
- Id of the added serverhost
- Address of the host where the added server is starteddomain
- Name of the domain where the server is addedport
- Listening port of the server in the specified domainserver
- Name of the added server
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void removeServer(int sid) throws java.net.ConnectException, AdminException
sid
- Id of the removed server
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void addDomain(java.lang.String domain, int sid, int port) throws java.net.ConnectException, AdminException
The domain will use the default network component "SimpleNetwork".
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.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void addDomain(java.lang.String domain, java.lang.String network, int sid, int port) throws java.net.ConnectException, AdminException
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.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void removeDomain(java.lang.String domain) throws java.net.ConnectException, AdminException
domain
- Name of the domain to remove
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.java.lang.String getConfiguration() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.int[] getServersIds() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.getServersIds(String)
int[] getServersIds(java.lang.String domain) throws java.net.ConnectException, AdminException
domain
- Name of the domain.
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.java.lang.String[] getDomainNames(int serverId) throws java.net.ConnectException, AdminException
serverId
- Unique identifier of the server.
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.java.lang.String getDefaultDMQId(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- Unique identifier of the server.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void setDefaultDMQId(int serverId, java.lang.String dmqId) throws java.net.ConnectException, AdminException
null
for unsetting previous DMQ).
The request fails if the target server does not belong to the platform.
serverId
- The identifier of the server.dmqId
- The dmqId (AgentId) to be set as the default one.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void setDefaultDMQId(java.lang.String dmqId) throws java.net.ConnectException, AdminException
null
for unsetting previous DMQ).
dmqId
- The dmqId (AgentId) to be set as the default one.
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.setDefaultDMQId(int, String)
java.lang.String getDefaultDMQId() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.getDefaultDMQId(int)
void setDefaultThreshold(int serverId, int threshold) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- The identifier of the server.threshold
- The threshold value to be set.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void setDefaultThreshold(int threshold) throws java.net.ConnectException, AdminException
threshold
- The threshold value to be set.
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.setDefaultThreshold(int, int)
int getDefaultThreshold(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.int getDefaultThreshold() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.getDefaultThreshold(int)
void getDestinations() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection is closed or broken.
AdminException
- Never thrown.getDestinations(int)
void getDestinations(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
java.net.ConnectException
- If the connection is closed or broken.
AdminException
- Never thrown.getDestinations()
void createQueue(java.lang.String name) throws AdminException, java.net.ConnectException
Queue
instance.
name
- The name of the queue.
AdminException
- If the creation fails.
java.net.ConnectException
- if the connection is closed or brokencreateQueue(int, String)
void createQueue(int serverId, java.lang.String name) throws AdminException, java.net.ConnectException
Queue
instance.
serverId
- The identifier of the server where deploying the queue.name
- The name of the queue.
AdminException
- If the creation fails.
java.net.ConnectException
- if the connection is closed or brokenvoid createTopic(java.lang.String name) throws AdminException, java.net.ConnectException
Topic
instance.
name
- The name of the topic.
AdminException
- If the creation fails.
java.net.ConnectException
- if the connection is closed or brokencreateTopic(int, String)
void createTopic(int serverId, java.lang.String name) throws AdminException, java.net.ConnectException
Topic
instance.
serverId
- The identifier of the server where deploying the topic.name
- The name of the topic.
AdminException
- If the creation fails.
java.net.ConnectException
- if the connection is closed or brokenvoid getUsers() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.getUsers(int)
void getUsers(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- Unique identifier of the given server.
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.void createUser(java.lang.String name, java.lang.String password) throws AdminException, java.net.ConnectException
name
- The login name of the user.password
- The password of the user.
AdminException
- If the creation fails.
java.net.ConnectException
- If the connection fails.createUser(String, String, int, String)
void createUser(java.lang.String name, java.lang.String password, java.lang.String identityClass) throws AdminException, java.net.ConnectException
name
- The login name of the user.password
- The password of the user.identityClass
- The identity class used for authentication.
AdminException
- If the creation fails.
java.net.ConnectException
- If the connection fails.createUser(String, String, int, String)
void createUser(java.lang.String name, java.lang.String password, int serverId) throws AdminException, java.net.ConnectException
name
- The login name of the user.password
- The password of the user.serverId
- The unique identifier of the Joram server.
AdminException
- If the creation fails.
java.net.ConnectException
- If the connection fails.createUser(String, String, int, String)
void createUser(java.lang.String name, java.lang.String password, int serverId, java.lang.String identityClass) throws java.net.ConnectException, AdminException
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.
AdminException
- If the creation fails.
java.net.ConnectException
- If the connection fails.void exportRepositoryToFile(java.lang.String exportDir, java.lang.String exportFilename) throws AdminException
exportDir
- target directory where the export file will be putexportFilename
- filename of the export file
AdminException
- if an error occursvoid executeXMLAdmin(java.lang.String cfgDir, java.lang.String cfgFileName) throws java.lang.Exception
Be careful, currently this method use the static administration connection through the AdminModule Class.
cfgDir
- The directory containing the file.cfgFileName
- The script filename.
java.lang.Exception
void executeXMLAdmin(java.lang.String path) throws java.lang.Exception
Be careful, currently this method use the static administration connection through the AdminModule Class.
path
- The script pathname.
java.lang.Exception
|
Joram 5.3.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |