com.ibm.datapower.wamt.clientAPI
Class RuntimeService

java.lang.Object
  extended by com.ibm.datapower.wamt.clientAPI.RuntimeService

public class RuntimeService
extends java.lang.Object

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

COPYRIGHT_2012_2013

public static final java.lang.String COPYRIGHT_2012_2013
See Also:
Constant Field Values
Constructor Detail

RuntimeService

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

getName

public java.lang.String getName()
Get the name of this RuntimeService

Returns:
the String representation of this object's name

getClassName

public java.lang.String getClassName()
Get the class name of this RuntimeService.

Returns:
the String representation of this object's class name

getClassDisplayName

public java.lang.String getClassDisplayName()
Get the class display name of this RuntimeService.

Returns:
the String representation of this object's display name

getUserComment

public java.lang.String getUserComment()
Get the user comment of this RuntimeService.

Returns:
the String representation of this object's user comments

getReferencedObjectsAndFiles

public ReferencedObjectCollection getReferencedObjectsAndFiles()
Get the referenced objects and file list of this RuntimeService.

Returns:
ReferencedObjectCollection

getAdminStatus

public AdminStatus getAdminStatus()
Get the admin state of this RumtimeService, enabled (AdminState.ENABLED) or disabled (AdminState.DISABLED).

Returns:
AdminState.ENABLED if this object's admin state is "enabled", AdminState.DISABLED is "disabled"

getOpStatus

public OpStatus getOpStatus()
Get the operation state of this RuntimeService, up (OpState.UP) or down (OpState.DOWN)

Returns:
OpState.UP if this object's opState is "up", OpState.DOWN is "down"

getQuiesceStatus

public QuiesceStatus getQuiesceStatus()
Get the quiesce State of this RuntimeService.

Returns:
quiesce Status of this RuntimeService

setQuiesceTimeout

public void setQuiesceTimeout(int timeout)
                       throws NotExistException,
                              AlreadyExistsInRepositoryException,
                              DatastoreException,
                              InvalidParameterException
Set the timeout value (in seconds) for checking the status of a service quiesce or unquiesce operation.

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.

Parameters:
timeout - value in seconds

quiesce

public void quiesce()
             throws DeletedException,
                    AMPException,
                    UnsuccessfulOperationException,
                    NotExistException
Quiesce this RuntimeService


unquiesce

public void unquiesce()
               throws DeletedException,
                      AMPException,
                      UnsuccessfulOperationException,
                      NotExistException
Unquiesce this RuntimeService


start

public void start()
           throws AMPException,
                  DeletedException,
                  NotExistException
Start this RuntimeService


stop

public void stop()
          throws AMPException,
                 DeletedException,
                 NotExistException
Stop this RuntimeService


getDomain

public Domain getDomain()
                 throws NotExistException
Get domain of this service


isDeleted

public boolean isDeleted()
Get a boolean value which indicates if this RuntimeService has been deleted.

Returns:
boolean value to indicate if this Runtime Service is deleted, True meaning it is deleted.

getPrimaryKey

public 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. Although this method isn't necessary for users of the clientAPI, it may be helpful for them to have so they don't need to implement it themselves. It is used internally within the clientAPI and is exposed here for your convenience.

Returns:
a String that could represent a unique instance of this object. It use the Name and ClassName as the primary key. (i.e. Name:Classname)

toString

public java.lang.String toString()
Get a String representation of object for the purpose of debugging or tracing

Overrides:
toString in class java.lang.Object
Returns:
a String representation


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.