Websphere MQ Everyplace

com.ibm.mqe.adapters
Class MQeDiskFieldsAdapter

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeAdapter
              |
              +--com.ibm.mqe.adapters.MQeDiskFieldsAdapter
All Implemented Interfaces:
MQeExceptionCodes
Direct Known Subclasses:
MQeCaseInsensitiveDiskAdapter, MQeMirroredDiskFieldsAdapter, MQeReducedDiskFieldsAdapter

public class MQeDiskFieldsAdapter
extends MQeAdapter

The MQeDiskFieldsAdapter is an adapter that provides support for reading and writing MQeFields information to a local disk. A single instance of this class refers to a single file on disk.

This file extends MQeAdapter class.

See Also:
MQeAdapter

Field Summary
 
Fields inherited from class com.ibm.mqe.MQeAdapter
MQe_Adapter_BYTECOUNTS, MQe_Adapter_EXISTS, MQe_Adapter_FILENAME, MQe_Adapter_FILTER, MQe_Adapter_LIST, MQe_Adapter_READ, MQe_Adapter_RENAME, MQe_Adapter_RETRIES, MQe_Adapter_UPDATE, MQe_Adapter_WRITE
 
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
MQeDiskFieldsAdapter()
           
 
Method Summary
 void activate(java.lang.String fileDesc, java.lang.Object param, java.lang.Object options, int lrecl, int noRec)
          Initializes a new MQeDiskFieldsAdapter object.
 void close(java.lang.Object opt)
          Closes the current MQeDiskFieldsAdapter object.
 java.lang.Object control(java.lang.Object opt, java.lang.Object ctrlObj)
          Allows the user to set the file filter or to list the files in the current file's folder.
 void erase(java.lang.Object opt)
          Erases a file from disk.
 void open(java.lang.Object opt)
          Opens a file for use.
 java.lang.Object readObject(java.lang.Object opt)
          Reads an MQeFields object from the current file.
 java.lang.String status(java.lang.Object opt)
          Provides information of the currently active settings.
 void writeObject(java.lang.Object opt, java.lang.Object data)
          Writes an MQeFields object to disk.
 
Methods inherited from class com.ibm.mqe.MQeAdapter
read
 
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
 

Constructor Detail

MQeDiskFieldsAdapter

public MQeDiskFieldsAdapter()
Method Detail

activate

public void activate(java.lang.String fileDesc,
                     java.lang.Object param,
                     java.lang.Object options,
                     int lrecl,
                     int noRec)
              throws java.lang.Exception

Initializes a new MQeDiskFieldsAdapter object.

The activate() method initialises a new MQeDiskFieldsAdapter object. Note that this call also sets the QOS Size parameter to be the size of the file or MQeFields object.

Overrides:
activate in class MQeAdapter
Parameters:
fileDesc - A String containing the name of this adapter, or its' alias, followed by a colon, followed by the directory path to be opened. Note: If you want to open a file the name of the file will be specified on the open. Just the path to the file here.
param - Object that sets the adapter's parameter value. Can supply an MQeAttribute object here that will cause the data to be encoded on disk.
options - Object, A String that specifies the open options:
        MQe_Adapter_READ   - read  the file
        MQe_Adapter_WRITE  - write the file
        MQe_Adapter_UPDATE - read and write the file
 
lrecl - Not used.
Returns:
void
Throws:
MQeException - If the specified directory hierarchy could not be created dynamically.
java.lang.Exception -

Usage Example :

mydfa.activate("./mydir/mysubdir",null,MQe.MQeAdapter_READ,0,0);

See Also:
readObject(java.lang.Object), writeObject(java.lang.Object, java.lang.Object)

close

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

Closes the current MQeDiskFieldsAdapter object.

Closes the current adapter so that it can no longer be read from or written to.

Overrides:
close in class MQeAdapter
Parameters:
opt - Object not used.
Returns:
void
Throws:
java.lang.Exception -

Usage Example :

mydfa.close(null);

control

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

Allows the user to set the file filter or to list the files in the current file's folder.

Overrides:
control in class MQeAdapter
Parameters:
opt - String options. One of:
        MQe_Adapter_FILTER - set the filter to the value of the
                             second parameter.
        MQe_Adapter_LIST   - to list the files.
ctrlObj - Object String that states the filter to use (if MQe_Adapter_FILTER was specified). Not used for MQe_Adapter_LIST.
Returns:
null for MQe_Adapter_FILTER, or the list of files in the case of MQe_Adapter_LIST.
Throws:
java.lang.Exception -

Usage Example :

String []fileList =(String [])mydfa.control(MQe.MQe_Adapter_LIST, null);

erase

public void erase(java.lang.Object opt)
           throws java.lang.Exception

Erases a file from disk.

Erases a file from disk. Does not erase directories.

Parameters:
opt - Object String that contains the file name to be deleted. Note: Before passing to the OS's delete routine, the file name is appended to the current FileDesc value.
Returns:
void
Throws:
MQeException - If the delete failed, or if the argument supplied referred to a directory or was not a String.
java.lang.Exception -

Usage Example :

mydfa.erase("myfile.txt");

open

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

Opens a file for use.

Opens a file for use, after having first closed any open file.

Overrides:
open in class MQeAdapter
Parameters:
opt - Object String that specifies the filename to be appended to the FileDesc.
Returns:
void
Throws:
java.lang.Exception -

Usage Example :

mydfa.open("myfile.txt");

readObject

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

Reads an MQeFields object from the current file.

Overrides:
readObject in class MQeAdapter
Parameters:
opt - Object MQeFields object that can be used to provide a filter within the directory object. Otherwise null.
Returns:
An MQeFields object that was read.
Throws:
MQeException - If no file matching the filter was found, or if the file is not open for reading.
java.lang.Exception -

Usage Example :

MQeFields myFields =(MQeFields)mydfa.readObject(null);

status

public java.lang.String status(java.lang.Object opt)
                        throws java.lang.Exception

Provides information of the currently active settings.

Parameters:
opt - Object String, one of :
     MQe_Adapter_FILTER - to get the name of the filter.
     MQe_Adapter_FILENAME - to get the name of the file.
 
Returns:
String either the name of the filter or the name of the file.
Throws:
java.lang.Exception -

Usage Example :

String filename =(String)mydfa.status(MQe.MQe_Adapter_FILENAME);

writeObject

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

Writes an MQeFields object to disk.

Overrides:
writeObject in class MQeAdapter
Parameters:
opt - Object not used.
data - Object MQeFields object to dump to disk.
Returns:
void
Throws:
MQeException - If an invalid data argument was supplied, or if the file was not opened for writing.
java.lang.Exception -

Usage Example :

mydfa.writeObject(null,myMQeFields);

Websphere MQ Everyplace