Websphere MQ Everyplace

com.ibm.mqe
Class MQeAdapter

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeAdapter
All Implemented Interfaces:
MQeExceptionCodes
Direct Known Subclasses:
MQeDiskFieldsAdapter, MQeDiskFieldsAdapter, MQeMappingAdapter, MQeMemoryFieldsAdapter, MQeMidpFieldsAdapter

public class MQeAdapter
extends MQe

This is the base class that provides the generic adapter features. It provides implementations for all methods that adapters could call. Any new adapters must inherit from MQeAdapter.

The default action is to throw an "unsupported" exception.

This class is a descendant of MQe class.


Field Summary
static java.lang.String MQe_Adapter_BYTECOUNTS
          An option that may be used when calling the status method.
static java.lang.String MQe_Adapter_EXISTS
          MQe_Adapter_EXISTS is used when calling the control method in order to ascertain if a particular file already exists.
static java.lang.String MQe_Adapter_FILENAME
          MQe_Adapter_FILENAME is used when calling the control method in order to obtain the current file name being operated on by that storage adapter.
static java.lang.String MQe_Adapter_FILTER
          MQe_Adapter_FILTER is used when calling the control method in order to set the current filter being used by that storage adapter.
static java.lang.String MQe_Adapter_LIST
          MQe_Adapter_LIST is used when calling the control method in order to obtain a list of files from the directory for this storage adapter.
static java.lang.String MQe_Adapter_READ
          MQe_Adapter_READ is used to set the file attributes in a storage adapter by passing this option in on the activate method
static java.lang.String MQe_Adapter_RENAME
          MQe_Adapter_RENAME is used when calling the control method in order to rename a file to the name contained in the storage adapter as currently set by the MQe_Adapter_FILTER.
static java.lang.String MQe_Adapter_RETRIES
          MQe_Adapter_RETRIES is used when activating a storage adapter to indicate the number of times the adapter should attempt to access a file before giving up.
static java.lang.String MQe_Adapter_UPDATE
          MQe_Adapter_UPDATE is used to set the file attributes in a storage adapter by passing this option in on the activate method
static java.lang.String MQe_Adapter_WRITE
          MQe_Adapter_WRITE is used to set the file attributes in a storage adapter by passing this option in on the activate method
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name, version
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
MQeAdapter()
           
 
Method Summary
 void activate(java.lang.String file, java.lang.Object param, java.lang.Object option, int notUsed1, int notUsed2)
          Used to activate an adapter.
 void close(java.lang.Object option)
          Closes an adapter.
 java.lang.Object control(java.lang.Object option, java.lang.Object ctrlObj)
          Modifies the behaviour of the adapter.
 void open(java.lang.Object option)
          Opens an adapter for use.
 byte[] read(java.lang.Object option, int value0)
          Reads data from the adapter.
 java.lang.Object readObject(java.lang.Object option)
          Reads an object from the adapter.
 void writeObject(java.lang.Object option, java.lang.Object data)
          Writes an object to the adapter stream.
 
Methods inherited from class com.ibm.mqe.MQe
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MQe_Adapter_FILENAME

public static final java.lang.String MQe_Adapter_FILENAME
MQe_Adapter_FILENAME is used when calling the control method in order to obtain the current file name being operated on by that storage adapter.

See Also:
Constant Field Values

MQe_Adapter_FILTER

public static final java.lang.String MQe_Adapter_FILTER
MQe_Adapter_FILTER is used when calling the control method in order to set the current filter being used by that storage adapter. If a filter is set on a storage adapter, a call to listMatchingFiles() will only return those file names that match the filter.

See Also:
Constant Field Values

MQe_Adapter_LIST

public static final java.lang.String MQe_Adapter_LIST
MQe_Adapter_LIST is used when calling the control method in order to obtain a list of files from the directory for this storage adapter. The files are filtered if the filter has been set for this adapter.

See Also:
Constant Field Values

MQe_Adapter_EXISTS

public static final java.lang.String MQe_Adapter_EXISTS
MQe_Adapter_EXISTS is used when calling the control method in order to ascertain if a particular file already exists.

See Also:
Constant Field Values

MQe_Adapter_RENAME

public static final java.lang.String MQe_Adapter_RENAME
MQe_Adapter_RENAME is used when calling the control method in order to rename a file to the name contained in the storage adapter as currently set by the MQe_Adapter_FILTER.

See Also:
Constant Field Values

MQe_Adapter_BYTECOUNTS

public static final java.lang.String MQe_Adapter_BYTECOUNTS
An option that may be used when calling the status method. The number of bytes read, written and in error for that particular storage adapter are returned

See Also:
Constant Field Values

MQe_Adapter_READ

public static final java.lang.String MQe_Adapter_READ
MQe_Adapter_READ is used to set the file attributes in a storage adapter by passing this option in on the activate method

See Also:
Constant Field Values

MQe_Adapter_UPDATE

public static final java.lang.String MQe_Adapter_UPDATE
MQe_Adapter_UPDATE is used to set the file attributes in a storage adapter by passing this option in on the activate method

See Also:
Constant Field Values

MQe_Adapter_WRITE

public static final java.lang.String MQe_Adapter_WRITE
MQe_Adapter_WRITE is used to set the file attributes in a storage adapter by passing this option in on the activate method

See Also:
Constant Field Values

MQe_Adapter_RETRIES

public static final java.lang.String MQe_Adapter_RETRIES
MQe_Adapter_RETRIES is used when activating a storage adapter to indicate the number of times the adapter should attempt to access a file before giving up. The default is no retries, this value only becomes important when using storage devices that may be locked out from applications.

See Also:
Constant Field Values
Constructor Detail

MQeAdapter

public MQeAdapter()
Method Detail

activate

public void activate(java.lang.String file,
                     java.lang.Object param,
                     java.lang.Object option,
                     int notUsed1,
                     int notUsed2)
              throws java.lang.Exception

Used to activate an adapter. Should only ever be called once in the life-time of the object.

Note : This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
file - String containing the file description ('fileid'). e.g. for network adapters this may be the IP address.
param - Object containing any required parameters of the adapter. e.g. an MQeAttribute for a file store adapter.
option - Object containing any objects (e.g. PERSIST, HISTORY)
Returns:
None
Throws:
java.lang.Exception - - Does not throw anything.

close

public void close(java.lang.Object option)
           throws java.lang.Exception

Closes an adapter.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

Note: This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
option - Any options for the adapter, or null.
Returns:
None
Throws:
MQeException - - MQe.Except_NotSupported.
java.lang.Exception

control

public java.lang.Object control(java.lang.Object option,
                                java.lang.Object ctrlObj)
                         throws java.lang.Exception

Modifies the behaviour of the adapter.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

 This class supplies two operations:
 Option = MQe.MQe_Adapter_GETPERSIST : Returns any persistent object.
 member variable associated with this adapter.
 Option = MQe.MQe_Adapter_PERSIST : Stores away a persistent object.
 member variable, and returns the previous one.

Parameters:
option - Object containing the operation(s) to perform or null.
ctrlObj - Object used by the adapter for the control.(specific to each adapter type)
Returns:
An Object dependent on the adapter type or null.
Throws:
MQeException - - MQe.Except_NotSupported.
java.lang.Exception

open

public void open(java.lang.Object option)
          throws java.lang.Exception

Opens an adapter for use.

This method is used to bind to a file through the adapter.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

Note : This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
option - Any options for the adapter, or null.
Returns:
None
Throws:
MQeException - MQe.Except_NotSupported.
java.lang.Exception

read

public byte[] read(java.lang.Object option,
                   int value0)
            throws java.lang.Exception

Reads data from the adapter.

This method is used to read a record from the specified file.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

Note : This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
option - Any options for the adapter, or null.
value0 - The record number to be written or -1
Returns:
A quality of service byte array containing the data bytes read from the file object.
Throws:
MQeException - MQe.Except_NotSupported.
java.lang.Exception

readObject

public java.lang.Object readObject(java.lang.Object option)
                            throws java.lang.Exception

Reads an object from the adapter.

This method is used to read an Object from the specified file.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

Note : This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
option - Any options for the adapter, or null.
Returns:
An Object containing the data read from the file.
Throws:
MQeException - MQe.Except_NotSupported.
java.lang.Exception

writeObject

public void writeObject(java.lang.Object option,
                        java.lang.Object data)
                 throws java.lang.Exception

Writes an object to the adapter stream.

This method is used to write an Object to the specified file.

The MQeAdapter base class throws a "not supported" exception. New adapters should override this method if appropriate.

Note : This entry point is meant to be used by the WebSphere MQ Everyplace object library not by application programs.

Parameters:
data - An Object containing the data to be written.
Returns:
None
Throws:
MQeException - - MQe.Except_NotSupported.
java.lang.Exception

Websphere MQ Everyplace