Joram 5.3.0

org.objectweb.joram.client.connector
Interface JoramAdapterMBean

All Known Implementing Classes:
JoramAdapter

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

getJMSVersion

java.lang.String getJMSVersion()
Gets the JMS API version.

Returns:
The JMS API version.

getJMSProviderName

java.lang.String getJMSProviderName()
Get the provider name: Joram.

Returns:
The provider name: Joram.

getProviderVersion

java.lang.String getProviderVersion()
Gets the Joram's implementation version.

Returns:
The Joram's implementation version.

getServerId

java.lang.Short getServerId()
Returns the unique identifier of the Joram server.

Returns:
The unique identifier of the Joram server.

getServerName

java.lang.String getServerName()
Returns the name of the Joram server.

Returns:
The name of the Joram server.

getHostName

java.lang.String getHostName()
Returns the location of the Joram server.

Returns:
The location of the Joram server.

getServerPort

java.lang.Integer getServerPort()
Returns the listening port of the Joram server.

Returns:
The listening port of the Joram server.

getPersistentPlatform

java.lang.Boolean getPersistentPlatform()
Returns true if the Joram server is persistent.

Returns:
true if the Joram server is persistent.

getCollocatedServer

java.lang.Boolean getCollocatedServer()
Returns true if the Joram server is collocated.

Returns:
true if the Joram server is collocated.

getConnectingTimer

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.


getTxPendingTimer

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


getCnxPendingTimer

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.


setTimeOutToAbortRequest

void setTimeOutToAbortRequest(long timeOut)
                              throws java.net.ConnectException
Sets timeout before abort a request.

Parameters:
timeOut - timeout before abort a request.
Throws:
java.net.ConnectException
See Also:
AdminModule.setTimeOutToAbortRequest(long)

getTimeOutToAbortRequest

long getTimeOutToAbortRequest()
                              throws java.net.ConnectException
Gets timeout before abort a request.

Returns:
timeout before abort a request.
Throws:
java.net.ConnectException
See Also:
AdminModule.getTimeOutToAbortRequest()

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 dead message queue of the local server or null if none exists.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.

getDefaultDMQId

java.lang.String getDefaultDMQId(short serverId)
                                 throws java.net.ConnectException,
                                        AdminException
Returns the unique identifier of the default dead message queue for a given server, null if not set.

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

Parameters:
serverId - Unique identifier of the given server.
Returns:
The unique identifier of the dead message queue of the given server or null if none exists.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

resetDefaultDMQ

void resetDefaultDMQ()
                     throws java.net.ConnectException,
                            AdminException
Unset the default dead message queue for the local server.

Throws:
java.net.ConnectException
AdminException

resetDefaultDMQ

void resetDefaultDMQ(short serverId)
                     throws java.net.ConnectException,
                            AdminException
Unset the default dead message queue for the given server.

Parameters:
serverId - Unique identifier of the hiven server.
Throws:
java.net.ConnectException
AdminException

getDefaultThreshold

int getDefaultThreshold()
                        throws java.net.ConnectException,
                               AdminException
Returns the default threshold of the Joram server.

Returns:
the default threshold of the Joram server.
Throws:
java.net.ConnectException
AdminException
See Also:
AdminModule.getDefaultThreshold()

getDefaultThreshold

int getDefaultThreshold(short serverId)
                        throws java.net.ConnectException,
                               AdminException
Returns the default threshold of the given Joram server.

Parameters:
serverId - Unique identifier of the given Joram server.
Returns:
the default threshold of the given Joram server.
Throws:
java.net.ConnectException
AdminException
See Also:
AdminModule.getDefaultThreshold(int)

setDefaultThreshold

void setDefaultThreshold(int threshold)
                         throws java.net.ConnectException,
                                AdminException
Sets the default threshold of the Joram server.

Parameters:
threshold - the default threshold of the Joram server.
Throws:
java.net.ConnectException
AdminException
See Also:
AdminModule.setDefaultThreshold(int)

setDefaultThreshold

void setDefaultThreshold(short serverId,
                         int threshold)
                         throws java.net.ConnectException,
                                AdminException
Sets the default threshold of the given Joram server.

Parameters:
serverId - Unique identifier of the given Joram server.
threshold - the default threshold of the given Joram server.
Throws:
java.net.ConnectException
AdminException
See Also:
AdminModule.setDefaultThreshold(int, int)

getDestinations

java.lang.String[] 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.

Returns:
An array containing the object name of all destinations defined on the given server or null if none exists.
Throws:
java.net.ConnectException - If the connection is closed or broken.
AdminException - Never thrown.
See Also:
getDestinations(short)

getDestinations

java.lang.String[] getDestinations(short 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.

Returns:
An array containing the object name of all destinations defined on the given server or null if none exists.
Throws:
java.net.ConnectException - If the connection is closed or broken.
AdminException - Never thrown.
See Also:
getDestinations(short)

createQueue

java.lang.String 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(short, String)

createQueue

java.lang.String createQueue(short 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

createTopic

java.lang.String 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)

createTopic

java.lang.String createTopic(short 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

removeDestination

void removeDestination(java.lang.String name)
                       throws AdminException
Remove a destination specified by its JNDI name on the underlying JORAM platform.

Parameters:
name - The JNDI name of the destination.
Throws:
AdminException

getUsers

java.lang.String[] 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.

Returns:
An array containing the object name of all users defined on the given server or null if none exists.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.
See Also:
getUsers(short)

getUsers

java.lang.String[] getUsers(short 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.
Returns:
An array containing the object name of all users defined on the given server or null if none exists.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

createUser

java.lang.String 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.
Returns:
The object name of created user.
Throws:
AdminException - If the creation fails.
java.net.ConnectException - If the connection fails.
See Also:
createUser(String, String, short, String)

createUser

java.lang.String 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.
Returns:
The object name of created user.
Throws:
AdminException - If the creation fails.
java.net.ConnectException - If the connection fails.
See Also:
createUser(String, String, short, String)

createUser

java.lang.String createUser(java.lang.String name,
                            java.lang.String password,
                            short 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.
Returns:
The object name of created user.
Throws:
AdminException - If the creation fails.
java.net.ConnectException - If the connection fails.
See Also:
createUser(String, String, short, String)

createUser

java.lang.String createUser(java.lang.String name,
                            java.lang.String password,
                            short 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.
Returns:
The object name of created user.
Throws:
AdminException - If the creation fails.
java.net.ConnectException - If the connection fails.

createCF

void createCF(java.lang.String name)
Creates a non managed connection factory and binds it to JNDI.

Parameters:
name - Name of created connection factory.

createQueueCF

void createQueueCF(java.lang.String name)
Creates a non managed PTP connection factory and binds it to JNDI.

Parameters:
name - Name of created connection factory.

createTopicCF

void createTopicCF(java.lang.String name)
Creates a non managed PubSub connection factory and binds it to JNDI.

Parameters:
name - Name of created connection factory.

getPlatformConfigDir

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.


getAdminFileXML

java.lang.String getAdminFileXML()
Path to the XML file containing a description of the administered objects to create and bind.


getAdminFileExportXML

java.lang.String getAdminFileExportXML()

executeXMLAdmin

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

exportRepositoryToFile

void exportRepositoryToFile(java.lang.String exportDir)
                            throws AdminException
Export the repository content to an XML file with default filename. - 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
Throws:
AdminException - if an error occurs

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

getServersIds

java.lang.Short[] getServersIds()
                                throws java.net.ConnectException,
                                       AdminException
Returns the list of the platform's servers' identifiers.

Returns:
an array containing the list of the platform's servers' identifiers.
Throws:
AdminException - If the request fails.
java.net.ConnectException - If the connection fails.

getServersNames

java.lang.String[] getServersNames()
                                   throws java.net.ConnectException,
                                          AdminException
Returns the list of the platform's servers' names.

Returns:
An array containing the list of server's names.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - Never thrown.

getConfiguration

java.lang.String getConfiguration()
                                  throws java.net.ConnectException,
                                         AdminException
Returns the current servers configuration (a3servers.xml).

Returns:
The current servers configuration.
Throws:
java.net.ConnectException - If the connection fails.
AdminException - If the request fails.

Joram 5.3.0

Copyright © 2000 - 2009 Scalagent D.T. - All rights reserved