Package | Description |
---|---|
com.hp.ucmdb.api |
This package contains the top level of API set for working with the UCMDB.
|
com.hp.ucmdb.api.classmodel |
This package contains services for querying and listening for changes in the
UCMDB class model.
|
com.hp.ucmdb.api.configuration |
This package contains services for Infrastructure settings management.
|
com.hp.ucmdb.api.datastoremgmt |
This package contains services for datastore management.
|
com.hp.ucmdb.api.discovery.types |
This package contains interfaces that represent the basic discovery elements of the API.
|
com.hp.ucmdb.api.impact |
This package contains services for analysing the impact of changes to configuration items in the IT universe.
|
com.hp.ucmdb.api.resources |
This package contains services for managing definitions of TQLs, views, users and other resources.
|
com.hp.ucmdb.api.topology |
This package contains services for defining and running TQL queries and processing the results.
|
com.hp.ucmdb.api.view |
This package contains services for handling UCMDB views.
|
Modifier and Type | Class and Description |
---|---|
class |
CommunicationException
Thrown on communication failure between the client and the UCMDB server or on protocol error.
|
class |
CustomerNotAvailableException
The UCMDB server is not yet ready to accept connect request.
|
class |
ExecutionException
A UCMDB server-side exception.
|
class |
IncompatibleVersionException
The server cannot support this version of the client implementation.
|
class |
InvalidCredentialsException
Client authentication failed.
|
Modifier and Type | Class and Description |
---|---|
class |
AttributeDoesNotExistException |
class |
AttributeNotStaticException
A non-static value was used in a context that requires a static value.
|
class |
AttributeStaticException
A static value was used in a context that requires a non-static value.
|
class |
ClassDoesNotExistException |
class |
QualifierDoesNotExistException |
Modifier and Type | Method and Description |
---|---|
String |
ConfigurationService.registerConfigurationParametersListener(ConfigurationParametersListener listener,
ConfigurationParametersListenerFilter filter)
Registers a listener to be called when specified configuration parameters change.
|
Modifier and Type | Class and Description |
---|---|
class |
DataStoreCheckedException |
class |
DataStoreConnectionException |
class |
DataStoreException |
Modifier and Type | Class and Description |
---|---|
class |
IllegalNetworkRangeException
Indicates that an input IP range is invalid.
|
class |
ParsingRuleDoesNotExistException |
class |
ProcessDoesNotExistException
Indicates that the ProcessSignature does not exist.
|
class |
SignatureDoesNotExistException
Indicates that the SoftwareSignature does not exist
|
Modifier and Type | Class and Description |
---|---|
class |
InvalidImpactDefinitionException |
Modifier and Type | Class and Description |
---|---|
class |
ResourceValidationException |
Modifier and Type | Method and Description |
---|---|
void |
ResourceManagementService.deployPackage(File packageFile)
Deploys the contents of the package file to the server.
|
void |
ResourceManagementService.deployPackage(String packageName,
InputStream packageContent)
Deploys the contents of the stream to the server as a package with the specified name.
|
Modifier and Type | Class and Description |
---|---|
class |
InvalidQueryDefinitionException
The query cannot be processed due to syntax or other error in the query.
|
class |
TopologyUpdateException |
class |
TopologyUpdateMissingDataException |
Modifier and Type | Method and Description |
---|---|
CreateOutput |
TopologyUpdateService.create(TopologyModificationData modificationData,
CreateMode mode)
Creates the specified set of CIs and relations in the UCMDB.
|
DeleteOutput |
TopologyUpdateService.delete(TopologyModificationData modificationData,
DeleteMode mode)
Deletes a set of CIs and relations from the UCMDB.
|
TopologyCount |
TopologyQueryService.evaluateNamedQuery(String queryName)
Executes the query of the specified name and return its result count.
|
TopologyCountByClasses |
TopologyQueryService.evaluateNamedQueryWithClassesBreakdown(String queryName,
Collection<String> elementNamesToCount)
Executes the query of the specified name and return its result count break-down by classes.
|
TopologyCount |
TopologyQueryService.evaluateQuery(ExecutableQuery query)
Executes a query stored on the server and returns the result count.
|
TopologyCount |
TopologyQueryService.evaluateQuery(QueryDefinition queryDefinition)
Executes a query defined on the client and returns its result count.
|
TopologyCountByClasses |
TopologyQueryService.evaluateQueryWithClassesBreakdown(ExecutableQuery query,
Collection<String> elementNamesToCount)
Executes a query stored on the server and returns the result count break-down by classes.
|
TopologyCountByClasses |
TopologyQueryService.evaluateQueryWithClassesBreakdown(QueryDefinition queryDefinition,
Collection<String> elementNamesToCount)
Executes a query defined on the client and return its result count break-down by classes.
|
ExecuteOutput |
TopologyUpdateService.execute(TopologyModificationBulk topologyModificationBulk)
Executes bulk of topology modifications
|
ExecuteOutput |
TopologyUpdateService.execute(TopologyModification topologyModification,
ModifyMode mode)
Deprecated.
|
Topology |
TopologyQueryService.executeNamedQuery(String queryName)
Executes the query of the specified name.
|
Topology |
TopologyQueryService.executeNamedQueryInBDMScope(String queryName)
Executes the query of the specified name within the BDM scope.
|
Topology |
TopologyQueryService.executeQuery(ExecutableQuery query)
Executes a query stored on the server and returns the result.
|
Topology |
TopologyQueryService.executeQuery(QueryDefinition queryDefinition)
Executes a query defined on the client.
|
Topology |
TopologyQueryService.executeQueryInBDMScope(ExecutableQuery query)
Executes a query that is stored on the server, within the BDM scope, and returns the result.
|
QueryResultChange |
LiveQueryResult.getChanges()
Returns the changes to the query result.
|
QueryResultChange |
LiveQuery.getChanges(QueryResultVersion queryResultVersion)
returns the changes in the result of the query since the result had the given result version
Notice that there may be cases where has changes returned true, but get changes will return empty changes
since it accumulates changes, for example, if certain object was added and than was removed
|
Topology |
LiveQueryResult.getCurrentTopology()
Returns current topology from the server.
|
LiveTopology |
LiveQuery.getQueryResult()
Gets the result of the query.
|
boolean |
LiveQueryResult.hasChanges()
Returns true if the server has changes on the query result.
|
boolean |
LiveQuery.hasChanges(QueryResultVersion queryResultVersion)
Determines whether there are changes in the result of the query since
the result had the given result version.
|
boolean |
TopologyQueryService.isActiveQueryInFailedState(String queryName)
Checks if the given query is defined ACTIVE in UCMDB and is currently in FAILED state.
|
MergeOutput |
TopologyUpdateService.merge(MergeInput idsToMerge)
Merge a set of CIs in the UCMDB.
|
String |
TopologyQueryService.queryDefinitionToString(QueryDefinition queryDefinition)
Returns the query's string representation.
|
void |
TopologyQueryService.registerModelListener(ModelListener listener)
Deprecated.
|
String |
TopologyQueryService.registerModelListener(ModelListener listener,
ModelEventsFilter filter)
Registers a listener to be called when the model stored on the UCMDB server changes.
|
String |
TopologyQueryService.registerModelListener(ModelListener listener,
ModelEventsFilter filter,
NotificationListenerFuse fuse)
Registers a listener to be called when the model stored on the UCMDB server changes.
|
String |
TopologyQueryService.registerModelListener(ModelListener listener,
ModelListenerFilter filter)
Deprecated.
|
void |
TopologyQueryService.registerQueryResultListener(QueryResultListener listener,
String queryName)
Registers a listener to be called when the result of the specified server-side query changes.
|
LiveQueryResultListener |
LiveQuery.removeQueryResultListener()
Unregisters live query listener.
|
UcmdbId |
TopologyUpdateFactory.restoreCIIdFromString(String id)
Returns the
UcmdbId object for the specified string representation of a CI ID. |
QueryDefinition |
TopologyQueryService.stringToQueryDefinition(String str)
Returns a copy of the original query definition used to create the string.
|
void |
TopologyUpdateService.touch(TopologyModificationData modificationData)
Delays deletion of UCMDB CIs and relations due to aging.
|
void |
TopologyQueryService.unregisterModelListener(String listenerId)
Unregisters the specified model listener.
|
void |
TopologyQueryService.unregisterQueryResultListener(QueryResultListener listener,
String queryName)
Unregisters the specified listener.
|
UpdateOutput |
TopologyUpdateService.update(TopologyModificationData modificationData)
Updates a set of CIs and relations in the UCMDB.
|
void |
TopologyQueryService.updateFilteredModelListener(String listenerId,
ModelEventsFilter filter)
Updates model listener filter definition.
|
void |
TopologyQueryService.updateFilteredModelListener(String listenerId,
ModelListenerFilter filter)
Deprecated.
|
boolean |
TopologyQueryService.validateBDMQuery(QueryDefinition queryDefinition)
Checks if the query definition is BDM compliant.
|
Modifier and Type | Class and Description |
---|---|
class |
ViewDoesNotExistException |
Modifier and Type | Method and Description |
---|---|
ViewDefinition |
ViewService.stringToViewDefinition(String str)
Given a string created by
ViewService.viewDefinitionToString(com.hp.ucmdb.api.view.ViewDefinition) , this methods returns a copy of the original
ViewDefinition. |
String |
ViewService.viewDefinitionToString(ViewDefinition viewDefinition)
Given a
ViewDefinition this method returns the view's string representation. |
Documentation Feedback
Copyright 2011 - 2018 Micro Focus or one of its affiliates.