|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.j2ca.base.WBIResourceAdapter
A ResourceAdapter instance acts as a central authority for the state and instance-specific information about the adapter; in addition, it provides a means for the JCA container to register endpoints for inbound event delivery.
This class provides a foundation implementation that offers:
A subclass should:
getResourceAdapterMetadata()
WBIPollableResourceAdapter
Constructor Summary | |
---|---|
WBIResourceAdapter()
|
Method Summary | |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Registers a listener for general property changes. |
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Registers a listener for changes in a specific property. |
protected com.ibm.j2ca.extension.eventmanagement.EventManager |
createEventManager()
Used by this class to instantiate new event manager instances for inbound event delivery. |
void |
endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory mef,
javax.resource.spi.ActivationSpec aspec)
Works in concert with endpointDeactivation
to allow the resource adapter adapter container to add and remove
endpoints from the adapter. |
void |
endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory mef,
javax.resource.spi.ActivationSpec aspec)
Works in concert with endpointActivation to
allow the resource adapter container to add and remove endpoints from the
adapter. |
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getAdapterID()
|
com.ibm.j2ca.base.bidi.WBIBiDiContext |
getBiDiContext()
|
java.lang.String |
getBiDiContextEIS()
|
java.lang.String |
getBiDiContextMetadata()
|
java.lang.String |
getBiDiContextSkip()
|
java.lang.String |
getBiDiContextSpecialFormat()
|
java.lang.Boolean |
getBiDiContextTurnBiDiOff()
|
java.lang.String |
getLogFilename()
|
int |
getLogFileSize()
|
int |
getLogNumberOfFiles()
|
LogUtils |
getLogUtils()
Gets the logUtils for this resource adapter. |
protected java.beans.PropertyChangeSupport |
getPropertyChangeSupport()
Provides a PropertyChangeSupport instance that can be used to notify any listeners of property changes on the resource adapter. |
abstract WBIResourceAdapterMetadata |
getResourceAdapterMetadata()
Returns metadata about the resource adapter implementation. |
java.lang.Boolean |
getThreadContextPropagationRequired()
|
java.lang.String |
getTraceFilename()
|
int |
getTraceFileSize()
|
int |
getTraceNumberOfFiles()
|
javax.transaction.xa.XAResource[] |
getXAResources(javax.resource.spi.ActivationSpec[] activationSpecs)
Invoked by the JCA container to get XAResource instances for inbound event recovery. |
int |
hashCode()
|
void |
onPollFailure(com.ibm.j2ca.base.WBIPollingTask task,
java.lang.Throwable cause)
Invoked by a WBIPollingTask instance if any errors occur during polling. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Unregisters a listener for general property changes. |
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Unregisters a listener for changes in a specific property. |
void |
setAdapterID(java.lang.String newValue)
|
void |
setBiDiContextEIS(java.lang.String biDiContextEIS)
|
void |
setBiDiContextMetadata(java.lang.String biDiContextMetadata)
|
void |
setBiDiContextSkip(java.lang.String biDiContextSkip)
|
void |
setBiDiContextSpecialFormat(java.lang.String biDiContextSpecialFormat)
|
void |
setBiDiContextTurnBiDiOff(java.lang.Boolean biDiContextTurnBiDiOff)
|
void |
setLogFilename(java.lang.String newValue)
|
void |
setLogFileSize(int i)
|
void |
setLogNumberOfFiles(int i)
|
protected void |
setLogUtils(LogUtils logUtils)
Sets the logUtils for this resource adapter. |
void |
setThreadContextPropagationRequired(java.lang.Boolean newValue)
|
void |
setTraceFilename(java.lang.String newValue)
|
void |
setTraceFileSize(int i)
|
void |
setTraceNumberOfFiles(int i)
|
void |
start(javax.resource.spi.BootstrapContext bootstrapCtx)
Initializes the internal configuration of this class. |
void |
stop()
Releases any resources used by this class. |
protected void |
validate()
Validates the configuration properties defined for this resource adapter instance. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WBIResourceAdapter()
Method Detail |
public void start(javax.resource.spi.BootstrapContext bootstrapCtx) throws javax.resource.spi.ResourceAdapterInternalException
A subclass should override this method if it has its own configuration to intialize. According to Java Connector Architecture standards, this method should execute in a non-blocking fashion . Additionally, any subclasses that override this method should avoid intensive operations (for example, connecting to the EIS) unless these operations are performed in a separate Work instance submitted to the WorkManager.
start
in interface javax.resource.spi.ResourceAdapter
javax.resource.spi.ResourceAdapterInternalException
public void stop()
A subclasses should override this method to free up any of its own resources, such as physical connections to the EIS.
stop
in interface javax.resource.spi.ResourceAdapter
public void endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory mef, javax.resource.spi.ActivationSpec aspec) throws javax.resource.ResourceException
endpointDeactivation
to allow the resource adapter adapter container to add and remove
endpoints from the adapter.
A subclass does not need to override this method unless it wants to explicitely track endpoints.
If a subclass implements WBIPollableResourceAdapter
, this method
will track endpoints and activate or deactivate polling as appropriate. If the EIS
does not support polling, a subclass can ignore both these methods.
endpointActivation
in interface javax.resource.spi.ResourceAdapter
javax.resource.ResourceException
public void endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory mef, javax.resource.spi.ActivationSpec aspec)
endpointActivation
to
allow the resource adapter container to add and remove endpoints from the
adapter.
endpointDeactivation
in interface javax.resource.spi.ResourceAdapter
public void onPollFailure(com.ibm.j2ca.base.WBIPollingTask task, java.lang.Throwable cause)
onPollFailure
in interface com.ibm.j2ca.base.WBIPollingTaskListener
protected com.ibm.j2ca.extension.eventmanagement.EventManager createEventManager()
public javax.transaction.xa.XAResource[] getXAResources(javax.resource.spi.ActivationSpec[] activationSpecs) throws javax.resource.ResourceException
getXAResources
in interface javax.resource.spi.ResourceAdapter
javax.resource.ResourceException
protected java.beans.PropertyChangeSupport getPropertyChangeSupport()
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
public LogUtils getLogUtils()
LogUtils
protected void setLogUtils(LogUtils logUtils)
logUtils
- LogUtils
public java.lang.String getBiDiContextMetadata()
public void setBiDiContextMetadata(java.lang.String biDiContextMetadata) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public java.lang.String getBiDiContextEIS()
public void setBiDiContextEIS(java.lang.String biDiContextEIS) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public java.lang.String getBiDiContextSpecialFormat()
public void setBiDiContextSpecialFormat(java.lang.String biDiContextSpecialFormat)
public java.lang.String getBiDiContextSkip()
public void setBiDiContextSkip(java.lang.String biDiContextSkip)
public java.lang.Boolean getBiDiContextTurnBiDiOff()
public void setBiDiContextTurnBiDiOff(java.lang.Boolean biDiContextTurnBiDiOff)
public com.ibm.j2ca.base.bidi.WBIBiDiContext getBiDiContext()
public java.lang.String getAdapterID()
public java.lang.String getLogFilename()
public int getLogFileSize()
public int getLogNumberOfFiles()
public java.lang.String getTraceFilename()
public int getTraceFileSize()
public int getTraceNumberOfFiles()
public void setAdapterID(java.lang.String newValue) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setLogFilename(java.lang.String newValue) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setLogFileSize(int i) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setLogNumberOfFiles(int i) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setTraceFilename(java.lang.String newValue) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setTraceFileSize(int i) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public void setTraceNumberOfFiles(int i) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
public java.lang.Boolean getThreadContextPropagationRequired()
public void setThreadContextPropagationRequired(java.lang.Boolean newValue)
public abstract WBIResourceAdapterMetadata getResourceAdapterMetadata() throws javax.resource.ResourceException
ConnectionFactory.getMetaData()
but makes the same
data available to both the inbound and outbound components of the
adapter. This is required for logging and tracing implementations.
javax.resource.ResourceException
public int hashCode()
public boolean equals(java.lang.Object o)
protected void validate() throws javax.resource.spi.InvalidPropertyException
A subclass should override this method and add checks for its custom
configuration properties , and it should also call call super.validate
.
javax.resource.spi.InvalidPropertyException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |