|
Oracle Fusion Middleware User Messaging Service 11.1.1.7.0 Java API Reference E14011-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.sdp.messaging.driver.DriverResourceAdapterBase
public abstract class DriverResourceAdapterBase
Base class for a Driver's ResourceAdapter implementation. It contains:
configuration/driverconfig.xml
file.A new Driver ResourceAdapter should extend from this class.
Constructor Summary | |
---|---|
DriverResourceAdapterBase()
This constructor initializes the base RA. |
Method Summary | |
---|---|
DriverMetaData |
createDriverMetaData()
|
void |
endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory factory,
javax.resource.spi.ActivationSpec spec)
|
void |
endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory factory,
javax.resource.spi.ActivationSpec spec)
|
java.lang.String |
getCapability()
The driver capability. |
java.lang.String |
getCost()
Get the cost level. |
java.lang.String |
getDefaultSenderAddress()
|
DriverContext |
getDriverContext()
Get the driver context. |
java.lang.String |
getDriverInstanceId()
Get the unique driver instance id. |
java.lang.String |
getInstanceName()
The driver instance name. |
Properties |
getProperties()
Get the driver configuration properties. |
java.lang.String |
getSenderAddresses()
|
java.lang.String |
getSendingQueuesInfo()
The driver sending queues info. |
java.lang.String |
getSpeed()
Get the speed level. |
java.lang.String |
getSupportedCarriers()
Get the supported carriers. |
java.lang.String |
getSupportedContentTypes()
|
java.lang.String |
getSupportedDeliveryTypes()
|
java.lang.String |
getSupportedProtocols()
Get the supported protocols. |
java.lang.String |
getSupportedStatusTypes()
|
java.lang.String |
getSupportsCancel()
|
java.lang.String |
getSupportsReplace()
|
java.lang.String |
getSupportsStatusPolling()
|
java.lang.String |
getSupportsTracking()
|
javax.transaction.xa.XAResource[] |
getXAResources(javax.resource.spi.ActivationSpec[] as)
|
void |
onCommand(MessagingObject command)
|
void |
onMessage(Message message)
Message callback entry point. |
void |
onStatus(Status status)
The on-status call-back. |
void |
onWorkingStateChanged(WorkingStateType stateType)
Callback to indicate change in working state. |
void |
registerDriverInfo()
Register this driver's information with an Messaging engine. |
void |
setCapability(java.lang.String capability)
The driver capability. |
void |
setCost(java.lang.String cost)
Set the cost level. |
void |
setDefaultSenderAddress(java.lang.String defaultSenderAddress)
The default sender address. |
void |
setInstanceName(java.lang.String instanceName)
The driver instance name. |
void |
setSenderAddresses(java.lang.String senderAddresses)
The list of sender addresses that the driver supports. |
void |
setSendingQueuesInfo(java.lang.String sendingQueuesInfo)
The information of the queues that this driver's DriverDispatcherBean MDB instances are listening to for sending messages. |
void |
setSpeed(java.lang.String speed)
Set the speed level. |
void |
setSupportedCarriers(java.lang.String carriers)
Set the supported carriers. |
void |
setSupportedContentTypes(java.lang.String supportedContentTypes)
The supported content types. |
void |
setSupportedDeliveryTypes(java.lang.String supportedDeliveryTypes)
The supported delivery types. |
void |
setSupportedProtocols(java.lang.String protocols)
Set the supported protocols. |
void |
setSupportedStatusTypes(java.lang.String supportedStatusTypes)
The types of status supported by the driver. |
void |
setSupportsCancel(java.lang.String supportsCancel)
Indicates whether the driver supports the message cancel operation. |
void |
setSupportsReplace(java.lang.String supportsReplace)
Indicates whether the driver supports the message replace operation. |
void |
setSupportsStatusPolling(java.lang.String supportsStatusPolling)
For certain protocols, an active polling of the remote gateway must be performed to check the status of a message previously sent. |
void |
setSupportsTracking(java.lang.String supportsTracking)
Indicates whether the driver supports status tracking. |
void |
start(javax.resource.spi.BootstrapContext ctx)
|
void |
stop()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.sdp.messaging.driver.DriverResourceAdapter |
---|
startDriver, stopDriver |
Constructor Detail |
---|
public DriverResourceAdapterBase()
Method Detail |
---|
public void registerDriverInfo() throws DriverException
DriverException
public void start(javax.resource.spi.BootstrapContext ctx) throws javax.resource.spi.ResourceAdapterInternalException
start
in interface javax.resource.spi.ResourceAdapter
javax.resource.spi.ResourceAdapterInternalException
public void stop()
stop
in interface javax.resource.spi.ResourceAdapter
public void endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory factory, javax.resource.spi.ActivationSpec spec) throws javax.resource.ResourceException
endpointActivation
in interface javax.resource.spi.ResourceAdapter
javax.resource.ResourceException
ResourceAdapter.endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory, javax.resource.spi.ActivationSpec)
public void endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory factory, javax.resource.spi.ActivationSpec spec)
endpointDeactivation
in interface javax.resource.spi.ResourceAdapter
ResourceAdapter.endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory, javax.resource.spi.ActivationSpec)
public javax.transaction.xa.XAResource[] getXAResources(javax.resource.spi.ActivationSpec[] as) throws javax.resource.ResourceException
getXAResources
in interface javax.resource.spi.ResourceAdapter
javax.resource.ResourceException
public void onMessage(Message message)
onMessage
in interface MessageListener
message
- the message sent to the listener.public void onStatus(Status status)
MessageListener
onStatus
in interface MessageListener
status
- the status sent to the listener.public Properties getProperties()
public DriverContext getDriverContext()
public java.lang.String getDriverInstanceId()
public void onCommand(MessagingObject command) throws MessagingException
onCommand
in interface oracle.sdpinternal.messaging.config.CommandListener
MessagingException
public void onWorkingStateChanged(WorkingStateType stateType)
WorkingStateListener
RUNNING
indicates the driver is successfully initialized
and can be registered with the engine.
onWorkingStateChanged
in interface WorkingStateListener
stateType
- the new working state.public java.lang.String getSendingQueuesInfo()
public void setSendingQueuesInfo(java.lang.String sendingQueuesInfo)
JNDIQueueConnectionFactoryName1:JNDIQueueName1[[,JNDIQueueName2];
JNDIQueueConnectionFactoryName2:JNDIQueueName3]
Examples:
jms/MyQCF1:jms/sdpm/MyDriverSendingQ1
jms/MyQCF1:jms/sdpm/MyDriverSendingQ1,jms/sdpm/MyDriverSendingQ2
jms/MyQCF1:jms/sdpm/MyDriverSendingQ1;
jms/MyQCF2:jms/sdpm/MyDriverSendingQ2
public java.lang.String getInstanceName()
public void setInstanceName(java.lang.String instanceName)
public java.lang.String getCapability()
public void setCapability(java.lang.String capability)
public java.lang.String getDefaultSenderAddress()
public void setDefaultSenderAddress(java.lang.String defaultSenderAddress)
defaultSenderAddress
- the defaultSenderAddress to set.public java.lang.String getSenderAddresses()
public void setSenderAddresses(java.lang.String senderAddresses)
senderAddresses
- the senderAddresses to set.public java.lang.String getSupportedContentTypes()
public void setSupportedContentTypes(java.lang.String supportedContentTypes)
supportedContentTypes
- the supportedContentTypes to set.public java.lang.String getSupportedDeliveryTypes()
public void setSupportedDeliveryTypes(java.lang.String supportedDeliveryTypes)
supportedDeliveryTypes
- the supportedDeliveryTypes to set.public java.lang.String getSupportedStatusTypes()
public void setSupportedStatusTypes(java.lang.String supportedStatusTypes)
supportedStatusTypes
- the supportedStatusTypes to set.public java.lang.String getSupportsCancel()
public void setSupportsCancel(java.lang.String supportsCancel)
supportsCancel
- the supportsCancel to set.public java.lang.String getSupportsReplace()
public void setSupportsReplace(java.lang.String supportsReplace)
supportsReplace
- the supportsReplace to set.public java.lang.String getSupportsStatusPolling()
public void setSupportsStatusPolling(java.lang.String supportsStatusPolling)
supportsStatusPolling
- the supportsStatusPolling to set.public java.lang.String getSupportsTracking()
public void setSupportsTracking(java.lang.String supportsTracking)
supportsTracking
- the supportsTracking to set.public java.lang.String getCost()
public void setCost(java.lang.String cost)
cost
- the cost level.public java.lang.String getSpeed()
public void setSpeed(java.lang.String speed)
speed
- the speed level.public java.lang.String getSupportedCarriers()
public void setSupportedCarriers(java.lang.String carriers)
carriers
- the supported carriers.public java.lang.String getSupportedProtocols()
public void setSupportedProtocols(java.lang.String protocols)
protocols
- the supported protocols.public DriverMetaData createDriverMetaData() throws DriverException
DriverException
|
Oracle Fusion Middleware User Messaging Service 11.1.1.7.0 Java API Reference E14011-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |