Overview Package Class Deprecated Help

dctr
AuditManager

The manager for the class that allows to audit virtual object which support "Audit" capability.

public class AuditManager

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

audit

Starts Audit action for all the objects under the hierarchy of the named objects in the input list.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
auditParam : dctr.AuditParam - A list of audit parameters for objects to be audited
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : dctr.AuditStatus - The current state of the audit
Exceptions:
dctr.AuditManager.auditException

getResult

Returns the result of a completed audit operation (the final state can be failure !!!).
Input Parameters:
auditParam : dctr.AuditParam -
objectType : dctr.AuditObjectType -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
resultList : List (generic.CommonManagedEntityInformation) - The results from the last audit.
Exceptions:
dctr.AuditManager.getResultException

getStatus

Gets the latest state of the audit operation.
Input Parameters:
auditParam : dctr.AuditParam - A list of audit parameters for objects to be audited
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : dctr.AuditStatus - The current state of the audit
Exceptions:
dctr.AuditManager.getStatusException