public interface JoramAdapterMBean
Modifier and Type | Method and Description |
---|---|
void |
createCF(String name)
Creates a non managed connection factory and binds it to JNDI.
|
String |
createQueue(short serverId,
String name)
Creates or retrieves a queue destination on the underlying JORAM server,
(re)binds the corresponding
Queue instance. |
String |
createQueue(String name)
Creates or retrieves a queue destination on the underlying JORAM server,
(re)binds the corresponding
Queue instance. |
void |
createQueueCF(String name)
Creates a non managed PTP connection factory and binds it to JNDI.
|
String |
createTopic(short serverId,
String name)
Creates or retrieves a topic destination on the underlying JORAM server,
(re)binds the corresponding
Topic instance. |
String |
createTopic(String name)
Creates or retrieves a topic destination on the underlying JORAM server,
(re)binds the corresponding
Topic instance. |
void |
createTopicCF(String name)
Creates a non managed PubSub connection factory and binds it to JNDI.
|
String |
createUser(String name,
String password)
Creates or retrieves a user on the underlying JORAM server.
|
String |
createUser(String name,
String password,
short serverId)
Creates or retrieves a user on the given JORAM server.
|
String |
createUser(String name,
String password,
short serverId,
String identityClass)
Creates or retrieves a user on the underlying JORAM server.
|
String |
createUser(String name,
String password,
String identityClass)
Creates or retrieves a user on the underlying JORAM server.
|
void |
executeXMLAdmin(String path) |
void |
exportRepositoryToFile(String exportDir)
Export the repository content to an XML file with default filename
|
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)
|
long |
getAdminDurationBeforeChangeState()
get the duration of admin connection before change state.
|
String |
getAdminDurationBeforeChangeStateDate()
get the duration of admin connection before change state.
|
String |
getAdminFileExportXML() |
String |
getAdminFileXML()
Path to the XML file containing a description of the administered objects
to create and bind.
|
Boolean |
getCollocated()
Returns
true if the Joram server is collocated. |
Boolean |
getCollocatedServer()
Deprecated.
only needed for compatibility with JOnAS 5.2 administration GUI
|
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.
|
String |
getDefaultDMQId()
Returns the unique identifier of the default dead message queue for the local
server, null if not set.
|
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.
|
String[] |
getDestinations()
Returns the list of all destinations that exist on the local server.
|
String[] |
getDestinations(short serverId)
Returns the list of all destinations that exist on the given server.
|
String |
getHostName()
Returns the location of the Joram server.
|
String |
getIdentityClass()
Identity class needed for authentication
|
String |
getJMSProviderName()
Get the provider name: Joram.
|
String |
getJMSVersion()
Gets the JMS API version.
|
String |
getJndiName()
The Joram resource adapter jndi name.
|
String |
getName()
Returns the name of the resource adapter.
|
String |
getPlatformConfigDir()
Path to the directory containing JORAM's configuration files
(
a3servers.xml , a3debug.cfg
and admin file), needed when StartJoramServer is set to true. |
String |
getProviderVersion()
Gets the Joram's implementation version.
|
String |
getRootName()
login name for administrator.
|
Short |
getServerId()
Returns the unique identifier of the Joram server.
|
String |
getServerName()
Deprecated.
only needed for compatibility with JOnAS 5.2 administration GUI
|
Integer |
getServerPort()
Returns the listening port of the Joram server.
|
Short[] |
getServersIds()
Returns the list of the platform's servers' identifiers.
|
String[] |
getServersNames()
Returns the list of the platform's servers' names.
|
Boolean |
getStartJoramServer()
true if the resource adapter start the JoramServer
|
String |
getStorage()
The persistence directory of the JORAM server to start,
needed when StartJoramServer is set to true.
|
long |
getTimeOutToAbortRequest()
Gets timeout before abort a request.
|
String[] |
getUsers()
Returns the list of all users that exist on the local server.
|
String[] |
getUsers(short serverId)
Returns the list of all users that exist on a given server.
|
boolean |
isActive()
return the activity of the Joram administration connection.
|
void |
removeDestination(String name)
Remove a destination specified by its JNDI name on the underlying
JORAM platform.
|
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.
|
boolean isActive()
long getAdminDurationBeforeChangeState()
String getAdminDurationBeforeChangeStateDate()
String getJMSVersion()
String getJMSProviderName()
String getProviderVersion()
Short getServerId()
String getName()
String getHostName()
Integer getServerPort()
Boolean getCollocated()
true
if the Joram server is collocated.true
if the Joram server is collocated.Integer getConnectingTimer()
void setTimeOutToAbortRequest(long timeOut) throws ConnectException
timeOut
- timeout before abort a request.ConnectException
AdminModule.setTimeOutToAbortRequest(long)
long getTimeOutToAbortRequest() throws ConnectException
ConnectException
AdminModule.getTimeOutToAbortRequest()
String getDefaultDMQId() throws ConnectException, AdminException
ConnectException
- If the connection fails.AdminException
- Never thrown.String getDefaultDMQId(short serverId) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- Unique identifier of the given server.ConnectException
- If the connection fails.AdminException
- If the request fails.void resetDefaultDMQ(short serverId) throws ConnectException, AdminException
serverId
- Unique identifier of the hiven server.ConnectException
AdminException
int getDefaultThreshold() throws ConnectException, AdminException
ConnectException
AdminException
AdminModule.getDefaultThreshold()
int getDefaultThreshold(short serverId) throws ConnectException, AdminException
serverId
- Unique identifier of the given Joram server.ConnectException
AdminException
AdminModule.getDefaultThreshold(int)
void setDefaultThreshold(int threshold) throws ConnectException, AdminException
threshold
- the default threshold of the Joram server.ConnectException
AdminException
AdminModule.setDefaultThreshold(int)
void setDefaultThreshold(short serverId, int threshold) throws ConnectException, AdminException
serverId
- Unique identifier of the given Joram server.threshold
- the default threshold of the given Joram server.ConnectException
AdminException
AdminModule.setDefaultThreshold(int, int)
String[] getDestinations() throws ConnectException, AdminException
ConnectException
- If the connection is closed or broken.AdminException
- Never thrown.getDestinations(short)
String[] getDestinations(short serverId) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform.
ConnectException
- If the connection is closed or broken.AdminException
- Never thrown.getDestinations(short)
String createQueue(String name) throws AdminException, ConnectException
Queue
instance.name
- The name of the queue.AdminException
- If the creation fails.ConnectException
- if the connection is closed or brokencreateQueue(short, String)
String createQueue(short serverId, String name) throws AdminException, ConnectException
Queue
instance.serverId
- The identifier of the server where deploying the queue.name
- The name of the queue.AdminException
- If the creation fails.ConnectException
- if the connection is closed or brokenString createTopic(String name) throws AdminException, ConnectException
Topic
instance.name
- The name of the topic.AdminException
- If the creation fails.ConnectException
- if the connection is closed or broken#createTopic(int, String)
String createTopic(short serverId, String name) throws AdminException, ConnectException
Topic
instance.serverId
- The identifier of the server where deploying the topic.name
- The name of the topic.AdminException
- If the creation fails.ConnectException
- if the connection is closed or brokenvoid removeDestination(String name) throws AdminException
name
- The JNDI name of the destination.AdminException
String[] getUsers() throws ConnectException, AdminException
ConnectException
- If the connection fails.AdminException
- Never thrown.getUsers(short)
String[] getUsers(short serverId) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform.
serverId
- Unique identifier of the given server.ConnectException
- If the connection fails.AdminException
- If the request fails.String createUser(String name, String password) throws AdminException, ConnectException
name
- The login name of the user.password
- The password of the user.AdminException
- If the creation fails.ConnectException
- If the connection fails.createUser(String, String, short, String)
String createUser(String name, String password, String identityClass) throws AdminException, 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.ConnectException
- If the connection fails.createUser(String, String, short, String)
String createUser(String name, String password, short serverId) throws AdminException, 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.ConnectException
- If the connection fails.createUser(String, String, short, String)
String createUser(String name, String password, short serverId, String identityClass) throws 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.ConnectException
- If the connection fails.void createCF(String name) throws Exception
name
- Name of created connection factory.Exception
void createQueueCF(String name)
name
- Name of created connection factory.void createTopicCF(String name)
name
- Name of created connection factory.String getPlatformConfigDir()
a3servers.xml
, a3debug.cfg
and admin file), needed when StartJoramServer is set to true.String getAdminFileXML()
String getAdminFileExportXML()
void exportRepositoryToFile(String exportDir) throws AdminException
exportDir
- target directory where the export file will be putAdminException
- if an error occursvoid exportRepositoryToFile(String exportDir, String exportFilename) throws AdminException
exportDir
- target directory where the export file will be putexportFilename
- filename of the export fileAdminException
- if an error occursShort[] getServersIds() throws ConnectException, AdminException
AdminException
- If the request fails.ConnectException
- If the connection fails.String[] getServersNames() throws ConnectException, AdminException
ConnectException
- If the connection fails.AdminException
- Never thrown.String getStorage()
String getJndiName()
String getRootName()
String getIdentityClass()
Boolean getStartJoramServer()
Boolean getCollocatedServer()
getCollocatedServer()
String getServerName()
getServerName()
Copyright © 2023 ScalAgent D.T.. All rights reserved.