SuspendableAdapter
public interface Suspendable
Modifier and Type | Field | Description |
---|---|---|
static int |
ALL |
Used to indicate that INBOUND, OUTBOUND & WORK are to be suspended/resumed
|
static int |
INBOUND |
Used to indicate that inbound communication is to be suspended/resumed
|
static int |
OUTBOUND |
Used to indicate that outbound communication is to be suspended/resumed
|
static int |
RESUME |
May be used to indicate a resume() operation
|
static int |
SUSPEND |
May be used to indicate a suspend() operation
|
static int |
WORK |
Used to indicate that submission of Work is to be suspended/resumed
|
Modifier and Type | Method | Description |
---|---|---|
void |
init(javax.resource.spi.ResourceAdapter ra,
java.util.Properties props) |
Used by WLS to inform a ResourceAdapter that it is a new version of an already deployed
resource adapter.
|
boolean |
isInboundSuspended(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory) |
Used to determine whether the inbound activity is currently suspended for
the given MessageEndpointFactory
|
boolean |
isSuspended(int type) |
Used to determine whether the specified type of activity is currently suspended.
|
void |
resume(int type,
java.util.Properties props) |
Request to resume the activity specified.
|
void |
resumeInbound(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory,
java.util.Properties props) |
Request to resume the inbound activity on the given MessageEndpointFactory
|
void |
startVersioning(javax.resource.spi.ResourceAdapter ra,
java.util.Properties props) |
Used by WLS to indicate to the current version of this resource adapter that a new
version of the resource adapter is being deployed.
|
boolean |
supportsInit() |
Used to determine if this resource adapter supports the init() method used for
resource adapter versioning (side-by-side deployment)
|
boolean |
supportsSuspend(int type) |
|
boolean |
supportsVersioning() |
Used to determine if this resource adapter supports the startVersioning() method used for
resource adapter versioning (side-by-side deployment)
|
void |
suspend(int type,
java.util.Properties props) |
Request to suspend the activity specified.
|
void |
suspendInbound(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory,
java.util.Properties props) |
Request to suspend the inbound activity on the given MessageEndpointFactory
|
static final int INBOUND
static final int OUTBOUND
static final int WORK
static final int ALL
static final int SUSPEND
static final int RESUME
void suspend(int type, java.util.Properties props) throws javax.resource.ResourceException
type
- An int from 1 to 7 specifying the type of suspension being
requested (i.e. Suspendable.INBOUND, .OUTBOUND, .WORK or the sum of
one or more of these, or the value Suspendable.ALL )props
- Optional Properties (or null) to be used for ResourceAdapter
specific purposesjavax.resource.ResourceException
- If the resource adapter can't complete the
requestvoid suspendInbound(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory, java.util.Properties props) throws javax.resource.ResourceException
endptFactory
- the factory for message endpoints that is being
suspendedprops
- Optional Properties (or null) to be used for ResourceAdapter
specific purposesjavax.resource.ResourceException
- If the resource adapter can't complete the
requestvoid resumeInbound(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory, java.util.Properties props) throws javax.resource.ResourceException
endptFactory
- the factory for message endpoints that is being
resumedprops
- Optional Properties (or null) to be used for ResourceAdapter
specific purposesjavax.resource.ResourceException
- If the resource adapter can't complete the
requestvoid resume(int type, java.util.Properties props) throws javax.resource.ResourceException
type
- An int from 1 to 7 specifying the type of resume being
requested (i.e. Suspendable.INBOUND, .OUTBOUND, .WORK or the sum of
one or more of these, or the value Suspendable.ALL )props
- Optional Properties (or null) to be used for ResourceAdapter
specific purposesjavax.resource.ResourceException
- If the resource adapter can't complete the
requestboolean supportsSuspend(int type)
type
- An int from 1 to 7 specifying the type of suspend this inquiry
is about (i.e. Suspendable.INBOUND, .OUTBOUND, .WORK or the sum of
one or more of these, or the value Suspendable.ALL )boolean isSuspended(int type)
type
- An int from 1 to 7 specifying the type of activity
requested (i.e. Suspendable.INBOUND, .OUTBOUND, .WORK or the sum of
one or more of these, or the value Suspendable.ALL )boolean isInboundSuspended(javax.resource.spi.endpoint.MessageEndpointFactory endptFactory) throws javax.resource.ResourceException
endptFactory
- the endpoint factoryjavax.resource.ResourceException
boolean supportsInit()
boolean supportsVersioning()
void startVersioning(javax.resource.spi.ResourceAdapter ra, java.util.Properties props) throws javax.resource.ResourceException
ra
- The new ResourceAdapter JavaBeanprops
- Properties associated with the versioning
when it can be undeployedjavax.resource.ResourceException
- If something goes wrongvoid init(javax.resource.spi.ResourceAdapter ra, java.util.Properties props) throws javax.resource.ResourceException
ra
- The old version of the resource adapter that is currently runningprops
- Properties associated with the versioning operationjavax.resource.ResourceException
- If the init() fails.