|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Object | +--disman.Launch
| Field Summary | |
static int |
ADMIN_STATUS_AUTOSTART
Valid state |
static int |
ADMIN_STATUS_DISABLED
Valid state |
static int |
ADMIN_STATUS_ENABLED
Valid state |
static java.lang.String[] |
adminStatusStrings
Array of admin state strings. |
static int |
CONTROL_ABORT
Valid control code |
static int |
CONTROL_NOP
Valid control code |
static int |
CONTROL_RESUME
Valid control code |
static int |
CONTROL_SUSPEND
Valid control code |
static java.lang.String[] |
controlStrings
Array of exit code strings. |
static long |
LIFETIME_NEVERENDING
Special smLifeTime value for never ending scripts. |
static int |
OPER_STATUS_DISABLED
Valid state |
static int |
OPER_STATUS_ENABLED
Valid state |
static int |
OPER_STATUS_EXPIRED
Valid state |
static java.lang.String[] |
operStatusStrings
Array of operation state strings. |
static int |
ROW_STATUS_ACTIVE
Valid row status |
static int |
ROW_STATUS_CREATE_AND_GO
Valid row status |
static int |
ROW_STATUS_CREATE_AND_WAIT
Valid row status |
static int |
ROW_STATUS_DESTROY
Valid row status |
static int |
ROW_STATUS_NOT_IN_SERVICE
Valid row status |
static int |
ROW_STATUS_NOT_READY
Valid row status |
static java.lang.String[] |
rowStatusStrings
Array of row status strings. |
static int |
STORAGE_TYPE_NON_VOLATILE
Valid storage type |
static int |
STORAGE_TYPE_OTHER
Valid storage type |
static int |
STORAGE_TYPE_PERMANENT
Valid storage type |
static int |
STORAGE_TYPE_READ_ONLY
Valid storage type |
static int |
STORAGE_TYPE_VOLATILE
Valid storage type |
static java.lang.String[] |
storageTypeStrings
Array of storage type strings. |
| Constructor Summary | |
Launch(Disman disman,
java.lang.String owner,
java.lang.String name)
Create a Launch object for a given Disman object indexed by a given owner and name by retrieval from the agent. |
|
Launch(Disman disman,
java.lang.String owner,
java.lang.String name,
Script script)
Create a Launch object for a given Disman object and a given Script object indexed by a given owner and name by creating it at the agent. |
|
| Method Summary | |
java.lang.String |
call()
Start a script from this launch button, block until it has been terminated and return the result string. |
void |
disable()
Disable the launch button. |
void |
enable()
Enable this launch button. |
int |
getAdminStatus()
Return an integer value representing the smLaunchAdminStatus. |
java.lang.String |
getAdminStatusString()
Return a String representing the smLaunchAdminStatus. |
java.lang.String |
getArgument()
Return the argument string to be passed to the script launched by this launch button (smLaunchArgument). |
int |
getControl()
Return an integer value representing the smLaunchControl value. |
java.lang.String |
getControlString()
Return a string representing the smLaunchControl value. |
java.lang.String |
getError()
Return the error string (smLaunchError). |
long |
getExpireTime()
Return the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime). |
java.util.Date |
getLastChange()
Return the last change time as a Date object (smLaunchLastChange). |
int[] |
getLastChangeTime()
Return the last change time as an array of integer values representing the MIB value's octets (smLaunchLastChange). |
long |
getLifeTime()
Return the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime). |
long |
getMaxCompleted()
Return the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted). |
long |
getMaxRunning()
Return the maximum number of running scripts started from this launch button (smLaunchMaxRunning). |
java.lang.String |
getName()
Return the name of this Launch object (smLaunchName). |
int |
getOperStatus()
Return an integer value representing the smLaunchOperStatus. |
java.lang.String |
getOperStatusString()
Return a String representing the smLaunchOperStatus. |
java.lang.String |
getOwner()
Return the owner of this Launch object (smScriptOwner). |
long |
getRowExpireTime()
Return the launch button's row expire time in milli seconds (smLaunchRowExpireTime). |
int |
getRowStatus()
Return an integer value representing the smLaunchRowStatus. |
java.lang.String |
getRowStatusString()
Return a String representing the smScriptRowStatus. |
int |
getRunIndexNext()
Return an integer value representing the smLaunchRunIndexNext. |
Script |
getScript()
Return the Script object that may be started by this Launch object. |
java.lang.String |
getScriptName()
Return the script name (smLaunchScriptName). |
java.lang.String |
getScriptOwner()
Return the script owner (smLaunchScriptOwner). |
int |
getStart()
Return an integer value representing the smLaunchStart value. |
int |
getStorageType()
Return an integer value representing the smLaunchStorageType. |
java.lang.String |
getStorageTypeString()
Return a String representing the smLaunchStorageType. |
boolean |
isDisabled()
Return true, if this script is disabled (smScriptOperStatus == disabled(2)). |
boolean |
isEnabled()
Return true, if this script is enabled (smScriptOperStatus == enabled(1)). |
boolean |
isExpired()
Return true, if this script is expired (smScriptOperStatus == expired(3)). |
boolean |
isNonVolatile()
Return true, if this launch button is stored non-volatile at the agent. |
boolean |
isPermanent()
Return true, if this launch button is stored permanently at the agent. |
boolean |
isReadOnly()
Return true, if this launch button is stored read-only at the agent. |
boolean |
isVolatile()
Return true, if this launch button is stored volatile at the agent. |
void |
remove()
Remove this Launch object. |
void |
setAdminStatus(int status)
Set the smLaunchAdminStatus represented by an integer value. |
void |
setArgument(java.lang.String argument)
Set the argument string to be passed to the script launched by this launch button (smLaunchArgument). |
void |
setControl(int control)
Set the smLaunchControl value to a given integer value. |
void |
setExpireTime(long time)
Set the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime). |
void |
setLifeTime(long time)
Set the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime). |
void |
setMaxCompleted(long max)
Set the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted). |
void |
setMaxRunning(long max)
Set the maximum number of running scripts started from this launch button (smLaunchMaxRunning). |
void |
setNonVolatile()
Make this launch button stored non-volatile at the agent. |
void |
setPermanent()
Make this launch button stored permanently at the agent. |
void |
setReadOnly()
Make this launch button stored read-only at the agent. |
void |
setRowExpireTime(long time)
Set the launch button's row expire time in milli seconds (smLaunchRowExpireTime). |
void |
setRowStatus(int status)
Return an integer value representing the smLaunchRowStatus. |
void |
setScript(Script script)
Set the Script object that may be started by this Launch object. |
void |
setScriptName(java.lang.String scriptname)
Set the script name (smLaunchScriptName). |
void |
setScriptOwner(java.lang.String scriptowner)
Set the script owner (smLaunchScriptOwner). |
void |
setStart(int runindex)
Set the smLaunchStart value to a given integer value. |
void |
setStorageType(int storageType)
Set the smLaunchStorageType represented by an integer value. |
void |
setVolatile()
Make this launch button stored volatile at the agent. |
Run |
start()
Start a script from this launch button and return the created Run object. |
Run |
start(int runindex)
Start a script with a given run index from this launch button and return the created Run object. |
java.lang.String |
toString()
Return a String representation of the launch entry. |
| Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
| Field Detail |
public static final long LIFETIME_NEVERENDING
public static final int CONTROL_ABORT
public static final int CONTROL_SUSPEND
public static final int CONTROL_RESUME
public static final int CONTROL_NOP
public static final java.lang.String[] controlStrings
public static final int ADMIN_STATUS_ENABLED
public static final int ADMIN_STATUS_DISABLED
public static final int ADMIN_STATUS_AUTOSTART
public static final java.lang.String[] adminStatusStrings
public static final int OPER_STATUS_ENABLED
public static final int OPER_STATUS_DISABLED
public static final int OPER_STATUS_EXPIRED
public static final java.lang.String[] operStatusStrings
public static final int STORAGE_TYPE_OTHER
public static final int STORAGE_TYPE_VOLATILE
public static final int STORAGE_TYPE_NON_VOLATILE
public static final int STORAGE_TYPE_PERMANENT
public static final int STORAGE_TYPE_READ_ONLY
public static final java.lang.String[] storageTypeStrings
public static final int ROW_STATUS_ACTIVE
public static final int ROW_STATUS_NOT_IN_SERVICE
public static final int ROW_STATUS_NOT_READY
public static final int ROW_STATUS_CREATE_AND_GO
public static final int ROW_STATUS_CREATE_AND_WAIT
public static final int ROW_STATUS_DESTROY
public static final java.lang.String[] rowStatusStrings
| Constructor Detail |
public Launch(Disman disman,
java.lang.String owner,
java.lang.String name)
throws SnmpException,
java.io.IOException,
NoSuchRowException
disman - the Disman object associated with this launch buttonowner - the launch button ownername - the launch button name
public Launch(Disman disman,
java.lang.String owner,
java.lang.String name,
Script script)
throws SnmpException,
java.io.IOException,
IllegalNameException
disman - the Disman object associated with this launch buttonowner - the launch button ownername - the launch button namescript - the script to be launched by this launch button| Method Detail |
public void remove()
throws java.io.IOException,
SnmpException,
TimeoutException
public java.lang.String getOwner()
public java.lang.String getName()
public Script getScript()
throws SnmpException,
java.io.IOException
public void setScript(Script script)
throws SnmpException,
java.io.IOException
script - the script to be launched by this launch button
public java.lang.String getScriptOwner()
throws SnmpException,
java.io.IOException
public void setScriptOwner(java.lang.String scriptowner)
throws SnmpException,
java.io.IOException,
IllegalNameException
scriptowner - the owner of the script to be launched by this launch button
public java.lang.String getScriptName()
throws SnmpException,
java.io.IOException
public void setScriptName(java.lang.String scriptname)
throws SnmpException,
java.io.IOException,
IllegalNameException
scriptname - the name of the script to be launched by this launch button
public java.lang.String getArgument()
throws SnmpException,
java.io.IOException
public void setArgument(java.lang.String argument)
throws SnmpException,
java.io.IOException
argument - the argument string
public long getMaxRunning()
throws SnmpException,
java.io.IOException
public void setMaxRunning(long max)
throws SnmpException,
java.io.IOException
max - the maximum number of running scripts
public long getMaxCompleted()
throws SnmpException,
java.io.IOException
public void setMaxCompleted(long max)
throws SnmpException,
java.io.IOException
max - the maximum number of completed scripts
public long getLifeTime()
throws SnmpException,
java.io.IOException
public void setLifeTime(long time)
throws SnmpException,
java.io.IOException
time - the maximum life time
public long getExpireTime()
throws SnmpException,
java.io.IOException
public void setExpireTime(long time)
throws SnmpException,
java.io.IOException
time - the expire time
public int getStart()
throws SnmpException,
java.io.IOException
public void setStart(int runindex)
throws SnmpException,
java.io.IOException
runindex - the smLaunchStart value
public Run start(int runindex)
throws java.io.IOException,
SnmpException,
TimeoutException
runindex - the run index to be used
public Run start()
throws java.io.IOException,
SnmpException,
TimeoutException
public java.lang.String call()
throws java.io.IOException,
SnmpException,
TimeoutException
public int getControl()
throws SnmpException,
java.io.IOException
public java.lang.String getControlString()
throws SnmpException,
java.io.IOException
public void setControl(int control)
throws SnmpException,
java.io.IOException
control - the smLaunchControl value
public int getAdminStatus()
throws SnmpException,
java.io.IOException
public java.lang.String getAdminStatusString()
throws SnmpException,
java.io.IOException
public void setAdminStatus(int status)
throws SnmpException,
java.io.IOException
status - the smLaunchAdminStatus value
public int getOperStatus()
throws SnmpException,
java.io.IOException
public java.lang.String getOperStatusString()
throws SnmpException,
java.io.IOException
public boolean isEnabled()
throws SnmpException,
java.io.IOException
public boolean isDisabled()
throws SnmpException,
java.io.IOException
public boolean isExpired()
throws SnmpException,
java.io.IOException
public void enable()
throws java.io.IOException,
SnmpException,
TimeoutException
public void disable()
throws java.io.IOException,
SnmpException,
TimeoutException
public int getRunIndexNext()
throws SnmpException,
java.io.IOException
public int getStorageType()
throws SnmpException,
java.io.IOException
public java.lang.String getStorageTypeString()
throws SnmpException,
java.io.IOException
public boolean isVolatile()
throws SnmpException,
java.io.IOException
public boolean isNonVolatile()
throws SnmpException,
java.io.IOException
public boolean isPermanent()
throws SnmpException,
java.io.IOException
public boolean isReadOnly()
throws SnmpException,
java.io.IOException
public void setStorageType(int storageType)
throws SnmpException,
java.io.IOException
storageType - the smLaunchStorageType value
public void setVolatile()
throws SnmpException,
java.io.IOException
public void setNonVolatile()
throws SnmpException,
java.io.IOException
public void setPermanent()
throws SnmpException,
java.io.IOException
public void setReadOnly()
throws SnmpException,
java.io.IOException
public int getRowStatus()
throws SnmpException,
java.io.IOException
public java.lang.String getRowStatusString()
throws SnmpException,
java.io.IOException
public void setRowStatus(int status)
throws SnmpException,
java.io.IOException
status - the smLaunchRowStatus value
public java.lang.String getError()
throws java.io.IOException,
SnmpException,
DismanReadException
public int[] getLastChangeTime()
throws java.io.IOException,
SnmpException
public java.util.Date getLastChange()
throws java.io.IOException,
SnmpException
public long getRowExpireTime()
throws java.io.IOException,
SnmpException
public void setRowExpireTime(long time)
throws java.io.IOException,
SnmpException
public java.lang.String toString()
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||