java.lang.Object
- org.ow2.joram.jakarta.connector.JoramResourceAdapter
- - org.ow2.joram.jakarta.connector.JoramAdapter

All Implemented Interfaces:

jakarta.jms.ExceptionListener, jakarta.resource.spi.ResourceAdapter, Serializable, JoramAdapterMBean
```
public final class JoramAdapter
extends JoramResourceAdapter
implements JoramAdapterMBean, jakarta.jms.ExceptionListener
```
A JoramAdapter instance manages connectivities to an underlying JORAM server: outbound connectivity (JCA connection management contract) and inbound connectivity (asynchronous message delivery as specified by the JCA message inflow contract).

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter
  JoramResourceAdapter.Status

Field Summary

Fields
Modifier and Type	Field	Description
`private long`	`adminDurationState`	The duration of admin connection before change state.
`private String`	`adminFileExportXML`	Path to the XML file containing a description of the exported administered objects (destination) from the platform.
`private String`	`adminFileXML`	Path to the XML file (joramAdmin.xml) containing a description of the administered objects to create and bind.
`private jakarta.jms.Connection`	`cnx`
`private boolean`	`collocated`	`true` if the underlying JORAM server is collocated.
`private int`	`connectingTimer`	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.
`private static boolean`	`DEBUG`
`private String`	`hostName`	Host name or IP of the underlying JORAM server. localhost if collocated.
`private String`	`identityClass`	Identity class needed for authentication
`private boolean`	`isActive`	`true` if admin connection connection is active.
`private static Logger`	`logger`
`private String`	`platformConfigDir`	Path to the directory containing JORAM's configuration files (`a3servers.xml`, `a3debug.cfg` and admin file), needed when StartJoramServer is set to true.
`private org.osgi.framework.ServiceRegistration<?>`	`registration`
`private String`	`rootName`	login name for administrator.
`private String`	`rootPasswd`	password for administrator
`private static long`	`serialVersionUID`	Define serialVersionUID for interoperability.
`private ServerDesc`	`serverDesc`
`private short`	`serverId`	Identifier of the JORAM server to start.
`private int`	`serverPort`	Port number of the underlying JORAM server. -1 if collocated
`private boolean`	`startJoramServer`	true start the JoramServer
`private String`	`storage`	the persistence directory of the JORAM server to start, needed when StartJoramServer is set to true.
`private JoramAdmin`	`wrapper`

Fields inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter
jmxRootName, jndiHelper, jndiName, name, status

Constructor Summary

Constructors
Constructor Description

JoramAdapter()
Constructs a JoramAdapter instance.

JoramAdapter(MBeanServer jmxServer)
Constructs a JoramAdapter instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`(package private) void`	`adminConnect()`	Initiates an admin session.
`(package private) void`	`adminDisconnect()`
`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(short serverId, String name, String className, Properties prop)`	First tries to retrieve a queue destination on the underlying JORAM server first using JNDI then the Joram's internal name service.
`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(short serverId, String name, String className, Properties prop)`	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.
`boolean`	`equals(Object o)`	Compares adapters according to their properties.
`void`	`executeXMLAdmin(String path)`	Executes the XML configuration file.
`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 duration of admin connection before change state.
`String`	`getAdminDurationBeforeChangeStateDate()`	get duration of admin connection before change state.
`String`	`getAdminFileExportXML()`	Returns the path of XML the file containing a description of the exported administered objects (destination) from the platform.
`String`	`getAdminFileXML()`	Returns the path of XML the file containing a description of the administered objects to create and bind at starting.
`Boolean`	`getCollocated()`	Returns `true` if the Joram server is collocated.
`Boolean`	`getCollocatedServer()`	Deprecated. only needed for compatibility with JOnAS 5.2 administration GUI
`String`	`getConfiguration()`	Returns the current servers configuration (a3servers.xml).
`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`	`getMBeanName()`
`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`	`getRootName()`	login name for administrator.
`String`	`getRootPasswd()`
`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 in ms 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.
`JoramAdmin`	`getWrapper()`	The admin wrapper.
`int`	`hashCode()`	Returns a code depending on the adapter properties.
`boolean`	`isActive()`	return the activity of the Joram administration connection.
`private boolean`	`isJoramServerRun()`
`void`	`reconnect()`
`void`	`removeDestination(String name)`	Remove a destination specified by its JNDI name on the underlying JORAM platform.
`private static String`	`removePrefix(String name)`	remove prefix name scn:comp/
`void`	`resetDefaultDMQ(short serverId)`	Unset the default dead message queue for the given server.
`void`	`setAdminFileExportXML(String adminFileExportXML)`	Sets the path of the XML file containing a description of the exported administered objects (destination) from the platform.
`void`	`setAdminFileXML(String adminFileXML)`	Sets the path of the XML file containing a description of the administered objects to create and bind at starting.
`void`	`setCollocated(Boolean collocated)`
`void`	`setConnectingTimer(Integer connectingTimer)`
`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`	`setHostName(String hostName)`
`void`	`setIdentityClass(String identityClass)`
`void`	`setPlatformConfigDir(String platformConfigDir)`
`void`	`setRootName(String rn)`
`void`	`setRootPasswd(String rp)`
`void`	`setServerId(Short serverId)`
`void`	`setServerPort(Integer serverPort)`
`void`	`setStartJoramServer(Boolean startJoramServer)`
`void`	`setStorage(String storage)`
`void`	`setTimeOutToAbortRequest(long timeOut)`	Sets timeout in ms before abort a request.
`void`	`start()`
`void`	`start(jakarta.resource.spi.BootstrapContext ctx)`	Initializes the adapter; starts, if needed, a collocated JORAM server, and if needed again, administers it.
`void`	`stop()`	Notifies the adapter to terminate the connections it manages, and if needed, to shutdown the collocated JORAM server.
`private void`	`waitAgentServerStarted()`

Methods inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter
addProducer, bind, createCF, createQueueCF, createTopicCF, endpointActivation, endpointDeactivation, getJMSProviderName, getJMSVersion, getJndiName, getName, getProviderVersion, getStatus, getStatusInfo, getXAResources, onException, removeProducer, setJmxServer, setJndiName, setName, setWorkManager, unbind

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.jms.ExceptionListener
onException

Methods inherited from interface org.ow2.joram.jakarta.connector.JoramAdapterMBean
getJMSProviderName, getJMSVersion, getJndiName, getName, getProviderVersion

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Define serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - logger
```
private static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - isActive
```
private boolean isActive
```
    true if admin connection connection is active.
  - adminDurationState
```
private long adminDurationState
```
    The duration of admin connection before change state.
  - wrapper
```
private JoramAdmin wrapper
```
  - serverDesc
```
private ServerDesc serverDesc
```
  - registration
```
private org.osgi.framework.ServiceRegistration<?> registration
```
  - cnx
```
private jakarta.jms.Connection cnx
```
  - collocated
```
private boolean collocated
```
    true if the underlying JORAM server is collocated.
  - startJoramServer
```
private boolean startJoramServer
```
    true start the JoramServer
  - hostName
```
private String hostName
```
    Host name or IP of the underlying JORAM server. localhost if collocated.
  - serverPort
```
private int serverPort
```
    Port number of the underlying JORAM server. -1 if collocated
  - rootName
```
private String rootName
```
    login name for administrator.
  - rootPasswd
```
private String rootPasswd
```
    password for administrator
  - identityClass
```
private String identityClass
```
    Identity class needed for authentication
  - serverId
```
private short serverId
```
    Identifier of the JORAM server to start.
  - storage
```
private String storage
```
    the persistence directory of the JORAM server to start, needed when StartJoramServer is set to true.
  - platformConfigDir
```
private String platformConfigDir
```
    Path to the directory containing JORAM's configuration files (a3servers.xml, a3debug.cfg and admin file), needed when StartJoramServer is set to true.
  - adminFileXML
```
private String adminFileXML
```
    Path to the XML file (joramAdmin.xml) containing a description of the administered objects to create and bind.
  - adminFileExportXML
```
private String adminFileExportXML
```
    Path to the XML file containing a description of the exported administered objects (destination) from the platform.
  - connectingTimer
```
private int connectingTimer
```
    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.
- Constructor Detail
  - JoramAdapter
```
public JoramAdapter()
```
    Constructs a JoramAdapter instance.
  - JoramAdapter
```
public JoramAdapter(MBeanServer jmxServer)
```
    Constructs a JoramAdapter instance.
- Method Detail
  - setCollocated
```
public void setCollocated(Boolean collocated)
```
  - getCollocated
```
public Boolean getCollocated()
```
    Description copied from interface: JoramAdapterMBean
    
    Returns true if the Joram server is collocated.
    
    Specified by:
    
    getCollocated in interface JoramAdapterMBean
    
    Returns:
    
    true if the Joram server is collocated.
  - setStartJoramServer
```
public void setStartJoramServer(Boolean startJoramServer)
```
  - getStartJoramServer
```
public Boolean getStartJoramServer()
```
    Description copied from interface: JoramAdapterMBean
    
    true if the resource adapter start the JoramServer
    
    Specified by:
    
    getStartJoramServer in interface JoramAdapterMBean
  - getHostName
```
public String getHostName()
```
    Description copied from interface: JoramAdapterMBean
    
    Returns the location of the Joram server.
    
    Specified by:
    
    getHostName in interface JoramAdapterMBean
    
    Returns:
    
    The location of the Joram server.
  - setHostName
```
public void setHostName(String hostName)
```
  - getServerPort
```
public Integer getServerPort()
```
    Description copied from interface: JoramAdapterMBean
    
    Returns the listening port of the Joram server.
    
    Specified by:
    
    getServerPort in interface JoramAdapterMBean
    
    Returns:
    
    The listening port of the Joram server.
  - setServerPort
```
public void setServerPort(Integer serverPort)
```
  - getRootName
```
public String getRootName()
```
    Description copied from interface: JoramAdapterMBean
    
    login name for administrator.
    
    Specified by:
    
    getRootName in interface JoramAdapterMBean
  - setRootName
```
public void setRootName(String rn)
```
  - getRootPasswd
```
public String getRootPasswd()
```
  - setRootPasswd
```
public void setRootPasswd(String rp)
```
  - getIdentityClass
```
public String getIdentityClass()
```
    Description copied from interface: JoramAdapterMBean
    
    Identity class needed for authentication
    
    Specified by:
    
    getIdentityClass in interface JoramAdapterMBean
  - setIdentityClass
```
public void setIdentityClass(String identityClass)
```
  - getServerId
```
public Short getServerId()
```
    Description copied from interface: JoramAdapterMBean
    
    Returns the unique identifier of the Joram server.
    
    Specified by:
    
    getServerId in interface JoramAdapterMBean
    
    Returns:
    
    The unique identifier of the Joram server.
  - setServerId
```
public void setServerId(Short serverId)
```
  - getStorage
```
public String getStorage()
```
    Description copied from interface: JoramAdapterMBean
    
    The persistence directory of the JORAM server to start, needed when StartJoramServer is set to true.
    
    Specified by:
    
    getStorage in interface JoramAdapterMBean
    
    Returns:
    
    the persistence directory.
  - setStorage
```
public void setStorage(String storage)
```
  - getPlatformConfigDir
```
public String getPlatformConfigDir()
```
    Description copied from interface: JoramAdapterMBean
    
    Path to the directory containing JORAM's configuration files (a3servers.xml, a3debug.cfg and admin file), needed when StartJoramServer is set to true.
    
    Specified by:
    
    getPlatformConfigDir in interface JoramAdapterMBean
  - setPlatformConfigDir
```
public void setPlatformConfigDir(String platformConfigDir)
```
  - getAdminFileXML
```
public String getAdminFileXML()
```
    Returns the path of XML the file containing a description of the administered objects to create and bind at starting.
    
    Specified by:
    
    getAdminFileXML in interface JoramAdapterMBean
  - setAdminFileXML
```
public void setAdminFileXML(String adminFileXML)
```
    Sets the path of the XML file containing a description of the administered objects to create and bind at starting.
  - getAdminFileExportXML
```
public String getAdminFileExportXML()
```
    Returns the path of XML the file containing a description of the exported administered objects (destination) from the platform.
    
    Specified by:
    
    getAdminFileExportXML in interface JoramAdapterMBean
  - setAdminFileExportXML
```
public void setAdminFileExportXML(String adminFileExportXML)
```
    Sets the path of the XML file containing a description of the exported administered objects (destination) from the platform.
  - getConnectingTimer
```
public Integer getConnectingTimer()
```
    Description copied from interface: JoramAdapterMBean
    
    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.
    
    Specified by:
    
    getConnectingTimer in interface JoramAdapterMBean
  - setConnectingTimer
```
public void setConnectingTimer(Integer connectingTimer)
```
  - isJoramServerRun
```
private boolean isJoramServerRun()
```
  - waitAgentServerStarted
```
private void waitAgentServerStarted()
                             throws jakarta.resource.spi.ResourceAdapterInternalException
```
    Throws:
    
    jakarta.resource.spi.ResourceAdapterInternalException
  - start
```
public void start(jakarta.resource.spi.BootstrapContext ctx)
           throws jakarta.resource.spi.ResourceAdapterInternalException
```
    Initializes the adapter; starts, if needed, a collocated JORAM server, and if needed again, administers it.
    
    Specified by:
    
    start in interface jakarta.resource.spi.ResourceAdapter
    
    Overrides:
    
    start in class JoramResourceAdapter
    
    Throws:
    
    jakarta.resource.spi.ResourceAdapterInternalException - If the adapter could not be initialized.
  - start
```
public void start()
           throws jakarta.resource.spi.ResourceAdapterInternalException
```
    Overrides:
    
    start in class JoramResourceAdapter
    
    Throws:
    
    jakarta.resource.spi.ResourceAdapterInternalException
  - adminConnect
```
void adminConnect()
           throws AdminException
```
    Initiates an admin session.
    
    Throws:
    
    AdminException - If the admin session could not be started.
  - getMBeanName
```
public String getMBeanName()
```
  - adminDisconnect
```
void adminDisconnect()
```
  - stop
```
public void stop()
```
    Notifies the adapter to terminate the connections it manages, and if needed, to shutdown the collocated JORAM server.
    
    Specified by:
    
    stop in interface jakarta.resource.spi.ResourceAdapter
    
    Overrides:
    
    stop in class JoramResourceAdapter
  - reconnect
```
public void reconnect()
               throws Exception
```
    Overrides:
    
    reconnect in class JoramResourceAdapter
    
    Throws:
    
    Exception
  - hashCode
```
public int hashCode()
```
    Returns a code depending on the adapter properties.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Compares adapters according to their properties.
    
    Overrides:
    
    equals in class Object
  - isActive
```
public boolean isActive()
```
    return the activity of the Joram administration connection.
    
    Specified by:
    
    isActive in interface JoramAdapterMBean
    
    Returns:
    
    true if connection is active.
  - getAdminDurationBeforeChangeState
```
public long getAdminDurationBeforeChangeState()
```
    get duration of admin connection before change state.
    
    Specified by:
    
    getAdminDurationBeforeChangeState in interface JoramAdapterMBean
    
    Returns:
    
    the duration of admin change connection state.
  - getAdminDurationBeforeChangeStateDate
```
public String getAdminDurationBeforeChangeStateDate()
```
    get duration of admin connection before change state.
    
    Specified by:
    
    getAdminDurationBeforeChangeStateDate in interface JoramAdapterMBean
    
    Returns:
    
    the duration of admin connection before change state.
  - getTimeOutToAbortRequest
```
public long getTimeOutToAbortRequest()
                              throws ConnectException
```
    Gets timeout in ms before abort a request.
    
    Specified by:
    
    getTimeOutToAbortRequest in interface JoramAdapterMBean
    
    Returns:
    
    timeout before abort a request.
    
    Throws:
    
    ConnectException
    
    Since:
    
    5.2.2
    
    See Also:
    
    wrapper#getTimeOutToAbortRequest()
  - setTimeOutToAbortRequest
```
public void setTimeOutToAbortRequest(long timeOut)
                              throws ConnectException
```
    Sets timeout in ms before abort a request.
    
    Specified by:
    
    setTimeOutToAbortRequest in interface JoramAdapterMBean
    
    Parameters:
    
    timeOut - timeout before abort a request.
    
    Throws:
    
    ConnectException
    
    Since:
    
    5.2.2
    
    See Also:
    
    wrapper#setTimeOutToAbortRequest(long)
  - getDefaultDMQId
```
public String getDefaultDMQId()
                       throws ConnectException,
                              AdminException
```
    Returns the unique identifier of the default dead message queue for the local server, null if not set.
    
    Specified by:
    
    getDefaultDMQId in interface JoramAdapterMBean
    
    Returns:
    
    The unique identifier of the dead message queue of the local server or null if none exists.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    wrapper#getDefaultDMQId()
  - getDefaultDMQId
```
public String getDefaultDMQId(short serverId)
                       throws 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.
    
    Specified by:
    
    getDefaultDMQId in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - Unique identifier of the server.
    
    Returns:
    
    The unique identifier of the dead message queue of the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
    
    See Also:
    
    wrapper#getDefaultDMQId()
  - resetDefaultDMQ
```
public void resetDefaultDMQ(short serverId)
                     throws ConnectException,
                            AdminException
```
    Unset the default dead message queue for the given server.
    
    Specified by:
    
    resetDefaultDMQ in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - Unique identifier of the given server.
    
    Throws:
    
    ConnectException
    
    AdminException
  - getDefaultThreshold
```
public int getDefaultThreshold()
                        throws ConnectException,
                               AdminException
```
    Returns the default threshold of the Joram server.
    
    Specified by:
    
    getDefaultThreshold in interface JoramAdapterMBean
    
    Returns:
    
    the default threshold of the Joram server.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    See Also:
    
    wrapper#getDefaultThreshold()
  - getDefaultThreshold
```
public int getDefaultThreshold(short serverId)
                        throws ConnectException,
                               AdminException
```
    Returns the default threshold of the given Joram server.
    
    Specified by:
    
    getDefaultThreshold in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - Unique identifier of the given Joram server.
    
    Returns:
    
    the default threshold of the given Joram server.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    See Also:
    
    wrapper#getDefaultThreshold(int)
  - setDefaultThreshold
```
public void setDefaultThreshold(int threshold)
                         throws ConnectException,
                                AdminException
```
    Sets the default threshold of the Joram server.
    
    Specified by:
    
    setDefaultThreshold in interface JoramAdapterMBean
    
    Parameters:
    
    threshold - the default threshold of the Joram server.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    See Also:
    
    wrapper#setDefaultThreshold(int)
  - setDefaultThreshold
```
public void setDefaultThreshold(short serverId,
                                int threshold)
                         throws ConnectException,
                                AdminException
```
    Sets the default threshold of the given Joram server.
    
    Specified by:
    
    setDefaultThreshold in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - Unique identifier of the given Joram server.
    
    threshold - the default threshold of the given Joram server.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    See Also:
    
    wrapper#setDefaultThreshold(int, int)
  - getDestinations
```
public String[] getDestinations()
                         throws 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.
    
    Specified by:
    
    getDestinations in interface JoramAdapterMBean
    
    Returns:
    
    An array containing the object name of all destinations defined on the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the connection is closed or broken.
    
    AdminException - Never thrown.
    
    See Also:
    
    getDestinations(short)
  - getDestinations
```
public String[] getDestinations(short serverId)
                         throws 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.
    
    Specified by:
    
    getDestinations in interface JoramAdapterMBean
    
    Returns:
    
    An array containing the object name of all destinations defined on the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the connection is closed or broken.
    
    AdminException - Never thrown.
    
    See Also:
    
    JoramAdapterMBean.getDestinations(short)
  - createQueue
```
public String createQueue(String name)
                   throws AdminException,
                          ConnectException
```
    Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
    
    Specified by:
    
    createQueue in interface JoramAdapterMBean
    
    Overrides:
    
    createQueue in class JoramResourceAdapter
    
    Parameters:
    
    name - The name of the queue.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
    
    See Also:
    
    createQueue(short, String, String, Properties)
  - createQueue
```
public String createQueue(short serverId,
                          String name)
                   throws AdminException,
                          ConnectException
```
    Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
    
    Specified by:
    
    createQueue in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - The identifier of the server where deploying the queue.
    
    name - The name of the queue.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
    
    See Also:
    
    createQueue(short, String, String, Properties)
  - createQueue
```
public String createQueue(short serverId,
                          String name,
                          String className,
                          Properties prop)
                   throws AdminException,
                          ConnectException
```
    First tries to retrieve a queue destination on the underlying JORAM server first using JNDI then the Joram's internal name service. Finally, if the destination does not exist it is created. Anyway at the end of this method the destination is bound in the JNDI repository.
    
    Parameters:
    
    serverId - The identifier of the server where deploying the queue.
    
    name - The name of the queue.
    
    className - The queue class name.
    
    prop - The queue properties.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
  - createTopic
```
public String createTopic(String name)
                   throws AdminException,
                          ConnectException
```
    Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
    
    Specified by:
    
    createTopic in interface JoramAdapterMBean
    
    Overrides:
    
    createTopic in class JoramResourceAdapter
    
    Parameters:
    
    name - The name of the topic.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
    
    See Also:
    
    createTopic(short, String, String, Properties)
  - createTopic
```
public String createTopic(short serverId,
                          String name)
                   throws AdminException,
                          ConnectException
```
    Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
    
    Specified by:
    
    createTopic in interface JoramAdapterMBean
    
    Parameters:
    
    serverId - The identifier of the server where deploying the topic.
    
    name - The name of the topic.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
    
    See Also:
    
    createTopic(short, String, String, Properties)
  - createTopic
```
public String createTopic(short serverId,
                          String name,
                          String className,
                          Properties prop)
                   throws AdminException,
                          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.
    
    className - The topic class name.
    
    prop - The topic properties.
    
    Throws:
    
    AdminException - If the creation fails.
    
    ConnectException - if the connection is closed or broken
  - removeDestination
```
public void removeDestination(String name)
                       throws AdminException
```
    Remove a destination specified by its JNDI name on the underlying JORAM platform.
    
    Specified by:
    
    removeDestination in interface JoramAdapterMBean
    
    Parameters:
    
    name - The JNDI name of the destination.
    
    Throws:
    
    AdminException
  - getUsers
```
public String[] getUsers()
                  throws 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.
    
    Specified by:
    
    getUsers in interface JoramAdapterMBean
    
    Returns:
    
    An array containing the object name of all users defined on the given server or null if none exists.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
    
    See Also:
    
    getUsers(short)
  - getUsers
```
public String[] getUsers(short serverId)
                  throws 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.
    
    Specified by:
    
    getUsers in interface JoramAdapterMBean
    
    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:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - createUser
```
public String createUser(String name,
                         String password)
                  throws AdminException,
                         ConnectException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface JoramAdapterMBean
    
    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.
    
    ConnectException - If the connection fails.
    
    See Also:
    
    createUser(String, String, short, String)
  - createUser
```
public String createUser(String name,
                         String password,
                         String identityClass)
                  throws AdminException,
                         ConnectException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface JoramAdapterMBean
    
    Overrides:
    
    createUser in class JoramResourceAdapter
    
    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.
    
    ConnectException - If the connection fails.
    
    See Also:
    
    createUser(String, String, short, String)
  - createUser
```
public String createUser(String name,
                         String password,
                         short serverId)
                  throws AdminException,
                         ConnectException
```
    Creates or retrieves a user on the given JORAM server.
    
    Specified by:
    
    createUser in interface JoramAdapterMBean
    
    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.
    
    ConnectException - If the connection fails.
    
    See Also:
    
    createUser(String, String, short, String)
  - createUser
```
public String createUser(String name,
                         String password,
                         short serverId,
                         String identityClass)
                  throws AdminException,
                         ConnectException
```
    Creates or retrieves a user on the underlying JORAM server.
    
    Specified by:
    
    createUser in interface JoramAdapterMBean
    
    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.
    
    ConnectException - If the connection fails.
  - createCF
```
public void createCF(String name)
```
    Creates a non managed connection factory and binds it to JNDI.
    
    Specified by:
    
    createCF in interface JoramAdapterMBean
    
    Parameters:
    
    name - Name of created connection factory.
  - createQueueCF
```
public void createQueueCF(String name)
```
    Creates a non managed PTP connection factory and binds it to JNDI.
    
    Specified by:
    
    createQueueCF in interface JoramAdapterMBean
    
    Parameters:
    
    name - Name of created connection factory.
  - createTopicCF
```
public void createTopicCF(String name)
```
    Creates a non managed PubSub connection factory and binds it to JNDI.
    
    Specified by:
    
    createTopicCF in interface JoramAdapterMBean
    
    Parameters:
    
    name - Name of created connection factory.
  - removePrefix
```
private static String removePrefix(String name)
```
    remove prefix name scn:comp/
  - executeXMLAdmin
```
public void executeXMLAdmin(String path)
                     throws Exception
```
    Executes the XML configuration file.
    
    Specified by:
    
    executeXMLAdmin in interface JoramAdapterMBean
    
    Parameters:
    
    path - the path for the joramAdmin file
    
    Throws:
    
    AdminException - if an error occurs
    
    Exception
  - exportRepositoryToFile
```
public void exportRepositoryToFile(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)
    
    Specified by:
    
    exportRepositoryToFile in interface JoramAdapterMBean
    
    Parameters:
    
    exportDir - target directory where the export file will be put
    
    Throws:
    
    AdminException - if an error occurs
  - exportRepositoryToFile
```
public void exportRepositoryToFile(String exportDir,
                                   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)
    
    Specified by:
    
    exportRepositoryToFile in interface JoramAdapterMBean
    
    Parameters:
    
    exportDir - target directory where the export file will be put
    
    exportFilename - filename of the export file
    
    Throws:
    
    AdminException - if an error occurs
  - getServersIds
```
public Short[] getServersIds()
                      throws ConnectException,
                             AdminException
```
    Returns the list of the platform's servers' identifiers.
    
    Specified by:
    
    getServersIds in interface JoramAdapterMBean
    
    Returns:
    
    an array containing the list of the platform's servers' identifiers.
    
    Throws:
    
    AdminException - If the request fails.
    
    ConnectException - If the connection fails.
  - getServersNames
```
public final String[] getServersNames()
                               throws ConnectException,
                                      AdminException
```
    Returns the list of the platform's servers' names.
    
    Specified by:
    
    getServersNames in interface JoramAdapterMBean
    
    Returns:
    
    An array containing the list of server's names.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - Never thrown.
  - getConfiguration
```
public final String getConfiguration()
                              throws ConnectException,
                                     AdminException
```
    Returns the current servers configuration (a3servers.xml).
    
    Returns:
    
    The current servers configuration.
    
    Throws:
    
    ConnectException - If the connection fails.
    
    AdminException - If the request fails.
  - getWrapper
```
public JoramAdmin getWrapper()
```
    The admin wrapper.
    
    Returns:
    
    the admin wrapper of this resource adapter.
  - getCollocatedServer
```
public Boolean getCollocatedServer()
```
    Deprecated.
    only needed for compatibility with JOnAS 5.2 administration GUI
    
    Returns true if the server is colocated.
    
    Specified by:
    
    getCollocatedServer in interface JoramAdapterMBean
    
    See Also:
    
    JoramAdapterMBean.getCollocatedServer()
  - getServerName
```
public String getServerName()
```
    Deprecated.
    only needed for compatibility with JOnAS 5.2 administration GUI
    
    Returns the server name.
    
    Specified by:
    
    getServerName in interface JoramAdapterMBean
    
    See Also:
    
    JoramAdapterMBean.getServerName()

Constructor	Description
`JoramAdapter()`	Constructs a `JoramAdapter` instance.
`JoramAdapter(MBeanServer jmxServer)`	Constructs a `JoramAdapter` instance.

Class JoramAdapter

Nested Class Summary

Nested classes/interfaces inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter

Field Summary

Fields inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter

Constructor Summary

Method Summary

Methods inherited from class org.ow2.joram.jakarta.connector.JoramResourceAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface jakarta.jms.ExceptionListener

Methods inherited from interface org.ow2.joram.jakarta.connector.JoramAdapterMBean

Field Detail

serialVersionUID

logger

DEBUG

isActive

adminDurationState

wrapper

serverDesc

registration

cnx

collocated

startJoramServer

hostName

serverPort

rootName

rootPasswd

identityClass

serverId

storage

platformConfigDir

adminFileXML

adminFileExportXML

connectingTimer

Constructor Detail

JoramAdapter

JoramAdapter

Method Detail

setCollocated

getCollocated

setStartJoramServer

getStartJoramServer

getHostName

setHostName

getServerPort

setServerPort

getRootName

setRootName

getRootPasswd

setRootPasswd

getIdentityClass

setIdentityClass

getServerId

setServerId

getStorage

setStorage

getPlatformConfigDir

setPlatformConfigDir

getAdminFileXML

setAdminFileXML

getAdminFileExportXML

setAdminFileExportXML

getConnectingTimer

setConnectingTimer

isJoramServerRun

waitAgentServerStarted

start

start

adminConnect

getMBeanName

adminDisconnect

stop

reconnect

hashCode

equals

isActive

getAdminDurationBeforeChangeState

getAdminDurationBeforeChangeStateDate

getTimeOutToAbortRequest

setTimeOutToAbortRequest