com.bmc.cmdb.api
Class CMDBUtil

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

public class CMDBUtil
extends java.lang.Object

The CMDBUtil class defines all the utility methods for the Class Manager API.

Field Summary

static int	AR_BULK_ENTRY_ACTION_CANCEL Specifies that the bulk entry of data into BMC Atrium CMDB is cancelled.
static int	AR_BULK_ENTRY_ACTION_SEND Specifies that data is entered in bulk into BMC Atrium CMDB.
static java.lang.String	CMDB_ALL_OBJECT Specifies that in a graph query, all objects are displayed.
static java.lang.String	CMDB_ALL_RELATIONSHIP Specifies that in a graph query, all relationships are displayed.
static int	CMDB_FEDERATION_ACTIVATION_EXPAND Specifies that the Federated Interface is expanded.
static int	CMDB_FEDERATION_ACTIVATION_LAUNCH Specifies that the Federated Interface is expanded and launched.
static int	CMDB_FEDERATION_ACTIVATION_NONE Specifies that no action is taken.
static int	CMDB_RELATIONSHIP_DIRECTION_BOTH Specifies that in a graph query, the object is either on the right or left of the node, with an arrow pointing at or away from the node.
static int	CMDB_RELATIONSHIP_DIRECTION_IN Specifies that in a graph query, the object is to the right of the node, and the arrow representing the relationship is pointing to the node.
static int	CMDB_RELATIONSHIP_DIRECTION_OUT Specifies that in a graph query, the object is to the left of the node, and the arrow representing the relationship is pointing to the node.
static java.lang.String	CMDB_VER_APP_ID_CMDB Specifies the application ID for BMC Atrium CMDB.
static java.lang.String	CMDB_VER_APP_ID_RECON_ENG Specifies the application ID for Reconciliation Engine.
static java.lang.String	CMDB_WEAK_OBJECT Specifies that in a graph query, the object is the weak member in a weak relationship.
static java.lang.String	CMDB_WEAK_RELATIONSHIP Specifies that in a graph query, the relationship is a weak relationship.

Constructor Summary

CMDBUtil()

Method Summary

static CMDBFederatedActivateInfo	CMDBActivateFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String federatedInstanceId, int activateOption) Launches the Federated Interface instance related to the specified instance and uses the activation option specified.
static CMDBFederatedActivateInfo	CMDBActivateFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDataSetId, java.lang.String instanceId, java.lang.String federatedInstanceId, int activateOption) Launches the Federated Interface instance that is related to an instance from the specified dataset.
static void	CMDBBeginBulkEntryTransaction(ARServerUser context) Starts a bulk entry transaction for the specified context object.
static java.lang.String	CMDBCreateGuid(ARServerUser context) Creates a GUID and returns it.
static BulkEntryReturn[]	CMDBEndBulkEntryTransaction(ARServerUser context, int actionType) Ends a bulk entry transaction by either sending a list of transactions to BMC Atrium CMDB or canceling the transaction.
static java.lang.String	CMDBExpandParametersForCI(ARServerUser context, java.lang.String paramString, CMDBInstanceBase instance) Gets the expand parameters for a CI.
static void	CMDBExport(ARServerUser context, CMDBItemBase[] exportItemArray, java.lang.String exportFormat, java.lang.String directoryPath) Deprecated. as of CMDB 2.0
static java.lang.String	CMDBExportData(ARServerUser ctx, CMDBClassNameKey aClassKey, java.lang.String datasetId, java.lang.String query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve) Exports instance data that matches the specified qualifications.
static java.lang.String	CMDBExportDef(ARServerUser context, CMDBXMLExportItem[] exportItemList) Exports a list of attribute definitions.
static CMDBUIComponentResult[]	CMDBGetCMDBUIComponents(ARServerUser context, CMDBUIComponentInfo inputInfo, java.lang.String datasetId, java.lang.String instanceId) Gets a list of user interface components for the specified instance.
static CMDBAuditValueList[]	CMDBGetCopyAuditData(ARServerUser context, CMDBClassNameKey classNameId, java.lang.String instanceId, java.lang.String datasetId, QualifierInfo query, java.lang.String[] attributeList) Gets a list of audit details for the specified qualified instance.
static CMDBInstanceBase	CMDBGetInstanceBase(ARServerUser context, CMDBClassNameKey classKey, java.lang.String datasetId, int getMask, java.lang.String instanceId, java.lang.String[] attributeNames) Gets the instances from the specified dataset that contain the specified attributes.
static CMDBInstanceBase[]	CMDBGetListInstanceWithAttributes1(ARServerUser ctx, CMDBClassNameKey aClassKey, java.lang.String datasetId, int getMask, java.lang.String query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches) Gets a list of all the instances from the specified dataset that match the specified qualifications.
static CMDBInstanceBase[]	CMDBGetRelatedFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String[] attributeNames) Gets a list of Federated Interface instances for the specified instance and attributes.
static CMDBInstanceBase[]	CMDBGetRelatedFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDataSetId, java.lang.String instanceId, java.lang.String[] attributeNames) Gets a list of related Federated Interface instances for the instances in the specified dataset.
static void	CMDBGetServerPort(ARServerUser context, java.lang.Integer tcpPort, java.lang.Integer rpcPort) Gets the AR System server TCP and RPC ports.
static CMDBVersionInfo[]	CMDBGetVersions(ARServerUser context, java.lang.String[] AppIdList) Gets a list of versions for the following parameters: applicationId (application ID), majorVer (major version), minorVer (minor version), maintenanceVer (maintenance version), patchNum (patch number), and isExist (Boolean value indicated whether Application ID exists)
static CMDBGraphResult	CMDBGraphQuery(ARServerUser context, CMDBClassNameKey startClassNameId, java.lang.String aDatasetId, int aGetMask, java.lang.String startExtensionId, java.lang.String startInstanceId, int numLevels, int direction, boolean noMatchProceed, boolean onMatchProceed, CMDBGraph[] graphArray) Generates a graph query starting with the node from the specified dataset, number of levels, and relationship direction.
static CMDBGraphResult	CMDBGraphQuery(ARServerUser context, CMDBClassNameKey startClassNameId, java.lang.String startExtensionId, java.lang.String startInstanceId, int numLevels, int direction, boolean noMatchProceed, boolean onMatchProceed, CMDBGraph[] graphArray) Generates a graph query starting with the specified node, using the specified number of levels and relationship direction.
static void	CMDBImport(ARServerUser context, CMDBItemBase[] importItemArray, java.lang.String directoryPath) Deprecated. as of CMDB 2.0
static void	CMDBImportData(ARServerUser ctx, int importOption, java.lang.String importBuf) Imports the Instance Data using the import option specified.
static void	CMDBImportDef(ARServerUser ctx, CMDBXMLImportItem[] importItem, int importOption, java.lang.String importBuf) Imports the class or attribute definitions using the import option specified.
static void	CMDBRECancelJobRun(ARServerUser context, java.lang.String jobRunId) Cancels the specified Reconciliation Engine job.
static java.lang.String	CMDBREStartJobRun(ARServerUser context, java.lang.String jobName, CMDBClassQual[] qualList, CMDBREDatasetPair[] datasetList) Starts an existing Reconciliation Engine job using the specified qualification information and dataset list.
static boolean	CMDBRunQualificationForCI(ARServerUser context, java.lang.String qualifier, CMDBAttributeValue[] attributeValue) Verifies if an instance is qualified.
static void	CMDBSetServerPort(ARServerUser context, java.lang.Integer tcpPort, java.lang.Integer rpcPort) Sets the AR System server TCP and RPC ports.
static void	CMDBSystemInit(ARServerUser context, PropInfo[] sysProps) Initializes the system properties.

Methods inherited from class java.lang.Object

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

Field Detail

AR_BULK_ENTRY_ACTION_SEND

public static final int AR_BULK_ENTRY_ACTION_SEND

Specifies that data is entered in bulk into BMC Atrium CMDB.

See Also:

Constant Field Values

AR_BULK_ENTRY_ACTION_CANCEL

public static final int AR_BULK_ENTRY_ACTION_CANCEL

Specifies that the bulk entry of data into BMC Atrium CMDB is cancelled.

See Also:

Constant Field Values

CMDB_RELATIONSHIP_DIRECTION_OUT

public static final int CMDB_RELATIONSHIP_DIRECTION_OUT

Specifies that in a graph query, the object is to the left of the node, and the arrow representing the relationship is pointing to the node.

See Also:

Constant Field Values

CMDB_RELATIONSHIP_DIRECTION_IN

public static final int CMDB_RELATIONSHIP_DIRECTION_IN

Specifies that in a graph query, the object is to the right of the node, and the arrow representing the relationship is pointing to the node.

See Also:

Constant Field Values

CMDB_RELATIONSHIP_DIRECTION_BOTH

public static final int CMDB_RELATIONSHIP_DIRECTION_BOTH

Specifies that in a graph query, the object is either on the right or left of the node, with an arrow pointing at or away from the node.

See Also:

Constant Field Values

CMDB_WEAK_RELATIONSHIP

public static final java.lang.String CMDB_WEAK_RELATIONSHIP

Specifies that in a graph query, the relationship is a weak relationship. Use the value "CMDB_WEAK_RELATIONSHIP" as the namespace and classname of the relationship object in the adjacency list.

See Also:

Constant Field Values

CMDB_WEAK_OBJECT

public static final java.lang.String CMDB_WEAK_OBJECT

Specifies that in a graph query, the object is the weak member in a weak relationship. Use the value "WEAK_OBJECT RELATIONSHIP" as the namespace and classname of the object in the adjacency list.

See Also:

Constant Field Values

CMDB_ALL_RELATIONSHIP

public static final java.lang.String CMDB_ALL_RELATIONSHIP

Specifies that in a graph query, all relationships are displayed. Use the value "CMDB_ALL_RELATIONSHIP" as the namespace and classname of the object in the adjacency list.

See Also:

Constant Field Values

CMDB_ALL_OBJECT

public static final java.lang.String CMDB_ALL_OBJECT

Specifies that in a graph query, all objects are displayed. Use the value "CMDB_ALL_OBJECT" as the namespace and classname of the object in the adjacency list.

See Also:

Constant Field Values

CMDB_FEDERATION_ACTIVATION_NONE

public static final int CMDB_FEDERATION_ACTIVATION_NONE

Specifies that no action is taken.

See Also:

Constant Field Values

CMDB_FEDERATION_ACTIVATION_EXPAND

public static final int CMDB_FEDERATION_ACTIVATION_EXPAND

Specifies that the Federated Interface is expanded.

See Also:

Constant Field Values

CMDB_FEDERATION_ACTIVATION_LAUNCH

public static final int CMDB_FEDERATION_ACTIVATION_LAUNCH

Specifies that the Federated Interface is expanded and launched.

See Also:

Constant Field Values

CMDB_VER_APP_ID_CMDB

public static final java.lang.String CMDB_VER_APP_ID_CMDB

Specifies the application ID for BMC Atrium CMDB.

See Also:

Constant Field Values

CMDB_VER_APP_ID_RECON_ENG

public static final java.lang.String CMDB_VER_APP_ID_RECON_ENG

Specifies the application ID for Reconciliation Engine.

See Also:

Constant Field Values

Constructor Detail

CMDBUtil

public CMDBUtil()

Method Detail

CMDBImport

public static void CMDBImport(ARServerUser context,
                              CMDBItemBase[] importItemArray,
                              java.lang.String directoryPath)
                       throws ARException,
                              java.io.IOException

Deprecated. as of CMDB 2.0

Imports a list of metadata and instance data from the specified directory into BMC Atrium CMDB.

Parameters:

context - AR System user and host information

importItemArray - array of items to be imported. If the value is NULL, all classes and instances are imported.

directoryPath - source directory for the specified classes or instances

Throws:

ARException - if the definition cannot be imported

java.io.IOException

CMDBExport

public static void CMDBExport(ARServerUser context,
                              CMDBItemBase[] exportItemArray,
                              java.lang.String exportFormat,
                              java.lang.String directoryPath)
                       throws ARException,
                              java.io.IOException

Deprecated. as of CMDB 2.0

Exports a list of metadata and instance data from BMC Atrium CMDB to the specified directory.

Parameters:

context - AR System user and host information

exportItemArray - array of items to be exported

exportFormat - export format. Currently only XML is supported, so specify "xml" or NULL.

directoryPath - source directory for the specified classes or instances

Throws:

ARException - if the definition cannot be exported

java.io.IOException

CMDBBeginBulkEntryTransaction

public static void CMDBBeginBulkEntryTransaction(ARServerUser context)
                                          throws ARException

Starts a bulk entry transaction for the specified context object.

Parameters:

context - AR System user and host information

Throws:

ARException - if the bulk transaction cannot be started

CMDBEndBulkEntryTransaction

public static BulkEntryReturn[] CMDBEndBulkEntryTransaction(ARServerUser context,
                                                            int actionType)
                                                     throws ARException

Ends a bulk entry transaction by either sending a list of transactions to BMC Atrium CMDB or canceling the transaction.

Parameters:

context - AR System user and host information

actionType - action type. It can be AR_BULK_ENTRY_ACTION_SEND or AR_BULK_ENTRY_ACTION_CANCEL

Returns:

status and entry ID of all bulked calls

Throws:

ARException - if the bulk transaction cannot be finished with the requested type

CMDBGraphQuery

public static CMDBGraphResult CMDBGraphQuery(ARServerUser context,
                                             CMDBClassNameKey startClassNameId,
                                             java.lang.String startExtensionId,
                                             java.lang.String startInstanceId,
                                             int numLevels,
                                             int direction,
                                             boolean noMatchProceed,
                                             boolean onMatchProceed,
                                             CMDBGraph[] graphArray)
                                      throws ARException

Generates a graph query starting with the specified node, using the specified number of levels and relationship direction.

Parameters:

context - AR System user and host information

startClassNameId - class name ID of the starting node

startExtensionId - extension ID of the starting node

startInstanceId - instance ID of the starting node

numLevels - number of levels to go, -1 means all

direction - 0 for out (node on the left), 1 for in (node on the right), and 2 for both directions

noMatchProceed - Boolean value indicating whether to proceed if instance does not match the specified qualification

onMatchProceed - Boolean value indicating whether to proceed on matching of the specified instance

graphArray - input graph on which to query

Returns:

CMDBGraphResult list of objects and relations returned by way of graph walking. An empty object is returned if there are no instance matches.

Throws:

ARException - if the query cannot be finished successfully

CMDBGraphQuery

public static CMDBGraphResult CMDBGraphQuery(ARServerUser context,
                                             CMDBClassNameKey startClassNameId,
                                             java.lang.String aDatasetId,
                                             int aGetMask,
                                             java.lang.String startExtensionId,
                                             java.lang.String startInstanceId,
                                             int numLevels,
                                             int direction,
                                             boolean noMatchProceed,
                                             boolean onMatchProceed,
                                             CMDBGraph[] graphArray)
                                      throws ARException

Generates a graph query starting with the node from the specified dataset, number of levels, and relationship direction.

Parameters:

context - AR System user and host information

startClassNameId - class name ID of the starting node

aDatasetId - dataset ID

aGetMask - dataset type, 0 for none, 1 for current, and 2 for overlay

startExtensionId - extension ID of the starting node

startInstanceId - instance ID of the starting node

numLevels - number of levels to go, -1 means all

direction - 0 for out (node on the left), 1 for in (node on the right), and 2 for both directions

noMatchProceed - Boolean value indicating whether to proceed if the instance does not match the specified qualification

onMatchProceed - Boolean value indicating whether to proceed on the matching of specified instance

graphArray - input graph to query on

Returns:

CMDBGraphResult list of objects and relations returned by way of graph walking. Empty object is returned if no instance matches.

Throws:

ARException - if the query cannot be finished successfully

CMDBSetServerPort

public static void CMDBSetServerPort(ARServerUser context,
                                     java.lang.Integer tcpPort,
                                     java.lang.Integer rpcPort)
                              throws ARException

Sets the AR System server TCP and RPC ports.

Parameters:

context - AR System user and host information

tcpPort - AR System server TCP port to be set. If NULL is provided, then TCP port will not be set.

rpcPort - AR System server RPC port to be set. If NULL is provided, then RPC port will not be set.

Throws:

ARException - if the port cannot be retrieved

CMDBGetServerPort

public static void CMDBGetServerPort(ARServerUser context,
                                     java.lang.Integer tcpPort,
                                     java.lang.Integer rpcPort)
                              throws ARException

Gets the AR System server TCP and RPC ports.

Parameters:

context - AR System user and host information

tcpPort - AR System server TCP port to retrieve. If NULL is provided, then TCP port will not be retrieved.

rpcPort - AR System server RPC port to retrieve. If NULL is provided, then RPC port will not be retrieved.

Throws:

ARException - if the port cannot be retrieved

CMDBCreateGuid

public static java.lang.String CMDBCreateGuid(ARServerUser context)
                                       throws ARException

Creates a GUID and returns it.

Parameters:

context - AR System user and host information

Throws:

ARException - if the GUID cannot be created

CMDBSystemInit

public static void CMDBSystemInit(ARServerUser context,
                                  PropInfo[] sysProps)
                           throws ARException

Initializes the system properties. This function is reserved for future use.

Parameters:

context - AR System user and host information

sysProps - system properties to be initialized

Throws:

ARException - if the system properties cannot be initialized

CMDBGetVersions

public static CMDBVersionInfo[] CMDBGetVersions(ARServerUser context,
                                                java.lang.String[] AppIdList)
                                         throws ARException

Gets a list of versions for the following parameters: applicationId (application ID), majorVer (major version), minorVer (minor version), maintenanceVer (maintenance version), patchNum (patch number), and isExist (Boolean value indicated whether Application ID exists)

Parameters:

context - AR System user and host information

AppIdList - AR System ID of application for which details are asked

Returns:

list of objects of CMDBVersionInfo, for Application IDs passed

Throws:

ARException - if version information cannot be retrieved

CMDBREStartJobRun

public static java.lang.String CMDBREStartJobRun(ARServerUser context,
                                                 java.lang.String jobName,
                                                 CMDBClassQual[] qualList,
                                                 CMDBREDatasetPair[] datasetList)
                                          throws ARException

Starts an existing Reconciliation Engine job using the specified qualification information and dataset list.

Parameters:

context - AR System user and host information

jobName - Reconciliation Engine job Name

qualList - class qualification list

datasetList - dataset list

Returns:

jobRunId ID of running Reconciliation Engine job

Throws:

ARException - if job cannot be started

CMDBRECancelJobRun

public static void CMDBRECancelJobRun(ARServerUser context,
                                      java.lang.String jobRunId)
                               throws ARException

Cancels the specified Reconciliation Engine job.

Parameters:

context - AR System user and host information

jobRunId - Reconciliation Engine Job Name

Throws:

ARException - Job Cannot Be Started

CMDBGetRelatedFederatedInContext

public static CMDBInstanceBase[] CMDBGetRelatedFederatedInContext(ARServerUser context,
                                                                  CMDBClassNameKey aClassKey,
                                                                  java.lang.String instanceId,
                                                                  java.lang.String[] attributeNames)
                                                           throws ARException

Gets a list of Federated Interface instances for the specified instance and attributes.

Parameters:

context - AR System user and host information

aClassKey - class key

instanceId - the instance ID

attributeNames - attribute name list

Returns:

returns the CMDBInstanceBase object

Throws:

ARException

CMDBGetRelatedFederatedInContext

public static CMDBInstanceBase[] CMDBGetRelatedFederatedInContext(ARServerUser context,
                                                                  CMDBClassNameKey aClassKey,
                                                                  java.lang.String aDataSetId,
                                                                  java.lang.String instanceId,
                                                                  java.lang.String[] attributeNames)
                                                           throws ARException

Gets a list of related Federated Interface instances for the instances in the specified dataset.

Parameters:

context - AR System user and host information

aClassKey - class key

aDataSetId - dataset from which you want to retrieve instances

instanceId - is the instance ID

attributeNames - is the attribute name list

Returns:

returns the CMDBInstanceBase object

Throws:

ARException

CMDBActivateFederatedInContext

public static CMDBFederatedActivateInfo CMDBActivateFederatedInContext(ARServerUser context,
                                                                       CMDBClassNameKey aClassKey,
                                                                       java.lang.String instanceId,
                                                                       java.lang.String federatedInstanceId,
                                                                       int activateOption)
                                                                throws ARException

Launches the Federated Interface instance related to the specified instance and uses the activation option specified.

Parameters:

context - AR System user and host information

aClassKey - class key

instanceId - instance ID

federatedInstanceId - instance ID for the Federated Interface

activateOption - activate option for the Federated Interface

Returns:

returns the CMDBFederatedActivateInfo object

Throws:

ARException

CMDBActivateFederatedInContext

public static CMDBFederatedActivateInfo CMDBActivateFederatedInContext(ARServerUser context,
                                                                       CMDBClassNameKey aClassKey,
                                                                       java.lang.String aDataSetId,
                                                                       java.lang.String instanceId,
                                                                       java.lang.String federatedInstanceId,
                                                                       int activateOption)
                                                                throws ARException

Launches the Federated Interface instance that is related to an instance from the specified dataset.

Parameters:

context - AR System user and host information

aClassKey - class key

aDataSetId - dataset ID of the instances you want to retrieve

instanceId - instance ID

federatedInstanceId - Federated Instance ID

activateOption - activate Option

Returns:

returns the CMDBFederatedActivateInfo object

Throws:

ARException

CMDBGetCMDBUIComponents

public static CMDBUIComponentResult[] CMDBGetCMDBUIComponents(ARServerUser context,
                                                              CMDBUIComponentInfo inputInfo,
                                                              java.lang.String datasetId,
                                                              java.lang.String instanceId)
                                                       throws ARException

Gets a list of user interface components for the specified instance.

Parameters:

context - AR System user and host information

inputInfo - CMDBUIComponentInfo object

datasetId - dataset ID

instanceId - instance ID

Returns:

returns CMDBUIComponentResult object array

Throws:

ARException

CMDBGetCopyAuditData

public static CMDBAuditValueList[] CMDBGetCopyAuditData(ARServerUser context,
                                                        CMDBClassNameKey classNameId,
                                                        java.lang.String instanceId,
                                                        java.lang.String datasetId,
                                                        QualifierInfo query,
                                                        java.lang.String[] attributeList)
                                                 throws ARException

Gets a list of audit details for the specified qualified instance.

Parameters:

context - AR System user and host information

classNameId - class key

instanceId - instance ID

datasetId - dataset ID

query - qualification information

attributeList - attribute list

Returns:

CMDBAuditValueList object list

Throws:

ARException

CMDBGetInstanceBase

public static CMDBInstanceBase CMDBGetInstanceBase(ARServerUser context,
                                                   CMDBClassNameKey classKey,
                                                   java.lang.String datasetId,
                                                   int getMask,
                                                   java.lang.String instanceId,
                                                   java.lang.String[] attributeNames)
                                            throws ARException

Gets the instances from the specified dataset that contain the specified attributes.

Parameters:

context - ARSystemUser structure that contains user and host information

classKey - class key of the class to which the instance belongs

datasetId - dataset ID of the instances you want to retrieve

getMask - the dataset type (current or overlay)

instanceId - instance ID

attributeNames - attribute name list

Returns:

CMDBInstanceBase object

Throws:

ARException

CMDBGetListInstanceWithAttributes1

public static CMDBInstanceBase[] CMDBGetListInstanceWithAttributes1(ARServerUser ctx,
                                                                    CMDBClassNameKey aClassKey,
                                                                    java.lang.String datasetId,
                                                                    int getMask,
                                                                    java.lang.String query,
                                                                    java.lang.String[] attributeGetList,
                                                                    CMDBSort[] sortArray,
                                                                    int firstRetrieve,
                                                                    int maxRetrieve,
                                                                    java.lang.Integer numMatches)
                                                             throws ARException

Gets a list of all the instances from the specified dataset that match the specified qualifications.

Parameters:

ctx - ARSystemUser structure that contains user and host information

aClassKey - the key of the class to which the instance belongs

datasetId - of which you want to retrieve instances

getMask - the get mask (current or overlay)

query - a query object where you specify a qualification for retrieving instances

attributeGetList - list of the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.

sortArray - sort array

firstRetrieve - first instance retrieved for the query chunk

maxRetrieve - instances to retrieve for the query

numMatches - number of matches

Returns:

CMDBInstanceBase object array

Throws:

ARException

CMDBExpandParametersForCI

public static java.lang.String CMDBExpandParametersForCI(ARServerUser context,
                                                         java.lang.String paramString,
                                                         CMDBInstanceBase instance)
                                                  throws ARException

Gets the expand parameters for a CI.

Parameters:

context - AR System user and host information

paramString - param string

instance - instance base

Throws:

ARException

CMDBRunQualificationForCI

public static boolean CMDBRunQualificationForCI(ARServerUser context,
                                                java.lang.String qualifier,
                                                CMDBAttributeValue[] attributeValue)
                                         throws ARException

Verifies if an instance is qualified.

Parameters:

context - AR System user and host information

qualifier - query

attributeValue - attribute value list

Returns:

Boolean value

Throws:

ARException

CMDBExportDef

public static java.lang.String CMDBExportDef(ARServerUser context,
                                             CMDBXMLExportItem[] exportItemList)
                                      throws ARException

Exports a list of attribute definitions.

Parameters:

context - AR System user and host information

exportItemList - list of items to be exported

Returns:

exported class/attribute in string format

Throws:

ARException

CMDBExportData

public static java.lang.String CMDBExportData(ARServerUser ctx,
                                              CMDBClassNameKey aClassKey,
                                              java.lang.String datasetId,
                                              java.lang.String query,
                                              java.lang.String[] attributeGetList,
                                              CMDBSort[] sortArray,
                                              int firstRetrieve,
                                              int maxRetrieve)
                                       throws ARException

Exports instance data that matches the specified qualifications.

Parameters:

ctx - ARSystemUser structure that contains user and host information

aClassKey - key of the class to which the instance belongs

query - a query object where you specify a qualification for retrieving instances

attributeGetList - list of the attribute to be retrieved

sortArray - sort array

firstRetrieve - first instance retrieved for the query chunk

maxRetrieve - instances to retrieve for the query

Returns:

exportBuf in form of string

Throws:

ARException

CMDBImportData

public static void CMDBImportData(ARServerUser ctx,
                                  int importOption,
                                  java.lang.String importBuf)
                           throws ARException

Imports the Instance Data using the import option specified.

Parameters:

ctx - AR System user and host information

importOption - import option, which can be: CMDBXMLImportItem.CMDB_DATA_IMPORT_OPT_ERROR_FOR_DUP, CMDBXMLImportItem.CMDB_DATA_IMPORT_OPT_NEWID_FOR_DUP, CMDBXMLImportItem.CMDB_DATA_IMPORT_OPT_MERGE_FOR_DUP, CMDBXMLImportItem.CMDB_DATA_IMPORT_OPT_NEWID_FOR_ALL.

importBuf - string passed to import

Throws:

ARException

CMDBImportDef

public static void CMDBImportDef(ARServerUser ctx,
                                 CMDBXMLImportItem[] importItem,
                                 int importOption,
                                 java.lang.String importBuf)
                          throws ARException

Imports the class or attribute definitions using the import option specified.

Parameters:

ctx - AR System user and host information

importItem - list of items to be imported

importOption - import option, which can be: CMDBXMLImportItem.CMDB_DEF_IMPORT_OPT_CREATE, CMDBXMLImportItem.CMDB_DEF_IMPORT_OPT_OVERWRITE.

importBuf - import Data in string format

Throws:

ARException