com.hp.ucmdb.api.topology

Interface TopologyUpdateFactory

public interface TopologyUpdateFactory

Factory for creating arguments for TopologyUpdateService methods. The methods of this factory create client-side representations of CIs and Relations. They do not actually create them in the UCMDB.

Method Summary

Modifier and Type	Method and Description
CI	createCI(String type) Creates the client-side representation of a new CI of the specified type.
CI	createCI(String id, String type) Returns the client-side object for a CI of the specified ID and type.
CI	createCI(UcmdbId id, String type) Returns the client-side object for a CI of the specified ID and type.
ListPropertiesUpdate	createListPropertiesUpdate(TopologyData topologyData)
Relation	createRelation(String type, CI end1, CI end2) Creates a client-side Relation of the specified type between the two specified CIs.
Relation	createRelation(String type, UcmdbId end1Id, UcmdbId end2Id) Creates a client-side Relation of the specified type between the two CIs specified by their IDs.
Relation	createRelation(UcmdbId id, String type, UcmdbId id1, UcmdbId id2) Creates a client-side Relation of the specified type and with the given ID between two CIs specified by their IDs.
SingleTopologyModification	createSingleTopologyModification(String changer, TopologyModificationData data, TopologyModificationAction action) Creates single topology modification
UcmdbId	createTemporaryCIId(String id) Creates a temporary CI ID from the specified string.
UcmdbId	createTemporaryRelationId(String id) Creates a temporary Relation ID from the specified string.
TopologyModification	createTopologyModification() Creates an object to be used as an argument to TopologyUpdateService execute method.
TopologyModificationBulk	createTopologyModificationBulk(String changer) Creates a bulk of topology modification elements
TopologyModificationBulkElement	createTopologyModificationBulkElement(TopologyModificationData data, TopologyModificationAction action) Creates a topology modification element
TopologyModificationData	createTopologyModificationData() Creates an object to be used as an argument to TopologyUpdateService create, update and delete methods.
TopologyModificationData	createTopologyModificationData(String additionalModifierInfo) Creates an object with information about the reporting agent to be used as an argument to TopologyUpdateService create, update and delete methods.
UcmdbId	restoreCIIdFromBytes(byte[] id) Returns the UcmdbId object for the specified bytes array representation of a CI ID.
UcmdbId	restoreCIIdFromString(String id) Returns the UcmdbId object for the specified string representation of a CI ID.
UcmdbId	restoreRelationIdFromBytes(byte[] id) Returns the UcmdbId object for the specified bytes array representation of a Relation ID.
UcmdbId	restoreRelationIdFromString(String id) Returns the UcmdbId object for the specified string representation of a Relation ID.

Method Detail

restoreCIIdFromString

UcmdbId restoreCIIdFromString(String id)
                       throws UcmdbException

Returns the UcmdbId object for the specified string representation of a CI ID.

Parameters:

id - id of the CI as string obtained from UcmdbId.getAsString()

Throws:

UcmdbException - if the string passed cannot be converted to a valid UCMDB ID

restoreCIIdFromBytes

UcmdbId restoreCIIdFromBytes(byte[] id)

Returns the UcmdbId object for the specified bytes array representation of a CI ID.

Parameters:

id - id of the CI as byte array obtained from UcmdbId.getAsBytes()

createTemporaryCIId

UcmdbId createTemporaryCIId(String id)

Creates a temporary CI ID from the specified string.

Returns:

a temporary ID

createCI

CI createCI(String type)

Creates the client-side representation of a new CI of the specified type. The ID of the CI is a unique, automatically generated, temporary ID.

Parameters:

type - the class name of the new CI

createCI

CI createCI(UcmdbId id,
            String type)

Returns the client-side object for a CI of the specified ID and type.

Parameters:

id - ID of the new CI

type - the class name of the new CI

createCI

CI createCI(String id,
            String type)

Returns the client-side object for a CI of the specified ID and type.

Parameters:

id - ID of the CI as string obtained from UcmdbId.getAsString()

type - the class name of the CI

Since:

8.0

restoreRelationIdFromString

UcmdbId restoreRelationIdFromString(String id)

Returns the UcmdbId object for the specified string representation of a Relation ID. The string representation of a Relation ID is obtained with UcmdbId.getAsString()

Parameters:

id - the string representation of a Relation ID

Throws:

UcmdbException - if the string passed cannot be converted to a valid UCMDB ID

restoreRelationIdFromBytes

UcmdbId restoreRelationIdFromBytes(byte[] id)

Returns the UcmdbId object for the specified bytes array representation of a Relation ID. The bytes representation of a Relation ID is obtained with UcmdbId.getAsBytes()

Parameters:

id - the bytes array representation of a Relation ID

createTemporaryRelationId

UcmdbId createTemporaryRelationId(String id)

Creates a temporary Relation ID from the specified string.

Returns:

a temporary id

createRelation

Relation createRelation(String type,
                        CI end1,
                        CI end2)

Creates a client-side Relation of the specified type between the two specified CIs. This Relation can be used in the TopologyUpdateService.create method. The ID of the Relation is a unique, automatically generated, temporary ID.

Parameters:

type - the class name of the new relation

createRelation

Relation createRelation(String type,
                        UcmdbId end1Id,
                        UcmdbId end2Id)

Creates a client-side Relation of the specified type between the two CIs specified by their IDs. This Relation can be used in the TopologyUpdateService.create method. The ID of the Relation is a unique, automatically generated, temporary ID.

Parameters:

type - the class name of the new relation

createRelation

Relation createRelation(UcmdbId id,
                        String type,
                        UcmdbId id1,
                        UcmdbId id2)

Creates a client-side Relation of the specified type and with the given ID between two CIs specified by their IDs. This Relation can be used in the TopologyUpdateService.create method.

Parameters:

id - the ID of the link

type - the type of the link

id1 - the ID of the first end of the link

id2 - the ID of the second end of the link

Returns:

a client-side relation object

createTopologyModificationData

TopologyModificationData createTopologyModificationData()

Creates an object to be used as an argument to TopologyUpdateService create, update and delete methods.

createTopologyModificationData

TopologyModificationData createTopologyModificationData(String additionalModifierInfo)

Creates an object with information about the reporting agent to be used as an argument to TopologyUpdateService create, update and delete methods. The reporting agent information is stored as the changer in the history database.

Parameters:

additionalModifierInfo - information about the agent that supplies the data. The string is application-dependant and my be used by your agent for any purpose. For example, an agent may use it to identify CIs created by that agent.

createTopologyModification

TopologyModification createTopologyModification()

Creates an object to be used as an argument to TopologyUpdateService execute method.

createListPropertiesUpdate

ListPropertiesUpdate createListPropertiesUpdate(TopologyData topologyData)

createTopologyModificationBulk

TopologyModificationBulk createTopologyModificationBulk(String changer)

Creates a bulk of topology modification elements

Parameters:

changer - short application dependent string which may be used by your agent for any purpose. E.g, an agent may use it to identify CIs created by that agent.

Returns:

the bulk of topology modification elements

Since:

UCMDB 10.1

createTopologyModificationBulkElement

TopologyModificationBulkElement createTopologyModificationBulkElement(TopologyModificationData data,
                                                                      TopologyModificationAction action)

Creates a topology modification element

Parameters:

data - topology modification data to process

action - action to be taken on the data

Returns:

topology modification element

Since:

UCMDB 10.1

createSingleTopologyModification

SingleTopologyModification createSingleTopologyModification(String changer,
                                                            TopologyModificationData data,
                                                            TopologyModificationAction action)

Creates single topology modification

Parameters:

changer - short application dependent string which may be used by your agent for any purpose. E.g, an agent may use it to identify CIs created by that agent.

action - action to be taken on the data

Returns:

topology modification element

Since:

UCMDB 10.1