public abstract class WmAdapter
extends java.lang.Object
WmAdapter
. This class serves as a "catch-all" for
properties of the adapter. This class also includes several methods to get
the adapter's resources.Modifier and Type | Field and Description |
---|---|
AdapterResourceBundleManager |
_resourceBundleManager
The adapter's manager for its resource bundle.
|
Constructor and Description |
---|
WmAdapter()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_init()
Initializes the adapter's resource bundles and performs ADK
initialization.
|
void |
cleanup()
Clean up any adapter-specific resources during termination.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this Adapter.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
com.wm.data.IData detail)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.String[] parms)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail,
java.lang.Throwable throwable)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail,
java.lang.Throwable throwable,
boolean log)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.String[] parms,
java.lang.Throwable throwable)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters and wrapped Throwable exception.
|
AdapterConnectionException |
createAdapterConnectionException(int minorCode,
java.lang.Throwable throwable)
Returns an AdapterConnectionException using the Major code and
ResourceBundle already associated with this adapter including a wrapped
Throwable exception.
|
AdapterException |
createAdapterException(int minorCode)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this Adapter.
|
AdapterException |
createAdapterException(int minorCode,
com.wm.data.IData detail)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter including insertion parameters,
IData detail information and a wrapped Throwable exception.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.String[] parms)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter, including insertion parameters.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter including insertion parameters
and IData detail information.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail,
java.lang.Throwable throwable)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter, including insertion parameters,
IData detail information and a wrapped Throwable exception.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.String[] parms,
java.lang.Throwable throwable)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter including insertion parameters
and a wrapped Throwable exception.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.String[] parms,
java.lang.Throwable throwable,
boolean log)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter including insertion parameters
and a wrapped Throwable exception.
|
AdapterException |
createAdapterException(int minorCode,
java.lang.Throwable throwable)
Returns an AdapterException using the Major Code and ResourceBundle that
are already associated with this adapter including a wrapped Throwable
exception.
|
AdapterServiceException |
createAdapterServiceException(int minorCode)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
com.wm.data.IData detail)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
java.lang.String[] parms)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
java.lang.String[] parms,
com.wm.data.IData detail,
java.lang.Throwable throwable)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters, IData detail information and a wrapped Throwable exception.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
java.lang.String[] parms,
java.lang.Throwable throwable)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including insertion
parameters and wrapped Throwable exception.
|
AdapterServiceException |
createAdapterServiceException(int minorCode,
java.lang.Throwable throwable)
Returns an AdapterServiceException using the Major code and
ResourceBundle already associated with this adapter including a wrapped
Throwable exception.
|
abstract void |
fillAdapterTypeInfo(AdapterTypeInfo info,
java.util.Locale locale)
Fills the
AdapterTypeInfo object with the adapter-specific
data in the specified locale. |
void |
fillResourceAdapterMetadataInfo(ResourceAdapterMetadataInfo info,
java.util.Locale locale)
Fill the ResourceAdapterMetadataInfo with the adapter-specific data in the specified locale.
|
java.lang.String |
getAdapterDescription(java.util.Locale locale)
Gets the adapter's description in the specified locale.
|
java.lang.String |
getAdapterDisplayName(java.util.Locale locale)
Gets the adapter's name in the specified locale.
|
abstract java.lang.String |
getAdapterJCASpecVersion()
Gets version of the J2EE JCA specification this adapter implements.
|
abstract int |
getAdapterMajorCode()
Gets the Major Code to be used by this adapter for journal logging and
exceptions.
|
abstract java.lang.String |
getAdapterName()
Gets the non-locale specific name for this adapter.
|
java.lang.String |
getAdapterOnlineHelp(java.util.Locale locale,
java.lang.String dspName)
Gets the adapter's base online help url.
|
java.lang.String |
getAdapterPatchLevel()
Get the adapter's patch level.
|
AdapterResourceBundleManager |
getAdapterResourceBundleManager()
Returns the AdapterResourceBundleManager associated with this adapter type.
|
abstract java.lang.String |
getAdapterResourceBundleName()
Gets the base Java class name for the adapter's resource bundle.
|
java.lang.String |
getAdapterVendorName(java.util.Locale locale)
Gets the adapter's vendor name in the specified locale.
|
abstract java.lang.String |
getAdapterVersion()
Gets the version of the adapter.
|
java.lang.String |
getUiItemHelp(java.lang.String name)
The adapter writer will override this method to associate a help page URL with
a custom menu item.
|
java.lang.String[] |
getUiItemNames()
The adapter writer will override this method to add custom menu items to
the adapter's main menu on the Integration Server Administrator Console.
|
java.lang.String |
getUiItemUrl(java.lang.String name)
The adapter writer will override this method to associate a URL with
a custom menu item.
|
abstract void |
initialize()
Initializes properties/resources associated with this adapter.
|
boolean |
isAdapterInDevMode() |
public AdapterResourceBundleManager _resourceBundleManager
AdapterResourceBundleManager
public WmAdapter() throws AdapterException
AdapterException
- if the AdapterResourceBundleManager cannot be created or if the
adapter's initialize() method returns an AdapterExceptionprotected void _init() throws AdapterException
AdapterException
- if internal initialization fails.public void cleanup()
public AdapterConnectionException createAdapterConnectionException(int minorCode)
minorCode
- int representing the Minor Code for this Exception.public AdapterConnectionException createAdapterConnectionException(int minorCode, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this Exception.detail
- An IData object representing Exception detail information.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.String[] parms)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.detail
- An IData object representing Exception detail information.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.detail
- An IData object representing Exception detail information.throwable
- A Throwable object representing the underlying error condition.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail, java.lang.Throwable throwable, boolean log)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.detail
- An IData object representing Exception detail information.throwable
- A Throwable object representing the underlying error condition.log
- a boolean to log the exception.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.String[] parms, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.throwable
- A Throwable object representing the underlying error condition.public AdapterConnectionException createAdapterConnectionException(int minorCode, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.throwable
- A Throwable object representing the underlying error condition.public AdapterException createAdapterException(int minorCode)
minorCode
- int representing the Minor Code for this exception.public AdapterException createAdapterException(int minorCode, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this exception.detail
- an IData object representing exception detail information.public AdapterException createAdapterException(int minorCode, java.lang.String[] parms)
minorCode
- int representing the Minor Code for this exception.parms
- an array of Strings to be inserted into the exception text.public AdapterException createAdapterException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this exception.parms
- an array of Strings to be inserted into the exception text.detail
- an IData object representing exception detail information.public AdapterException createAdapterException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this exception.parms
- an array of Strings to be inserted into the exception text.detail
- an IData object representing exception detail information.throwable
- a Throwable object representing the underlying error condition.public AdapterException createAdapterException(int minorCode, java.lang.String[] parms, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this exception.parms
- an array of Strings to be inserted into the exception text.throwable
- a Throwable object representing the underlying error condition.public AdapterException createAdapterException(int minorCode, java.lang.String[] parms, java.lang.Throwable throwable, boolean log)
minorCode
- int representing the Minor Code for this exception.parms
- an array of Strings to be inserted into the exception text.throwable
- a Throwable object representing the underlying error condition.log
- a boolean to log the exception.public AdapterException createAdapterException(int minorCode, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this exception.throwable
- a Throwable object representing the underlying error condition.public AdapterServiceException createAdapterServiceException(int minorCode)
minorCode
- int representing the Minor Code for this Exception.public AdapterServiceException createAdapterServiceException(int minorCode, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this Exception.detail
- An IData object representing Exception detail information.public AdapterServiceException createAdapterServiceException(int minorCode, java.lang.String[] parms)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.public AdapterServiceException createAdapterServiceException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.detail
- An IData object representing Exception detail information.public AdapterServiceException createAdapterServiceException(int minorCode, java.lang.String[] parms, com.wm.data.IData detail, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.detail
- An IData object representing Exception detail information.throwable
- A Throwable object representing the underlying error condition.public AdapterServiceException createAdapterServiceException(int minorCode, java.lang.String[] parms, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.parms
- An array of strings to be inserted into the Exception text.throwable
- A Throwable object representing the underlying error condition.public AdapterServiceException createAdapterServiceException(int minorCode, java.lang.Throwable throwable)
minorCode
- int representing the Minor Code for this Exception.throwable
- A Throwable object representing the underlying error condition.public abstract void fillAdapterTypeInfo(AdapterTypeInfo info, java.util.Locale locale)
AdapterTypeInfo
object with the adapter-specific
data in the specified locale. Instances of AdapterTypeInfo
describe the connections supported by this adapter and the notifications
supported by this adapter.
Adapter writers must implement this method to register the connections
supported by this adapter by calling AdapterTypeInfo.addConnectionFactory(java.lang.String)
for each connection type. Adapter
writers must also call AdapterTypeInfo.addNotificationType(java.lang.String)
for
each notification type this adapter supports.info
- the AdapterTypeInfo object the adapter should fill.locale
- the locale of the locale-dependent field values of AdapterTypeInfo
that should be used to create those field values. Currently, the locale is not used.AdapterTypeInfo
public void fillResourceAdapterMetadataInfo(ResourceAdapterMetadataInfo info, java.util.Locale locale) throws AdapterException
ResourceAdapterMetadataInfo
describe the adapter, and
include information such as the adapter's name, description, vendor name, and version.info
- the ResourceAdapterMetadataInfo object the adapter should fill.locale
- the locale of the locale-dependent field values of ResourceAdapterMetadataInfo
that should be used to create those field values.AdapterException
ResourceAdapterMetadataInfo
public java.lang.String getAdapterDescription(java.util.Locale locale) throws AdapterException
l
- the Locale object representing the locale the adapter description should be returned in.AdapterException
- if a problem was encountered getting the adapter description in the specified locale.public java.lang.String getAdapterDisplayName(java.util.Locale locale) throws AdapterException
l
- the Locale object representing the locale the adapter name should be returned in.AdapterException
- if a problem was encountered getting the adapter name in the specified locale.public abstract java.lang.String getAdapterJCASpecVersion()
public abstract int getAdapterMajorCode()
public abstract java.lang.String getAdapterName()
public java.lang.String getAdapterOnlineHelp(java.util.Locale locale, java.lang.String dspName) throws AdapterException
AdapterException
- if a problem was encountered getting the adapter help url.public java.lang.String getAdapterPatchLevel()
public AdapterResourceBundleManager getAdapterResourceBundleManager()
public abstract java.lang.String getAdapterResourceBundleName()
public java.lang.String getAdapterVendorName(java.util.Locale locale) throws AdapterException
l
- the Locale object representing the locale the adapter's vendor name should be returned in.AdapterException
- if a problem was encountered getting the adapter's vendor name in the specified locale.public abstract java.lang.String getAdapterVersion()
public java.lang.String getUiItemHelp(java.lang.String name)
name
- a String returned by the getUiItem() method.public java.lang.String[] getUiItemNames()
public java.lang.String getUiItemUrl(java.lang.String name)
name
- a String returned by the getUiItem() method.public abstract void initialize() throws AdapterException
AdapterException
- if a problem was encountered while initializing properties/resourcespublic boolean isAdapterInDevMode()
Copyright © 2003 - 2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.