com.bmc.cmdb.api
Class CMDBAuditInfo

java.lang.Object
  com.bmc.cmdb.api.CMDBAuditInfo

Direct Known Subclasses:

CMDBAuditLogInfo

public class CMDBAuditInfo
extends java.lang.Object

The CMDBAuditInfo class allows you to define the audit information for an instance. When an instance is audited, the changes to the instance are tracked by creating a copy of the modified instance, by writing the changes to a log form, or by performing both. QualifierInfo, which is passed as a parameter for this class, contains the query information that is used to qualify the instance for auditing. Once you create the CMDBAuditInfo object, you can perform queries against it.

Field Summary

static int	CMDB_CLASS_AUDITTYPE_COPY Specifies that a copy of the instance being modified will be created.
static int	CMDB_CLASS_AUDITTYPE_LOG Specifies that changes to the instance will be written to a log.
static int	CMDB_CLASS_AUDITTYPE_NONE Specifies that no auditing will be performed for instances of the class.
static java.lang.String	CMDB_DEFAULT_AUDIT_LOG_FORM When the audit type is log, this constant specifies the name of the BMC Atrium CMDB form to which audit log entries are written by default.
static int	CMDB_QUAL_TYPE_NONE Specifies that the qualifier type is none.
static int	CMDB_QUAL_TYPE_STRING Specifies that for the audit to take place, the instance must match the string value provided in the query.
static int	CMDB_QUAL_TYPE_STRUCT Specifies that for the audit to take place, the instance must match the query provided in the qualifier information object.

Constructor Summary

CMDBAuditInfo()
Default constructor that creates an empty CMDBAuditInfo object.

CMDBAuditInfo(int aType)
Sets the audit type with out any qualification

CMDBAuditInfo(int aType, QualifierInfo aQualObject)
Sets the audit type and qualifier information for the CMDBAuditInfo object.

CMDBAuditInfo(int aType, java.lang.String aQualString)
Initializes the audit type and qualifier string for the CMDBAuditInfo object.

Method Summary

java.lang.String	getLogForm() Gets the BMC Atrium CMDB form into which audit log entries are written.
QualifierInfo	getQualObject() Returns the qualifier information for the CMDBAuditInfo object.
java.lang.String	getQualString() Returns the qualifier string for the CMDBAuditInfo object.
int	getQualType() Returns the qualifier type for the CMDBAuditInfo object.
int	getType() Gets the audit type for the CMDBAuditInfo object (CMDB_CLASS_AUDITTYPE_<>)
void	setLogForm(java.lang.String aLogForm) Sets the BMC Atrium CMDB form into which audit log entries are written.
void	setQualObject(QualifierInfo aQualObject) Sets the qualifier information for the CMDBAuditInfo object.
void	setQualString(java.lang.String aQualString) Sets the qualifier string for the CMDBAuditInfo object.
void	setQualType(int aQualType) Sets the qualifier type for the CMDBAuditInfo object.
void	setType(int aType) Sets the audit type for the CMDBAuditInfo object (CMDB_CLASS_AUDITTYPE_<>)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CMDB_CLASS_AUDITTYPE_NONE

public static final int CMDB_CLASS_AUDITTYPE_NONE

Specifies that no auditing will be performed for instances of the class.

See Also:

Constant Field Values

CMDB_CLASS_AUDITTYPE_COPY

public static final int CMDB_CLASS_AUDITTYPE_COPY

Specifies that a copy of the instance being modified will be created.

See Also:

Constant Field Values

CMDB_CLASS_AUDITTYPE_LOG

public static final int CMDB_CLASS_AUDITTYPE_LOG

Specifies that changes to the instance will be written to a log.

See Also:

Constant Field Values

CMDB_DEFAULT_AUDIT_LOG_FORM

public static final java.lang.String CMDB_DEFAULT_AUDIT_LOG_FORM

When the audit type is log, this constant specifies the name of the BMC Atrium CMDB form to which audit log entries are written by default. For this CMDBAuditInfo object, if you want audit log entries written to a different BMC Atrium CMDB form, use setLogForm() to specify the BMC Atrium CMDB form for the audit log entries.

See Also:

Constant Field Values

CMDB_QUAL_TYPE_NONE

public static final int CMDB_QUAL_TYPE_NONE

Specifies that the qualifier type is none.

See Also:

Constant Field Values

CMDB_QUAL_TYPE_STRING

public static final int CMDB_QUAL_TYPE_STRING

Specifies that for the audit to take place, the instance must match the string value provided in the query.

See Also:

Constant Field Values

CMDB_QUAL_TYPE_STRUCT

public static final int CMDB_QUAL_TYPE_STRUCT

Specifies that for the audit to take place, the instance must match the query provided in the qualifier information object.

See Also:

Constant Field Values

Constructor Detail

CMDBAuditInfo

public CMDBAuditInfo()

Default constructor that creates an empty CMDBAuditInfo object.

CMDBAuditInfo

public CMDBAuditInfo(int aType)

Sets the audit type with out any qualification

Parameters:

aType - the audit type

CMDBAuditInfo

public CMDBAuditInfo(int aType,
                     QualifierInfo aQualObject)

Sets the audit type and qualifier information for the CMDBAuditInfo object.

Parameters:

aType - the audit type

aQualObject - a query that can include one or more attributes and any combination of conditional, relational, and arithmetic operations.

CMDBAuditInfo

public CMDBAuditInfo(int aType,
                     java.lang.String aQualString)

Initializes the audit type and qualifier string for the CMDBAuditInfo object.

Parameters:

aType - the audit type

aQualString - the string value that the instance must match to be qualified for auditing.

Method Detail

getType

public int getType()

Gets the audit type for the CMDBAuditInfo object (CMDB_CLASS_AUDITTYPE_<>)

Returns:

audit type for the CMDBAuditInfo object

getQualObject

public QualifierInfo getQualObject()

Returns the qualifier information for the CMDBAuditInfo object.

Returns:

qualifier information for the CMDBAuditInfo object

getQualString

public java.lang.String getQualString()

Returns the qualifier string for the CMDBAuditInfo object.

Returns:

qualifier string for the CMDBAuditInfo object

getQualType

public int getQualType()

Returns the qualifier type for the CMDBAuditInfo object.

Returns:

qualifier type for the CMDBAuditInfo object

getLogForm

public java.lang.String getLogForm()

Gets the BMC Atrium CMDB form into which audit log entries are written.

Returns:

logForm for the given CMDBAuditInfo object

setType

public void setType(int aType)

Sets the audit type for the CMDBAuditInfo object (CMDB_CLASS_AUDITTYPE_<>)

Parameters:

aType - audit type for the CMDBAuditInfo object

setQualObject

public void setQualObject(QualifierInfo aQualObject)

Sets the qualifier information for the CMDBAuditInfo object.

Parameters:

aQualObject - qualifier information for the CMDBAuditInfo object.

setQualString

public void setQualString(java.lang.String aQualString)

Sets the qualifier string for the CMDBAuditInfo object.

Parameters:

aQualString - qualifier string for the CMDBAuditInfo object

setQualType

public void setQualType(int aQualType)

Sets the qualifier type for the CMDBAuditInfo object.

Parameters:

aQualType - the qualifier type for the CMDBAuditInfo object

setLogForm

public void setLogForm(java.lang.String aLogForm)

Sets the BMC Atrium CMDB form into which audit log entries are written.

Parameters:

aLogForm - for the given CMDBAuditInfo object