WBI BrokersTM
Config Manager Proxy API
A B C D E F G H I L M N O P R S T U V W

A

ACL - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
A constant containing the unique identifier of the ACL.
AccessControlEntry - class com.ibm.broker.config.proxy.AccessControlEntry.
A small class to represent an Access Control Entry Contains a principal name, principal type (user or group) and permission
AccessControlEntry(String, AccessControlEntryPrincipalType, AccessControlEntryPermission) - Constructor for class com.ibm.broker.config.proxy.AccessControlEntry
Constructor.
AccessControlEntryPermission - class com.ibm.broker.config.proxy.AccessControlEntryPermission.
Defines a set of abilities over which security can be applied.
AccessControlEntryPrincipalType - class com.ibm.broker.config.proxy.AccessControlEntryPrincipalType.
Defines a set of principal types over which security can be applied.
AdministeredObject - class com.ibm.broker.config.proxy.AdministeredObject.
This is the abstract superclass from which all Proxy-type objects inherit.
AdministeredObjectListener - interface com.ibm.broker.config.proxy.AdministeredObjectListener.
User-written classes that implement this interface are stating that they can receive notifications from the Config Manager Proxy.
AdvancedAdministeredObjectListener - interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener.
User-written classes that extend this class are stating that they can receive notifications from the Config Manager Proxy that contain more information than is provided by the basic AdministeredObjectListener interface.
AttributeConstants - interface com.ibm.broker.config.proxy.AttributeConstants.
This is a common set of strings used by the Config Manager Proxy to describe attributes of objects in the Configuration Manager's domain.
actionresponse - Static variable in class com.ibm.broker.config.proxy.OperationType
This OperationType is used internally by the Config Manager Proxy and is not required by user applications.
addBrokers(String[]) - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Adds an array of broker UUIDs to this collective's list of members and sends the results to the Config Manager.
addDefaultPolicy(TopicProxy.Policy) - Method in class com.ibm.broker.config.proxy.TopicProxy
Adds the default Topic Policy.
addDefaultPolicy(TopicProxy.Policy) - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Does nothing when applied to the topic root.
addPolicies(TopicProxy.Policy[]) - Method in class com.ibm.broker.config.proxy.TopicProxy
Adds an array of policies to this topic's list of policies and sends the results to the Config Manager.
all - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents all configuration object types

B

BARFILENAME_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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.
BARNAME_KEYWORD - Static variable in interface com.ibm.broker.config.proxy.DeployedObject
The keyword used to denote the BAR File name of a DeployedObject.
BROKER_AUTHPROTOCOLS_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the broker's authentication protocols setting.
BROKER_INTERBROKERHOST_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker hostname setting.
BROKER_INTERBROKERPORT_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the broker's interbroker port setting.
BROKER_ISYSQOP_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
This constant is reserved for future use.
BROKER_MULTICAST_ADDRESSRANGE_MINMAXDELIMITER - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast address ranges the broker.
BROKER_MULTICAST_BACKOFFTIME_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes whether multicast is enabled on the broker.
BROKER_MULTICAST_HBTIMEOUT_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
This constant is reserved for future use.
BROKER_MULTICAST_INTERFACE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast network interface for the broker.
BROKER_MULTICAST_LIMITTRANSRATE_DISABLED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of BROKER_MULTICAST_LIMITTRANSRATE_PROPERTY, it means that congestion control is disabled in the broker.
BROKER_MULTICAST_LIMITTRANSRATE_DYNAMIC - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast congestion control behaviour.
BROKER_MULTICAST_LIMITTRANSRATE_STATIC - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the broker's default behaviour for overlapping topics.
BROKER_MULTICAST_PACKETBUFFERS_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast protocol type for the broker.
BROKER_MULTICAST_PROTOCOLTYPE_PTL - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast security setting for the broker.
BROKER_MULTICAST_SOCKETBUFFERSIZE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property describes the multicast TTL setting for the broker.
BROKER_NEWUUID_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property denotes whether SSL connector is enabled on the broker.
BROKER_SSLKEYRINGFILE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a BrokerProxy's attribute key name, the value of this property is the Quality of Protection setting for the broker's temporary topic.
BrokerProxy - class com.ibm.broker.config.proxy.BrokerProxy.
Each broker within the Config Manager's domain can be represented by a BrokerProxy.
BrokerProxy.MulticastParameterSet - class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet.
A small data structure that represents the set of parameters required to enable multicast on this broker.
BrokerProxy.MulticastParameterSet() - Constructor for class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
 
beginUpdates() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Tells the ConfigManagerProxy to hold back from sending any subsequent state-changing requests to the Config Manager, so multiple requests can be later sent off in a single message (or "batch").
broker - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the broker type

C

CHILD_NAME_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'failure'.
COMPLETIONCODE_INITIATED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'initiated'.
COMPLETIONCODE_NOTREQUIRED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'notRequired'.
COMPLETIONCODE_PENDING - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'pending'.
COMPLETIONCODE_SUBMITTED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'submitted'.
COMPLETIONCODE_SUCCESS - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'success'.
COMPLETIONCODE_SUCCESSSOFAR - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'successSoFar'.
COMPLETIONCODE_UNKNOWN - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
String representation of CompletionCodeType instance 'unknown'.
CONFIGMGR_FULLVERSION_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 Config Manager Proxy application is connected.
CONFIGMGR_INCOMPATIBLEVERSION_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 Config Manager Proxy because the versions are incompatible.
CONFIGMGR_OSARCH_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of CONFIGMGR_TRACE_PROPERTY it means that system tracing for the Configuration Manager is off.
CONFIGMGR_TRACE_NORMAL - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
For request reference properties, this key is always present and describes the type of the object that was manipulated.
CollectiveProxy - class com.ibm.broker.config.proxy.CollectiveProxy.
Represents a totally connected set of pub/sub brokers.
CompletionCodeType - class com.ibm.broker.config.proxy.CompletionCodeType.
The CompletionCodeType type is used to describe the outcome of the operation that has been performed.
ConfigManagerConnectionParameters - interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters.
Config Manager Proxy applications must pass objects that implement this interface to the ConfigManagerProxy.getInstance() method, which enables them to connect to Configuration Managers.
ConfigManagerProxy - class com.ibm.broker.config.proxy.ConfigManagerProxy.
This class allows applications to connect to and manipulate Configuration Managers.
ConfigManagerProxyException - exception com.ibm.broker.config.proxy.ConfigManagerProxyException.
Abstract base class for all exceptions originating on the ConfigManagerProxy.
ConfigManagerProxyIncompatibilityException - exception com.ibm.broker.config.proxy.ConfigManagerProxyIncompatibilityException.
This exception is thrown after an incompatibility between versions of the Configuration Manager and the connected Config Manager Proxy is detected.
ConfigManagerProxyLoggedException - exception com.ibm.broker.config.proxy.ConfigManagerProxyLoggedException.
This exception is used to describe a general problem with the Config Manager Proxy, as a result of an internal error or a misuse of the API.
ConfigManagerProxyLoggedMQException - exception com.ibm.broker.config.proxy.ConfigManagerProxyLoggedMQException.
This class is used to describe exceptions due to problems flagged by the WebSphere MQ Classes for Java.
ConfigManagerProxyPropertyNotInitializedException - exception com.ibm.broker.config.proxy.ConfigManagerProxyPropertyNotInitializedException.
This exception type represents the condition when an application attempts to get a property of an AdministeredObject, but the property has not yet been set to a value by the Config Manager.
ConfigurationObjectType - class com.ibm.broker.config.proxy.ConfigurationObjectType.
The ConfigurationObjectType type is used to describe the types of various objects managed by the Configuration Manager.
cancelDeployment() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Tells the Configuration Manager to cancel any deployment actions to this broker that are currently in progress.
cancelDeployment() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Tells the Configuration Manager to cancel ALL deployment actions in the domain that are currently in progress.
channelIntegrity - Static variable in class com.ibm.broker.config.proxy.TopicProxy.QoP
Defines Channel Integrity QoP.
clear() - Method in class com.ibm.broker.config.proxy.LogProxy
Removes all log entries associated with this LogProxy (that is, clears the log of all of this user's messages).
clearUpdates() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Tells the ConfigManagerProxy to discard any state-changing requests received since the last call to beginUpdates().
collective - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the pub/sub collective type
com.ibm.broker.config.proxy - package com.ibm.broker.config.proxy
The com.ibm.broker.config.proxy package gives user-written applications programmatic control of broker domains by providing a remote interface to Configuration Managers.
configmanager - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the Configuration Manager type
connection - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the pub/sub connection type
containsBroker(String) - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns true if and only if the broker with the supplied UUID is a member of the collective.
createBroker(String, String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to add a broker with the supplied name and queue manager to the Topology workspace.
createChildTopic(String) - Method in class com.ibm.broker.config.proxy.TopicProxy
Creates a topic of the supplied name so that it sits under the current topic.
createCollective(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to create a collective with the supplied name.
createConnectionByName(String, String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to create a logical connection between two brokers.
createConnectionByUUID(String, String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to create a logical connection between two brokers by UUID.
createExecutionGroup(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Asks the Config Manager to add an Execution Group of the supplied name to the broker.
createExecutionGroup(String, int) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Asks the Config Manager to add an Execution Group of the supplied name to the broker.
createchild - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to create a logical subcomponent.

D

DEBUG_COMMSMESSAGE_IO - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If and only if this is set to true, all comms between the Config Manager and Proxy will be sent to System.out.
DEFAULT_CORRELID - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The default value for the correlation id field, used internally when submitting a set of requests with the ConfigManagerProxy.sendUpdates() method.
DEPENDENCY_PROPERTY_GROUP - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
For request reference properties, the value of this key on a request with a 'deploy' operation type is the user identifer to which log messages are sent.
DEPLOYRESULT_SUPPRESSION - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value supplied as the 'maxWaitTimeMs' parameter to a deploy() method, the Config Manager Proxy will wait indefinitely for all broker responses to be returned.
DEPLOYTIME_TIMESTAMP_FORMAT - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The format used to describe the timestamp in attributes that describe the time an object was deployed.
DEPLOYTYPE_CANCEL - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of DEPLOYTYPE_PROPERTY, it means that the deployment was sent as delta to what was already deployed.
DEPLOYTYPE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The String used in the Config Manager Proxy's access control lists that separates a user or group name from the machine or domain on which it is defined.
DeployResult - class com.ibm.broker.config.proxy.DeployResult.
The DeployResult type is used to describe the outcome of deployment operations.
DeployedObject - interface com.ibm.broker.config.proxy.DeployedObject.
Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.
debug - Static variable in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
Defines debug user trace.
delete - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to delete an object controlled by the Configuration Manager.
delete(SubscriptionsProxy) - Method in class com.ibm.broker.config.proxy.Subscription
Asks the Configuration Manager to delete the supplied subscription.
deleteAllExecutionGroupsAndDeploy() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Deletes all execution groups existing in the broker and deploys this change to the broker.
deleteAllExecutionGroupsAndDeploy(long) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Deletes all execution groups existing in the broker and deploys this change to the broker.
deleteBroker(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to remove the broker with the supplied name from the Topology workspace.
deleteChildTopic(String) - Method in class com.ibm.broker.config.proxy.TopicProxy
Removes the topic with the supplied name (and its children) from the current topic.
deleteCollective(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to remove the collective with the supplied name from the Topology workspace.
deleteConnectionByName(String, String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to remove a logical connection between two brokers.
deleteConnectionByUUID(String, String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Asks the Config Manager to remove a logical connection between two brokers.
deleteDeployedObjects(DeployedObject[], long) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Asks the Configuration Manager to remove deployed objects from the execution group.
deleteDeployedObjectsByName(String[], long) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Asks the Configuration Manager to remove deployed objects from the execution group.
deleteExecutionGroup(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Asks the Config Manager to remove the Execution Group with the supplied name from the Broker.
deleteSubscriptions(Subscription[]) - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Asks the Configuration Manager to delete the supplied subscriptions.
deletechild - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to delete a logical subcomponent.
dependency - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the message flow dependency type.
deploy - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPermission
 
deploy() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Deploys the broker's configuration to the broker.
deploy(long) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Deploys the broker's configuration to the broker.
deploy(String, boolean, long) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Starts a deploy of the BAR file pointed to by the supplied filename, to the execution group.
deploy(InputStream, String, boolean, long) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Starts a deploy of the BAR file pointed to by the supplied filename, to the execution group.
deploy(String) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Starts an incremental deploy of the BAR file pointed to by the supplied filename, to the execution group.
deploy(InputStream) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Starts an incremental deploy of the BAR file pointed to by the supplied filename, to the execution group.
deploy - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to start or cancel a deployment request.
deploy() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Deploys any changes to the topic tree to all brokers
deploy(boolean) - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Deploys the topic tree to all brokers.
deploy(boolean, long) - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Deploys the topic tree to the brokers
deploy() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Deploys any changes made to the pub/sub topology since the last pub/sub topology deploy to the affected brokers.
deploy(boolean) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Deploys the pub/sub topology configuration to brokers.
deploy(boolean, long) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Deploys the pub/sub topology configuration to brokers.
deregister - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to ask the Configuration Manager to stop keeping the Config Manager Proxy up-to-date with changes to the current object.
deregisterListener(AdministeredObjectListener) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager Proxy to unsubscribe a previously registered AdministeredObjectListener, given the listener instance that was supplied during registration.
deregisterListener(AdvancedAdministeredObjectListener) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager Proxy to unsubscribe a previously registered AdvancedAdministeredObjectListener, given the listener instance that was supplied during registration.
deregisterListeners() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Deregisters ALL external listeners associated with the current ConfigManagerProxy connection.
disableConfigManagerProxyTracing() - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Stops Config Manager Proxy service tracing.
disableDomainAwareness() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Prevents Windows domain awareness support from initialising for this instance.
disableDomainAwareness() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Prevents Windows domain awareness support from initialising for this instance.
disableMQJavaClientTracing() - Static method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Disables WebSphere MQ Java Client tracing
disableMQJavaClientTracing() - Static method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Disables WebSphere MQ Java Client tracing
disconnect() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Deregisters all listeners registered to this ConfigManagerProxy instance and closes the link to the Config Manager.

E

EG_PROCESSOR_ARCHITECTURE - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an ExecutionGroupProxy's attribute key name, the value of this property describes the number or bits in the architecture of the underlying execution group.
ExecutionGroupProxy - class com.ibm.broker.config.proxy.ExecutionGroupProxy.
Each execution group associated with a broker can be represented by an ExecutionGroupProxy.
edit - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPermission
 
elements(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
For groups of attributes (such as subcomponents) this method returns the largest number for which a attribute exists in the current object.
elements() - Method in class com.ibm.broker.config.proxy.LogProxy
Returns an Enumeration of all LogEntry objects available to the user in the log.
elements() - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Returns an Enumeration of all Subscription objects available to the user that match this query.
enableConfigManagerProxyTracing(String) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Enables Config Manager Proxy service tracing, sending output to the file with the supplied name.
enableMQJavaClientTracing(String) - Static method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Sends level 5 WebSphere MQ Java Client tracing to the specified file.
enableMQJavaClientTracing(String) - Static method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Sends level 5 WebSphere MQ Java Client tracing to the specified file.
encrypted - Static variable in class com.ibm.broker.config.proxy.TopicProxy.QoP
Defines Encrypted QoP.
executiongroup - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the execution group type

F

FALSE - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
This value can be used to represent something that is not TRUE.
failure - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
States that an operation failed.
fullControl - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPermission
 

G

generateUniqueDeployID() - Static method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Generates a deploy ID and returns it.
generateUniqueDeployID() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Sets the deploy ID for the current connection to a unique String and returns it.
getAccessControlEntries() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Obtain the list of access control entries which apply to this object.
getAccessControlEntryPermission(String) - Static method in class com.ibm.broker.config.proxy.AccessControlEntryPermission
Get an AccessControlEntryPermission object from a textual representation.
getAccessControlEntryPrincipalType(String) - Static method in class com.ibm.broker.config.proxy.AccessControlEntryPrincipalType
Get an AccessControlEntryPrincipalType object from a textual representation.
getAdditionalInstances() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the value of the "AdditionalInstances" parameter
getAuthenticationProtocols() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the name of the 'Authentication Protocols' attribute associated with this broker.
getBARFileName() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the name of the BAR file that was used to deploy the object to the execution group.
getBARFileName() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the name of the BAR file that was used to deploy the dependency to the execution group.
getBARFileName() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the name of the BAR file that was used to deploy the message flow to the execution group.
getBroker() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the broker field for the current subscription
getBroker(Properties) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the first BrokerProxy object that matches the filter specified by the Properties argument.
getBrokerByName(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the BrokerProxy object with the supplied name, or null if a broker of that name does not exist or if the supplied argument was null.
getBrokerUUIDs() - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns a Enumeration of all the brokers in the collective's list.
getBrokers(Properties) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns an enumeration of all the BrokerProxy objects that match the filter specified by the Properties argument.
getChildTopic(Properties) - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the first TopicProxy object directly (that is, one level) underneath the current one that matches the supplied filter.
getChildTopicByName(String) - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the TopicProxy object with the supplied name, or null if a topic of that name does not exist or if the supplied argument was null.
getChildTopics(Properties) - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns an enumeration of all TopicProxy objects directly (that is, one level) underneath the current one that match the supplied filter.
getClient() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the client field for the current subscription
getCollective(Properties) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the first CollectiveProxy object that matches the filter specified by the Properties argument.
getCollectiveByName(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the CollectiveProxy object with the supplied name, or null if a collective of that name does not exist or if the supplied argument was null.
getCollectives(Properties) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns an enumeration of all the CollectiveProxy objects that match the filter specified by the Properties argument.
getCommitCount() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the value of the "CommitCount" parameter
getCommitInterval() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the value of the "CommitInterval" parameter
getCompletionCode() - Method in class com.ibm.broker.config.proxy.DeployResult
Returns the overall outcome for the current deployment.
getCompletionCodeForBroker(BrokerProxy) - Method in class com.ibm.broker.config.proxy.DeployResult
Returns the completion code for the supplied broker.
getCompletionCodeType(int) - Static method in class com.ibm.broker.config.proxy.CompletionCodeType
Returns the CompletionCodeType object that has the supplied int value.
getConfigManagerFullVersion() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the full version string of the Configuration Manager to which this Config Manager Proxy instance is connected.
getConfigManagerOSArch() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns a string describing the architecture of the Configuration Manager machine to which this Config Manager Proxy is connected.
getConfigManagerOSName() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns a string describing the name of the operating system running on the Configuration Manager machine to which this Config Manager Proxy is connected.
getConfigManagerOSVersion() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns a string describing the version of the operation system on the Configuration Manager machine to which this Config Manager Proxy is connected.
getConfigManagerProxyVersion() - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the version string for the Config Manager Proxy.
getConfigManagerVersion() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the major version identifier of the Configuration Manager to which the Config Manager Proxy is connected.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType(String) - Static method in class com.ibm.broker.config.proxy.ConfigurationObjectType
Returns the ConfigurationObjectType object that has the supplied unique value.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.LogProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectType() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the ConfigurationObjectType associated with this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.LogProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConfigurationObjectTypeOfParent() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
getConnections() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns an enumeration of all TopologyProxy.Connection objects.
getConnections(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns an enumeration of TopologyProxy.Connection objects that affect the broker with the supplied UUID
getCoordinatedTransaction() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the value of the "CoordinatedTransaction" parameter
getDefaultPolicy() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the default Topic Policy.
getDeployID() - Method in interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getDeployID() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Returns the string used to uniquely map each deployment request back to this ConfigManagerProxy connection.
getDeployID() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Returns the string used to uniquely map each deployment request back to this ConfigManagerProxy connection.
getDeployTime() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the time that the current deployed object was last received by the Configuration Manager for deployment to the execution group.
getDeployTime() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the time that the current dependency was last received by the Configuration Manager for deployment to the execution group.
getDeployTime() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the time that the current message flow was last received by the Configuration Manager for deployment to the execution group.
getDeployedBrokers() - Method in class com.ibm.broker.config.proxy.DeployResult
Returns an enumeration of BrokerProxy objects to which the deploy was sent.
getDeployedObjectByName(String) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns a message flow dependency with the supplied name (e.g.
getDeployedObjectFromSubcomponentString(String) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
If the supplied string is the value part of a property in the dependency or subcomponent groups, AND it represents a DeployedObject instance (including subcomponents beginning with the v5 syntax 'messageset'), this method returns a DeployedObject instance that represents it.
getDeployedObjects() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an Enumeration of all the objects deployed to the current execution group.
getDeployedObjects(String) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an enumeration of all the message flow dependencies with the supplied extension that are deployed to the current execution group.
getDetail() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the detail field for the current log entry
getExecutionGroup(Properties) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the first ExecutiongroupProxy object that matches the filter specified by the Properties argument.
getExecutionGroup() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns a reference to the execution group on which this deployed object was deployed.
getExecutionGroup() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns a reference to the execution group on which this dependency was deployed.
getExecutionGroup() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns a reference to the execution group on which this message flow was deployed.
getExecutionGroupByName(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the ExecutionGroupProxy object with the supplied name, or null if a execution group of that name does not exist or if the supplied argument was null.
getExecutionGroups(Properties) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns an enumeration of all the ExecutionGroupProxy objects that match the filter specified by the Properties argument.
getFileExtension() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the file extension of the current deployed object.
getFileExtension() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the file extension of the current dependency.
getFileExtension() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the file extension relevant to message flows.
getFilter() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the filter field for the current subscription
getFullName() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the name of the current deployed object as it existed in the BAR file at deployment time- including any file extension but excluding any path information.
getFullName() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the name of the current dependency as it existed in the BAR file at deployment time- including any file extension but excluding any path information.
getFullName() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the name of the current deployable as it existed in the BAR file at deployment time- including any file extension but excluding any path information.
getGroups() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Returns an Enumeration of all group principals known to the User Name Server.
getISysQualityOfProtectionLevel() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the 'ISys' Quality of Protection level associated with this broker.
getInsert(int) - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the insert with the supplied number.
getInsertsSize() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the number of available inserts for the current log entry.
getInstance(ConfigManagerConnectionParameters) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Asks the Config Manager Proxy to connect to a Configuration Manager with the supplied parameters.
getInterbrokerHost() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the interbroker host associated with this broker.
getInterbrokerPort() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the interbroker port associated with this broker.
getKeywordValue(String) - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the value of the supplied keyword.
getKeywordValue(String) - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the value of the supplied keyword.
getKeywordValue(String) - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the value of the supplied keyword.
getKeywords() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the set of keywords for this deployed object which were found embedded in the object at deploy time.
getKeywords() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the set of keywords for this dependency which were found embedded in the object at deploy time.
getKeywords() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the set of keywords for this deployed object which were found embedded in the object at deploy time.
getLastBIPMessages() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the last vector of BIP messages that are associated with this object.
getLastCompletionCode() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the completion code of the last operation that was performed by this connection to the Configuration Manager on the object that this AdministeredObject represents.
getLastUpdateUser() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the userid of the person who caused the last modification message to be sent for this object.
getLog() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Asks the Configuration Manager to register for all log records associated with the current user, through a LogProxy instance.
getLogEntries() - Method in class com.ibm.broker.config.proxy.DeployResult
Returns any LogEntry objects, supplied by the Configuration Manager, that describe the overall outcome of the deployment request.
getLogEntriesForBroker(BrokerProxy) - Method in class com.ibm.broker.config.proxy.DeployResult
Returns an enumeration of available LogEntry objects that describe the deployment outcome for the current broker.
getLogEntry(int) - Method in class com.ibm.broker.config.proxy.LogProxy
Returns the LogEntry at the supplied position in the log,
getLogEntryFromString(String) - Static method in class com.ibm.broker.config.proxy.LogEntry
Returns a new LogEntry object that contains the information described in the encoded String.
getLongDescription() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Helper method to return the long description field for the current Administered Object.
getManagedSubcomponent(Properties) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the first object that has the requested properties.
getManagedSubcomponentFromStringRepresentation(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the object which has the current object as a parent that has the supplied string representation.
getManagedSubcomponents(Properties) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to return an enumeration of all the existing objects that logically belong directly within the current administered object (for example, the execution groups within a broker).
getManagedSubcomponents(Properties, boolean) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to return an enumeration of all the existing objects that logically belong directly within the current administered object (for example, the execution groups within a broker).
getManagedSubcomponents(Properties, boolean, Properties) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to return an enumeration of all the existing objects that logically belong directly within the current administered object (for example, the execution groups within a broker).
getManagedSubcomponents(Properties) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an Enumeration of MessageFlowProxy objects that match the supplied filter.
getManagedSubcomponents(Properties, boolean) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an Enumeration of MessageFlowProxy objects, or an Enumeration of Strings representing MessageFlowProxy objects, that match the supplied filter.
getMessage() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the message field for the current log entry
getMessageFlow(Properties) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns the first MessageflowProxy object that matches the filter specified by the Properties argument.
getMessageFlowByName(String) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns the MessageFlowProxy object with the supplied name, or null if a flow of that name does not exist or if the supplied argument was null.
getMessageFlowDependencies() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an Enumeration of all the dependencies deployed to the current execution group.
getMessageFlows(Properties) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an enumeration of all the MessageFlowProxy objects that match the filter specified by the Properties argument.
getMessageNumber() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the BIP message number for the current log entry.
getMessageSets() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns an Enumeration of all the message set names deployed at the broker level.
getMessageSets() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns an Enumeration of all the Message Sets deployed to the current execution group.
getModifyTime() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the time that the current deployed object was last modified, according to the file modification date set in the broker archive file.
getModifyTime() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the time that the current dependency was last modified, according to the file modification date set in the broker archive file.
getModifyTime() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the time that the current message flow was last modified, according to the file modification associated with the cmf file in the broker archive.
getMulticastEnabled() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the multicast 'enabled' string associated with this topic.
getMulticastEncrypted() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the multicast 'encrypted' flag associated with this topic.
getMulticastIPv4GroupAddress() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the IPv4 multicast group address associated with this topic.
getMulticastIPv6GroupAddress() - Method in class com.ibm.broker.config.proxy.TopicProxy
This method is reserved for future use.
getMulticastParameters() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns a data structure that contains all the active multicast properties.
getMulticastQualityOfService() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the multicast 'qualityOfService' flag associated with this topic.
getName() - Method in class com.ibm.broker.config.proxy.AccessControlEntry
Get the principal name for this entry.
getName() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the name of the object
getName() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the name of the current deployed object.
getName() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the name of the current dependency.
getNumberOfConnections(String) - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the number of Connection objects in the topology, or that involve the broker with the supplied UUID.
getNumberOfConnections() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Returns the number of Connection objects in the topology.
getNumberOfPolicies() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the number of TopicProxy.Policy objects in the topic's list, excluding any default policy.
getNumberOfSubcomponents() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the number of subcomponents that are directly owned by this one.
getOperationType(int) - Static method in class com.ibm.broker.config.proxy.OperationType
Returns the OperationType object that has the supplied int value.
getOperationType(String) - Static method in class com.ibm.broker.config.proxy.OperationType
Returns the OperationType object that has the supplied String value.
getParent() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the AdministeredObject that logically owns this one.
getPermission() - Method in class com.ibm.broker.config.proxy.AccessControlEntry
Get the permission for this entry.
getPersistence() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns the persistence value associated with this principal.
getPolicies() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns a Enumeration of all the TopicProxy.Policy objects in the topic's list.
getPolicyFromString(String) - Static method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns a policy object from a String representation
getPolicyFromString(String, boolean) - Static method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns a policy object from a String representation
getPredictedNewSubcomponents() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns a clone of the predictedNewSubcomponents vector.
getPrincipalName() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns the user or group name associated with this principal
getPrincipalType() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns the type of the name associated with this principal.
getProcessorArchitecture() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns the processor architecture of this execution group.
getProperties() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns a clone of the complete local attribute list for the current object, based on information supplied solely from the Config Manager.
getProperty(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the local value of the supplied attribute.
getProperty(String, boolean) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the local value of the supplied attribute.
getProperty(String, int) - Method in class com.ibm.broker.config.proxy.AdministeredObject
For properties that end in a number (for example, subcomponent properties) this method returns the value of the property that ends in the supplied number, waiting if the information is not available.
getProperty(String, int, boolean) - Method in class com.ibm.broker.config.proxy.AdministeredObject
For properties that end in a number (for example, subcomponent properties) this method returns the value of the property that ends in the supplied number, optionally waiting if the information is not available.
getProtocol() - Method in interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getProtocol() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getProtocol() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getProxyClassName() - Method in class com.ibm.broker.config.proxy.ConfigurationObjectType
Maps from a ConfigurationObjectType to a class name in the Proxy model
getPublicGroups() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Returns an Enumeration of all public group principals known to the User Name Server.
getPublish() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns the publish value associated with this policy.
getQualityOfProtectionFromString(String) - Static method in class com.ibm.broker.config.proxy.TopicProxy.QoP
Returns a QoP value given a property String.
getQualityOfProtectionLevel() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the Quality of Protection level associated with this topic.
getQueueManagerName() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the name of the Queue Manager associated with this broker.
getReasonCode() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxyLoggedMQException
The reason code thrown by the WebSphere MQ Classes for Java.
getReceiver() - Method in interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getReceiver() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getReceiver() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getRegistrationDate() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the registration date for the current subscription
getRepositoryTimestamp() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the most recent repository timestamp associated with this object.
getRequiresParentUUID() - Method in class com.ibm.broker.config.proxy.ConfigurationObjectType
States whether objects of this type require parent UUIDs in order to uniquely identify them.
getSSLConnectorEnabled() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns true if and only if the SSL connector is enabled on the broker.
getSSLKeyRingFileName() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the name of the SSL Key ring file associated with this broker.
getSSLPasswordFileName() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the name of the SSL Password file associated with this broker.
getSender() - Method in interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getSender() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getSender() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getServiceInformation() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxyLoggedException
Returns some non-translated service resolution information for the current exception.
getSessionIDString() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Returns a String representation of the session Id for this connection to the Configuration Manager.
getSessionIDString() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Returns a String representation of the Session ID for this MQ Connection.
getShortDescription() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Helper method to return the short description field for the Administered Object.
getSize() - Method in class com.ibm.broker.config.proxy.LogProxy
Returns the number of LogEntry objects available to the user.
getSize() - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Returns the number of Subscription objects available to the user.
getSource() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the source field for the current log entry
getSubscribe() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns the subscribe value associated with this principal.
getSubscription(int) - Method in class com.ibm.broker.config.proxy.SubscriptionsProxy
Returns the Subscription at the supplied position in the list.
getSubscriptionFromString(String) - Static method in class com.ibm.broker.config.proxy.Subscription
Returns a new Subscription object that contains the information described in the encoded String.
getSubscriptionPoint() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the subscription point field for the current subscription
getSubscriptions(String, String, String, String, GregorianCalendar, GregorianCalendar) - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Generates a SubscriptionsProxy that represents those subscriptions fulfilling the supplied criteria.
getSupportedSSLCipherSuites() - Static method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Minimum set of supported SSL Cipher Suites
getSysQualityOfProtectionLevel() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the 'Sys' Quality of Protection level associated with this broker.
getTemporaryTopicQualityOfProtectionLevel() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns the Quality of Protection level associated with this broker's temporary topic.
getTimeOfLastCompletionCode() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the time that the completion code field was last updated, as a result of a request that was sent out by this connection to the Config Manager.
getTimeOfLastUpdate() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns the time that the object was last updated by a Config Manager publication.
getTimestamp() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns the timestamp for the current log entry
getTopicName() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the topicname field for the current subscription
getTopicName() - Method in class com.ibm.broker.config.proxy.TopicProxy
Returns the name of the topic
getTopicRoot() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the RootTopicProxy object associated with this Config Manager.
getTopology() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns the TopologyProxy object associated with this Config Manager.
getType() - Method in class com.ibm.broker.config.proxy.AccessControlEntry
Get the principal type for this entry.
getType() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Convenience method to return the type of this administered object.
getUUID() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Convenience method to return the unique identifier of this administered object.
getUser() - Method in class com.ibm.broker.config.proxy.Subscription
Returns the user field for the current subscription
getUserID() - Method in interface com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
This method is required by the Config Manager Proxy and should not be called by user applications.
getUserID() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Crosses the JNI to return the correctly formatted MQSeries userId & domain.
getUserID() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Crosses the JNI to return the correctly formatted MQSeries userId & domain.
getUserTrace() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the current state of user trace for this message flow
getUserTraceFromString(String) - Static method in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
Returns a user trace value given a property String.
getUsers() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Returns an Enumeration of all user principals known to the User Name Server.
getVersion() - Method in interface com.ibm.broker.config.proxy.DeployedObject
Returns the value of the 'version' keyword if it was embedded in the object at deploy time.
getVersion() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns the version string for this dependency as it was set at deploy time.
getVersion() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns the version string associated with the current message flow.
group - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPrincipalType
 

H

hasBeenRestrictedByConfigManager() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if the proxy has been told by the Config Manager that the object is not available for use by the current user.
hasBeenRestrictedByConfigManager(boolean) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if the proxy has been told by the Config Manager that the object is not available for use by the current user.
hasBeenUpdatedByConfigManager() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if this object handle has received at least one update publication from the Config Manager.
hasBeenUpdatedByConfigManager(boolean) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if this object handle has received at least one update publication from the Config Manager.

I

initiated - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
When querying the completion code of a deploy operation, this object states that the Config Manager has replied stating that deployment has started, but no broker responses were received before the timeout occurred.
intValue() - Method in class com.ibm.broker.config.proxy.CompletionCodeType
Returns the unique int associated with this instance.
intValue() - Method in class com.ibm.broker.config.proxy.OperationType
Returns the unique int associated with this instance.
isAwaitingSubmissionForCreation() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if the current object has been created as part of the current batch, but the batch has not yet been sent to the Config Manager.
isBatching() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns true if and only if the creation of a batch is currently in progress.
isDeployed() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if the object that this AdministeredObject represents exists in the deployed section of the Configuration Manager database.
isErrorMessage() - Method in class com.ibm.broker.config.proxy.LogEntry
Returns true if and only if the BIP message number indicates an error (that is, if the 8th character in the detail field is 'E' or 'S').
isIncompatible() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns true if and only if the Config Manager Proxy has received a message from the Configuration Manager which indicates that the Configuration Manager is unable to process requests from this Config Manager Proxy because the versions are not compatible.
isIncompatible(boolean) - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns true if and only if the Config Manager Proxy has received a message from the Configuration Manager which indicates that the Configuration Manager is unable to process requests from this Config Manager Proxy because the versions are not compatible.
isInstantiable() - Method in class com.ibm.broker.config.proxy.ConfigurationObjectType
Returns true if and only if the object refers to concrete AdministeredObject type.
isRunning() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Returns true if the broker is running.
isRunning() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns true if and only if the execution group is running.
isRunning() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns true if the Message Flow is running.
isShared() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Returns true if and only if the object that this AdministeredObject represents exists in the shared section of the Configuration Manager database.

L

LAST_ELEMENT_IN_BATCH_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The string used to delimit the elements in the String representation of a log entry.
LOGENTRY_PROPERTY_GROUP - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If an 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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property is the long description of the object.
LogEntry - class com.ibm.broker.config.proxy.LogEntry.
The LogEntry class represents an entry in the broker message log table.
LogProxy - class com.ibm.broker.config.proxy.LogProxy.
The LogProxy represents the selection of broker log entries for the current user.
log - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the log type

M

MESSAGEFLOW_ADDITIONALINSTANCES_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a MessageFlowProxy's attribute key name, the value of this property describes the 'additional instances' property of the message flow.
MESSAGEFLOW_COMMITCOUNT_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit count' property of the message flow.
MESSAGEFLOW_COMMITINTERVAL_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a MessageFlowProxy's attribute key name, the value of this property describes the 'commit interval' property of the message flow.
MESSAGEFLOW_COORDINATEDTRANSACTION_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a MessageFlowProxy's attribute key name, the value of this property is the time that the message flow was deployed.
MESSAGEFLOW_IMMEDIATE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "debug" mode.
MESSAGEFLOW_USERTRACE_NONE - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is not currently active.
MESSAGEFLOW_USERTRACE_NORMAL - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of MESSAGEFLOW_USERTRACE_PROPERTY, it means that user trace is currently on and in "normal" mode.
MESSAGEFLOW_USERTRACE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an MessageFlow's attribute key name, the value of this property describes state of user trace for the message flow.
MODIFYTIME_TIMESTAMP_FORMAT - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The format used to describe the timestamp in attributes that describe the time an object was modified.
MQConfigManagerConnectionParameters - class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters.
Allows user-written Config Manager Proxy applications to specify a set of connection parameters that can be used to connect to MQ-based Configuration Managers.
MQConfigManagerConnectionParameters(String, int, String) - Constructor for class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Takes the parameters required to connect to an MQSeries-based Config Manager.
MQConfigManagerConnectionParameters(String, int, String, String) - Constructor for class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Takes the parameters required to connect to an MQSeries-based Config Manager.
MQConfigManagerConnectionParameters(String, int, String, String, URL) - Constructor for class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Takes the parameters required to connect to an MQSeries-based Config Manager.
MQConfigManagerConnectionParameters(String, int, String, String, URL, String, String, String, String, String) - Constructor for class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Constructor.
MQConfigManagerConnectionParameters(String, int, String, String, URL, String, String, String, String, Collection) - Constructor for class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Constructor.
MQPropertyFileConfigManagerConnectionParameters - class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters.
Provides the connection parameters to a Configuration Manager by reading a properties file that contains the hostname, queue manager, port and security exit information.
MQPropertyFileConfigManagerConnectionParameters(String) - Constructor for class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Constructs a new instance that refers to connection properties in the file with the supplied fully qualified name.
MQPropertyFileConfigManagerConnectionParameters() - Constructor for class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Constructs a new instance that refers to connection properties in the file 'mqsicfgutil.ini' in the JRE's current directory.
MessageFlowDependency - class com.ibm.broker.config.proxy.MessageFlowDependency.
Represents an object deployed to an execution group that is required in order for it to process message flow logic.
MessageFlowProxy - class com.ibm.broker.config.proxy.MessageFlowProxy.
Represents a message flow that has been deployed to an execution group.
MessageFlowProxy.UserTrace - class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace.
A small structure that represents all the possible types of user trace.
messageIntegrity - Static variable in class com.ibm.broker.config.proxy.TopicProxy.QoP
Defines Message Integrity QoP.
messageflow - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the message flow type
messageset - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the v5 message set type.
modify - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to modify attributes of an object controlled by the Configuration Manager.
moveBroker(String, CollectiveProxy) - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Atomically removes the broker with the supplied name from the current collective and adds it to the supplied instance.
moveTopic(String, TopicProxy) - Method in class com.ibm.broker.config.proxy.TopicProxy
Atomically removes the topic tree with the supplied name from the current TopicProxy and adds it to the supplied instance.
multicastBackoffTimeMillis - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] NACK suppression parameter.
multicastDataPort - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The UDP data port of which multicast packets will be transmitted and received.
multicastDefaultQOS - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
Default QOS.
multicastDefaultSecurity - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
Default security mode.
multicastEnabled - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The switch for turning multicast support on or off.
multicastHeartbeatTimeoutSec - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The transmitter periodically transmits a heartbeat packet to let receivers know there is still an active stream.
multicastHistoryCleaningTimeSec - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] The period of retransmission buffer cleaning, in secs.
multicastIPv4Interface - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The name/address of the network interface over which IPv4 multicast packets will be transmitted.
multicastIPv6Interface - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
This parameter is reserved for future use.
multicastLimitTransRate - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] Denotes whether congestion control is enabled by the broker.
multicastMaxKeyAge - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] The maximum age of a key (in minutes).
multicastMaxMemoryAllowedKBytes - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The value of the multicast maximum memory allowed parameter.
multicastMaximumIPv4Address - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The highest IPv4 address that the broker could automatically allocate for multicast.
multicastMaximumIPv6Address - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
This parameter is reserved for future use.
multicastMcastSocketTTL - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
Time to Live of network packets.
multicastMinimalHistoryKBytes - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] The minimum size (in Kb) of a buffer allocated for storing the transmitted packets, kept for possible future repair requests from the receivers.
multicastMinimumIPv4Address - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
The lowest IP address that the broker could automatically allocate for multicast.
multicastMinimumIPv6Address - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
This parameter is reserved for future use.
multicastNACKAccumulationTimeMillis - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] The time (in milliseconds) NACKs are aggregated in the broker before repairs are sent.
multicastNACKCheckPeriodMillis - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] The time between periodic checks of reception status and sequence gap detection for NACK building.
multicastOverlappingTopicBehaviour - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
In the case where a subscription is made to a TSP where at a lower level in the hierarchy the following course of action would be applied.
multicastPacketBuffers - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] Number of memory buffers created upon start up for packet reception.
multicastPacketSizeBytes - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
Size of multicast packets.
multicastProtocolType - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
Denotes the type of multicast protocol in use by the broker.
multicastSocketBufferSizeKBytes - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] Size of socket receiver buffer, in Kb.
multicastTransRateLimitKbps - Variable in class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet
[ADVANCED] This limits the overall transmission rate in kilobits per second.

N

NAME_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property is the name of the object.
none - Static variable in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
States that user trace is not running.
none - Static variable in class com.ibm.broker.config.proxy.TopicProxy.QoP
States that QoP is not applied.
normal - Static variable in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
Defines normal user trace.
notRequired - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
States that a deployment request was submitted to the Configuration Manager, but the broker to which this CompletionCode refers was not sent the request because its configuration is already up to date.

O

OBJECT_DEPLOYED_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property describes whether or not the object is running.
OBJECT_RUNSTATE_RUNNING - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is running.
OBJECT_RUNSTATE_STOPPED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of OBJECT_RUNSTATE_PROPERTY, it means that the broker, message flow or execution group is stopped.
OBJECT_SHARED_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
For request reference properties, this key is always present and describes the type of operation that was requested.
OperationType - class com.ibm.broker.config.proxy.OperationType.
The OperationType type is used to describe the outcome of a Configuration Manager request that has been processed.

P

PARENT_TYPE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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.
pending - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
When querying the completion code of a deploy operation, this object states that the deploy is held in a batch and will not be sent until the user issues ConfigManagerProxy.sendUpdates().
policy - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the topic policy type
processActionResponse(AdministeredObject, CompletionCodeType, List, Properties) - Method in interface com.ibm.broker.config.proxy.AdministeredObjectListener
States that the Config Manager has processed a request that previously originated from the current connection to the Config Manager.
processActionResponse(AdministeredObject, CompletionCodeType, List, Properties, int, boolean) - Method in interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener
States that the Config Manager has processed a request that previously originated from the current connection to the Config Manager.
processDelete(AdministeredObject) - Method in interface com.ibm.broker.config.proxy.AdministeredObjectListener
States the the supplied Config Manager Administered Object has been deleted on the server.
processDelete(AdministeredObject, long) - Method in interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener
States the the supplied Config Manager Administered Object has been deleted on the server.
processModify(AdministeredObject, List, List, List) - Method in interface com.ibm.broker.config.proxy.AdministeredObjectListener
States that the supplied Config Manager Administered Object has been modified by the current or another application.
processModify(AdministeredObject, List, List, List, long) - Method in interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener
States that the supplied Config Manager Administered Object has been modified by the current or another application.

R

refresh() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Forces this AdministeredObject to reregister itself with the Configuration Manager and to re-receive the object's complete set of attributes.
register - Static variable in class com.ibm.broker.config.proxy.OperationType
States that the operation was to ask the Configuration Manager to keep the Config Manager Proxy up-to-date with changes to the current object.
registerListener(AdministeredObjectListener) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to keep the caller informed of any changes to the current AdministeredObject.
registerListener(AdvancedAdministeredObjectListener, boolean, Object) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to keep the caller informed of any changes to the current AdministeredObject, and ask to be provided with advanced notifications.
registerListener(AdvancedAdministeredObjectListener) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Config Manager to keep the caller informed of any changes to the current AdministeredObject.
removeBrokers(String[]) - Method in class com.ibm.broker.config.proxy.CollectiveProxy
Removes a list of broker UUIDs from this collective's list of members and sends the results to the Config Manager.
removeDefaultPolicy() - Method in class com.ibm.broker.config.proxy.TopicProxy
Removes the default Topic Policy.
removeDefaultPolicy() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Does nothing when applied to the topic root.
removePolicies(TopicProxy.Policy[]) - Method in class com.ibm.broker.config.proxy.TopicProxy
Removes a list of policies from this topic's list of policies and sends the results to the Config Manager.
reregister - Static variable in class com.ibm.broker.config.proxy.OperationType
This OperationType is used internally by the Config Manager Proxy and is not required by user applications.

S

SHORT_DESCRIPTION_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property is the short description of the object.
SUBCOMPONENT_PROPERTY_GROUP - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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.
Subscription - class com.ibm.broker.config.proxy.Subscription.
Each Subscription object represents a single topic subscription on a broker.
SubscriptionsProxy - class com.ibm.broker.config.proxy.SubscriptionsProxy.
Represents a query of the Configuration Manager's broker subscriptions table, and the results.
sendUpdates() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Tells the ConfigManagerProxy to send to the Config Manager all requests received since the beginUpdates() call.
sendUpdates(int) - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Tells the ConfigManagerProxy to send to the Config Manager all requests received since the beginUpdates() call.
setAccessControlEntries(AccessControlEntry[]) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Sets the list of access control entries that applies to this object.
setAdvancedConnectionParameters(String, String, String, int, int, String, byte[]) - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
Sets the 'advanced' options for a connection to MQ.
setAdvancedConnectionParameters(String, String, String, int, int, String, byte[]) - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
Sets the 'advanced' options for a connection to MQ.
setAuthenticationProtocols(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the authentication parameter for the broker.
setDefaultPolicy(TopicProxy.Policy) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the default Topic Policy.
setISysQualityOfProtectionLevel(TopicProxy.QoP) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the 'ISys' Quality of Protection level for this broker.
setInterbrokerHost(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the interbroker host associated with this broker.
setInterbrokerPort(int) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the interbroker port associated with this broker.
setLogger(String, String) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Initializes a Config Manager Proxy logger.
setLogger(String) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
If directed to gather Config Manager Proxy trace for IBM service, do not use this method - use enableTracing(String) and disableTracing() instead.
setLongDescription(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Helper method to set the long description field of the current Administered Object.
setMulticastEnabled(String) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the multicast 'enabled' value for the topic.
setMulticastEncrypted(boolean) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the multicast 'encrypted' flag for the topic.
setMulticastGroupAddress(String, String) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the multicast group addresses for the topic.
setMulticastParameters(BrokerProxy.MulticastParameterSet) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Modifies the set of Multicast parameters for this broker.
setMulticastQualityOfService(boolean) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the multicast QoS flag for the topic.
setName(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Helper method to set the name of the Administered Object.
setPersistence(String) - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Sets whether persistence is enabled.
setPrincipalName(String) - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Sets the user or group name of the principal.
setPrincipalType(String) - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Sets the type of the principal.
setProperties(Properties) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Configuration Manager to update a set of attributes for the current object.
setPublish(String) - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Sets whether publish is allowed by the policy.
setQualityOfProtectionLevel(TopicProxy.QoP) - Method in class com.ibm.broker.config.proxy.TopicProxy
Sets the Quality of Protection level for the topic.
setQueueManagerName(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the queue manager name of the broker.
setRetryCharacteristics(int, int, int) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Sets the retry characteristics for the Config Manager Proxy.
setRetryCharacteristics(long) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Sets the retry characteristics for the Config Manager Proxy.
setSSLConnectorEnabled(boolean) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Enables or disables the SSL connector on this broker.
setSSLKeyRingFileName(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the SSL key ring file parameter for the broker.
setSSLPasswordFileName(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the SSL password file parameter for the broker.
setShortDescription(String) - Method in class com.ibm.broker.config.proxy.AdministeredObject
Helper method to set the short description field of the Administered Object.
setSubscribe(String) - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Sets whether subscribe is allowed by the policy.
setSysQualityOfProtectionLevel(TopicProxy.QoP) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the 'Sys' Quality of Protection level for this broker.
setTemporaryTopicQualityOfProtectionLevel(TopicProxy.QoP) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Sets the Quality of Protection level for this broker's temporary topic.
setUUID(String) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Replaces all occurrences of the broker's UUID in the Configuration Manager repository with the supplied value.
setUserTrace(MessageFlowProxy.UserTrace) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Configures the user trace settings for every execution group under the execution group's control.
setUserTrace(MessageFlowProxy.UserTrace) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Configures the user trace settings for every deployed message flow under the execution group's control.
setUserTrace(MessageFlowProxy.UserTrace) - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Configures the user trace setting for the current flow.
source - Variable in class com.ibm.broker.config.proxy.TopologyProxy.Connection
The UUID of the source broker
start() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Requests that the messageflow.runstate attribute be set to "running", which causes the message flow to start.
startDebugSystemTrace() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Asks the Configuration Manager to start debug system trace.
startMessageFlows() - Method in class com.ibm.broker.config.proxy.BrokerProxy
Asks the Configuration Manager to start all message flows deployed to the broker.
startMessageFlows() - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Asks the broker to start all message flows in the deployed execution group.
startSystemTrace() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Asks the Configuration Manager to start system trace.
stop(boolean) - Method in class com.ibm.broker.config.proxy.MessageFlowProxy
Requests that the messageflow.runstate attribute be set to "stopped", which causes the message flow to stop.
stopMessageFlows(boolean) - Method in class com.ibm.broker.config.proxy.BrokerProxy
Asks the Configuration Manager to stop all message flows deployed to the broker.
stopMessageFlows(boolean) - Method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Invokes the stopMessageFlows() method for each Message Flow within the execution group's control.
stopSystemTrace() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Asks the Configuration Manager to stop system trace.
submitted - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
States that the deploy message was sent to the Config Manager but no 'deploy initiated' response was received from the Config Manager before the timeout occurred.
subscription - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents type subscription type
success - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
States that an operation completed successfully.
successSoFar - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
States that the Config Manager issued the deployment request and some, but not all, brokers responded with a “success” message before the timeout period expired.

T

TOPICROOT_GROUPS_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The String used to delimit a list of principals.
TOPICROOT_PUBLICGROUPS_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicRootProxy's attribute key name, the value of this property is the list of users defined in the User Name Server.
TOPIC_DEFAULTPOLICY_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicProxy's attribute key name, the value of this property is the default policy for the topic root.
TOPIC_MULTICAST_ENABLE_INHERIT - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicProxy's attribute key name, the value of this property describes whether multicast is enabled on the topic.
TOPIC_MULTICAST_ENCRYPTED_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicProxy's attribute key name, the value of this property describes the multicast encryption setting for the topic.
TOPIC_MULTICAST_GROUPADDRESS_IPV4IPV6DELIMITER - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
This constant is reserved for future use.
TOPIC_MULTICAST_GROUPADDRESS_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicProxy's attribute key name, the value of this property describes the group address of the topic.
TOPIC_MULTICAST_PROPERTY_GROUP - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The String used to separate multiple policies when described in a single String (for example, separates policy_one from policy_two).
TOPIC_PRINCIPAL_ALLOW - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is not persistent.
TOPIC_PRINCIPAL_PERSISTENT - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If the value of this constant is returned from TopicProxy.Policy.getPersistence() it means that the policy is persistent.
TOPIC_PRINCIPAL_PUBLICGROUP - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of TOPIC_QOP_PROPERTY, it means that channel integrity Quality of Protection applies.
TOPIC_QOP_ENCRYPTED - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of TOPIC_QOP_PROPERTY, it means that encrypted Quality of Protection applies.
TOPIC_QOP_MESSAGEINTEGRITY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of TOPIC_QOP_PROPERTY, it means that message integrity Quality of Protection applies.
TOPIC_QOP_NONE - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
If this is the value of TOPIC_QOP_PROPERTY, it means that no Quality of Protection applies.
TOPIC_QOP_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As a TopicProxy's attribute key name, the value of this property is the Quality of Protection setting for the topic.
TOPIC_REMOVEDPOLICIES_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
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.
TRUE - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
Various attributes use this value to mean that the specified property exists or is enabled.
TYPE_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property is the type of the object.
TopicProxy - class com.ibm.broker.config.proxy.TopicProxy.
Represents a node in the topic hierarchy.
TopicProxy.Policy - class com.ibm.broker.config.proxy.TopicProxy.Policy.
A small class that represents a policy for a given topic.
TopicProxy.Policy(String, String, String, String, String) - Constructor for class com.ibm.broker.config.proxy.TopicProxy.Policy
Creates a new Policy object.
TopicProxy.QoP - class com.ibm.broker.config.proxy.TopicProxy.QoP.
A small structure that represents all the possible types of a topic's quality of protection.
TopicRootProxy - class com.ibm.broker.config.proxy.TopicRootProxy.
Represents the root of the topic hierarchy.
TopologyProxy - class com.ibm.broker.config.proxy.TopologyProxy.
There is exactly one Topology associated with each Config Manager, and this is referenced by the TopologyProxy object.
TopologyProxy.Connection - class com.ibm.broker.config.proxy.TopologyProxy.Connection.
A small data structure representing a connection between two brokers in the topology.
target - Variable in class com.ibm.broker.config.proxy.TopologyProxy.Connection
The UUID of the target broker
toString() - Method in class com.ibm.broker.config.proxy.AccessControlEntryPermission
Return a textual representation of the permission.
toString() - Method in class com.ibm.broker.config.proxy.AccessControlEntryPrincipalType
Return a textual representation of the principal type.
toString() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Displays the type and UUID of the current object (or the name if it is available).
toString() - Method in class com.ibm.broker.config.proxy.CompletionCodeType
Returns a String representation of the instance.
toString() - Method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Displays the name of the object
toString() - Method in class com.ibm.broker.config.proxy.ConfigurationObjectType
Returns the unique classname associated with the instance.
toString() - Method in class com.ibm.broker.config.proxy.DeployResult
Returns a String representation of the overall outcome of the deploy.
toString() - Method in class com.ibm.broker.config.proxy.LogEntry
Displays information on the log entry (for trace)
toString() - Method in class com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
For diagnostic information, this method displays the current connection parameters.
toString() - Method in class com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
For diagnostic information, this method displays the current connection parameters.
toString() - Method in class com.ibm.broker.config.proxy.MessageFlowDependency
Returns a string representation of the object.
toString() - Method in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
Returns the String representation of the user trace.
toString() - Method in class com.ibm.broker.config.proxy.OperationType
Returns a String representation of the instance.
toString() - Method in class com.ibm.broker.config.proxy.Subscription
Displays information on the subscription (for trace)
toString() - Method in class com.ibm.broker.config.proxy.TopicProxy.Policy
Returns a String representation of the policy.
toString() - Method in class com.ibm.broker.config.proxy.TopicProxy.QoP
Returns the String representation of the QoP.
toString() - Method in class com.ibm.broker.config.proxy.TopicRootProxy
Displays the name of the object
toString() - Method in class com.ibm.broker.config.proxy.TopologyProxy
Displays the name of the object
toVerboseString() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Displays the list of all properties currently associated with this administered object.
topic - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the topic type
topicroot - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the root topic type
topology - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents the topology type

U

UUID_DELIMITER - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
The string used to separate the type parameter from the UUID parameter in the subcomponent properties.
UUID_LOG - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
A constant containing the unique identifier of the broker log.
UUID_PROPERTY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As an AdministeredObject attribute key name, the value of this property uniquely identifies the object within the Configuration Manager's domain.
UUID_TOPICROOT - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
A constant containing the unique identifier of the topic root.
UUID_TOPOLOGY - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
A constant containing the unique identifier of the topology.
unknown - Static variable in class com.ibm.broker.config.proxy.CompletionCodeType
New administered objects will return a getLastReturnCode() of unknown when they have never been updated by the Config Manager.
unknown - Static variable in class com.ibm.broker.config.proxy.ConfigurationObjectType
Represents an unknown configuration object type
unknown - Static variable in class com.ibm.broker.config.proxy.MessageFlowProxy.UserTrace
Defines an unknown user trace setting.
unknown - Static variable in class com.ibm.broker.config.proxy.TopicProxy.QoP
Defines an unknown QoP.
unsubscribeFromConfigurationManagerUpdates() - Method in class com.ibm.broker.config.proxy.AdministeredObject
Asks the Proxy to explicitly unsubscribe the current AdministeredObject from receiving future Configuration Manager updates.
user - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPrincipalType
 

V

VERSION_2 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Config Manager Proxy application is connected is of version 2.1 or earlier.
VERSION_5 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Config Manager Proxy application is connected is of version 5 or version 5.1 (any fixpack level).
VERSION_6 - Static variable in interface com.ibm.broker.config.proxy.AttributeConstants
As the return code from ConfigManagerProxy.getConfigManagerVersion(), this states that the version of the Configuration Manager to which the Config Manager Proxy application is connected is of version 6.
VERSION_KEYWORD - Static variable in interface com.ibm.broker.config.proxy.DeployedObject
The keyword used to denote the version of a DeployedObject.
view - Static variable in class com.ibm.broker.config.proxy.AccessControlEntryPermission
 

W

withName(String) - Static method in class com.ibm.broker.config.proxy.AdministeredObject
Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withName(String) - Static method in class com.ibm.broker.config.proxy.BrokerProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withName(String) - Static method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withName(String) - Static method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withName(String) - Static method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withName(String) - Static method in class com.ibm.broker.config.proxy.TopicProxy
Returns a new Properties object that has the Name attribute set to the supplied String, and the type attribute to be the name of the Topic class.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.AdministeredObject
Returns a new Properties object that has the UUID attribute set to the supplied String, and (for subclass implementations) the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.BrokerProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.CollectiveProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.ConfigManagerProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.ExecutionGroupProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.MessageFlowProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
withUUID(String) - Static method in class com.ibm.broker.config.proxy.TopicProxy
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the Topic class.

A B C D E F G H I L M N O P R S T U V W
WBI BrokersTM
Config Manager Proxy API