com.ibm.j2ca.base
Class WBIActivationSpec

java.lang.Object
  extended bycom.ibm.j2ca.base.WBIActivationSpec
All Implemented Interfaces:
javax.resource.spi.ActivationSpec, com.ibm.j2ca.extension.eventmanagement.EventManagerActivationSpecExtension, javax.resource.spi.ResourceAdapterAssociation

public class WBIActivationSpec
extends java.lang.Object
implements javax.resource.spi.ActivationSpec, com.ibm.j2ca.extension.eventmanagement.EventManagerActivationSpecExtension

Provides a generic implementation of the ActivationSpec interface including properties required by the base classes. This class should be used directly or extended by resource adapter developers for their own ActivationSpec implementations. If extended, this class should provide JavaBean-compliant accessor pairs to get/set EIS-specific inbound configuration properties and extend validate() to verify that user-provided values are appropriate.

In addition, adapter developers should be sure to update the adapter deployment descriptor to ensure that the JCA container (and users) are made aware of the additional properties available.


Field Summary
static java.lang.String DELIVERY_TYPE_DEBUG
          Delivers events to the endpoint in order on a single thread.
static java.lang.String DELIVERY_TYPE_ORDERED
          Delivers events to the endpoint while maintaining their sequence.
static java.lang.String DELIVERY_TYPE_UNORDERED
          Delivers events to the endpoint concurrently and without regard to their order in the EIS.
protected  LogUtils logUtils
           
 
Constructor Summary
WBIActivationSpec()
           
 
Method Summary
 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.String getBiDiTanslatedEDTDatabaseName(java.lang.String db)
           
 java.lang.String getBiDiTanslatedEDTPassword(java.lang.String password)
           
 java.lang.String getBiDiTanslatedEDTSchema(java.lang.String schema)
           
 java.lang.String getBiDiTanslatedEDTTable(java.lang.String table)
           
 java.lang.String getBiDiTanslatedEDTURL(java.lang.String url)
           
 java.lang.String getBiDiTanslatedEDTUser(java.lang.String user)
           
 java.lang.String getBONamespace()
          Returns the value of configuration property BONamespace.
 java.lang.String getDeliveryType()
           
 java.lang.String getEDT_BiDiFormat()
           
 java.lang.String getEDT_BiDiSkip()
           
 java.lang.String getEDTDatabaseName()
           
 java.lang.String getEDTDriverName()
           
 int getEDTPortNumber()
           
 java.lang.String getEDTSchemaName()
           
 java.lang.String getEDTServerName()
           
 java.lang.String getEDTTableName()
           
 java.lang.String getEDTURL_BiDiSkip()
           
 java.lang.String getEDTURL_BiDiSpecialFormat()
           
 java.lang.String getEDTURL()
           
 java.lang.String getEDTUserName()
           
 java.lang.String getEDTUserPassword()
           
 int getPollPeriod()
           
 int getPollQuantity()
           
 javax.resource.spi.ResourceAdapter getResourceAdapter()
           
 int getRetryInterval()
           
 boolean isAutoCreateEDT()
          Indicates whether autoCreate has been enabled.
 void setAutoCreateEDT(boolean autoCreateEDT)
          Specifies whether autoCreate is enabled.
 void setBiDiContextEIS(java.lang.String str)
           
 void setBiDiContextMetadata(java.lang.String str)
           
 void setBiDiContextSkip(java.lang.String str)
           
 void setBiDiContextSpecialFormat(java.lang.String str)
           
 void setBONamespace(java.lang.String newValue)
          Sets the value of configuration property BONamespace.
 void setDeliveryType(java.lang.String deliveryType)
          Sets the order in which events will be published by the event manager.
 void setEDT_BiDiFormat(java.lang.String str)
           
 void setEDT_BiDiSkip(java.lang.String str)
           
 void setEDTDatabaseName(java.lang.String edtDatabaseName)
           
 void setEDTDriverName(java.lang.String edtDriverName)
           
 void setEDTPortNumber(int edtPortNumber)
           
 void setEDTSchemaName(java.lang.String edtSchemaName)
           
 void setEDTServerName(java.lang.String edtServerName)
           
 void setEDTTableName(java.lang.String edtTableName)
           
 void setEDTURL_BiDiSkip(java.lang.String str)
           
 void setEDTURL_BiDiSpecialFormat(java.lang.String str)
           
 void setEDTURL(java.lang.String edtURL)
           
 void setEDTUserName(java.lang.String edtUserName)
           
 void setEDTUserPassword(java.lang.String edtUserPassword)
           
 void setLogUtils(LogUtils utils)
          Specifies a LogUtils instance for logging, tracing, and monitoring
 void setPollPeriod(int pollPeriod)
           
 void setPollQuantity(int pollQuantity)
           
 void setResourceAdapter(javax.resource.spi.ResourceAdapter resourceAdapter)
           
 void setRetryInterval(int retryInterval)
           
 void validate()
          Validates the configuration properties specified in the ActivationSpec instance to ensure they comply with documented constraints.
protected  void verifyBiDiFormatValues()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELIVERY_TYPE_DEBUG

public static final java.lang.String DELIVERY_TYPE_DEBUG
Delivers events to the endpoint in order on a single thread. Due to low performance, should only be used to eliminate risk of threading issues during diagnostics.

See Also:
Constant Field Values

DELIVERY_TYPE_ORDERED

public static final java.lang.String DELIVERY_TYPE_ORDERED
Delivers events to the endpoint while maintaining their sequence.

See Also:
Constant Field Values

DELIVERY_TYPE_UNORDERED

public static final java.lang.String DELIVERY_TYPE_UNORDERED
Delivers events to the endpoint concurrently and without regard to their order in the EIS.

See Also:
Constant Field Values

logUtils

protected LogUtils logUtils
Constructor Detail

WBIActivationSpec

public WBIActivationSpec()
Method Detail

validate

public void validate()
              throws javax.resource.spi.InvalidPropertyException
Validates the configuration properties specified in the ActivationSpec instance to ensure they comply with documented constraints.

Specified by:
validate in interface javax.resource.spi.ActivationSpec
Throws:
javax.resource.spi.InvalidPropertyException - if one or more property values are invalid }
See Also:
ActivationSpec.validate()

getResourceAdapter

public javax.resource.spi.ResourceAdapter getResourceAdapter()
Specified by:
getResourceAdapter in interface javax.resource.spi.ResourceAdapterAssociation
Returns:
a WBIResourceAdapter instance
See Also:
ResourceAdapterAssociation.getResourceAdapter()

setResourceAdapter

public void setResourceAdapter(javax.resource.spi.ResourceAdapter resourceAdapter)
                        throws javax.resource.ResourceException
Specified by:
setResourceAdapter in interface javax.resource.spi.ResourceAdapterAssociation
Parameters:
resourceAdapter - - a WBIResourceAdapter instance
Throws:
javax.resource.ResourceException
See Also:
ResourceAdapterAssociation.setResourceAdapter(javax.resource.spi.ResourceAdapter)

getDeliveryType

public java.lang.String getDeliveryType()
Specified by:
getDeliveryType in interface com.ibm.j2ca.extension.eventmanagement.EventManagerActivationSpecExtension
Returns:
Returns the order in which events will be published by the event manager.

setDeliveryType

public void setDeliveryType(java.lang.String deliveryType)
Sets the order in which events will be published by the event manager.

Specified by:
setDeliveryType in interface com.ibm.j2ca.extension.eventmanagement.EventManagerActivationSpecExtension
Parameters:
deliveryType - can be one of the following:
  • "DEBUG"
  • "ORDERED"
  • "UNORDERED"

getEDTDatabaseName

public java.lang.String getEDTDatabaseName()
Returns:
Returns the edtDatabaseName.

setEDTDatabaseName

public void setEDTDatabaseName(java.lang.String edtDatabaseName)
Parameters:
edtDatabaseName - The edtDatabaseName to set.

getEDTDriverName

public java.lang.String getEDTDriverName()
Returns:
Returns the edtDriverName.

setEDTDriverName

public void setEDTDriverName(java.lang.String edtDriverName)
Parameters:
edtDriverName - The edtDriverName to set.

getEDTSchemaName

public java.lang.String getEDTSchemaName()
Returns:
Returns the edtSchemaName.

setEDTSchemaName

public void setEDTSchemaName(java.lang.String edtSchemaName)
Parameters:
edtSchemaName - The edtSchemaName to set.

getEDTTableName

public java.lang.String getEDTTableName()
Returns:
Returns the edtTableName.

setEDTTableName

public void setEDTTableName(java.lang.String edtTableName)
Parameters:
edtTableName - The edtTableName to set.

getEDTUserName

public java.lang.String getEDTUserName()
Returns:
Returns the edtUserName.

setEDTUserName

public void setEDTUserName(java.lang.String edtUserName)
Parameters:
edtUserName - The edtUserName to set.

getEDTUserPassword

public java.lang.String getEDTUserPassword()
Returns:
Returns the edtUserPassword.

setEDTUserPassword

public void setEDTUserPassword(java.lang.String edtUserPassword)
Parameters:
edtUserPassword - The edtUserPassword to set.

getPollPeriod

public int getPollPeriod()
Returns:
Returns the pollPeriod.

setPollPeriod

public void setPollPeriod(int pollPeriod)
Parameters:
pollPeriod - The pollPeriod to set.

getPollQuantity

public int getPollQuantity()
Returns:
Returns the pollQuantity.

setPollQuantity

public void setPollQuantity(int pollQuantity)
Parameters:
pollQuantity - The pollQuantity to set.

setRetryInterval

public void setRetryInterval(int retryInterval)
Parameters:
retryInterval - The desired interval in seconds

getRetryInterval

public int getRetryInterval()
Returns:
the retry interval in seconds

isAutoCreateEDT

public boolean isAutoCreateEDT()
Indicates whether autoCreate has been enabled.

Returns:
true if autoCreate has been enabled.

setAutoCreateEDT

public void setAutoCreateEDT(boolean autoCreateEDT)
Specifies whether autoCreate is enabled.

Parameters:
autoCreateEDT - The autoCreateEDT to set.

setLogUtils

public void setLogUtils(LogUtils utils)
Specifies a LogUtils instance for logging, tracing, and monitoring

Parameters:
utils - The LogUtils instance

getEDTURL

public java.lang.String getEDTURL()
Returns:
Returns the edtURL.

setEDTURL

public void setEDTURL(java.lang.String edtURL)
Parameters:
edtURL - The edtURL to set.

getEDTServerName

public java.lang.String getEDTServerName()
Returns:
Returns the edtServerName.

setEDTServerName

public void setEDTServerName(java.lang.String edtServerName)
Parameters:
edtServerName - The edtServerName to set.

getEDTPortNumber

public int getEDTPortNumber()
Returns:
Returns the edtPortNumber.

setEDTPortNumber

public void setEDTPortNumber(int edtPortNumber)
Parameters:
edtPortNumber - The edtPortNumber to set.

getBiDiContextEIS

public java.lang.String getBiDiContextEIS()

setBiDiContextEIS

public void setBiDiContextEIS(java.lang.String str)
                       throws javax.resource.ResourceException
Throws:
javax.resource.ResourceException

getBiDiContextMetadata

public java.lang.String getBiDiContextMetadata()

setBiDiContextMetadata

public void setBiDiContextMetadata(java.lang.String str)
                            throws javax.resource.ResourceException
Throws:
javax.resource.ResourceException

getBiDiContextSpecialFormat

public java.lang.String getBiDiContextSpecialFormat()

setBiDiContextSpecialFormat

public void setBiDiContextSpecialFormat(java.lang.String str)

getBiDiContextSkip

public java.lang.String getBiDiContextSkip()

setBiDiContextSkip

public void setBiDiContextSkip(java.lang.String str)

getBiDiContext

public com.ibm.j2ca.base.bidi.WBIBiDiContext getBiDiContext()

setEDT_BiDiFormat

public void setEDT_BiDiFormat(java.lang.String str)
                       throws javax.resource.ResourceException
Throws:
javax.resource.ResourceException

getEDT_BiDiFormat

public java.lang.String getEDT_BiDiFormat()

setEDTURL_BiDiSpecialFormat

public void setEDTURL_BiDiSpecialFormat(java.lang.String str)

getEDTURL_BiDiSpecialFormat

public java.lang.String getEDTURL_BiDiSpecialFormat()

setEDT_BiDiSkip

public void setEDT_BiDiSkip(java.lang.String str)

getEDT_BiDiSkip

public java.lang.String getEDT_BiDiSkip()

setEDTURL_BiDiSkip

public void setEDTURL_BiDiSkip(java.lang.String str)

getEDTURL_BiDiSkip

public java.lang.String getEDTURL_BiDiSkip()

getBiDiTanslatedEDTUser

public java.lang.String getBiDiTanslatedEDTUser(java.lang.String user)

getBiDiTanslatedEDTPassword

public java.lang.String getBiDiTanslatedEDTPassword(java.lang.String password)

getBiDiTanslatedEDTTable

public java.lang.String getBiDiTanslatedEDTTable(java.lang.String table)

getBiDiTanslatedEDTSchema

public java.lang.String getBiDiTanslatedEDTSchema(java.lang.String schema)

getBiDiTanslatedEDTDatabaseName

public java.lang.String getBiDiTanslatedEDTDatabaseName(java.lang.String db)

getBiDiTanslatedEDTURL

public java.lang.String getBiDiTanslatedEDTURL(java.lang.String url)

verifyBiDiFormatValues

protected void verifyBiDiFormatValues()
                               throws javax.resource.ResourceException
Throws:
javax.resource.ResourceException

setBONamespace

public void setBONamespace(java.lang.String newValue)
Sets the value of configuration property BONamespace. See documentation for description and usage.


getBONamespace

public java.lang.String getBONamespace()
Returns the value of configuration property BONamespace. See documentation for description and usage.