Object ID
Every object addressable by the TIBCO Enterprise Administrator server must have a unique object ID. The object ID must identify an agent and an object managed by that agent.
All TIBCO Enterprise Administrator object IDs have the following structure:
<agentID>:<agentType>:<agentVersion>:<objectType>:<objectKey>
The agentId, agentType, agentVersion, objectType and objectKey tokens are URL encoded and the character colon ':' is allowed in those tokens.
Object ID tokens
- agentID
-
Specifies the agent that owns a requested object or collection.
Ensure that the Agent IDs are reproducible using only the sort of information that external applications use to identify related objects. For example, an EMS server would base its Object id either on the JNDI name of the connection factory or on the connection URL (possibly with a well-known, hard-coded prefix such as "jndi:" or "url:"). Avoid using Agent IDs that contain random numbers, internal-use-only keys or other difficult-to-reproduce information. Agent developers must address this issue to support pivoting.
An effective agent ID must not begin with "_". All strings beginning with "_" are reserved for TIBCO Enterprise Administrator.
- agentType
-
Name of the Agent type.
Agent type names must not begin with "_". All strings beginning with "_" are reserved for TIBCO Enterprise Administrator.
- agentTypeVersion
- Version of the Agent type.
- objectType
-
Name of the Object type.
Object type names must not begin with "_". All strings beginning with "_" are reserved for TIBCO Enterprise Administrator. The name "agent" is reserver for use by TIBCO Enterprise Administrator.
- objectKey
-
A key to show details about a specific object instance.
The object key is an opaque string. The pair (agentID, objKey) must be unique among all objects that share the same pair (agent type, object type).
An effective object key should not begin with "_". All strings beginning with "_" are reserved for TIBCO Enterprise Administrator.