|
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 | +--examples.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 the base adapter class (com.ibm.mqe.MQeAdapter).
MQeAdapter
Field Summary | |
protected java.lang.String |
fileName
The disk file name that this instance is working with. |
protected java.lang.String |
filePath
The drive and directory path of the file. |
protected java.lang.String |
filter
File type filter. |
protected boolean |
reading
True if the file is opened for reading. |
static short[] |
version
|
protected boolean |
writing
True if the file is opened for writing. |
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 | |
boolean |
accept(java.io.File dir,
java.lang.String name)
Checks the extension of the given string to see if it ends with the currently defined file filter. |
void |
activate(java.lang.String fileDesc,
java.lang.Object param,
java.lang.Object options,
int lrecl,
int noRec)
The activate() method initialises a new MQeDiskFieldsAdapter object. |
void |
close(java.lang.Object opt)
Closes the current file. |
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 directory. |
void |
erase(java.lang.Object opt)
Erases a file from disk. |
void |
open(java.lang.Object opt)
Opens a file for use, after having first closed any open file. |
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 |
Field Detail |
public static short[] version
protected java.lang.String filter
protected java.lang.String fileName
protected java.lang.String filePath
protected boolean reading
protected boolean writing
Constructor Detail |
public MQeDiskFieldsAdapter()
Method Detail |
public boolean accept(java.io.File dir, java.lang.String name)
accept
in interface java.io.FilenameFilter
dir
- File (not used)name
- String, the name of the file to be checked.
public void activate(java.lang.String fileDesc, java.lang.Object param, java.lang.Object options, int lrecl, int noRec) throws java.lang.Exception
activate
in class MQeAdapter
fileDesc
- String, 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. See the writeObject/readObject methods.options
- 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.
java.lang.Exception
public void close(java.lang.Object opt) throws java.lang.Exception
close
in class MQeAdapter
opt
- Object (not used)
java.lang.Exception
public java.lang.Object control(java.lang.Object opt, java.lang.Object ctrlObj) throws java.lang.Exception
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
public void erase(java.lang.Object opt) throws java.lang.Exception
opt
- Object String that contains the file name to be deleted.
java.lang.Exception
- Note: Before passing to the OS's delete routine, the file name is appended to the current FileDesc value.
Does not work for directories.
public void open(java.lang.Object opt) throws java.lang.Exception
open
in class MQeAdapter
opt
- Object String that specifies the filename to be
appended to the FileDesc.
java.lang.Exception
public java.lang.Object readObject(java.lang.Object opt) throws java.lang.Exception
readObject
in class MQeAdapter
opt
- Object MQeFields object that can be used to
provide a filter within the directory object. Otherwise null.
java.lang.Exception
public java.lang.String status(java.lang.Object opt) throws java.lang.Exception
opt
- Object String, one of the following :
MQe_Adapter_FILTER - to get the name of the filter. MQe_Adapter_FILENAME - to get the name of the file.
java.lang.Exception
public void writeObject(java.lang.Object opt, java.lang.Object data) throws java.lang.Exception
writeObject
in class MQeAdapter
opt
- Object not used.data
- Object MQeFields object to dump to disk.
java.lang.Exception
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |