public interface DriverInterface
Modifier and Type | Field and Description |
---|---|
static int |
START_OPTION_AUTO
Parameter value for
setDriverStartOption . |
static int |
START_OPTION_DISABLED
Parameter value for
setDriverStartOption . |
static int |
START_OPTION_MANUAL
Parameter value for
setDriverStartOption . |
Modifier and Type | Method and Description |
---|---|
boolean |
isDriverEnabled()
Return
true if the driver start option is auto or manual, false if driver is disabled. |
boolean |
isDriverRunning()
Return
true if the driver is running, false if not. |
JobResult |
queueEventDocument(XmlDocument doc)
Place an XML document in the subscriber channel event queue (cache) for the driver.
|
JobResult |
setDriverStartOption(int option,
boolean suppressResync)
Set the driver's start option to enable or disable the driver.
|
JobResult |
startDriver(int maxWait)
Start the driver associated with the job if it is not running.
|
JobResult |
stopDriver()
Stop a driver associated with the job if it is running.
|
XmlDocument |
submitCommandDocument(XmlDocument doc)
Submit a command document to the driver and return the result from the shim.
|
XmlDocument |
submitEventDocument(XmlDocument doc)
Submit an event document to the driver and return the results from processing.
|
static final int START_OPTION_DISABLED
setDriverStartOption
.static final int START_OPTION_MANUAL
setDriverStartOption
.static final int START_OPTION_AUTO
setDriverStartOption
.boolean isDriverRunning()
true
if the driver is running, false
if not.true
if driver is running.boolean isDriverEnabled()
true
if the driver start option is auto or manual, false
if driver is disabled.true
if driver is enabledJobResult setDriverStartOption(int option, boolean suppressResync) throws java.lang.IllegalArgumentException
option
- START_OPTION_DISABLED
, START_OPTION_MANUAL
, or START_OPTION_AUTO
.suppressResync
- if true
and enabling driver, no automatic resync of the driver is performedjava.lang.IllegalArgumentException
JobResult queueEventDocument(XmlDocument doc)
doc
- document to queueCheckPrivileges
XmlDocument submitCommandDocument(XmlDocument doc)
doc
- the command documentCheckPrivileges
XmlDocument submitEventDocument(XmlDocument doc)
doc
- the event documentCheckPrivileges
JobResult startDriver(int maxWait)
maxWait
is <= 0
then this method will return success before determining if the
driver has actually started. It is then the caller's responsibility to check if the driver
is running or not.maxWait
- maximum time to wait for driver to start (in seconds)CheckPrivileges
JobResult stopDriver()
CheckPrivileges