|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.client.connector.JoramAdapter
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).
Field Summary | |
int |
cnxPendingTimer
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. |
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. |
com.scalagent.jmx.JMXServer |
jmxServer
|
int |
txPendingTimer
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". |
Constructor Summary | |
JoramAdapter()
Constructs a JoramAdapter instance. |
Method Summary | |
void |
createCF(java.lang.String name)
Creates a non managed connection factory and binds it to JNDI. |
void |
createQCF(java.lang.String name)
Creates a non managed PTP connection factory and binds it to JNDI. |
javax.jms.Destination |
createQueue(int serverId,
java.lang.String name)
Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance. |
javax.jms.Destination |
createQueue(int serverId,
java.lang.String name,
java.lang.String className,
java.util.Properties prop)
Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance. |
javax.jms.Destination |
createQueue(java.lang.String name)
Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance. |
void |
createTCF(java.lang.String name)
Creates a non managed PubSub connection factory and binds it to JNDI. |
javax.jms.Destination |
createTopic(int serverId,
java.lang.String name)
Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance. |
javax.jms.Destination |
createTopic(int serverId,
java.lang.String name,
java.lang.String className,
java.util.Properties prop)
Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance. |
javax.jms.Destination |
createTopic(java.lang.String name)
Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance. |
void |
createUser(java.lang.String name,
java.lang.String password)
Creates or retrieves a user on the underlying JORAM server. |
void |
createUser(java.lang.String name,
java.lang.String password,
int serverId)
Creates or retrieves a user on the underlying JORAM server. |
void |
endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory,
javax.resource.spi.ActivationSpec spec)
Notifies the adapter to setup asynchronous message delivery for an application server endoint. |
void |
endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory,
javax.resource.spi.ActivationSpec spec)
Notifies the adapter to deactivate message delivery for a given endpoint. |
boolean |
equals(java.lang.Object o)
Compares adapters according to their properties. |
void |
exit()
|
java.lang.String |
getAdminFile()
Path to the 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()
|
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. |
DeadMQueue |
getDefaultDMQ()
|
DeadMQueue |
getDefaultDMQ(int serverId)
|
java.util.List |
getDestinations()
|
java.util.List |
getDestinations(int serverId)
|
java.lang.String |
getHostName()
|
java.util.List |
getLocalUsers()
|
java.lang.Boolean |
getPersistentPlatform()
true if the JORAM server to start 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.util.List |
getPlatformServersIds()
Platform servers identifiers. |
java.lang.Short |
getServerId()
Identifier of the JORAM server to start. |
java.lang.String |
getServerName()
Name of the JORAM server to start. |
java.lang.Integer |
getServerPort()
|
long |
getTimeOutToAbortRequest()
wait 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.util.List |
getUsers()
|
java.util.List |
getUsers(int serverId)
|
javax.transaction.xa.XAResource[] |
getXAResources(javax.resource.spi.ActivationSpec[] specs)
Returns XA resources given an array of ActivationSpec instances. |
int |
hashCode()
Returns a code depending on the adapter properties. |
void |
removeDestination(java.lang.String name)
Remove a destination on the underlying JORAM server |
void |
setAdminFile(java.lang.String adminFile)
|
void |
setCnxPendingTimer(java.lang.Integer cnxPendingTimer)
|
void |
setCollocatedServer(java.lang.Boolean collocatedServer)
|
void |
setConnectingTimer(java.lang.Integer connectingTimer)
|
void |
setDefaultDMQ(int serverId,
DeadMQueue dmq)
|
void |
setHostName(java.lang.String hostName)
|
void |
setPersistentPlatform(java.lang.Boolean persistentPlatform)
|
void |
setPlatformConfigDir(java.lang.String platformConfigDir)
|
void |
setServerId(java.lang.Short serverId)
|
void |
setServerName(java.lang.String serverName)
|
void |
setServerPort(java.lang.Integer serverPort)
|
void |
setTimeOutToAbortRequest(long timeOut)
wait before abort a request. |
void |
setTxPendingTimer(java.lang.Integer txPendingTimer)
|
void |
start(javax.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 shut down the collocated JORAM server. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public int connectingTimer
public int txPendingTimer
public int cnxPendingTimer
public com.scalagent.jmx.JMXServer jmxServer
Constructor Detail |
public JoramAdapter()
JoramAdapter
instance.
Method Detail |
public void start(javax.resource.spi.BootstrapContext ctx) throws javax.resource.spi.ResourceAdapterInternalException
start
in interface javax.resource.spi.ResourceAdapter
javax.resource.spi.ResourceAdapterInternalException
- If the adapter could not be
initialized.public void stop()
stop
in interface javax.resource.spi.ResourceAdapter
public void endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory, javax.resource.spi.ActivationSpec spec) throws javax.resource.ResourceException
endpointActivation
in interface javax.resource.spi.ResourceAdapter
javax.resource.spi.IllegalStateException
- If the adapter is either not started,
or stopped.
javax.resource.NotSupportedException
- If the provided activation parameters
are invalid.
javax.resource.spi.CommException
- If the JORAM server is not reachable.
java.lang.SecurityException
- If connecting is not allowed.
javax.resource.ResourceException
- Generic exception.public void endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory, javax.resource.spi.ActivationSpec spec)
endpointDeactivation
in interface javax.resource.spi.ResourceAdapter
public javax.transaction.xa.XAResource[] getXAResources(javax.resource.spi.ActivationSpec[] specs) throws javax.resource.ResourceException
getXAResources
in interface javax.resource.spi.ResourceAdapter
javax.resource.spi.IllegalStateException
- If the adapter is either not started,
or stopped.
javax.resource.NotSupportedException
- If provided activation parameters
are invalid.
javax.resource.spi.CommException
- If the JORAM server is not reachable.
java.lang.SecurityException
- If connecting is not allowed.
javax.resource.ResourceException
- Generic exception.public int hashCode()
public boolean equals(java.lang.Object o)
public java.util.List getDestinations()
getDestinations
in interface JoramAdminMBean
public java.util.List getDestinations(int serverId)
getDestinations
in interface JoramAdminMBean
public java.util.List getUsers()
getUsers
in interface JoramAdminMBean
public java.util.List getUsers(int serverId)
getUsers
in interface JoramAdminMBean
public java.util.List getPlatformServersIds()
JoramAdapterMBean
getPlatformServersIds
in interface JoramAdapterMBean
public java.util.List getLocalUsers()
getLocalUsers
in interface JoramAdapterMBean
public void setDefaultDMQ(int serverId, DeadMQueue dmq) throws java.net.ConnectException, AdminException
setDefaultDMQ
in interface JoramAdminMBean
java.net.ConnectException
AdminException
public DeadMQueue getDefaultDMQ(int serverId) throws java.net.ConnectException, AdminException
getDefaultDMQ
in interface JoramAdminMBean
java.net.ConnectException
AdminException
public DeadMQueue getDefaultDMQ() throws java.net.ConnectException, AdminException
getDefaultDMQ
in interface JoramAdminMBean
java.net.ConnectException
AdminException
public void exit()
exit
in interface JoramAdminMBean
public void setTimeOutToAbortRequest(long timeOut)
setTimeOutToAbortRequest
in interface JoramAdminMBean
public long getTimeOutToAbortRequest()
getTimeOutToAbortRequest
in interface JoramAdminMBean
public void createUser(java.lang.String name, java.lang.String password) throws AdminException
createUser
in interface JoramAdminMBean
AdminException
- If the creation fails.public void createUser(java.lang.String name, java.lang.String password, int serverId) throws AdminException
createUser
in interface JoramAdminMBean
AdminException
- If the creation fails.public void createCF(java.lang.String name)
public void createQCF(java.lang.String name)
public void createTCF(java.lang.String name)
public javax.jms.Destination createQueue(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop) throws AdminException
Queue
instance.
createQueue
in interface JoramAdminMBean
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.
AdminException
- If the creation fails.public javax.jms.Destination createQueue(int serverId, java.lang.String name) throws AdminException
Queue
instance.
createQueue
in interface JoramAdminMBean
serverId
- The identifier of the server where deploying the queue.name
- The name of the queue.
AdminException
- If the creation fails.public javax.jms.Destination createQueue(java.lang.String name) throws AdminException
Queue
instance.
createQueue
in interface JoramAdminMBean
name
- The name of the queue.
AdminException
- If the creation fails.public javax.jms.Destination createTopic(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop) throws AdminException
Topic
instance.
createTopic
in interface JoramAdminMBean
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.
AdminException
- If the creation fails.public javax.jms.Destination createTopic(int serverId, java.lang.String name) throws AdminException
Topic
instance.
createTopic
in interface JoramAdminMBean
serverId
- The identifier of the server where deploying the topic.name
- The name of the topic.
AdminException
- If the creation fails.public javax.jms.Destination createTopic(java.lang.String name) throws AdminException
Topic
instance.
createTopic
in interface JoramAdminMBean
name
- The name of the topic.
AdminException
- If the creation fails.public void removeDestination(java.lang.String name) throws AdminException
removeDestination
in interface JoramAdapterMBean
name
- The name of the destination.
AdminException
public void setPlatformConfigDir(java.lang.String platformConfigDir)
public void setPersistentPlatform(java.lang.Boolean persistentPlatform)
public void setServerId(java.lang.Short serverId)
public void setServerName(java.lang.String serverName)
public void setAdminFile(java.lang.String adminFile)
public void setCollocatedServer(java.lang.Boolean collocatedServer)
public void setHostName(java.lang.String hostName)
public void setServerPort(java.lang.Integer serverPort)
public void setConnectingTimer(java.lang.Integer connectingTimer)
public void setTxPendingTimer(java.lang.Integer txPendingTimer)
public void setCnxPendingTimer(java.lang.Integer cnxPendingTimer)
public java.lang.String getPlatformConfigDir()
JoramAdapterMBean
a3servers.xml
, a3debug.cfg
and admin file), needed when starting the collocated JORAM server.
getPlatformConfigDir
in interface JoramAdapterMBean
public java.lang.Boolean getPersistentPlatform()
JoramAdapterMBean
true
if the JORAM server to start is persistent.
getPersistentPlatform
in interface JoramAdapterMBean
public java.lang.Short getServerId()
JoramAdapterMBean
getServerId
in interface JoramAdapterMBean
public java.lang.String getServerName()
JoramAdapterMBean
getServerName
in interface JoramAdapterMBean
public java.lang.String getAdminFile()
JoramAdapterMBean
getAdminFile
in interface JoramAdapterMBean
public java.lang.Boolean getCollocatedServer()
getCollocatedServer
in interface JoramAdapterMBean
public java.lang.String getHostName()
getHostName
in interface JoramAdapterMBean
public java.lang.Integer getServerPort()
getServerPort
in interface JoramAdapterMBean
public java.lang.Integer getConnectingTimer()
JoramAdapterMBean
getConnectingTimer
in interface JoramAdapterMBean
public java.lang.Integer getTxPendingTimer()
JoramAdapterMBean
getTxPendingTimer
in interface JoramAdapterMBean
public java.lang.Integer getCnxPendingTimer()
JoramAdapterMBean
getCnxPendingTimer
in interface JoramAdapterMBean
|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |