Class Hierarchy All Classes All Fields and Methods

Interface com.ibm.broker.config.proxy.AttributeConstants

public interface AttributeConstants

This is a common set of strings used by the Configuration Manager Proxy to describe attributes of objects in the Configuration Manager's domain. The constants are used in two places:

  1. Each AdministeredObject has a set of key->value attributes which describes it, and the constants in this interface are used to define all the keys and (for several attribute types) possible values. However, it is not normally necessary to use these constants when looking up AdministeredObject attributes, as there tend to be convenience methods for each attribute that performs the attribute lookup and returns the desired information in a more easily parseable form. For instance, instead of:
         String s = adminObj.getProperty(AttributeConstants.TYPE_PROPERTY);
         ConfigurationObjectType c = ConfigurationObjectType.getConfigurationObjectType(s);
     
    consider:
         ConfigurationObjectType c = adminObject.getConfigurationObjectType(); 
     

  2. The constants in this interface are also used by the AdministeredObjectListener.processActionResponse() method to give the listener information on the request to which the response refers. In the descriptions below, these are referred to as "request reference properties".

com.ibm.broker.config.common.AttributeConstants

Responsibilities A set of constants for describing AdministeredObject attributes.
Internal Collaborators None


 Change Activity:
 --------  ----------- -------------   ------------------------------------
 Reason:   Date:       Originator:     Comments:
 --------  ----------- -------------   ------------------------------------
 25103.12  2004-04-06  HDMPL           v6 Release

 

Field Index
Field Description
ACL As an AdministeredObject's attribute key name, the value of this property describes the access control list for the object.
ACL_PERMISSION_DEPLOY When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted deploy access to the object.
ACL_PERMISSION_EDIT When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted edit access to the object.
ACL_PERMISSION_FULLCONTROL When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted full control over the object.
ACL_PERMISSION_VIEW When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted view access to the object.
ACL_PRINCIPALTYPE_GROUP When applied in the principal type field of an AdministeredObject's ACL property, this value states that the principal being described is an operating system group.
ACL_PRINCIPALTYPE_USER When applied in the principal type field of an AdministeredObject's ACL property, this value states that the principal being described is a user name.
BARFILENAME_PROPERTY For request reference properties, the value of this key on a request with a 'deploy' operation type is the name of the Broker Archive file which was deployed.
BROKER_AUTHPROTOCOLS_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the broker's authentication protocols setting.
BROKER_FORCESUBSCRIBE_PROPERTY For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to force the Configuration Manager to resubscribe to a broker's status topics has been processed.
BROKER_INTERBROKERHOST_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker hostname setting.
BROKER_INTERBROKERPORT_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker port setting.
BROKER_ISYSQOP_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the ISys Quality of Protection setting for the broker.
BROKER_MULTICAST_ADDRESSRANGE_IPV4IPV6DELIMITER This constant is reserved for future use.
BROKER_MULTICAST_ADDRESSRANGE_MINMAXDELIMITER This constant is used in the value of the BROKER_MULTICAST_ADDRESSRANGE property, as the String that separates the minimum IP address from the maximum.
BROKER_MULTICAST_ADDRESSRANGE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast address ranges the broker.
BROKER_MULTICAST_BACKOFFTIME_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK backoff time for the broker.
BROKER_MULTICAST_DATAPORT_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast data port setting for the broker.
BROKER_MULTICAST_ENABLE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes whether multicast is enabled on the broker.
BROKER_MULTICAST_HBTIMEOUT_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast heartbeat timeout setting for the broker.
BROKER_MULTICAST_HISTORYCLEANINGTIME_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the time in seconds that the retransmission buffer for multicast will be cleaned.
BROKER_MULTICAST_INTERFACE_IPV4IPV6DELIMITER This constant is reserved for future use.
BROKER_MULTICAST_INTERFACE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast network interface for the broker.
BROKER_MULTICAST_LIMITTRANSRATE_DISABLED If this is the value of BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY, it means that congestion control is disabled in the broker.
BROKER_MULTICAST_LIMITTRANSRATE_DYNAMIC If this is the value of BROKER_MULTICAST_SUBSCRIPTION_PROPERTY, it means that congestion control is set to 'dynamic' in the broker.
BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast congestion control behavior.
BROKER_MULTICAST_LIMITTRANSRATE_STATIC If this is the value of BROKER_MULTICAST_SUBSCRIPTION_PROPERTY, it means that congestion control is set to 'static' in the broker.
BROKER_MULTICAST_MAXKEYAGE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast maximum key age for the broker.
BROKER_MULTICAST_MAXMEMORYALLOWEDKBYTES_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast maximum memory allowed (in KBytes) for this broker.
BROKER_MULTICAST_MINIMALHISTORYSIZE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast minimum history size parameter (in Kb) for the broker.
BROKER_MULTICAST_NACKACCUMULATIONTIME_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK accumulation time (in ms) for the broker.
BROKER_MULTICAST_NACKCHECKPERIOD_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK check period for the broker.
BROKER_MULTICAST_OVERLAPPINGTOPIC_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the broker's default behavior for overlapping topics.
BROKER_MULTICAST_PACKETBUFFERS_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the number of multicast packet buffers created in the broker.
BROKER_MULTICAST_PACKETSIZE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast packet size setting for the broker.
BROKER_MULTICAST_PROPERTY_GROUP If a BrokerProxy's attribute key name or request reference property begins with the value of this constant, the attribute is multicast related.
BROKER_MULTICAST_PROTOCOLTYPE_PGMIP If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is PGM/IP.
BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast protocol type for the broker.
BROKER_MULTICAST_PROTOCOLTYPE_PTL If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is PTL.
BROKER_MULTICAST_PROTOCOLTYPE_UDPENCAPSULATEDPGM If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is UDP encapsulated PGM.
BROKER_MULTICAST_QOS_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast quality of service setting for the broker.
BROKER_MULTICAST_SECURITY_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast security setting for the broker.
BROKER_MULTICAST_SOCKETBUFFERSIZE_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the size of the multicast socket receive buffer in Kb.
BROKER_MULTICAST_TRANSRATELIMITKBP_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast transmission rate limit for the broker.
BROKER_MULTICAST_TTL_PROPERTY As a BrokerProxy's attribute key name, the value of this property describes the multicast TTL setting for the broker.
BROKER_NEWUUID_PROPERTY For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the UUID of the broker reference in the Configuration Manager's repository was processed.
BROKER_QMGR_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the queue manager to which the broker is associated.
BROKER_SSLCONNECTORENABLED_PROPERTY As a BrokerProxy's attribute key name, the value of this property denotes whether SSL connector is enabled on the broker.
BROKER_SSLKEYRINGFILE_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the location of the SSL keyring file, using a file spec local to the broker machine.
BROKER_SSLPASSWORDFILE_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the location of the SSL password file, using a file spec local to the broker machine.
BROKER_SYSQOP_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the Sys Quality of Protection setting for the broker.
BROKER_TEMPTOPICQOP_PROPERTY As a BrokerProxy's attribute key name, the value of this property is the Quality of Protection setting for the broker's temporary topic.
CHILD_FORCEDELETE_PROPERTY For request reference properties, if the operation type of the request is 'deletechild', if this property is set to AttributeConstants.TRUE, the request was to remove all references to the child from the Configuration Manager repository.
CHILD_NAME_PROPERTY For request reference properties, if the operation type of the property is 'createchild' or 'deletechild', the value of this property refers to the name of the object being created or deleted.
CHILD_TYPE_PROPERTY For request reference properties, if the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the type of the object being created or deleted.
CHILD_UUID_PROPERTY For request reference properties, if the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the unique identifier of the object being created or deleted.
COLLECTIVE_NEWBROKERS_PROPERTY For request reference properties involving a collective, the value of this property is the list of broker unique identifiers that was requested to be added to the collective.
COLLECTIVE_REMOVEDBROKERS_PROPERTY For request reference properties involving a collective, the value of this property is the list of broker unique identifiers that was requested to be removed from the collective.
COMPLETIONCODE_FAILURE String representation of CompletionCodeType instance 'failure'.
COMPLETIONCODE_INITIATED String representation of CompletionCodeType instance 'initiated'.
COMPLETIONCODE_NOTREQUIRED String representation of CompletionCodeType instance 'notRequired'.
COMPLETIONCODE_PENDING String representation of CompletionCodeType instance 'pending'.
COMPLETIONCODE_SUBMITTED String representation of CompletionCodeType instance 'submitted'.
COMPLETIONCODE_SUCCESS String representation of CompletionCodeType instance 'success'.
COMPLETIONCODE_SUCCESSSOFAR String representation of CompletionCodeType instance 'successSoFar'.
COMPLETIONCODE_UNKNOWN String representation of CompletionCodeType instance 'unknown'.
CONFIGMGR_FULLVERSION_PROPERTY As a ConfigManagerProxy's attribute key name, this is a string in an unspecified format that describes the version of the Configuration Manager to which the Configuration Manager Proxy application is connected.
CONFIGMGR_INCOMPATIBLEVERSION_PROPERTY As a ConfigManagerProxy's attribute key name, if and only if the value of this property has been set to AttributeConstants.TRUE, it means that the Configuration Manager cannot talk to the Configuration Manager Proxy because the versions are incompatible.
CONFIGMGR_OSARCH_PROPERTY As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.arch' in the Configuration Manager (that is, the operating system architecture of the Configuration Manager).
CONFIGMGR_OSNAME_PROPERTY As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.name' in the Configuration Manager (that is, the operating system name of the Configuration Manager).
CONFIGMGR_OSVERSION_PROPERTY As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.version' in the Configuration Manager (that is, the operating system version of the Configuration Manager).
CONFIGMGR_TRACE_DEBUG If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is on and set to "debug".
CONFIGMGR_TRACE_NONE If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is off.
CONFIGMGR_TRACE_NORMAL If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is on and set to "normal".
CONFIGMGR_TRACE_PROPERTY For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the Configuration Manager's system trace level has been processed.
CONFIGMGR_VERSION_PROPERTY As a ConfigManagerProxy's attribute key name, if and only if the value of this property has been set to AttributeConstants.VERSION_6, it means that the Configuration Manager is talking to a version 6.x Configuration Manager.
CONFIGURATION_OBJECT_TYPE_PROPERTY For request reference properties, this key is always present and describes the type of the object that was manipulated.
DEBUG_COMMSMESSAGE_IO If and only if this is set to true, all comms between the Configuration Manager and Proxy will be sent to System.out.
DEFAULT_CORRELID The default value for the correlation id field, used internally when submitting a set of requests with the ConfigManagerProxy.sendUpdates() method.
DEPENDENCY_PROPERTY_GROUP If an ExecutionGroupProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of logical subcomponents owned by the object.
DEPLOYID_PROPERTY For request reference properties, the value of this key on a request with a 'deploy' operation type is the user identifier to which log messages are sent.
DEPLOYRESULT_SUPPRESSION If this is the value supplied as the 'maxWaitTimeMs' parameter to a deploy() method, the DeployResult object will not be calculated and the deploy() method will return null.
DEPLOYRESULT_WAIT_INDEFINITELY If this is the value supplied as the 'maxWaitTimeMs' parameter to a deploy() method, the Configuration Manager Proxy will wait indefinitely for all broker responses to be returned.
DEPLOYTIME_TIMESTAMP_FORMAT The format used to describe the timestamp in attributes that describe the time an object was deployed.
DEPLOYTYPE_CANCEL If this is the value of DEPLOYTYPE_PROPERTY, it means that the Configuration Manager was told to forget about any outstanding deployments to the current object.
DEPLOYTYPE_COMPLETE If this is the value of DEPLOYTYPE_PROPERTY, it means that the deployment should be complete; that is, any information that was currently deployed is to be cleared before the new information is deployed.
DEPLOYTYPE_DELETEALLEGS If this is the value of DEPLOYTYPE_PROPERTY, this means that the deployment was to delete all execution groups belonging to the broker.
DEPLOYTYPE_DELTA If this is the value of DEPLOYTYPE_PROPERTY, it means that the deployment was sent as delta to what was already deployed.
DEPLOYTYPE_PROPERTY For request reference properties, the value of this key on a request with a 'deploy' operation type is the type of deploy that was actioned.
DOMAIN_USER_DELIMITER The String used in the Configuration Manager Proxy's access control lists that separates a user or group name from the machine or domain on which it is defined.
EG_PROCESSOR_ARCHITECTURE This constant is reserved for future use.
FALSE This value can be used to represent something that is not TRUE.
LAST_ELEMENT_IN_BATCH_PROPERTY For request reference properties, the presence of this key, only if its value is AttributeConstants.TRUE, states that this notification will be the last one to be published for the current batch of requests.
LAST_PROPERTY_IN_GROUP When found at the end of an attribute key name or request reference property, this constant signifies that the value of the attribute is the number of elements in the attribute group of the text before this key.
LOGENTRY_DATA_DELIMITER The string used to delimit the elements in the String representation of a log entry.
LOGENTRY_PROPERTY_GROUP If a LogProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of log entries.
LONG_DESCRIPTION_PROPERTY As an AdministeredObject attribute key name, the value of this property is the long description of the object.
MESSAGEFLOW_ADDITIONALINSTANCES_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property describes the 'additional instances' property of the message flow.
MESSAGEFLOW_COMMITCOUNT_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit count' property of the message flow.
MESSAGEFLOW_COMMITINTERVAL_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit interval' property of the message flow.
MESSAGEFLOW_COORDINATEDTRANSACTION_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property describes the 'co-ordinated transaction' property of the message flow.
MESSAGEFLOW_DEPLOYTIME_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property is the time that the message flow was deployed.
MESSAGEFLOW_IMMEDIATE_PROPERTY For request reference properties, the presence of this key, if its value is AttributeConstants.TRUE, means that the request was to stop the flow with the 'immediate' flag on.
MESSAGEFLOW_KEYWORDS_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property is the encoded keywords that were found in the cmf file at deploy time.
MESSAGEFLOW_MODIFYTIME_PROPERTY As a MessageFlowProxy's attribute key name, the value of this property is the modification time of the deployed cmf (set inside the BAR).
MESSAGEFLOW_USERTRACE_DEBUG If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "debug" mode.
MESSAGEFLOW_USERTRACE_NONE If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is not currently active.
MESSAGEFLOW_USERTRACE_NORMAL If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "normal" mode.
MESSAGEFLOW_USERTRACE_PROPERTY As an MessageFlow's attribute key name, the value of this property describes state of user trace for the message flow.
MODIFYTIME_TIMESTAMP_FORMAT The format used to describe the timestamp in attributes that describe the time an object was modified.
NAME_PROPERTY As an AdministeredObject attribute key name, the value of this property is the name of the object.
OBJECT_DEPLOYED_PROPERTY As an AdministeredObject attribute key name, if the value of this property is set to AttributeConstants.TRUE, it means that the object exists in the deployed section of the Configuration Manager data store.
OBJECT_LASTUPDATEUSER_PROPERTY As an AdministeredObject attribute key name, the value of this property describes the last user to cause a modification to the object.
OBJECT_REPOSITORY_TIMESTAMP As an AdministeredObject attribute key name, the value of this property is the time (in an unspecified format) that the property was last modified in the Configuration Manager data store.
OBJECT_RUNSTATE_PROPERTY As an AdministeredObject attribute key name, the value of this property describes whether or not the object is running.
OBJECT_RUNSTATE_RUNNING If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is running.
OBJECT_RUNSTATE_STOPPED If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is stopped.
OBJECT_SHARED_PROPERTY As an AdministeredObject attribute key name, if the value of this property is set to AttributeConstants.TRUE, it means that the object exists in the shared section of the Configuration Manager data store.
OPERATION_TYPE_PROPERTY For request reference properties, this key is always present and describes the type of operation that was requested.
PARENT_TYPE_PROPERTY As an AdministeredObject attribute key name, the value of this property uniquely identifies the type of the current object's parent within the Configuration Manager's object hierarchy.
PARENT_UUID_PROPERTY As an AdministeredObject attribute key name, the value of this property uniquely identifies the parent of the current object within the Configuration Manager's object hierarchy.
SHORT_DESCRIPTION_PROPERTY As an AdministeredObject attribute key name, the value of this property is the short description of the object.
SUBCOMPONENT_PROPERTY_GROUP If an AdministeredObject's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of logical subcomponents owned by the object.
SUBSCRIPTION_PROPERTY_GROUP If an SubscriptionsProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the set of matching subscriptions.
TOPIC_DEFAULTPOLICY_PROPERTY As a TopicProxy's attribute key name, the value of this property is the default policy for the topic root.
TOPIC_MULTICAST_ENABLE_INHERIT If this is the value of TOPIC_MULTICAST_ENABLE_PROPERTY it means that the multicast enabled property is inherited from the topic's parent.
TOPIC_MULTICAST_ENABLE_PROPERTY As a TopicProxy's attribute key name, the value of this property describes whether multicast is enabled on the topic.
TOPIC_MULTICAST_ENCRYPTED_PROPERTY As a TopicProxy's attribute key name, the value of this property describes the multicast encryption setting for the topic.
TOPIC_MULTICAST_GROUPADDRESS_IPV4IPV6DELIMITER This constant is reserved for future use.
TOPIC_MULTICAST_GROUPADDRESS_PROPERTY As a TopicProxy's attribute key name, the value of this property describes the group address of the topic.
TOPIC_MULTICAST_PROPERTY_GROUP If a TopicProxy's attribute key name or request reference property begins with the value of this constant, the attribute is multicast related.
TOPIC_MULTICAST_QOS_PROPERTY As a TopicProxy's attribute key name, the value of this property describes the multicast Quality of Service setting for the topic.
TOPIC_NEWPOLICIES_PROPERTY For request reference properties involving a topic, the value of this property is the list of policies that were requested to be added to the topic.
TOPIC_POLICIES_DELIMITER The String used to separate multiple policies when described in a single String (for example, separates policy_one from policy_two).
TOPIC_PRINCIPAL_ALLOW If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the action is permitted by the policy.
TOPIC_PRINCIPAL_DENY If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the action is denied by the policy.
TOPIC_PRINCIPAL_GROUP If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a group.
TOPIC_PRINCIPAL_INHERIT If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the permission for the action is inherited from the parent topic.
TOPIC_PRINCIPAL_NOTPERSISTENT If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is not persistent.
TOPIC_PRINCIPAL_PERSISTENT If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is persistent.
TOPIC_PRINCIPAL_PUBLICGROUP If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a public group.
TOPIC_PRINCIPAL_USER If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a user.
TOPIC_QOP_CHANNELINTEGRITY If this is the value of TOPIC_QOP_PROPERTY, it means that channel integrity Quality of Protection applies.
TOPIC_QOP_ENCRYPTED If this is the value of TOPIC_QOP_PROPERTY, it means that encrypted Quality of Protection applies.
TOPIC_QOP_MESSAGEINTEGRITY If this is the value of TOPIC_QOP_PROPERTY, it means that message integrity Quality of Protection applies.
TOPIC_QOP_NONE If this is the value of TOPIC_QOP_PROPERTY, it means that no Quality of Protection applies.
TOPIC_QOP_PROPERTY As a TopicProxy's attribute key name, the value of this property is the Quality of Protection setting for the topic.
TOPIC_REMOVEDPOLICIES_PROPERTY For request reference properties involving a topic, the value of this property is the list of policies that were requested to be removed from the topic.
TOPICROOT_GROUPS_PROPERTY As a TopicRootProxy's attribute key name, the value of this property is the list of groups defined in the User Name Server.
TOPICROOT_PRINCIPALSLIST_DELIMITER The String used to delimit a list of principals.
TOPICROOT_PUBLICGROUPS_PROPERTY As a TopicRootProxy's attribute key name, the value of this property is the list of public groups defined in the User Name Server.
TOPICROOT_USERS_PROPERTY As a TopicRootProxy's attribute key name, the value of this property is the list of users defined in the User Name Server.
TRUE Various attributes use this value to mean that the specified property exists or is enabled.
TYPE_PROPERTY As an AdministeredObject attribute key name, the value of this property is the type of the object.
UUID_CONFIGMANAGER A constant describing the domain-unique identifier of the ConfigManagerProxy object.
UUID_DELIMITER The string used to separate the type parameter from the UUID parameter in the subcomponent properties.
UUID_LOG A constant containing the domain-unique identifier of the broker log.
UUID_PROPERTY As an AdministeredObject attribute key name, the value of this property uniquely identifies the object within the Configuration Manager's domain.
UUID_TOPICROOT A constant containing the domain-unique identifier of the topic root.
UUID_TOPOLOGY A constant containing the domain-unique identifier of the topology.
VERSION_2 As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 2.1 or earlier.
VERSION_5 As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 5 or version 5.1 (any fixpack level).
VERSION_6 As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 6.

Fields

ACL

public static final java.lang.String ACL

As an AdministeredObject's attribute key name, the value of this property describes the access control list for the object.

For request reference properties, the value of this key on a request with a 'modify' operation type is the new access control list for the object that is being manipulated. This property is not available if either the connected Configuration Manager is of a version earlier than v6. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

ACL_PERMISSION_DEPLOY

public static final java.lang.String ACL_PERMISSION_DEPLOY

When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted deploy access to the object.

This is also the return value for AccessControlEntryPermission.deploy.toString().

ACL_PERMISSION_EDIT

public static final java.lang.String ACL_PERMISSION_EDIT

When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted edit access to the object.

This is also the return value for AccessControlEntryPermission.edit.toString().

ACL_PERMISSION_FULLCONTROL

public static final java.lang.String ACL_PERMISSION_FULLCONTROL

When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted full control over the object.

This is also the return value for AccessControlEntryPermission.fullControl.toString().

ACL_PERMISSION_VIEW

public static final java.lang.String ACL_PERMISSION_VIEW

When applied in the permission field of an AdministeredObject's ACL property, this value states that the principal being described has been granted view access to the object.

This is also the return value for AccessControlEntryPermission.view.toString().

ACL_PRINCIPALTYPE_GROUP

public static final java.lang.String ACL_PRINCIPALTYPE_GROUP

When applied in the principal type field of an AdministeredObject's ACL property, this value states that the principal being described is an operating system group.

This is also the return value for AccessControlEntryPrincipalType.group.toString().

ACL_PRINCIPALTYPE_USER

public static final java.lang.String ACL_PRINCIPALTYPE_USER

When applied in the principal type field of an AdministeredObject's ACL property, this value states that the principal being described is a user name.

This is also the return value for AccessControlEntryPrincipalType.user.toString().

BARFILENAME_PROPERTY

public static final java.lang.String BARFILENAME_PROPERTY

For request reference properties, the value of this key on a request with a 'deploy' operation type is the name of the Broker Archive file which was deployed. This property is not available if either the connected Configuration Manager is of a version earlier than v6, or if the file was deployed by supplying an InputStream argument to ExecutionGroupProxy.deploy() without a barFileLabel argument.

This attribute is not used in AdministeredObject attribute key names.

BROKER_AUTHPROTOCOLS_PROPERTY

public static final java.lang.String BROKER_AUTHPROTOCOLS_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the broker's authentication protocols setting.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the authentication protocols setting has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_FORCESUBSCRIBE_PROPERTY

public static final java.lang.String BROKER_FORCESUBSCRIBE_PROPERTY

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to force the Configuration Manager to resubscribe to a broker's status topics has been processed. The UUID of the affected broker is contained in the value of the AttributeConstants.UUID property. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

This attribute is not used in AdministeredObject attribute key names.

BROKER_INTERBROKERHOST_PROPERTY

public static final java.lang.String BROKER_INTERBROKERHOST_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker hostname setting.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the interbroker hostname has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_INTERBROKERPORT_PROPERTY

public static final java.lang.String BROKER_INTERBROKERPORT_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker port setting.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the interbroker port has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_ISYSQOP_PROPERTY

public static final java.lang.String BROKER_ISYSQOP_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the ISys Quality of Protection setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the ISys Quality of Protection was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_MULTICAST_ADDRESSRANGE_IPV4IPV6DELIMITER

public static final java.lang.String BROKER_MULTICAST_ADDRESSRANGE_IPV4IPV6DELIMITER

This constant is reserved for future use.

BROKER_MULTICAST_ADDRESSRANGE_MINMAXDELIMITER

public static final java.lang.String BROKER_MULTICAST_ADDRESSRANGE_MINMAXDELIMITER

This constant is used in the value of the BROKER_MULTICAST_ADDRESSRANGE property, as the String that separates the minimum IP address from the maximum.

BROKER_MULTICAST_ADDRESSRANGE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_ADDRESSRANGE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast address ranges the broker. The value contains the IPv4 minimum and maximum addresses, in the form:

    minIPv4 - maxIPv4
where '-' is defined in BROKER_MULTICAST_ADDRESSRANGE_MINMAXDELIMITER.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the address ranges has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is not policed by the Configuration Manager Proxy.

BROKER_MULTICAST_BACKOFFTIME_PROPERTY

public static final java.lang.String BROKER_MULTICAST_BACKOFFTIME_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK backoff time for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the NACK backoff time has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 0 and 1000 inclusive (the time in milliseconds).

BROKER_MULTICAST_DATAPORT_PROPERTY

public static final java.lang.String BROKER_MULTICAST_DATAPORT_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast data port setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast data port has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 1 and 65535 inclusive.

BROKER_MULTICAST_ENABLE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_ENABLE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes whether multicast is enabled on the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to enable or disable multicast has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is one of:

BROKER_MULTICAST_HBTIMEOUT_PROPERTY

public static final java.lang.String BROKER_MULTICAST_HBTIMEOUT_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast heartbeat timeout setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast heartbeat timeout has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int greater than or equal to 0.

BROKER_MULTICAST_HISTORYCLEANINGTIME_PROPERTY

public static final java.lang.String BROKER_MULTICAST_HISTORYCLEANINGTIME_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the time in seconds that the retransmission buffer for multicast will be cleaned.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the history cleaning time has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 1 and 20 inclusive.

BROKER_MULTICAST_INTERFACE_IPV4IPV6DELIMITER

public static final java.lang.String BROKER_MULTICAST_INTERFACE_IPV4IPV6DELIMITER

This constant is reserved for future use.

BROKER_MULTICAST_INTERFACE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_INTERFACE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast network interface for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast network interface has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is not policed by the Configuration Manager Proxy.

BROKER_MULTICAST_LIMITTRANSRATE_DISABLED

public static final java.lang.String BROKER_MULTICAST_LIMITTRANSRATE_DISABLED

If this is the value of BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY, it means that congestion control is disabled in the broker.

BROKER_MULTICAST_LIMITTRANSRATE_DYNAMIC

public static final java.lang.String BROKER_MULTICAST_LIMITTRANSRATE_DYNAMIC

If this is the value of BROKER_MULTICAST_SUBSCRIPTION_PROPERTY, it means that congestion control is set to 'dynamic' in the broker.

BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast congestion control behavior.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast congestion control property has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is one of:

BROKER_MULTICAST_LIMITTRANSRATE_STATIC

public static final java.lang.String BROKER_MULTICAST_LIMITTRANSRATE_STATIC

If this is the value of BROKER_MULTICAST_SUBSCRIPTION_PROPERTY, it means that congestion control is set to 'static' in the broker.

BROKER_MULTICAST_MAXKEYAGE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_MAXKEYAGE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast maximum key age for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the maximum key age has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int greater than or equal to 1.

BROKER_MULTICAST_MAXMEMORYALLOWEDKBYTES_PROPERTY

public static final java.lang.String BROKER_MULTICAST_MAXMEMORYALLOWEDKBYTES_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast maximum memory allowed (in KBytes) for this broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the maximum memory allowed has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int greater than or equal to 0.

BROKER_MULTICAST_MINIMALHISTORYSIZE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_MINIMALHISTORYSIZE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast minimum history size parameter (in Kb) for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the minimum history size has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 1000 and 1000000 inclusive.

BROKER_MULTICAST_NACKACCUMULATIONTIME_PROPERTY

public static final java.lang.String BROKER_MULTICAST_NACKACCUMULATIONTIME_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK accumulation time (in ms) for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the NACK accumulation time has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 50 and 1000 inclusive.

BROKER_MULTICAST_NACKCHECKPERIOD_PROPERTY

public static final java.lang.String BROKER_MULTICAST_NACKCHECKPERIOD_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast NACK check period for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the NACK check period has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 10 and 1000 inclusive.

BROKER_MULTICAST_OVERLAPPINGTOPIC_PROPERTY

public static final java.lang.String BROKER_MULTICAST_OVERLAPPINGTOPIC_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the broker's default behavior for overlapping topics.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast overlapping topic behavior has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is a String representation of an integer, where

BROKER_MULTICAST_PACKETBUFFERS_PROPERTY

public static final java.lang.String BROKER_MULTICAST_PACKETBUFFERS_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the number of multicast packet buffers created in the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the number of packet buffers has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 1 and 5000 inclusive.

BROKER_MULTICAST_PACKETSIZE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_PACKETSIZE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast packet size setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast packet size has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 500 and 32000 inclusive.

BROKER_MULTICAST_PROPERTY_GROUP

public static final java.lang.String BROKER_MULTICAST_PROPERTY_GROUP

If a BrokerProxy's attribute key name or request reference property begins with the value of this constant, the attribute is multicast related.

On its own, this property is not used as a property key name or request reference property.

BROKER_MULTICAST_PROTOCOLTYPE_PGMIP

public static final java.lang.String BROKER_MULTICAST_PROTOCOLTYPE_PGMIP

If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is PGM/IP.

BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast protocol type for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the protocol type has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is one of the following constants:

BROKER_MULTICAST_PROTOCOLTYPE_PTL

public static final java.lang.String BROKER_MULTICAST_PROTOCOLTYPE_PTL

If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is PTL.

BROKER_MULTICAST_PROTOCOLTYPE_UDPENCAPSULATEDPGM

public static final java.lang.String BROKER_MULTICAST_PROTOCOLTYPE_UDPENCAPSULATEDPGM

If this is the value of BROKER_MULTICAST_PROTOCOLTYPE_PROPERTY, it means that the multicast protocol type in the broker is UDP encapsulated PGM.

BROKER_MULTICAST_QOS_PROPERTY

public static final java.lang.String BROKER_MULTICAST_QOS_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast quality of service setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast quality of service has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is one of:

BROKER_MULTICAST_SECURITY_PROPERTY

public static final java.lang.String BROKER_MULTICAST_SECURITY_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast security setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast security setting has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is one of:

BROKER_MULTICAST_SOCKETBUFFERSIZE_PROPERTY

public static final java.lang.String BROKER_MULTICAST_SOCKETBUFFERSIZE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the size of the multicast socket receive buffer in Kb.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the socket buffer size has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 65 and 10000 inclusive.

BROKER_MULTICAST_TRANSRATELIMITKBP_PROPERTY

public static final java.lang.String BROKER_MULTICAST_TRANSRATELIMITKBP_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast transmission rate limit for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the transmission rate limit has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 10 and 1000000 inclusive.

BROKER_MULTICAST_TTL_PROPERTY

public static final java.lang.String BROKER_MULTICAST_TTL_PROPERTY

As a BrokerProxy's attribute key name, the value of this property describes the multicast TTL setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the multicast TTL was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of the attribute is a String representation of an int between 0 and 255 inclusive.

BROKER_NEWUUID_PROPERTY

public static final java.lang.String BROKER_NEWUUID_PROPERTY

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the UUID of the broker reference in the Configuration Manager's repository was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

This attribute is not used in BrokerProxy attribute key names.

BROKER_QMGR_PROPERTY

public static final java.lang.String BROKER_QMGR_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the queue manager to which the broker is associated.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the queue manager of the broker was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_SSLCONNECTORENABLED_PROPERTY

public static final java.lang.String BROKER_SSLCONNECTORENABLED_PROPERTY

As a BrokerProxy's attribute key name, the value of this property denotes whether SSL connector is enabled on the broker. The feature will be enabled if and only if the value of this attribute is set to AttributeConstants.TRUE.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the value of this attribute was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_SSLKEYRINGFILE_PROPERTY

public static final java.lang.String BROKER_SSLKEYRINGFILE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the location of the SSL keyring file, using a file spec local to the broker machine.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the SSL Keyring file was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_SSLPASSWORDFILE_PROPERTY

public static final java.lang.String BROKER_SSLPASSWORDFILE_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the location of the SSL password file, using a file spec local to the broker machine.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the SSL password file was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_SYSQOP_PROPERTY

public static final java.lang.String BROKER_SYSQOP_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the Sys Quality of Protection setting for the broker.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the Sys Quality of Protection was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

BROKER_TEMPTOPICQOP_PROPERTY

public static final java.lang.String BROKER_TEMPTOPICQOP_PROPERTY

As a BrokerProxy's attribute key name, the value of this property is the Quality of Protection setting for the broker's temporary topic.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the temporary topic's Quality of Protection was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

CHILD_FORCEDELETE_PROPERTY

public static final java.lang.String CHILD_FORCEDELETE_PROPERTY

For request reference properties, if the operation type of the request is 'deletechild', if this property is set to AttributeConstants.TRUE, the request was to remove all references to the child from the Configuration Manager repository. This constant is only supported when removing a broker from the topology. In this case, either the broker's UUID or its name may not be available in the reference properties. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

This attribute is not used in AdministeredObject attribute key names.

CHILD_NAME_PROPERTY

public static final java.lang.String CHILD_NAME_PROPERTY

For request reference properties, if the operation type of the property is 'createchild' or 'deletechild', the value of this property refers to the name of the object being created or deleted. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

This attribute is not used in AdministeredObject attribute key names.

CHILD_TYPE_PROPERTY

public static final java.lang.String CHILD_TYPE_PROPERTY

For request reference properties, if the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the type of the object being created or deleted. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) If the String value of this property is 'v', it can be parsed as follows:

     ConfigurationObjectType c = ConfigurationObjectType.getConfigurationObjectType(v);
     if (c == ConfigurationObjectType.executiongroup) {
         // etc.
     }
 

This attribute is not used in AdministeredObject attribute key names.

CHILD_UUID_PROPERTY

public static final java.lang.String CHILD_UUID_PROPERTY

For request reference properties, if the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the unique identifier of the object being created or deleted. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

This attribute is not used in AdministeredObject attribute key names.

COLLECTIVE_NEWBROKERS_PROPERTY

public static final java.lang.String COLLECTIVE_NEWBROKERS_PROPERTY

For request reference properties involving a collective, the value of this property is the list of broker unique identifiers that was requested to be added to the collective. Each broker identifier in the value is separated with AttributeConstants.UUID_DELIMITER.

This attribute is not used in AdministeredObject attribute key names.

COLLECTIVE_REMOVEDBROKERS_PROPERTY

public static final java.lang.String COLLECTIVE_REMOVEDBROKERS_PROPERTY

For request reference properties involving a collective, the value of this property is the list of broker unique identifiers that was requested to be removed from the collective. Each broker identifier in the value is separated with AttributeConstants.UUID_DELIMITER.

This attribute is not used in AdministeredObject attribute key names.

COMPLETIONCODE_FAILURE

public static final java.lang.String COMPLETIONCODE_FAILURE

String representation of CompletionCodeType instance 'failure'.

COMPLETIONCODE_INITIATED

public static final java.lang.String COMPLETIONCODE_INITIATED

String representation of CompletionCodeType instance 'initiated'.

COMPLETIONCODE_NOTREQUIRED

public static final java.lang.String COMPLETIONCODE_NOTREQUIRED

String representation of CompletionCodeType instance 'notRequired'.

COMPLETIONCODE_PENDING

public static final java.lang.String COMPLETIONCODE_PENDING

String representation of CompletionCodeType instance 'pending'.

COMPLETIONCODE_SUBMITTED

public static final java.lang.String COMPLETIONCODE_SUBMITTED

String representation of CompletionCodeType instance 'submitted'.

COMPLETIONCODE_SUCCESS

public static final java.lang.String COMPLETIONCODE_SUCCESS

String representation of CompletionCodeType instance 'success'.

COMPLETIONCODE_SUCCESSSOFAR

public static final java.lang.String COMPLETIONCODE_SUCCESSSOFAR

String representation of CompletionCodeType instance 'successSoFar'.

COMPLETIONCODE_UNKNOWN

public static final java.lang.String COMPLETIONCODE_UNKNOWN

String representation of CompletionCodeType instance 'unknown'.

CONFIGMGR_FULLVERSION_PROPERTY

public static final java.lang.String CONFIGMGR_FULLVERSION_PROPERTY

As a ConfigManagerProxy's attribute key name, this is a string in an unspecified format that describes the version of the Configuration Manager to which the Configuration Manager Proxy application is connected.

The constant is not used in request reference properties.

CONFIGMGR_INCOMPATIBLEVERSION_PROPERTY

public static final java.lang.String CONFIGMGR_INCOMPATIBLEVERSION_PROPERTY

As a ConfigManagerProxy's attribute key name, if and only if the value of this property has been set to AttributeConstants.TRUE, it means that the Configuration Manager cannot talk to the Configuration Manager Proxy because the versions are incompatible.

The constant is not used in request reference properties.

CONFIGMGR_OSARCH_PROPERTY

public static final java.lang.String CONFIGMGR_OSARCH_PROPERTY

As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.arch' in the Configuration Manager (that is, the operating system architecture of the Configuration Manager). This property is not set when connected to Configuration Managers earlier than v6.

The constant is not used in request reference properties.

CONFIGMGR_OSNAME_PROPERTY

public static final java.lang.String CONFIGMGR_OSNAME_PROPERTY

As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.name' in the Configuration Manager (that is, the operating system name of the Configuration Manager). This property is not set when connected to Configuration Managers earlier than v6.

The constant is not used in request reference properties.

CONFIGMGR_OSVERSION_PROPERTY

public static final java.lang.String CONFIGMGR_OSVERSION_PROPERTY

As a ConfigManagerProxy's attribute key name, this is the value of the system property 'os.version' in the Configuration Manager (that is, the operating system version of the Configuration Manager). This property is not set when connected to Configuration Managers earlier than v6.

The constant is not used in request reference properties.

CONFIGMGR_TRACE_DEBUG

public static final java.lang.String CONFIGMGR_TRACE_DEBUG

If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is on and set to "debug".

CONFIGMGR_TRACE_NONE

public static final java.lang.String CONFIGMGR_TRACE_NONE

If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is off.

CONFIGMGR_TRACE_NORMAL

public static final java.lang.String CONFIGMGR_TRACE_NORMAL

If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is on and set to "normal".

CONFIGMGR_TRACE_PROPERTY

public static final java.lang.String CONFIGMGR_TRACE_PROPERTY

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to set the Configuration Manager's system trace level has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) The value of an attribute with this key is one of:

This attribute is not used in AdministeredObject attribute key names.

CONFIGMGR_VERSION_PROPERTY

public static final java.lang.String CONFIGMGR_VERSION_PROPERTY

As a ConfigManagerProxy's attribute key name, if and only if the value of this property has been set to AttributeConstants.VERSION_6, it means that the Configuration Manager is talking to a version 6.x Configuration Manager. This property is never set to AttributeConstants.VERSION_2 or AttributeConstants.VERSION_5; use ConfigManagerProxy.getConfigManagerVersion() to discover the version of a Configuration Manager. This property may be set to other values in the future.

The constant is not used in request reference properties.

CONFIGURATION_OBJECT_TYPE_PROPERTY

public static final java.lang.String CONFIGURATION_OBJECT_TYPE_PROPERTY

For request reference properties, this key is always present and describes the type of the object that was manipulated. Where the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the type of the parent object. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) If the String value of this property is 'v', it can be parsed as follows:

     ConfigurationObjectType c = ConfigurationObjectType.getConfigurationObjectType(v);
     if (c == ConfigurationObjectType.executiongroup) {
         // etc.
     }
 

This attribute is not used in AdministeredObject attribute key names.

DEBUG_COMMSMESSAGE_IO

public static final boolean DEBUG_COMMSMESSAGE_IO

If and only if this is set to true, all comms between the Configuration Manager and Proxy will be sent to System.out. Note: The value of this constant is dynamically calculated from the system property "CONFIGMGR_DEBUG" - if it is set, the value of this constant is true. Otherwise it is false.

DEFAULT_CORRELID

public static final int DEFAULT_CORRELID

The default value for the correlation id field, used internally when submitting a set of requests with the ConfigManagerProxy.sendUpdates() method.

DEPENDENCY_PROPERTY_GROUP

public static final java.lang.String DEPENDENCY_PROPERTY_GROUP

If an ExecutionGroupProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of logical subcomponents owned by the object.

A key that is made up of this constant with an integer value appended has a value that describes a String representation of single message flow dependency of the current object. The format of the String representation is not guaranteed.

A key that is made up of this constant with the value of AttributeConstants.LAST_PROPERTY_IN_GROUP appended has a value that describes the total number of dependencies owned by the object. In other words, if the value of

     o.getProperty(AttributeConstants.DEPENDENCY_PROPERTY_GROUP + AttributeConstants.LAST_PROPERTY_IN_GROUP)
 
was 3, then
     o.getProperty(AttributeConstants.DEPENDENCY_PROPERTY_GROUP + 3)
 
would return a valid string representation of a dependency but
     o.getProperty(AttributeConstants.DEPENDENCY_PROPERTY_GROUP + 4)
 
would not.

On its own, this property is not used as a property key name or request reference property.

DEPLOYID_PROPERTY

public static final java.lang.String DEPLOYID_PROPERTY

For request reference properties, the value of this key on a request with a 'deploy' operation type is the user identifier to which log messages are sent. This is usually equal to the user who initiated the deploy, although this is not necessarily so.

This attribute is not used in AdministeredObject attribute key names.

DEPLOYRESULT_SUPPRESSION

public static final long DEPLOYRESULT_SUPPRESSION

If this is the value supplied as the 'maxWaitTimeMs' parameter to a deploy() method, the DeployResult object will not be calculated and the deploy() method will return null.

DEPLOYRESULT_WAIT_INDEFINITELY

public static final long DEPLOYRESULT_WAIT_INDEFINITELY

If this is the value supplied as the 'maxWaitTimeMs' parameter to a deploy() method, the Configuration Manager Proxy will wait indefinitely for all broker responses to be returned.

DEPLOYTIME_TIMESTAMP_FORMAT

public static final java.lang.String DEPLOYTIME_TIMESTAMP_FORMAT

The format used to describe the timestamp in attributes that describe the time an object was deployed.

DEPLOYTYPE_CANCEL

public static final java.lang.String DEPLOYTYPE_CANCEL

If this is the value of DEPLOYTYPE_PROPERTY, it means that the Configuration Manager was told to forget about any outstanding deployments to the current object.

DEPLOYTYPE_COMPLETE

public static final java.lang.String DEPLOYTYPE_COMPLETE

If this is the value of DEPLOYTYPE_PROPERTY, it means that the deployment should be complete; that is, any information that was currently deployed is to be cleared before the new information is deployed.

DEPLOYTYPE_DELETEALLEGS

public static final java.lang.String DEPLOYTYPE_DELETEALLEGS

If this is the value of DEPLOYTYPE_PROPERTY, this means that the deployment was to delete all execution groups belonging to the broker. This is a special type of deploy sent on 'broker configuration' deploys only.

DEPLOYTYPE_DELTA

public static final java.lang.String DEPLOYTYPE_DELTA

If this is the value of DEPLOYTYPE_PROPERTY, it means that the deployment was sent as delta to what was already deployed.

DEPLOYTYPE_PROPERTY

public static final java.lang.String DEPLOYTYPE_PROPERTY

For request reference properties, the value of this key on a request with a 'deploy' operation type is the type of deploy that was actioned. The value of an attribute with this key is one of:

This attribute is not used in AdministeredObject attribute key names.

DOMAIN_USER_DELIMITER

public static final java.lang.String DOMAIN_USER_DELIMITER

The String used in the Configuration Manager Proxy's access control lists that separates a user or group name from the machine or domain on which it is defined. For example, the '\\' in "machine\\user".

EG_PROCESSOR_ARCHITECTURE

public static final java.lang.String EG_PROCESSOR_ARCHITECTURE

This constant is reserved for future use. Do not use it.

FALSE

public static final java.lang.String FALSE

This value can be used to represent something that is not TRUE. Callers should not check if an attribute equals this one; instead they should check that the property does not equal AttributeConstants.TRUE.

LAST_ELEMENT_IN_BATCH_PROPERTY

public static final java.lang.String LAST_ELEMENT_IN_BATCH_PROPERTY

For request reference properties, the presence of this key, only if its value is AttributeConstants.TRUE, states that this notification will be the last one to be published for the current batch of requests. Batches are controlled by the ConfigManagerProxy instance using the beginUpdates(), clearUpdates() and sendUpdates() methods.

This attribute is not used in AdministeredObject attribute key names.

LAST_PROPERTY_IN_GROUP

public static final java.lang.String LAST_PROPERTY_IN_GROUP

When found at the end of an attribute key name or request reference property, this constant signifies that the value of the attribute is the number of elements in the attribute group of the text before this key. For example,

     o.getProperty(AttributeConstants.SUBCOMPONENT_PROPERTY_GROUP + AttributeConstants.LAST_PROPERTY_IN_GROUP)
 
returns the number of subcomponents of the current object.

LOGENTRY_DATA_DELIMITER

public static final java.lang.String LOGENTRY_DATA_DELIMITER

The string used to delimit the elements in the String representation of a log entry. Consider using LogEntry.getLogEntryFromString() instead of parsing log entry property strings manually.

LOGENTRY_PROPERTY_GROUP

public static final java.lang.String LOGENTRY_PROPERTY_GROUP

If a LogProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of log entries.

A key that is made up of this constant with an integer value appended has a value that describes a String representation of single log entry. The format of the String representation is not guaranteed, but is parseable using the method LogEntry.getLogEntryFromString().

A key that is made up of this constant with the value of AttributeConstants.LAST_PROPERTY_IN_GROUP appended has a value that describes the total number of log entries owned by the user. In other words, if the value of

     o.getProperty(AttributeConstants.LOGENTRY_PROPERTY_GROUP + AttributeConstants.LAST_PROPERTY_IN_GROUP)
 
was 3, then
     o.getProperty(AttributeConstants.LOGENTRY_PROPERTY_GROUP + 3)
 
would return a valid string representation of a log entry but
     o.getProperty(AttributeConstants.LOGENTRY_PROPERTY_GROUP + 4)
 
would not.

On its own, this property is not used as a property key name or request reference property.

LONG_DESCRIPTION_PROPERTY

public static final java.lang.String LONG_DESCRIPTION_PROPERTY

As an AdministeredObject attribute key name, the value of this property is the long description of the object.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the long description of the object was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

MESSAGEFLOW_ADDITIONALINSTANCES_PROPERTY

public static final java.lang.String MESSAGEFLOW_ADDITIONALINSTANCES_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property describes the 'additional instances' property of the message flow.

For request reference properties this key name is not used.

MESSAGEFLOW_COMMITCOUNT_PROPERTY

public static final java.lang.String MESSAGEFLOW_COMMITCOUNT_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit count' property of the message flow.

For request reference properties this key name is not used.

MESSAGEFLOW_COMMITINTERVAL_PROPERTY

public static final java.lang.String MESSAGEFLOW_COMMITINTERVAL_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit interval' property of the message flow.

For request reference properties this key name is not used.

MESSAGEFLOW_COORDINATEDTRANSACTION_PROPERTY

public static final java.lang.String MESSAGEFLOW_COORDINATEDTRANSACTION_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property describes the 'co-ordinated transaction' property of the message flow. The value of an attribute with this key is one of:

For request reference properties this key name is not used.

MESSAGEFLOW_DEPLOYTIME_PROPERTY

public static final java.lang.String MESSAGEFLOW_DEPLOYTIME_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property is the time that the message flow was deployed. The value of the property is parseable using the DEPLOYTIME_TIMESTAMP_FORMAT template, although it is recommended to use the DeployedObject.getDeployTime() method to do this.

For request reference properties this key name is not used.

MESSAGEFLOW_IMMEDIATE_PROPERTY

public static final java.lang.String MESSAGEFLOW_IMMEDIATE_PROPERTY

For request reference properties, the presence of this key, if its value is AttributeConstants.TRUE, means that the request was to stop the flow with the 'immediate' flag on.

This attribute is not used in AdministeredObject attribute key names.

MESSAGEFLOW_KEYWORDS_PROPERTY

public static final java.lang.String MESSAGEFLOW_KEYWORDS_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property is the encoded keywords that were found in the cmf file at deploy time.

For request reference properties this key name is not used; the version can only be set at deployment time.

MESSAGEFLOW_MODIFYTIME_PROPERTY

public static final java.lang.String MESSAGEFLOW_MODIFYTIME_PROPERTY

As a MessageFlowProxy's attribute key name, the value of this property is the modification time of the deployed cmf (set inside the BAR). The value of the property is parseable using the MODIFYTIME_TIMESTAMP_FORMAT template, although it is recommended to use the DeployedObject.getModifyTime() method to do this.

For request reference properties this key name is not used.

MESSAGEFLOW_USERTRACE_DEBUG

public static final java.lang.String MESSAGEFLOW_USERTRACE_DEBUG

If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "debug" mode.

MESSAGEFLOW_USERTRACE_NONE

public static final java.lang.String MESSAGEFLOW_USERTRACE_NONE

If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is not currently active.

MESSAGEFLOW_USERTRACE_NORMAL

public static final java.lang.String MESSAGEFLOW_USERTRACE_NORMAL

If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "normal" mode.

MESSAGEFLOW_USERTRACE_PROPERTY

public static final java.lang.String MESSAGEFLOW_USERTRACE_PROPERTY

As an MessageFlow's attribute key name, the value of this property describes state of user trace for the message flow.

For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change user trace settings for the message flow was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

In all cases, the value of an attribute with this key is one of:

  • AttributeConstants.MESSAGEFLOW_USERTRACE_NONE (user trace is disabled, or a request to stop user trace was received)
  • AttributeConstants.MESSAGEFLOW_USERTRACE_NORMAL (normal user trace is enabled, or a request to start normal user trace was received)
  • AttributeConstants.MESSAGEFLOW_USERTRACE_DEBUG (debug user trace is enabled, or a request to start debug user trace was received)

  • MODIFYTIME_TIMESTAMP_FORMAT

    public static final java.lang.String MODIFYTIME_TIMESTAMP_FORMAT

    The format used to describe the timestamp in attributes that describe the time an object was modified.

    NAME_PROPERTY

    public static final java.lang.String NAME_PROPERTY

    As an AdministeredObject attribute key name, the value of this property is the name of the object.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the name of the object was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    OBJECT_DEPLOYED_PROPERTY

    public static final java.lang.String OBJECT_DEPLOYED_PROPERTY

    As an AdministeredObject attribute key name, if the value of this property is set to AttributeConstants.TRUE, it means that the object exists in the deployed section of the Configuration Manager data store. Deployed objects have been the subject of a deployment action at least once- that is, have been deployed to brokers.

    For request reference properties this key name is not used.

    OBJECT_LASTUPDATEUSER_PROPERTY

    public static final java.lang.String OBJECT_LASTUPDATEUSER_PROPERTY

    As an AdministeredObject attribute key name, the value of this property describes the last user to cause a modification to the object. The value of this property may not always be available, as object modifications are not always directly initiated by a user.

    For request reference properties this key name is not used.

    OBJECT_REPOSITORY_TIMESTAMP

    public static final java.lang.String OBJECT_REPOSITORY_TIMESTAMP

    As an AdministeredObject attribute key name, the value of this property is the time (in an unspecified format) that the property was last modified in the Configuration Manager data store.

    For request reference properties this key name is not used.

    OBJECT_RUNSTATE_PROPERTY

    public static final java.lang.String OBJECT_RUNSTATE_PROPERTY

    As an AdministeredObject attribute key name, the value of this property describes whether or not the object is running.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to start or stop the object was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    In all cases, the value of an attribute with this key is one of:

  • AttributeConstants.OBJECT_RUNSTATE_RUNNING (the object is running, or the object was requested to start)
  • AttributeConstants.OBJECT_RUNSTATE_STOPPED (the object is stopped, or the object was requested to stop)

  • OBJECT_RUNSTATE_RUNNING

    public static final java.lang.String OBJECT_RUNSTATE_RUNNING

    If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is running.

    OBJECT_RUNSTATE_STOPPED

    public static final java.lang.String OBJECT_RUNSTATE_STOPPED

    If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is stopped.

    OBJECT_SHARED_PROPERTY

    public static final java.lang.String OBJECT_SHARED_PROPERTY

    As an AdministeredObject attribute key name, if the value of this property is set to AttributeConstants.TRUE, it means that the object exists in the shared section of the Configuration Manager data store. Shared objects can be viewed or modified by the user of any Configuration Manager Proxy application that has the relevant authority.

    For request reference properties this key name is not used.

    OPERATION_TYPE_PROPERTY

    public static final java.lang.String OPERATION_TYPE_PROPERTY

    For request reference properties, this key is always present and describes the type of operation that was requested. If the String value of this property is 'v', it can be parsed as follows:

         OperationType c = OperationType.getOperationType(v);
         if (c == OperationType.modify) {
             // etc.
         }
     

    This attribute is not used in AdministeredObject attribute key names.

    PARENT_TYPE_PROPERTY

    public static final java.lang.String PARENT_TYPE_PROPERTY

    As an AdministeredObject attribute key name, the value of this property uniquely identifies the type of the current object's parent within the Configuration Manager's object hierarchy.

    On request reference properties, this key may be used to clarify the type of the parent of the object being manipulated. Where the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the type of the grandparent of the object being created or deleted. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) If the String value of this property is 'v', it can be parsed as follows:

         ConfigurationObjectType c = ConfigurationObjectType.getConfigurationObjectType(v);
         if (c == ConfigurationObjectType.executiongroup) {
             // etc.
         }
     

    PARENT_UUID_PROPERTY

    public static final java.lang.String PARENT_UUID_PROPERTY

    As an AdministeredObject attribute key name, the value of this property uniquely identifies the parent of the current object within the Configuration Manager's object hierarchy.

    On request reference properties, this key may be used to clarify the unique identifier of the parent of the object being manipulated. Where the operation type of the request is 'createchild' or 'deletechild', the value of this property refers to the unique identifier of the grandparent of the object being created or deleted. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    SHORT_DESCRIPTION_PROPERTY

    public static final java.lang.String SHORT_DESCRIPTION_PROPERTY

    As an AdministeredObject attribute key name, the value of this property is the short description of the object.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the short description of the object was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    SUBCOMPONENT_PROPERTY_GROUP

    public static final java.lang.String SUBCOMPONENT_PROPERTY_GROUP

    If an AdministeredObject's attribute key name or request reference property begins with the value of this constant, the attribute is related to the description of logical subcomponents owned by the object.

    A key that is made up of this constant with an integer value appended has a value that describes a String representation of single subcomponent of the current object. The format of the String representation is not guaranteed, but is parseable using the method AdministeredObject.getManagedSubcomponentFromStringRepresentation().

    A key that is made up of this constant with the value of AttributeConstants.LAST_PROPERTY_IN_GROUP appended has a value that describes the total number of subcomponents owned by the object. In other words, if the value of

         o.getProperty(AttributeConstants.SUBCOMPONENT_PROPERTY_GROUP + AttributeConstants.LAST_PROPERTY_IN_GROUP)
     
    was 3, then
         o.getProperty(AttributeConstants.SUBCOMPONENT_PROPERTY_GROUP + 3)
     
    would return a valid string representation of a subcomponent but
         o.getProperty(AttributeConstants.SUBCOMPONENT_PROPERTY_GROUP + 4)
     
    would not.

    On its own, this property is not used as a property key name or request reference property.

    SUBSCRIPTION_PROPERTY_GROUP

    public static final java.lang.String SUBSCRIPTION_PROPERTY_GROUP

    If an SubscriptionsProxy's attribute key name or request reference property begins with the value of this constant, the attribute is related to the set of matching subscriptions.

    A key that is made up of this constant with an integer value appended has a value that describes a String representation of single subscription. The format of the String representation is not guaranteed, but is parseable using the method Subscription.getSubscriptionFromString().

    A key that is made up of this constant with the value of AttributeConstants.LAST_PROPERTY_IN_GROUP appended has a value that describes the total number of log entries owned by the user. In other words, if the value of

         o.getProperty(AttributeConstants.SUBSCRIPTION_PROPERTY_GROUP + AttributeConstants.LAST_PROPERTY_IN_GROUP)
     
    was 3, then
         o.getProperty(AttributeConstants.SUBSCRIPTION_PROPERTY_GROUP + 3)
     
    would return a valid string representation of a subscription but
         o.getProperty(AttributeConstants.SUBSCRIPTION_PROPERTY_GROUP + 4)
     
    would not.

    On its own, this property is not used as a property key name or request reference property.

    TOPIC_DEFAULTPOLICY_PROPERTY

    public static final java.lang.String TOPIC_DEFAULTPOLICY_PROPERTY

    As a TopicProxy's attribute key name, the value of this property is the default policy for the topic root.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the default policy was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    TOPIC_MULTICAST_ENABLE_INHERIT

    public static final java.lang.String TOPIC_MULTICAST_ENABLE_INHERIT

    If this is the value of TOPIC_MULTICAST_ENABLE_PROPERTY it means that the multicast enabled property is inherited from the topic's parent.

    TOPIC_MULTICAST_ENABLE_PROPERTY

    public static final java.lang.String TOPIC_MULTICAST_ENABLE_PROPERTY

    As a TopicProxy's attribute key name, the value of this property describes whether multicast is enabled on the topic.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to enable or disable multicast has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    In all cases, the value of an attribute with this key is one of:

    TOPIC_MULTICAST_ENCRYPTED_PROPERTY

    public static final java.lang.String TOPIC_MULTICAST_ENCRYPTED_PROPERTY

    As a TopicProxy's attribute key name, the value of this property describes the multicast encryption setting for the topic.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to modify the encryption setting has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) In all cases, the value of an attribute with this key is one of:

    TOPIC_MULTICAST_GROUPADDRESS_IPV4IPV6DELIMITER

    public static final java.lang.String TOPIC_MULTICAST_GROUPADDRESS_IPV4IPV6DELIMITER

    This constant is reserved for future use.

    TOPIC_MULTICAST_GROUPADDRESS_PROPERTY

    public static final java.lang.String TOPIC_MULTICAST_GROUPADDRESS_PROPERTY

    As a TopicProxy's attribute key name, the value of this property describes the group address of the topic.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to modify the group address has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.)

    TOPIC_MULTICAST_PROPERTY_GROUP

    public static final java.lang.String TOPIC_MULTICAST_PROPERTY_GROUP

    If a TopicProxy's attribute key name or request reference property begins with the value of this constant, the attribute is multicast related.

    On its own, this property is not used as a property key name or request reference property.

    TOPIC_MULTICAST_QOS_PROPERTY

    public static final java.lang.String TOPIC_MULTICAST_QOS_PROPERTY

    As a TopicProxy's attribute key name, the value of this property describes the multicast Quality of Service setting for the topic.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to modify the Quality of Service setting has been processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) In all cases, the value of an attribute with this key is one of:

    TOPIC_NEWPOLICIES_PROPERTY

    public static final java.lang.String TOPIC_NEWPOLICIES_PROPERTY

    For request reference properties involving a topic, the value of this property is the list of policies that were requested to be added to the topic. Each policy identifier in the value is separated with AttributeConstants.TOPIC_POLICIES_DELIMITER. The String representation of each policy is not guaranteed but is parseable using TopicProxy.Policy.getPolicyFromString().

    This attribute is not used in AdministeredObject attribute key names.

    TOPIC_POLICIES_DELIMITER

    public static final java.lang.String TOPIC_POLICIES_DELIMITER

    The String used to separate multiple policies when described in a single String (for example, separates policy_one from policy_two).

    TOPIC_PRINCIPAL_ALLOW

    public static final java.lang.String TOPIC_PRINCIPAL_ALLOW

    If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the action is permitted by the policy. This constant can also be passed to the equivalent setter methods in order to change the publish or subscribe settings of policies.

    TOPIC_PRINCIPAL_DENY

    public static final java.lang.String TOPIC_PRINCIPAL_DENY

    If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the action is denied by the policy. This constant can also be passed to the equivalent setter methods in order to change the publish or subscribe settings of policies.

    TOPIC_PRINCIPAL_GROUP

    public static final java.lang.String TOPIC_PRINCIPAL_GROUP

    If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a group. This constant can also be passed to the equivalent setter method in order to change the principal type of policies.

    TOPIC_PRINCIPAL_INHERIT

    public static final java.lang.String TOPIC_PRINCIPAL_INHERIT

    If the value of this constant is returned from TopicProxy.Policy.getPublish() or TopicProxy.Policy.getSubscribe() it means that the permission for the action is inherited from the parent topic. This constant can also be passed to the equivalent setter methods in order to change the publish or subscribe settings of policies.

    TOPIC_PRINCIPAL_NOTPERSISTENT

    public static final java.lang.String TOPIC_PRINCIPAL_NOTPERSISTENT

    If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is not persistent. This constant can also be passed to the equivalent setter method in order to change the persistence setting of policies.

    TOPIC_PRINCIPAL_PERSISTENT

    public static final java.lang.String TOPIC_PRINCIPAL_PERSISTENT

    If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is persistent. This constant can also be passed to the equivalent setter method in order to change the persistence setting of policies.

    TOPIC_PRINCIPAL_PUBLICGROUP

    public static final java.lang.String TOPIC_PRINCIPAL_PUBLICGROUP

    If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a public group. This constant can also be passed to the equivalent setter method in order to change the principal type of policies.

    TOPIC_PRINCIPAL_USER

    public static final java.lang.String TOPIC_PRINCIPAL_USER

    If the value of this constant is returned from TopicProxy.Policy.getPrincipalType() it means that the principal to which the policy refers is a user. This constant can also be passed to the equivalent setter method in order to change the principal type of policies.

    TOPIC_QOP_CHANNELINTEGRITY

    public static final java.lang.String TOPIC_QOP_CHANNELINTEGRITY

    If this is the value of TOPIC_QOP_PROPERTY, it means that channel integrity Quality of Protection applies.

    TOPIC_QOP_ENCRYPTED

    public static final java.lang.String TOPIC_QOP_ENCRYPTED

    If this is the value of TOPIC_QOP_PROPERTY, it means that encrypted Quality of Protection applies.

    TOPIC_QOP_MESSAGEINTEGRITY

    public static final java.lang.String TOPIC_QOP_MESSAGEINTEGRITY

    If this is the value of TOPIC_QOP_PROPERTY, it means that message integrity Quality of Protection applies.

    TOPIC_QOP_NONE

    public static final java.lang.String TOPIC_QOP_NONE

    If this is the value of TOPIC_QOP_PROPERTY, it means that no Quality of Protection applies.

    TOPIC_QOP_PROPERTY

    public static final java.lang.String TOPIC_QOP_PROPERTY

    As a TopicProxy's attribute key name, the value of this property is the Quality of Protection setting for the topic.

    For request reference properties, the presence of this key on a request with a 'modify' operation type states that a request to change the Quality of Protection was processed. (See the description for OPERATION_TYPE_PROPERTY for information on how to determine the operation type of a request.) In all cases, the value of an attribute with this key is one of:

    TOPIC_REMOVEDPOLICIES_PROPERTY

    public static final java.lang.String TOPIC_REMOVEDPOLICIES_PROPERTY

    For request reference properties involving a topic, the value of this property is the list of policies that were requested to be removed from the topic. Each policy identifier in the value is separated with AttributeConstants.TOPIC_POLICIES_DELIMITER. The String representation of each policy is not guaranteed but is parseable using TopicProxy.Policy.getPolicyFromString().

    This attribute is not used in AdministeredObject attribute key names.

    TOPICROOT_GROUPS_PROPERTY

    public static final java.lang.String TOPICROOT_GROUPS_PROPERTY

    As a TopicRootProxy's attribute key name, the value of this property is the list of groups defined in the User Name Server. Each userid is separated with the value of AttributeConstants.TOPICROOT_PRINCIPALSLIST_DELIMITER.

    For request reference properties this key name is not used.

    TOPICROOT_PRINCIPALSLIST_DELIMITER

    public static final java.lang.String TOPICROOT_PRINCIPALSLIST_DELIMITER

    The String used to delimit a list of principals.

    TOPICROOT_PUBLICGROUPS_PROPERTY

    public static final java.lang.String TOPICROOT_PUBLICGROUPS_PROPERTY

    As a TopicRootProxy's attribute key name, the value of this property is the list of public groups defined in the User Name Server. Each userid is separated with the value of AttributeConstants.TOPICROOT_PRINCIPALSLIST_DELIMITER.

    For request reference properties this key name is not used.

    TOPICROOT_USERS_PROPERTY

    public static final java.lang.String TOPICROOT_USERS_PROPERTY

    As a TopicRootProxy's attribute key name, the value of this property is the list of users defined in the User Name Server. Each userid is separated with the value of AttributeConstants.TOPICROOT_PRINCIPALSLIST_DELIMITER.

    For request reference properties this key name is not used.

    TRUE

    public static final java.lang.String TRUE

    Various attributes use this value to mean that the specified property exists or is enabled. For these properties, if the key does not exist or if the value is set to anything other than TRUE, it means that its value is false.

    TYPE_PROPERTY

    public static final java.lang.String TYPE_PROPERTY

    As an AdministeredObject attribute key name, the value of this property is the type of the object. If the String value of this property is 'v', it can be parsed as follows:

         ConfigurationObjectType c = ConfigurationObjectType.getConfigurationObjectType(v);
         if (c == ConfigurationObjectType.executiongroup) {
             // etc.
         }
     
    If the AdministeredObject handle is available, use getConfigurationObjectType() instead.

    For request reference properties, the constant CONFIGURATION_OBJECT_TYPE is used to describe the type of the object being manipulated.

    UUID_CONFIGMANAGER

    public static final java.lang.String UUID_CONFIGMANAGER

    A constant describing the domain-unique identifier of the ConfigManagerProxy object.

    UUID_DELIMITER

    public static final java.lang.String UUID_DELIMITER

    The string used to separate the type parameter from the UUID parameter in the subcomponent properties.

    UUID_LOG

    public static final java.lang.String UUID_LOG

    A constant containing the domain-unique identifier of the broker log.

    UUID_PROPERTY

    public static final java.lang.String UUID_PROPERTY

    As an AdministeredObject attribute key name, the value of this property uniquely identifies the object within the Configuration Manager's domain.

    On request reference properties, this key is always present and describes unique identifier of the object on which the request was performed. (For creation and deletion requests, this is the identifier of the parent object.)

    UUID_TOPICROOT

    public static final java.lang.String UUID_TOPICROOT

    A constant containing the domain-unique identifier of the topic root.

    UUID_TOPOLOGY

    public static final java.lang.String UUID_TOPOLOGY

    A constant containing the domain-unique identifier of the topology.

    VERSION_2

    public static final int VERSION_2

    As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 2.1 or earlier.

    Configuration Manager Proxy applications cannot manipulate domains controlled by these Configuration Managers.

    VERSION_5

    public static final int VERSION_5

    As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 5 or version 5.1 (any fixpack level).

    Some Configuration Manager Proxy functions do not work when manipulating domains controlled by these Configuration Managers.

    VERSION_6

    public static final int VERSION_6

    As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Configuration Manager Proxy application is connected is of version 6. This is the latest level of Configuration Manager version supported by this Configuration Manager Proxy. All Configuration Manager Proxy functions are possible when manipulating domains controlled by these Configuration Managers.

    As the return code from ConfigManagerProxy.getConfigManagerProxyVersion(), this states that the command level of the Configuration Manager Proxy is v6.

    Class Hierarchy All Classes All Fields and Methods