|
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. |
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 |
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. |
java.lang.String |
getAdminFile()
|
java.lang.Integer |
getCnxPendingTimer()
|
java.lang.Boolean |
getCollocatedServer()
|
java.lang.Integer |
getConnectingTimer()
|
java.lang.String |
getHostName()
|
java.lang.Boolean |
getPersistentPlatform()
|
java.lang.String |
getPlatformConfigDir()
|
java.lang.Short |
getServerId()
|
java.lang.String |
getServerName()
|
java.lang.Integer |
getServerPort()
|
java.lang.Integer |
getTxPendingTimer()
|
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 |
setAdminFile(java.lang.String adminFile)
|
void |
setCnxPendingTimer(java.lang.Integer cnxPendingTimer)
|
void |
setCollocatedServer(java.lang.Boolean collocatedServer)
|
void |
setConnectingTimer(java.lang.Integer connectingTimer)
|
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 |
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
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 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()
public java.lang.Boolean getPersistentPlatform()
public java.lang.Short getServerId()
public java.lang.String getServerName()
public java.lang.String getAdminFile()
public java.lang.Boolean getCollocatedServer()
public java.lang.String getHostName()
public java.lang.Integer getServerPort()
public java.lang.Integer getConnectingTimer()
public java.lang.Integer getTxPendingTimer()
public java.lang.Integer getCnxPendingTimer()
|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |