|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.clientAPI.RuntimeService
public class RuntimeService
The RuntimeService is to represent the service which is created on runtime, such as the return from Domain.getServices()
or ServiceDeployment.getInterDependentServices()
. Some operations are provided to manipulate it.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2012_2013
|
Constructor Summary | |
---|---|
RuntimeService(java.lang.String name,
java.lang.String className,
java.lang.String classDisplayName,
java.lang.String userComments,
AdminStatus adminState,
OpStatus opState,
boolean needsSave,
QuiesceStatus quiesceStatus)
|
Method Summary | |
---|---|
AdminStatus |
getAdminStatus()
Get the admin state of this RumtimeService, enabled (AdminState.ENABLED) or disabled (AdminState.DISABLED). |
java.lang.String |
getClassDisplayName()
Get the class display name of this RuntimeService. |
java.lang.String |
getClassName()
Get the class name of this RuntimeService. |
Domain |
getDomain()
Get domain of this service |
java.lang.String |
getName()
Get the name of this RuntimeService |
OpStatus |
getOpStatus()
Get the operation state of this RuntimeService, up (OpState.UP) or down (OpState.DOWN) |
java.lang.String |
getPrimaryKey()
Get the pre-built String that could be used as a primary key for this object if you need to get it anywhere or put it in a hash collection. |
QuiesceStatus |
getQuiesceStatus()
Get the quiesce State of this RuntimeService. |
ReferencedObjectCollection |
getReferencedObjectsAndFiles()
Get the referenced objects and file list of this RuntimeService. |
java.lang.String |
getUserComment()
Get the user comment of this RuntimeService. |
boolean |
isDeleted()
Get a boolean value which indicates if this RuntimeService has been deleted. |
void |
quiesce()
Quiesce this RuntimeService |
void |
setQuiesceTimeout(int timeout)
Set the timeout value (in seconds) for checking the status of a service quiesce or unquiesce operation. |
void |
start()
Start this RuntimeService |
void |
stop()
Stop this RuntimeService |
java.lang.String |
toString()
Get a String representation of object for the purpose of debugging or tracing |
void |
unquiesce()
Unquiesce this RuntimeService |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2012_2013
Constructor Detail |
---|
public RuntimeService(java.lang.String name, java.lang.String className, java.lang.String classDisplayName, java.lang.String userComments, AdminStatus adminState, OpStatus opState, boolean needsSave, QuiesceStatus quiesceStatus)
Method Detail |
---|
public java.lang.String getName()
public java.lang.String getClassName()
public java.lang.String getClassDisplayName()
public java.lang.String getUserComment()
public ReferencedObjectCollection getReferencedObjectsAndFiles()
public AdminStatus getAdminStatus()
public OpStatus getOpStatus()
public QuiesceStatus getQuiesceStatus()
public void setQuiesceTimeout(int timeout) throws NotExistException, AlreadyExistsInRepositoryException, DatastoreException, InvalidParameterException
Quiesce only pertains to Firmware levels 3.8.1.0 or later. Earlier levels of firmware do not support quiesce so calling this method has no effect. Note: An exception will not be thrown if you call this method for a domain on a device that has a firmware level below 3.8.1.0 - so this value will be available if firmware is ever upgraded.
If a value of zero is set then the quiesce operation will be initiated on supported firmware, but the quiesce or unquiesce status will not be checked. If a nonzero value less than 60 is set, then the value will automatically be set to a minimum of 60 seconds. Values higher than 60 are OK.
timeout
- value in secondspublic void quiesce() throws DeletedException, AMPException, UnsuccessfulOperationException, NotExistException
public void unquiesce() throws DeletedException, AMPException, UnsuccessfulOperationException, NotExistException
public void start() throws AMPException, DeletedException, NotExistException
public void stop() throws AMPException, DeletedException, NotExistException
public Domain getDomain() throws NotExistException
public boolean isDeleted()
public java.lang.String getPrimaryKey()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |