|
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.MQeDiskFieldsAdapter
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.
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 | |
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 |
public MQeDiskFieldsAdapter()
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 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.
activate
in class MQeAdapter
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.
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);readObject(java.lang.Object)
,
writeObject(java.lang.Object, java.lang.Object)
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.
close
in class MQeAdapter
opt
- Object not used.
java.lang.Exception
- Usage Example :
mydfa.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
Erases a file from disk.
Erases a file from disk. Does not erase directories.
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.
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");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.
open
in class MQeAdapter
opt
- Object String that specifies the filename to be
appended to the FileDesc.
java.lang.Exception
- Usage Example :
mydfa.open("myfile.txt");public java.lang.Object readObject(java.lang.Object opt) throws java.lang.Exception
Reads an MQeFields object from the current file.
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)mydfa.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, one of :
MQe_Adapter_FILTER - to get the name of the filter. MQe_Adapter_FILENAME - to get the name of the file.
java.lang.Exception
- Usage Example :
String filename =(String)mydfa.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 disk.
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 :
mydfa.writeObject(null,myMQeFields);
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |