|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mqe.MQe | +--com.ibm.mqe.MQeAdapter | +--com.ibm.mqe.adapters.MQeMemoryFieldsAdapter
The MQeMemoryFieldsAdapter is an adapter that provides support for reading and writing MQeFields information to memory. This adapter behaves in a similar fashion to the MQeDiskFieldsAdapter, except that the “directory” structure is actually an internal hash table.
This file extends MQeAdapter class.
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 |
Constructor Summary | |
MQeMemoryFieldsAdapter()
|
Method Summary | |
void |
activate(java.lang.String fileDesc,
java.lang.Object param,
java.lang.Object options,
int lrecl,
int noRec)
Initializes a new MQeMemoryFieldsAdapter object. |
void |
close(java.lang.Object opt)
Closes the current MQeMemoryFieldsAdapter 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)
Removes a file from memory. |
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 memory. |
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 |
public MQeMemoryFieldsAdapter()
Method Detail |
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 MQeMemoryFieldsAdapter object.
The activate() method initialises a new MQeDiskFieldsAdapter object. Note that this call also sets the QOS Size parameter to be -1, and QoS bytes read and written is not updated.
activate
in class MQeAdapter
fileDesc
- String containing 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 - 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.options
- Object containing any objects (e.g. PERSIST,
HISTORY)
java.lang.Exception
- Usage Example :
mymfa.activate("./mydir/mysubdir",null,MQe.MQeAdapter_READ,0,0);public void close(java.lang.Object opt) throws java.lang.Exception
Closes the current MQeMemoryFieldsAdapter object.
Closes the current adapter so that it can no longer be read from or written to.
close
in class MQeAdapter
opt
- Object not used.
java.lang.Exception
- Usage Example :
mymfa.close(null);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.
control
in class MQeAdapter
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.
java.lang.Exception
- Usage Example :
String [] fileList =(String[])mydfa.control(MQe.MQe_Adapter_LIST, null);public void erase(java.lang.Object opt) throws java.lang.Exception
Removes a file from memory.
Erases a file from memory. Does not erase directories.
opt
- Object String that contains the file name to be deleted.
Before the name is passed to the hash tables remove routine, the
file name is appended to the current value of the File descriptor.
MQeException
- If the argument supplied referred to a directory or
was not a String.
java.lang.Exception
- Usage Example :
public void open(java.lang.Object opt) throws java.lang.Exception
Opens a file for use.
Closes any open files and then opens a file for use.
open
in class MQeAdapter
opt
- Object A String that specifies the filename to be opened.
This file should exist in the folder specified on the File Descriptor
value (supplied on the activate call).
java.lang.Exception
- Usage Example :
mymfa.open("myfile.txt");public java.lang.Object readObject(java.lang.Object opt) throws java.lang.Exception
Reads an MQeFields object from the current file.
We need to clone the object before returning it, as we do not want the caller to be able to modify our copy.
readObject
in class MQeAdapter
opt
- Object MQeFields object that can be used to
provide a filter within the directory object. Otherwise null.
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)mymfa.readObject(null);public java.lang.String status(java.lang.Object opt) throws java.lang.Exception
Provides information of the currently active settings.
opt
- Object String, only supports
MQe_Adapter_FILENAME - to get the name of the file.
java.lang.Exception
- Usage Example :
String filename =(String)mymfa.status(MQe.MQe_Adapter_FILENAME);public void writeObject(java.lang.Object opt, java.lang.Object data) throws java.lang.Exception
Writes an MQeFields object to memory.
writeObject
in class MQeAdapter
opt
- Object not used.data
- Object MQeFields object to dump to disk.
MQeException
- If an invalid data argument was supplied, or if the file
was not opened for writing.
java.lang.Exception
- Usage Example :
mymfa.writeObject(null,myMQeFields);
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |