|
Joram 5.3.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JoramAdapterMBean
Method Summary | |
---|---|
void |
createCF(java.lang.String name)
Creates a non managed connection factory and binds it to JNDI. |
java.lang.String |
createQueue(short serverId,
java.lang.String name)
Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance. |
java.lang.String |
createQueue(java.lang.String name)
Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance. |
void |
createQueueCF(java.lang.String name)
Creates a non managed PTP connection factory and binds it to JNDI. |
java.lang.String |
createTopic(short serverId,
java.lang.String name)
Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance. |
java.lang.String |
createTopic(java.lang.String name)
Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance. |
void |
createTopicCF(java.lang.String name)
Creates a non managed PubSub connection factory and binds it to JNDI. |
java.lang.String |
createUser(java.lang.String name,
java.lang.String password)
Creates or retrieves a user on the underlying JORAM server. |
java.lang.String |
createUser(java.lang.String name,
java.lang.String password,
short serverId)
Creates or retrieves a user on the given JORAM server. |
java.lang.String |
createUser(java.lang.String name,
java.lang.String password,
short serverId,
java.lang.String identityClass)
Creates or retrieves a user on the underlying JORAM server. |
java.lang.String |
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)
|
void |
exportRepositoryToFile(java.lang.String exportDir)
Export the repository content to an XML file with default filename |
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 |
getAdminFileExportXML()
|
java.lang.String |
getAdminFileXML()
Path to the XML file containing a description of the administered objects to create and bind. |
java.lang.Integer |
getCnxPendingTimer()
Period in milliseconds between two ping requests sent by the client connection to the server; if the server does not receive any ping request during more than 2 * cnxPendingTimer, the connection is considered as dead and processed as required. |
java.lang.Boolean |
getCollocatedServer()
Returns true if the Joram server is collocated. |
java.lang.String |
getConfiguration()
Returns the current servers configuration (a3servers.xml). |
java.lang.Integer |
getConnectingTimer()
Duration in seconds during which connecting is attempted (connecting might take time if the server is temporarily not reachable); the 0 value is set for connecting only once and aborting if connecting failed. |
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(short serverId)
Returns the unique identifier of the default dead message queue for a given server, null if not set. |
int |
getDefaultThreshold()
Returns the default threshold of the Joram server. |
int |
getDefaultThreshold(short serverId)
Returns the default threshold of the given Joram server. |
java.lang.String[] |
getDestinations()
Returns the list of all destinations that exist on the local server. |
java.lang.String[] |
getDestinations(short serverId)
Returns the list of all destinations that exist on the given server. |
java.lang.String |
getHostName()
Returns the location of the Joram server. |
java.lang.String |
getJMSProviderName()
Get the provider name: Joram. |
java.lang.String |
getJMSVersion()
Gets the JMS API version. |
java.lang.Boolean |
getPersistentPlatform()
Returns true if the Joram server is persistent. |
java.lang.String |
getPlatformConfigDir()
Path to the directory containing JORAM's configuration files ( a3servers.xml , a3debug.cfg
and admin file), needed when starting the collocated JORAM server. |
java.lang.String |
getProviderVersion()
Gets the Joram's implementation version. |
java.lang.Short |
getServerId()
Returns the unique identifier of the Joram server. |
java.lang.String |
getServerName()
Returns the name of the Joram server. |
java.lang.Integer |
getServerPort()
Returns the listening port of the Joram server. |
java.lang.Short[] |
getServersIds()
Returns the list of the platform's servers' identifiers. |
java.lang.String[] |
getServersNames()
Returns the list of the platform's servers' names. |
long |
getTimeOutToAbortRequest()
Gets timeout before abort a request. |
java.lang.Integer |
getTxPendingTimer()
Duration in seconds during which a JMS transacted (non XA) session might be pending; above that duration the session is rolled back and closed; the 0 value means "no timer". |
java.lang.String[] |
getUsers()
Returns the list of all users that exist on the local server. |
java.lang.String[] |
getUsers(short serverId)
Returns the list of all users that exist on a given server. |
void |
removeDestination(java.lang.String name)
Remove a destination specified by its JNDI name on the underlying JORAM platform. |
void |
resetDefaultDMQ()
Unset the default dead message queue for the local server. |
void |
resetDefaultDMQ(short serverId)
Unset the default dead message queue for the given server. |
void |
setDefaultThreshold(int threshold)
Sets the default threshold of the Joram server. |
void |
setDefaultThreshold(short serverId,
int threshold)
Sets the default threshold of the given Joram server. |
void |
setTimeOutToAbortRequest(long timeOut)
Sets timeout before abort a request. |
Method Detail |
---|
java.lang.String getJMSVersion()
java.lang.String getJMSProviderName()
java.lang.String getProviderVersion()
java.lang.Short getServerId()
java.lang.String getServerName()
java.lang.String getHostName()
java.lang.Integer getServerPort()
java.lang.Boolean getPersistentPlatform()
true
if the Joram server is persistent.
true
if the Joram server is persistent.java.lang.Boolean getCollocatedServer()
true
if the Joram server is collocated.
true
if the Joram server is collocated.java.lang.Integer getConnectingTimer()
java.lang.Integer getTxPendingTimer()
java.lang.Integer getCnxPendingTimer()
void setTimeOutToAbortRequest(long timeOut) throws java.net.ConnectException
timeOut
- timeout before abort a request.
java.net.ConnectException
AdminModule.setTimeOutToAbortRequest(long)
long getTimeOutToAbortRequest() throws java.net.ConnectException
java.net.ConnectException
AdminModule.getTimeOutToAbortRequest()
java.lang.String getDefaultDMQId() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.java.lang.String getDefaultDMQId(short 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 resetDefaultDMQ() throws java.net.ConnectException, AdminException
java.net.ConnectException
AdminException
void resetDefaultDMQ(short serverId) throws java.net.ConnectException, AdminException
serverId
- Unique identifier of the hiven server.
java.net.ConnectException
AdminException
int getDefaultThreshold() throws java.net.ConnectException, AdminException
java.net.ConnectException
AdminException
AdminModule.getDefaultThreshold()
int getDefaultThreshold(short serverId) throws java.net.ConnectException, AdminException
serverId
- Unique identifier of the given Joram server.
java.net.ConnectException
AdminException
AdminModule.getDefaultThreshold(int)
void setDefaultThreshold(int threshold) throws java.net.ConnectException, AdminException
threshold
- the default threshold of the Joram server.
java.net.ConnectException
AdminException
AdminModule.setDefaultThreshold(int)
void setDefaultThreshold(short serverId, int threshold) throws java.net.ConnectException, AdminException
serverId
- Unique identifier of the given Joram server.threshold
- the default threshold of the given Joram server.
java.net.ConnectException
AdminException
AdminModule.setDefaultThreshold(int, int)
java.lang.String[] getDestinations() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection is closed or broken.
AdminException
- Never thrown.getDestinations(short)
java.lang.String[] getDestinations(short 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(short)
java.lang.String 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(short, String)
java.lang.String createQueue(short 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 brokenjava.lang.String 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 broken#createTopic(int, String)
java.lang.String createTopic(short 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 removeDestination(java.lang.String name) throws AdminException
name
- The JNDI name of the destination.
AdminException
java.lang.String[] getUsers() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.getUsers(short)
java.lang.String[] getUsers(short 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.java.lang.String 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, short, String)
java.lang.String 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, short, String)
java.lang.String createUser(java.lang.String name, java.lang.String password, short 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, short, String)
java.lang.String createUser(java.lang.String name, java.lang.String password, short 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 createCF(java.lang.String name)
name
- Name of created connection factory.void createQueueCF(java.lang.String name)
name
- Name of created connection factory.void createTopicCF(java.lang.String name)
name
- Name of created connection factory.java.lang.String getPlatformConfigDir()
a3servers.xml
, a3debug.cfg
and admin file), needed when starting the collocated JORAM server.
java.lang.String getAdminFileXML()
java.lang.String getAdminFileExportXML()
void executeXMLAdmin(java.lang.String path) throws java.lang.Exception
java.lang.Exception
void exportRepositoryToFile(java.lang.String exportDir) throws AdminException
exportDir
- target directory where the export file will be put
AdminException
- if an error occursvoid 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 occursjava.lang.Short[] getServersIds() throws java.net.ConnectException, AdminException
AdminException
- If the request fails.
java.net.ConnectException
- If the connection fails.java.lang.String[] getServersNames() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- Never thrown.java.lang.String getConfiguration() throws java.net.ConnectException, AdminException
java.net.ConnectException
- If the connection fails.
AdminException
- If the request fails.
|
Joram 5.3.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |