|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.remedy.cmdb.api.CMDBUtil
The CMDBUtil
class defines all the utility methods for the
Class Manager API.
Field Summary | |
static int |
AR_BULK_ENTRY_ACTION_CANCEL
Cancels all bulked transactions. |
static int |
AR_BULK_ENTRY_ACTION_SEND
Sends all bulked transactions to AR System. |
static java.lang.String |
CMDB_ALL_OBJECT
All-relationship graph query. |
static java.lang.String |
CMDB_ALL_RELATIONSHIP
All-relationship graph query. |
static int |
CMDB_FEDERATION_ACTIVATION_EXPAND
Return the expanded federated link |
static int |
CMDB_FEDERATION_ACTIVATION_LAUNCH
Launch the federated link in context |
static int |
CMDB_FEDERATION_ACTIVATION_NONE
Take no action |
static int |
CMDB_RELATIONSHIP_DIRECTION_IN
Relation on an object where the object is on the right, with an arrow pointing at the node. |
static int |
CMDB_RELATIONSHIP_DIRECTION_OUT
Relation on an object where the object is on the left, with an arrow coming out from the node. |
static java.lang.String |
CMDB_VER_APP_ID_CMDB
Application ID for CMDB |
static java.lang.String |
CMDB_VER_APP_ID_RECON_ENG
Application ID for Reconciliation Engine |
static java.lang.String |
CMDB_WEAK_OBJECT
Weak relationship-only graph query. |
static java.lang.String |
CMDB_WEAK_RELATIONSHIP
Weak relationship-only graph query. |
Constructor Summary | |
CMDBUtil()
|
Method Summary | |
static CMDBFederatedActivateInfo |
CMDBActivateFederatedInContext(ARServerUser context,
CMDBClassNameKey aClassKey,
java.lang.String instanceId,
java.lang.String federatedInstanceId,
int activateOption)
Get Activate Federated In Context |
static CMDBFederatedActivateInfo |
CMDBActivateFederatedInContext(ARServerUser context,
CMDBClassNameKey aClassKey,
java.lang.String aDataSetId,
java.lang.String instanceId,
java.lang.String federatedInstanceId,
int activateOption)
Get Activate Federated In Context |
static void |
CMDBBeginBulkEntryTransaction(ARServerUser context)
Utility method to start a bulk entry transaction. |
static java.lang.String |
CMDBCreateGuid(ARServerUser context)
Creates a GUID and returns it. |
static BulkEntryReturn[] |
CMDBEndBulkEntryTransaction(ARServerUser context,
int actionType)
Utility method to end a bulk entry transaction by either sending the transaction to AR System 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)
Utility method to export the metadata and instance data from AR System. |
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)
Export the Instance Data |
static java.lang.String |
CMDBExportDef(ARServerUser context,
CMDBXMLExportItem[] exportItemList)
Export the Class/Attribute definitions |
static CMDBUIComponentResult[] |
CMDBGetCMDBUIComponents(ARServerUser context,
CMDBUIComponentInfo inputInfo,
java.lang.String datasetId,
java.lang.String instanceId)
|
static CMDBAuditValueList[] |
CMDBGetCopyAuditData(ARServerUser context,
CMDBClassNameKey classNameId,
java.lang.String instanceId,
java.lang.String datasetId,
QualifierInfo query,
java.lang.String[] attributeList)
|
static CMDBInstanceBase |
CMDBGetInstanceBase(ARServerUser context,
CMDBClassNameKey classKey,
java.lang.String datasetId,
int getMask,
java.lang.String instanceId,
java.lang.String[] attributeNames)
|
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)
|
static CMDBInstanceBase[] |
CMDBGetRelatedFederatedInContext(ARServerUser context,
CMDBClassNameKey aClassKey,
java.lang.String instanceId,
java.lang.String[] attributeNames)
Get Related Federated In Context |
static CMDBInstanceBase[] |
CMDBGetRelatedFederatedInContext(ARServerUser context,
CMDBClassNameKey aClassKey,
java.lang.String aDataSetId,
java.lang.String instanceId,
java.lang.String[] attributeNames)
Get Related Federated In Context |
static void |
CMDBGetServerPort(ARServerUser context,
java.lang.Integer tcpPort,
java.lang.Integer rpcPort)
Gets the server TCP and RPC ports. |
static CMDBVersionInfo[] |
CMDBGetVersions(ARServerUser context,
java.lang.String[] AppIdList)
Gets Version information in CMDBVersionInfo which is having following parameter. |
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)
Method to run a graph query. |
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)
Method to run a graph query. |
static void |
CMDBImport(ARServerUser context,
CMDBItemBase[] importItemArray,
java.lang.String directoryPath)
Utility method to import the metadata and instance data into AR System. |
static void |
CMDBImportData(ARServerUser ctx,
int importOption,
java.lang.String importBuf)
Import the Instance Data |
static void |
CMDBImportDef(ARServerUser ctx,
CMDBXMLImportItem[] importItem,
int importOption,
java.lang.String importBuf)
Import the Class/Attribute definitions |
static void |
CMDBRECancelJobRun(ARServerUser context,
java.lang.String jobRunId)
Cancel running Reconciliation Engine Job |
static java.lang.String |
CMDBREStartJobRun(ARServerUser context,
java.lang.String jobName,
CMDBClassQual[] qualList,
CMDBREDatasetPair[] datasetList)
Start Existing Reconciliation Engine Job |
static boolean |
CMDBRunQualificationForCI(ARServerUser context,
java.lang.String qualifier,
CMDBAttributeValue[] attributeValue)
Check the qualification for a CI |
static void |
CMDBSetServerPort(ARServerUser context,
java.lang.Integer tcpPort,
java.lang.Integer rpcPort)
Sets the 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 |
public static final int AR_BULK_ENTRY_ACTION_SEND
public static final int AR_BULK_ENTRY_ACTION_CANCEL
public static final int CMDB_RELATIONSHIP_DIRECTION_OUT
public static final int CMDB_RELATIONSHIP_DIRECTION_IN
public static final java.lang.String CMDB_WEAK_RELATIONSHIP
public static final java.lang.String CMDB_WEAK_OBJECT
public static final java.lang.String CMDB_ALL_RELATIONSHIP
public static final java.lang.String CMDB_ALL_OBJECT
public static final int CMDB_FEDERATION_ACTIVATION_NONE
public static final int CMDB_FEDERATION_ACTIVATION_EXPAND
public static final int CMDB_FEDERATION_ACTIVATION_LAUNCH
public static final java.lang.String CMDB_VER_APP_ID_CMDB
public static final java.lang.String CMDB_VER_APP_ID_RECON_ENG
Constructor Detail |
public CMDBUtil()
Method Detail |
public static void CMDBImport(ARServerUser context, CMDBItemBase[] importItemArray, java.lang.String directoryPath) throws ARException, java.io.IOException
context
- AR System user and host informationimportItemArray
- Array of items to be imported. NULL is OK; implies import of all classes
and instances present in the given directory i.e. all the suitable files within this directory.directoryPath
- source directory to import the specified classes or instances
ARException
- if the definition cannot be imported
java.io.IOException
public static void CMDBExport(ARServerUser context, CMDBItemBase[] exportItemArray, java.lang.String exportFormat, java.lang.String directoryPath) throws ARException, java.io.IOException
context
- AR System user and host informationexportItemArray
- array of items to be exportedexportFormat
- Export format. Currently only XML is supported, so specify "xml" or NULL.directoryPath
- source directory to import the specified classes or instances
ARException
- if the definition cannot be exported
java.io.IOException
public static void CMDBBeginBulkEntryTransaction(ARServerUser context) throws ARException
context
- AR System user and host information
ARException
- if the bulk transaction cannot be startedpublic static BulkEntryReturn[] CMDBEndBulkEntryTransaction(ARServerUser context, int actionType) throws ARException
context
- AR System user and host informationactionType
- The action type. It can be
AR_BULK_ENTRY_ACTION_SEND
or
AR_BULK_ENTRY_ACTION_CANCEL
ARException
- if the bulk transaction cannot be finished with the requested typepublic 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
context
- AR System user and host informationstartClassNameId
- class name ID of the starting nodestartExtensionId
- extension ID of the starting nodestartInstanceId
- instance ID of the starting nodenumLevels
- number of levels to go, -1 means alldirection
- 1 for impact (node on the right), 0 for cause (node on the left)noMatchProceed
- boolean indicating whether to proceed if instance does not match specified qualificationonMatchProceed
- boolean indicating whether to proceed on matching of specified instancegraphArray
- input graph to query on
ARException
- if the query cannot be finished successfullypublic 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
context
- AR System user and host informationstartClassNameId
- class name ID of the starting nodeaDatasetId
- DataSetIdaGetMask
- get mask 0 for none, 1 for current and 2 for an overlaystartExtensionId
- extension ID of the starting nodestartInstanceId
- instance ID of the starting nodenumLevels
- number of levels to go, -1 means alldirection
- 1 for impact (node on the right), 0 for cause (node on the left)noMatchProceed
- boolean indicating whether to proceed if instance does not match specified qualificationonMatchProceed
- boolean indicating whether to proceed on matching of specified instancegraphArray
- input graph to query on
ARException
- if the query cannot be finished successfullypublic static void CMDBSetServerPort(ARServerUser context, java.lang.Integer tcpPort, java.lang.Integer rpcPort) throws ARException
context
- AR System user and host infomationtcpPort
- 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.
ARException
- if the port cannot be retrievedpublic static void CMDBGetServerPort(ARServerUser context, java.lang.Integer tcpPort, java.lang.Integer rpcPort) throws ARException
context
- AR System user and host infomationtcpPort
- 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.
ARException
- if the port cannot be retrievedpublic static java.lang.String CMDBCreateGuid(ARServerUser context) throws ARException
context
- AR System user and host infomation
ARException
- if the GUID cannot be createdpublic static void CMDBSystemInit(ARServerUser context, PropInfo[] sysProps) throws ARException
context
- AR System user and host infomationsysProps
- The system properties to be initialized
ARException
- if the system properties cannot be initializedpublic static CMDBVersionInfo[] CMDBGetVersions(ARServerUser context, java.lang.String[] AppIdList) throws ARException
context
- AR System user and host infomationAppIdList
- AR System ID of application for which details are asked.
ARException
- if Version Information cannot be retrivedpublic static java.lang.String CMDBREStartJobRun(ARServerUser context, java.lang.String jobName, CMDBClassQual[] qualList, CMDBREDatasetPair[] datasetList) throws ARException
context
- AR System user and host infomationjobName
- Reconciliation Engine Job NamequalList
- class qualification listdatasetList
- dataset list
ARException
- if Job cannot be startedpublic static void CMDBRECancelJobRun(ARServerUser context, java.lang.String jobRunId) throws ARException
context
- AR System user and host infomationjobRunId
- Reconciliation Engine Job Name
ARException
- Job Cannot Be Startedpublic static CMDBInstanceBase[] CMDBGetRelatedFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String[] attributeNames) throws ARException
context
- AR System user and host infomationaClassKey
- is the classKeyinstanceId
- is the instance idattributeNames
- is the attribute Name list
ARException
public static CMDBInstanceBase[] CMDBGetRelatedFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDataSetId, java.lang.String instanceId, java.lang.String[] attributeNames) throws ARException
context
- AR System user and host infomationaClassKey
- is the classKeyaDataSetId
- DataSetId of which you want to retrieve instancesinstanceId
- is the instance idattributeNames
- is the attribute Name list
ARException
public static CMDBFederatedActivateInfo CMDBActivateFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String federatedInstanceId, int activateOption) throws ARException
context
- AR System user and host infomationaClassKey
- is the Class KeyinstanceId
- is the Instance IdfederatedInstanceId
- is the Federated Instance IdactivateOption
- is the activate Option
ARException
public static CMDBFederatedActivateInfo CMDBActivateFederatedInContext(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDataSetId, java.lang.String instanceId, java.lang.String federatedInstanceId, int activateOption) throws ARException
context
- AR System user and host infomationaClassKey
- is the Class KeyaDataSetId
- DataSetId of which you want to retrieve instancesinstanceId
- is the Instance IdfederatedInstanceId
- is the Federated Instance IdactivateOption
- is the activate Option
ARException
public static CMDBUIComponentResult[] CMDBGetCMDBUIComponents(ARServerUser context, CMDBUIComponentInfo inputInfo, java.lang.String datasetId, java.lang.String instanceId) throws ARException
context
- AR System user and host infomationinputInfo
- CMDBUIComponentInfo objectdatasetId
- is the DataSetIdinstanceId
- is the Instance Id
ARException
public static CMDBAuditValueList[] CMDBGetCopyAuditData(ARServerUser context, CMDBClassNameKey classNameId, java.lang.String instanceId, java.lang.String datasetId, QualifierInfo query, java.lang.String[] attributeList) throws ARException
context
- AR System user and host infomationclassNameId
- is the Class KeyinstanceId
- is the Instance IddatasetId
- is the dataset Idquery
- is the qualifierattributeList
- is the attribute list
ARException
public static CMDBInstanceBase CMDBGetInstanceBase(ARServerUser context, CMDBClassNameKey classKey, java.lang.String datasetId, int getMask, java.lang.String instanceId, java.lang.String[] attributeNames) throws ARException
context
- ARSystemUser structure that contains user
and host informationclassKey
- aClassKey the key of the class that the instance belongs todatasetId
- DatasetId of which you want to retrieve instancesgetMask
- the get mask (current, overlay, etc)instanceId
- is the Instance IdattributeNames
- is the attribute Name list
ARException
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
ctx
- ARSystemUser structure that contains user
and host informationaClassKey
- the key of the class that the instance belongs todatasetId
- of which you want to retrieve instancesgetMask
- the get mask (current, overlay, etc)query
- an query object where you specify a qualification for retrieving instancesattributeGetList
- attributeGetList the attribute to be retrieved. If attributeGetList
is NULL, then all attribute values of the instance will be
returned.sortArray
- is the sortArrayfirstRetrieve
- First instance retrieved for the query chunk.maxRetrieve
- instances to retrieve for the querynumMatches
- Number of Matches
ARException
public static java.lang.String CMDBExpandParametersForCI(ARServerUser context, java.lang.String paramString, CMDBInstanceBase instance) throws ARException
context
- AR System user and host infomationparamString
- is the param Stringinstance
- is the Instance Base
ARException
public static boolean CMDBRunQualificationForCI(ARServerUser context, java.lang.String qualifier, CMDBAttributeValue[] attributeValue) throws ARException
context
- AR System user and host infomationqualifier
- is the qualifierattributeValue
- is attribute value list
ARException
public static java.lang.String CMDBExportDef(ARServerUser context, CMDBXMLExportItem[] exportItemList) throws ARException
context
- AR System user and host infomationexportItemList
- is the export item list which is to be exported
ARException
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
ctx
- ARSystemUser structure that contains user
and host informationaClassKey
- the key of the class that the instance belongs toquery
- an query object where you specify a qualification for retrieving instancesattributeGetList
- attributeGetList the attribute to be retrieved.sortArray
- is the sortArrayfirstRetrieve
- First instance retrieved for the query chunk.maxRetrieve
- instances to retrieve for the query
ARException
public static void CMDBImportData(ARServerUser ctx, int importOption, java.lang.String importBuf) throws ARException
ctx
- AR System user and host infomationimportOption
- 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
ARException
public static void CMDBImportDef(ARServerUser ctx, CMDBXMLImportItem[] importItem, int importOption, java.lang.String importBuf) throws ARException
ctx
- AR System user and host infomationimportItem
- is the import item list which is to be importedimportOption
- option, which can be:
CMDBXMLImportItem.CMDB_DEF_IMPORT_OPT_CREATE
,
CMDBXMLImportItem.CMDB_DEF_IMPORT_OPT_OVERWRITE
.importBuf
- import Data in string format
ARException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |