|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.base.DSENotifier
com.ibm.dse.base.Service
com.ibm.dse.services.jxfs.JXFSService
This class implements a Service that manages a generic JXFS Device Control.
Field Summary | |
---|---|
static boolean |
AUTOOPEN_NO
|
static boolean |
AUTOOPEN_YES
|
protected java.lang.String |
configKey
The configuration application key used in the repository. |
protected java.util.Hashtable |
ids
The Hashtable for the synchronous pending operations identificationIDs. |
protected Vector |
idSyncs
The vector for the synchronous pending operations identificationIDs. |
protected int |
preOpenTimeout
The timeout for every function to wait for opening if there is automatic open. |
protected java.lang.String |
sdmAddparm
The first parameter of sdm. |
protected java.lang.String |
sdmName
The name of specific device manager (sdm). |
protected int |
syncTimeout
The timeout in miliseconds used by synchronous utilities. |
protected boolean |
trace
|
protected static int |
waitMsgTime
The poll time in miliseconds used by synchronous utilities. |
protected java.lang.String |
workstationName
The workstation name. |
Fields inherited from class com.ibm.dse.base.Service |
---|
externalizer |
Fields inherited from class com.ibm.dse.base.DSENotifier |
---|
handlersList, name |
Fields inherited from interface com.jxfs.events.IJxfsOperationCompleteListener |
---|
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL |
Fields inherited from interface com.jxfs.events.IJxfsStatusListener |
---|
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL |
Fields inherited from interface com.jxfs.events.IJxfsIntermediateListener |
---|
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL |
Fields inherited from interface com.jxfs.general.IJxfsConst |
---|
JXFS_ALL, JXFS_ALM_OFFSET, JXFS_CAM_OFFSET, JXFS_CDR_OFFSET, JXFS_CHK_OFFSET, JXFS_COPYRIGHT, JXFS_DEP_OFFSET, JXFS_E_BUSY, JXFS_E_CANCELLED, JXFS_E_CLAIMED, JXFS_E_CLOSED, JXFS_E_DISABLED, JXFS_E_EXISTS, JXFS_E_FAILURE, JXFS_E_FIRMWARE, JXFS_E_HARDWAREERROR, JXFS_E_ILLEGAL, JXFS_E_IO, JXFS_E_NOCONTROL, JXFS_E_NOEXIST, JXFS_E_NOHARDWARE, JXFS_E_NOSERVICE, JXFS_E_NOT_SUPPORTED, JXFS_E_NOTCLAIMED, JXFS_E_NOTREMOTE, JXFS_E_OFFLINE, JXFS_E_OPEN, JXFS_E_PARAMETER_INVALID, JXFS_E_REMOTE, JXFS_E_SYSTEM, JXFS_E_TIMEOUT, JXFS_E_UNREGISTERED, JXFS_FOREVER, JXFS_ISO_OFFSET, JXFS_LEVEL_ACTIVE, JXFS_LEVEL_ALL, JXFS_LEVEL_CONFIGURED, JXFS_LEVEL_WORKSTATION, JXFS_LOG_USEROFFSET, JXFS_MSD_OFFSET, JXFS_O_CLOSE, JXFS_O_OPEN, JXFS_O_UPDATEFIRMWARE, JXFS_PIN_OFFSET, JXFS_PTR_OFFSET, JXFS_RC_SUCCESSFUL, JXFS_RC_UNSUCCESSFUL, JXFS_S_BIN_STATUS, JXFS_S_CLAIMED, JXFS_S_HARDWAREERROR, JXFS_S_MEDIA_STATUS, JXFS_S_POWERSAVEOFF, JXFS_S_POWERSAVEON, JXFS_S_RELEASED, JXFS_S_REMOTEFAILURE, JXFS_S_SERVICE_STARTED, JXFS_S_SERVICE_STOPPED, JXFS_S_SHUTDOWN, JXFS_S_USERACTIONERROR, JXFS_S_WORKING, JXFS_SIU_OFFSET, JXFS_TIO_OFFSET, JXFS_VALID_CONTROLID, JXFS_VERSION_CONTROL, JXFSDEVICE_OFFSET, JXFSDIRECTIO_OFFSET, JXFSERR, JXFSERREXT, NO_MATCH, NO_SOURCE, NO_SUPPORT, OK_EQUAL, OK_NEWER, OK_OLDER, OK_OTHER |
Constructor Summary | |
---|---|
JXFSService()
This constructor creates a JXFSService object. |
|
JXFSService(java.lang.String aName)
This constructor creates a JXFSService object. |
Method Summary | |
---|---|
void |
cancel(int identificationID)
Makes a cancel call to the J/XFS Device Control. |
boolean |
claim(int timeout)
Makes a claim call to the J/XFS Device Control. |
int |
closeSync()
Makes a close call to the J/XFS Device Control and waits for the operation complete event. |
protected void |
finalize()
Makes a final clean and closes the device. |
java.lang.String |
getConfigKey()
Returns the value of the configKey property. |
com.jxfs.control.JxfsBaseControl |
getDeviceControl()
Returns the value of the myDeviceControl property. |
com.jxfs.general.JxfsDeviceManager |
getDeviceManager()
Returns the value of the myDeviceControl property. |
java.lang.String |
getDeviceName()
Returns the value of the deviceName property. |
java.lang.String |
getIniConfigFile()
Returns the value of the iniConfigFile property. |
java.lang.String |
getSdmAddparm()
Returns the value of the sdmAddparm property. |
java.lang.String |
getSdmName()
Returns the value of the sdmName property. |
com.jxfs.general.JxfsStatus |
getStatus()
Makes a getStatus call to the J/XFS Device Control. |
java.lang.String |
getWorkstationName()
Returns the value of the workstationName property. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes a JXFSService object with the aTag attributes. |
void |
intermediateOccurred(com.jxfs.events.JxfsIntermediateEvent anEvent)
Receives the intermediate events. |
boolean |
isAutoOpen()
Sets the value of the autoOpen property. |
boolean |
isOpened()
Sets the value of the isOpened property. |
protected boolean |
isValidURL(java.lang.String fileName)
Checks if the filename is a valid URL. |
int |
openSync()
Makes an open call to the J/XFS Device Control and waits for the operation complete event. |
void |
operationCompleteOccurred(com.jxfs.events.JxfsOperationCompleteEvent anEvent)
Receives the operation complete event |
protected void |
registerListener()
Registers the service as listener of the J/XFS Device Control events. |
boolean |
release(int timeout)
Makes a release call to the J/XFS Device Control. |
void |
setAutoOpen(boolean newValue)
Sets the value of the autoOpen property. |
void |
setConfigKey(java.lang.String configKey)
Sets the value of the configKey property. |
void |
setDeviceName(java.lang.String newValue)
Sets the value of the deviceName property. |
void |
setIniConfigFile(java.lang.String newValue)
Sets the value of the iniConfigfile property. |
void |
setPreOpenTimeout(int newValue)
Sets the value of the preOpenTimeout property. |
void |
setSdmAddparm(java.lang.String sdmAddparm)
Sets the value of the sdmAddparm property. |
void |
setSdmName(java.lang.String sdmName)
Sets the value of the sdmName property. |
void |
setSyncTimeout(int newValue)
Sets the value of the syncTimeout property. |
void |
setWorkstationName(java.lang.String workstationName)
Sets the value of the workstationName property. |
void |
statusOccurred(com.jxfs.events.JxfsStatusEvent anEvent)
Receives the status events. |
void |
terminate()
Performs housekeeping for the service instance when the J/XFS Device Control closes. |
java.lang.String |
toString()
Returns a visual representation of the service. |
protected int |
waitForID(int anID)
Waits for the arrival of the operation complete event with the specified identification. |
boolean |
waitOpen(long timeout)
Waits for the Device to be opened. |
Methods inherited from class com.ibm.dse.base.Service |
---|
externalizer, getExternalizer, getTagName, readExternal, readExternal, readObject, removeExternal, setExternalizer, toStrings, toTags, writeExternal, writeExternal |
Methods inherited from class com.ibm.dse.base.DSENotifier |
---|
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.dse.base.Externalizable |
---|
getName, setName |
Field Detail |
public static final boolean AUTOOPEN_YES
public static final boolean AUTOOPEN_NO
protected boolean trace
protected int preOpenTimeout
protected java.util.Hashtable ids
protected Vector idSyncs
protected static final int waitMsgTime
protected int syncTimeout
protected java.lang.String workstationName
protected java.lang.String configKey
protected java.lang.String sdmName
protected java.lang.String sdmAddparm
Constructor Detail |
public JXFSService()
public JXFSService(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String Object name
java.io.IOException
- The object cannot be created.Method Detail |
public void cancel(int identificationID) throws com.jxfs.events.JxfsException
identificationID
- int - ID of the function to cancel
com.jxfs.events.JxfsException
- The device is not openedpublic boolean claim(int timeout) throws com.jxfs.events.JxfsException
timeout
- int - time to wait for the function to finish
com.jxfs.events.JxfsException
- The device is not openedpublic int closeSync() throws com.jxfs.events.JxfsException
com.jxfs.events.JxfsException
- The device is not openedprotected void finalize() throws com.jxfs.events.JxfsException
com.jxfs.events.JxfsException
- The device cannot be closed
com.jxfs.events.JxfsException
- The device is not openpublic java.lang.String getConfigKey()
public com.jxfs.control.JxfsBaseControl getDeviceControl()
public com.jxfs.general.JxfsDeviceManager getDeviceManager()
public java.lang.String getDeviceName()
public java.lang.String getIniConfigFile()
public java.lang.String getSdmAddparm()
public java.lang.String getSdmName()
public com.jxfs.general.JxfsStatus getStatus() throws com.jxfs.events.JxfsException
com.jxfs.events.JxfsException
- The device is not openpublic java.lang.String getWorkstationName()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
initializeFrom
in interface Externalizable
initializeFrom
in class Service
aTag
- com.ibm.dse.base.Tag - contains the name and attributes of the object to be created.
java.io.IOException
- The object cannot be created.
java.io.DSEException
- The object cannot be created.
DSEException
public void intermediateOccurred(com.jxfs.events.JxfsIntermediateEvent anEvent)
intermediateOccurred
in interface com.jxfs.events.IJxfsIntermediateListener
anEvent
- com.jxfs.events.IntermediateEvent - the IntermediateEvent event receivedpublic boolean isAutoOpen()
public boolean isOpened()
protected boolean isValidURL(java.lang.String fileName)
fileName
- The filename to check
public int openSync() throws com.jxfs.events.JxfsException
com.jxfs.events.JxfsException
- The device could not be openedpublic void operationCompleteOccurred(com.jxfs.events.JxfsOperationCompleteEvent anEvent)
operationCompleteOccurred
in interface com.jxfs.events.IJxfsOperationCompleteListener
anEvent
- com.jxfs.events.OperationCompleteEvent - the OperationCompleteEvent event receivedprotected void registerListener()
public boolean release(int timeout) throws com.jxfs.events.JxfsException
timeout
- int - time to wait for the function to finish
com.jxfs.events.JxfsException
- The device is not openedpublic void setAutoOpen(boolean newValue)
newValue
- boolean - the new value of the property.public void setConfigKey(java.lang.String configKey)
configKey
- - the new value of the configKey propertypublic void setDeviceName(java.lang.String newValue)
newValue
- String - the new value of the property.public void setIniConfigFile(java.lang.String newValue)
newValue
- String - the new value of the property.public void setPreOpenTimeout(int newValue)
newValue
- int - the new value of the property.public void setSdmAddparm(java.lang.String sdmAddparm)
sdmAddparm
- - the new value of the sdmAddparm propertypublic void setSdmName(java.lang.String sdmName)
sdmName
- - the new value of the sdmName propertypublic void setSyncTimeout(int newValue)
newValue
- int - the new value of the property.public void setWorkstationName(java.lang.String workstationName)
workstationName
- - the new value of the workstationName propertypublic void statusOccurred(com.jxfs.events.JxfsStatusEvent anEvent)
statusOccurred
in interface com.jxfs.events.IJxfsStatusListener
anEvent
- com.jxfs.events.StatusEvent - the StatusEvent event receivedpublic void terminate() throws DSEException
terminate
in interface Notifier
terminate
in class Service
DSEException
- The terminate could not be donepublic java.lang.String toString()
toString
in class Service
protected int waitForID(int anID)
anID
- int - the identification of the event operation
public boolean waitOpen(long timeout)
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |