com.ibm.broker.config.proxy

Class ExecutionGroupProxy



  • public class ExecutionGroupProxy
    extends DeployedObjectGroupProxy

    Each Integration server associated with a broker can be represented by an ExecutionGroupProxy.

    In order to use ExecutionGroupProxy objects, applications must first obtain handles to them. Here is an example of how to do this:

         BrokerProxy b = BrokerProxy.getInstance(
             new IntegrationNodeConnectionParameters("localhost", 4414)); 
         ExecutionGroupProxy e = b.getExecutionGroupByName("default");
     

    com.ibm.broker.config.proxy.ExecutionGroupProxy extends com.ibm.broker.config.proxy.AdministeredObject

    Responsibilities Acts as a container of deployed message flows. Provides the ability to deploy information to the integration server represented by each instance.
    Internal Collaborators com.ibm.broker.config.proxy.MessageFlowProxy
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     25103.7  2004-03-18  HDMPL           v6 Release
     45112.7  2007-07-30  HDMPL           v6.1 release:
                                             Methods now return genericized types where relevant 
                                             Added getQueues()
                                             Added getNodeTypes()
                                             Added setRuntimeProperty(String, String)
                                             Added getRuntimeProperty(String)
                                             Added getRuntimePropertyNames()
                                             Added getDeployedPolicySetBindingsNames()
                                             Added getDeployedPolicySetNames()
     51619    2008-08-20  HDMPL          v7 release:
                                             Deprecated immediate parameter on stopMessageFlows()
                                             Deprecated methods related to ACLs
                                             Added setServiceTrace()
                                             Added getLocalInstance()
                                             Added start()
                                             Added stop()
                                             Added setResourceStatisticsEnabled()
                                             Added getResourceStatisticsEnabled()
                                             Added getDebugPort()
                                             Added setDebugPort()
                                             Added isDebugPortActive()
     54148.6  2009-08-05  HDMJB              Added getServiceFederationManager()
     80006.2  2011-04-10  HDCAB          v8 release:
                                             Inherit from DeployedObjectGroupProxy
                                             Added getApplications()
                                             Added getApplication()
                                             Added getApplicationByName()
                                             Added getLibraries()
                                             Added getLibrary()
                                             Added getLibraryByName()
                                             Added startApplications()
                                             Added stopApplications()
                                             Added getResourceManagers()
                                             Added getResourceManagerByName()
     80006.8  2011-10-10  HDDJS              Added getDataCapture() methods
    
     
    • Method Detail

      • getLocalInstance

        public static ExecutionGroupProxy getLocalInstance()
                                                    throws ConfigManagerProxyLoggedException
        Returns the ExecutionGroupProxy object that represents the integration server in which the current application is deployed. This method must only be called when the current application is deployed as a JavaCompute node or Java User Defined Node. If the current application is not deployed inside an integration server, a ConfigManagerProxyLoggedException is thrown.

        When deploying an IBM Integration API (CMP) application inside a Java node, take care when using methods that might affect the message flow in which the IBM Integration API application is running; for example, stopping, deleting or redeploying the message flow. As the IBM Integration API application can never receive notifications that such operations have successfully completed, their use in such scenarios is not recommended.

        Throws:
        ConfigManagerProxyLoggedException - if the application is not deployed inside an integration server.
      • isRunning

        public boolean isRunning()
                          throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if both the integration server is configured to run as reported by isRunEnabled() and the parent integration node is running. isRunEnabled() can return true even if the integration node is stopped. isRunning() does not show whether the integration server is processing messages; use Accounting and Statistics to check whether messages are being processed.
        Returns:
        boolean True if both the integration server is configured to run and the parent integration node is running.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.
      • isRunEnabled

        public boolean isRunEnabled()
                             throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if the integration server is able to run when the broker is started. This method reports the logical runstate of the integration server, which means that it can return 'true' even if the broker in which the integration server is defined is currently stopped. Use isRunning() to report whether the integration server is currently running.
        Returns:
        boolean True if and only if the integration server is able to run when the broker is started.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.
      • stop

        public void stop()
                  throws ConfigManagerProxyLoggedException
        Asks the broker to stop the integration server process. The current run state of the message flows will be remembered: stopping the integration server process will cause all message flows to finish, but any subsequent call to this integration server's start() method will cause only those message flows that were running at the time of this stop() invocation to be restarted. Consider using ExecutionGroupProxy.stopMessageFlows() to stop all message flows but keep the integration server process running.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • start

        public void start()
                   throws ConfigManagerProxyLoggedException
        Asks the broker to start the integration server process. Only those message flows that were running when the integration server process was last stopped will be restarted. All other message flows will remain stopped until they are explicitly started.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • setServiceTrace

        public void setServiceTrace(MessageFlowProxy.UserTrace newTrace)
                             throws ConfigManagerProxyLoggedException
        Configures the service trace setting for the integration server.
        Parameters:
        newTrace - One of:
        • MessageFlowProxy.UserTrace.normal to enable normal service trace
        • MessageFlowProxy.UserTrace.debug to enable debug service trace
        • MessageFlowProxy.UserTrace.none to disable service trace
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • withUUID

        public static java.util.Properties withUUID(java.lang.String uuid)
        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. This provides an easy way of supplying filters to the get*() calls. For example, broker1.getExecutionGroup(ExecutionGroup.withUUID("1234")); will return the integration server with UUID "1234" that exists in broker1.
        Returns:
        java.util.Properties a new Properties object with the relevant key/value pairs set.
      • withName

        public static java.util.Properties withName(java.lang.String name)
        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. This provides an easy way of supplying filters to the get*() calls. For example, broker1.getManagedSubcomponent(ExecutionGroup.withName("eg1")); will return the integration server with Name "eg1" that exists in broker1.
        Returns:
        java.util.Properties a new Properties object with the relevant key/value pairs set.
      • getAccessControlEntries

        public AccessControlEntry[] getAccessControlEntries()
        Deprecated. This method is unique to Configuration Manager connections, and as such is no longer used as of WebSphere Message Broker V7.
        This method returns an array with no elements.
      • setRuntimeProperty

        public void setRuntimeProperty(java.lang.String objectAndPropertyName,
                                       java.lang.String propertyValue)
                                throws ConfigManagerProxyLoggedException,
                                       java.lang.IllegalArgumentException
        Asks the broker to configure an arbitrary integration server property. The set of properties configurable using this method are those that can be manipulated using the mqsichangeproperties command that has the -e flag specified.

        To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the integration server's user trace level property. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.

        The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.

        Parameters:
        objectAndPropertyName - The complete object and property name of the property being manipulated
        propertyValue - The new value to associate with the property
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not of a valid syntax.
      • setAllMessageFlowsRuntimeProperty

        public void setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
                                                      java.lang.String propertyValue)
                                               throws ConfigManagerProxyLoggedException,
                                                      java.lang.IllegalArgumentException
        Asks the broker to configure an arbitrary property of all message flows owned by the integration server.

        To set runtime properties that affect the broker, use BrokerProxy.setRuntimeProperty(). To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the integration server's user trace level property. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.

        The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.

        Specified by:
        setAllMessageFlowsRuntimeProperty in class DeployedObjectGroupProxy
        Parameters:
        objectAndPropertyName - The complete object and property name of the property being manipulated
        propertyValue - The new value to associate with the property
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not a valid syntax.
      • setAllMessageFlowsRuntimeProperties

        public void setAllMessageFlowsRuntimeProperties(java.util.Properties props)
                                                 throws ConfigManagerProxyLoggedException,
                                                        java.lang.IllegalArgumentException
        Asks the broker to configure an arbitrary set of properties of all message flows owned by the integration server.

        To set runtime properties that affect the broker, use BrokerProxy.setRuntimeProperty(). To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the integration server's user trace level property. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.

        The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.

        Specified by:
        setAllMessageFlowsRuntimeProperties in class DeployedObjectGroupProxy
        Parameters:
        props - A set of properties to set on all message flows owned by the integration server. The key is the complete object and property name of the property being manipulated. The value is the new value to associate with the property
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not a valid syntax.
      • getRuntimePropertyNames

        public java.lang.String[] getRuntimePropertyNames()
        Returns a string array of all runtime configurable service properties associated with this object. Use getRuntimeProperty() to get the current value associated with a given property and setRuntimeProperty() to set it. Each String is of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters of mqsireportproperties. The '/' character that separates the two values is defined in AttributeConstants.OBJECT_NAME_DELIMITER.
        Returns:
        String[] containing configurable service property names that have been defined on the broker
      • getRuntimeProperty

        public java.lang.String getRuntimeProperty(java.lang.String objectAndPropertyName)
                                            throws ConfigManagerProxyPropertyNotInitializedException,
                                                   java.lang.IllegalArgumentException
        Returns the value of the runtime property with the supplied name. The set of properties discoverable in this way are those reported by the getRuntimePropertyNames() method.

        If you wish to directly look up a specific named property, use constants defined in the AttributeConstants interface wherever possible. If a constant does not exist, the objectAndpropertyName parameter can be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.

        Parameters:
        objectAndPropertyName - The name of the property to be reported
        Returns:
        String The value of the supplied property. A value of null means that the property does not exist or has not been set on the broker.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the property could not be determined because the information was not supplied from the broker before a timeout occurred.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not a valid syntax.
      • getResourceStatisticsEnabled

        public boolean getResourceStatisticsEnabled(java.lang.String resourceType)
                                             throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if statistics gathering is enabled for the resource type of the supplied name. The list of resource types can be obtained using BrokerProxy.getResourceTypeNames(). If the supplied String is null, the method will return true if statistics gathering is enabled for ANY of the integration server's resource types. If a resource type of the supplied name cannot be found, false is returned.
        Parameters:
        resourceType - Name of the resource type to show statistics for, or null.
        Returns:
        boolean
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the setting could not be determined because the information was not supplied from the broker before a timeout occurred.
      • setResourceStatisticsEnabled

        public void setResourceStatisticsEnabled(java.lang.String resourceType,
                                                 boolean isEnabled)
                                          throws ConfigManagerProxyPropertyNotInitializedException,
                                                 ConfigManagerProxyLoggedException
        Enables or disables resources statistics gathering for the supplied resource type. If the supplied String is null, the method will enable or disable statistics gathering for all of the integration server's resource types.
        Parameters:
        resourceType - Name of the resource type to modify, or null.
        isEnabled - True to enable resource-level statistics for the supplied resource type, or false to disable.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
        ConfigManagerProxyPropertyNotInitializedException - if the list of all resource types could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getServiceFederationManager

        public ServiceFederationManagerProxy getServiceFederationManager()
                                                                  throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. 
        Returns this integration server's ServiceFederationManagerProxy object if Service Federation is enabled.
        Returns:
        null or a ServiceFederationManagerProxy containing all Service Federation Management objects, ServiceGroupProxyItem, ServiceProxyItem owned by this integration server. Will return null if Service Federation Management is not enabled in the Broker.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the Service Federation Management object could not be retrieved because the information was not supplied from the broker before a timeout occurred.
      • getDebugPort

        public int getDebugPort()
                         throws ConfigManagerProxyPropertyNotInitializedException
        Returns the configured value of the debug port associated with the current integration server, or 0 if the debug port has not been configured.

        A non-zero value does not mean that the debug port is currently enabled. Use isDebugPortEnabled() to determine whether or not the debug port is currently enabled and listening.

        Note: This method is functionally equivalent to getRuntimeProperty(AttributeConstants.EG_COMIBMJVMMANAGER_JVMDEBUGPORT_PROPERTY) followed by with a conversion to an int. Use getRuntimeProperty(AttributeConstants.EG_COMIBMJVMMANAGER_JVMDEBUGPORTACTIVEVALUE_PROPERTY) to return the actual value in use.

        Returns:
        int The configured value of the debug port, or 0 if the debug port has not been configured.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the setting could not be determined because the information was not supplied from the broker before a timeout occurred.
      • isDebugPortActive

        public boolean isDebugPortActive()
                                  throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if a debug port has been configured for the current execution group AND that the debug port is currently listening. Use getDebugPort() to return the configured value of the debug port.
        Returns:
        boolean whether the debug port is currently active.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the setting could not be determined because the information was not supplied from the broker before a timeout occurred.
      • setDebugPort

        public void setDebugPort(int newPortValue)
                          throws ConfigManagerProxyPropertyNotInitializedException,
                                 ConfigManagerProxyLoggedException
        Configures the value of the debug port for the integration server. A non-zero value is the value of the TCP/IP port on which the debugger should listen. A value of 0 means that the debugger will be disabled for the integration server.

        Note that enabling debug can significantly reduce the performance of the integration server.

        After changing the value of the debug port, the integration server must be restarted in order for the new value to take effect. To do this using the IBM Integration API (CMP), use ExecutionGroupProxy.stop() followed by ExecutionGroupProxy.start().

        A single integration server must have a unique port on any given machine, and that port cannot be used by any other process, integration server or broker on that machine. If the configured port is already in use when the integration server starts, the debugger will not be enabled for that integration server and isDebugPortActive() will return false.

        Parameters:
        newPortValue - The TCP/IP port on which the debugger should listen, or 0 to disable the debugger.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
        ConfigManagerProxyPropertyNotInitializedException - if the list of all resource managers could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getApplications

        public java.util.Enumeration<ApplicationProxy> getApplications(java.util.Properties filter)
                                                                throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the ApplicationProxy objects that match the filter specified by the Properties argument.
        Parameters:
        filter - Filter to select which applications to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all applications deployed to this integration server.
        Returns:
        Enumeration The ApplicationProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if application information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getApplication

        public ApplicationProxy getApplication(java.util.Properties props)
                                        throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first ApplicationProxy object that matches the filter specified by the Properties argument. If multiple applications match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the ApplicationProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary application deployed to this integration server.
        Returns:
        ApplicationProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if application information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getApplicationByName

        public ApplicationProxy getApplicationByName(java.lang.String applicationName)
                                              throws ConfigManagerProxyPropertyNotInitializedException
        Returns the ApplicationProxy object with the supplied name, or null if an application of that name does not exist or if the supplied argument was null.
        Parameters:
        applicationName - Name of the application to look up
        Returns:
        ApplicationProxy Object representing the named application
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if application information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getRestApis

        public java.util.Enumeration<RestApiProxy> getRestApis(java.util.Properties filter)
                                                        throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the RestApiProxy objects that match the filter specified by the Properties argument.
        Parameters:
        filter - Filter to select which REST APIs to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all REST APIs deployed to this integration server.
        Returns:
        Enumeration The RestApiProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if REST API information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getRestApi

        public RestApiProxy getRestApi(java.util.Properties props)
                                throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first RestApiProxy object that matches the filter specified by the Properties argument. If multiple REST APIs match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the RestApiProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary REST API deployed to this integration server.
        Returns:
        RestApiProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if REST API information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getRestApiByName

        public RestApiProxy getRestApiByName(java.lang.String restApiName)
                                      throws ConfigManagerProxyPropertyNotInitializedException
        Returns the RestApiProxy object with the supplied name, or null if an REST API of that name does not exist or if the supplied argument was null.
        Parameters:
        restApiName - Name of the REST API to look up
        Returns:
        RestApiProxy Object representing the named REST API
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if REST API information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getLibraries

        @Deprecated
        public java.util.Enumeration<LibraryProxy> getLibraries(java.util.Properties filter)
                                                                     throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. As of Integration Bus V10, libraries have been renamed to static libraries. Use getStaticLibraries instead.
        Returns an Enumeration of all the LibraryProxy objects that match the filter specified by the Properties argument.
        Parameters:
        filter - Filter to select which libraries to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all libraries deployed to this integration server.
        Returns:
        Enumeration The LibraryProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getLibrary

        @Deprecated
        public LibraryProxy getLibrary(java.util.Properties props)
                                            throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. As of Integration Bus V10, libraries have been renamed to static libraries. Use getStaticLibrary instead.
        Returns the first LibraryProxy object that matches the filter specified by the Properties argument. If multiple libraries match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the LibraryProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary library deployed to this integration server.
        Returns:
        LibraryProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getLibraryByName

        @Deprecated
        public LibraryProxy getLibraryByName(java.lang.String libraryName)
                                                  throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. As of Integration Bus V10, libraries have been renamed to static libraries. Use getStaticLibraryByName instead.
        Returns the LibraryProxy object with the supplied name, or null if an library of that name does not exist or if the supplied argument was null.
        Parameters:
        libraryName - Name of the library to look up
        Returns:
        LibraryProxy Object representing the named library
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getStaticLibraries

        public java.util.Enumeration<StaticLibraryProxy> getStaticLibraries(java.util.Properties filter)
                                                                     throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the StaticLibraryProxy objects that match the filter specified by the Properties argument.
        Parameters:
        filter - Filter to select which static libraries to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all static libraries deployed to this integration server.
        Returns:
        Enumeration The StaticLibraryProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if static library information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getStaticLibrary

        public StaticLibraryProxy getStaticLibrary(java.util.Properties props)
                                            throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first StaticLibraryProxy object that matches the filter specified by the Properties argument. If multiple static libraries match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the StaticLibraryProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary static library deployed to this integration server.
        Returns:
        StaticLibraryProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if static library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getStaticLibraryByName

        public StaticLibraryProxy getStaticLibraryByName(java.lang.String staticLibraryName)
                                                  throws ConfigManagerProxyPropertyNotInitializedException
        Returns the StaticLibraryProxy object with the supplied name, or null if an static library of that name does not exist or if the supplied argument was null.
        Parameters:
        staticLibraryName - Name of the static library to look up
        Returns:
        StaticLibraryProxy Object representing the named static library
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if static library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getSharedLibraries

        public java.util.Enumeration<SharedLibraryProxy> getSharedLibraries(java.util.Properties filter)
                                                                     throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the SharedLibraryProxy objects that match the filter specified by the Properties argument.
        Parameters:
        filter - Filter to select which shared libraries to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all shared libraries deployed to this integration server.
        Returns:
        Enumeration The SharedLibraryProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if shared library information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getSharedLibrary

        public SharedLibraryProxy getSharedLibrary(java.util.Properties props)
                                            throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first SharedLibraryProxy object that matches the filter specified by the Properties argument. If multiple shared libraries match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the SharedLibraryProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary shared library deployed to this integration server.
        Returns:
        SharedLibraryProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if shared library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getSharedLibraryByName

        public SharedLibraryProxy getSharedLibraryByName(java.lang.String sharedLibraryName)
                                                  throws ConfigManagerProxyPropertyNotInitializedException
        Returns the SharedLibraryProxy object with the supplied name, or null if an shared library of that name does not exist or if the supplied argument was null.
        Parameters:
        sharedLibraryName - Name of the shared library to look up
        Returns:
        SharedLibraryProxy Object representing the named shared library
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if shared library information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getMessageFlowByName

        public MessageFlowProxy getMessageFlowByName(java.lang.String messageFlowName,
                                                     java.lang.String applicationName,
                                                     java.lang.String libraryName)
                                              throws ConfigManagerProxyPropertyNotInitializedException
        Returns the MessageFlowProxy object with the supplied name in the named application and libary, or null if a flow of that name does not exist at the given location or if the supplied messageFlowName argument was null.
        Parameters:
        messageFlowName - Name of the message flow to look up
        applicationName - Name of the application in which to look for the flow, or null if the flow is not in an application.
        libraryName - Name of the library in which to look for the flow, or null if the flow is not in a library
        Returns:
        MessageFlowProxy Object representing the named message flow
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • startApplications

        public void startApplications()
                               throws ConfigManagerProxyLoggedException
        Asks the broker to start all applications in the deployed integration server. The integration server process is assumed to be running; use ExecutionGroupProxy.start() to start the integration server process.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • startApplications

        public void startApplications(boolean includeExecutionGroupFlows)
                               throws ConfigManagerProxyLoggedException
        Asks the broker to start all applications in the deployed integration server. The integration server process is assumed to be running; use DeployedObjectGroupProxy.start() to start the integration server process.
        Parameters:
        includeExecutionGroupFlows - Indicates if the request is to include flows at the integration server level. Therefore if true is specified this means that all flows will be started throughout the integration server.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • stopApplications

        public void stopApplications()
                              throws ConfigManagerProxyLoggedException
        Stops all applications in the integration server, but allows the integration server process to continue to run. All applications deployed to the broker will be stopped once they have finished their current unit of work. Alternatively, consider using DeployedObjectGroupProxy.stop() to stop the integration server process.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • stopApplications

        public void stopApplications(boolean includeExecutionGroupFlows)
                              throws ConfigManagerProxyLoggedException
        Stops all applications in the integration server, but allows the integration server process to continue to run. All applications deployed to the broker will be stopped once they have finished their current unit of work. Alternatively, consider using DeployedObjectGroupProxy.stop() to stop the integration server process.
        Parameters:
        includeExecutionGroupFlows - Indicates if the request is to include flows at the integration server level. Therefore if true is specified this means that all flows will be started throughout the integration server.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. If synchronous updates have been enabled using BrokerProxy.setSynchronous(), subclasses of this exception type will also be thrown if the request is rejected by the broker, or if the request is not processed before a timeout occurs.
      • getResourceManagers

        public java.util.Enumeration<ResourceManagerProxy> getResourceManagers(java.util.Properties props)
                                                                        throws ConfigManagerProxyPropertyNotInitializedException

        Returns an enumeration of all the ResourceManagerProxy objects that match the filter specified by the Properties argument.

        Parameters:
        props - Filter to select the ResourceManagerProxy to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all resourcemanagers of this integration server.
        Returns:
        Enumeration The ResourceManagerProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getServices

        public java.util.Enumeration<ServiceInterface> getServices(java.util.Properties filter)
                                                            throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the ServiceInterface objects that match the filter specified by the Properties argument. These will be ApplicationProxy objects that implement services.
        Parameters:
        filter - Filter to select which applications to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all applications deployed to this integration servers.
        Returns:
        Enumeration The ServiceInterface objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if service information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getService

        public ServiceInterface getService(java.util.Properties props)
                                    throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first ServiceInterface object that matches the filter specified by the Properties argument. If multiple services match the supplied filter, an arbitrary match is returned.
        Parameters:
        props - Filter to select the service Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary service deployed to this integration servers.
        Returns:
        ServiceInterface The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if service information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getServiceByName

        public ServiceInterface getServiceByName(java.lang.String serviceName)
                                          throws ConfigManagerProxyPropertyNotInitializedException
        Returns the ServiceInterface object with the supplied name, or null if a service of that name does not exist or if the supplied argument was null.
        Parameters:
        serviceName - Name of the service to look up
        Returns:
        ServiceInterface Object representing the named service
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if service information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • execute

        public AdminQueueEntry execute(java.lang.String action,
                                       java.util.Properties actionParameters,
                                       java.lang.String objectName,
                                       java.util.Properties objectProperties)
                                throws ConfigManagerProxyLoggedException
        Asks the broker to execute an action against this execution group.
        Parameters:
        action - the action to execute
        actionParameters - parameters to apply to the action
        objectName - optional objectName to which to apply the action.
        objectProperties - properties that are applied to the object
        Returns:
        AdminQueueEntry that contains the progress/results of the action.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker, or (only if synchronous updates have been enabled) the request was not successfully processed by the broker.
        ConfigManagerProxyRequestTimeoutException - if synchronous updates have been enabled and a response was not received by the broker before a timeout occurred. (Note that this exception type extends ConfigManagerProxyLoggedException).
        ConfigManagerProxyRequestFailureException - if synchronous updates have been enabled and the request was rejected by the broker. (Note that this exception type extends ConfigManagerProxyLoggedException).
      • setInjectionMode

        public void setInjectionMode(java.lang.String newInjectionMode)
                              throws ConfigManagerProxyLoggedException
        Configures the injection mode setting for this integration server.

        When injection is enabled you can inject messages using injectTestData.

        Parameters:
        newInjectionMode - One of:
        • AttributeConstants.MODE_ENABLED
        • AttributeConstants.MODE_DISABLED
        Throws:
        ConfigManagerProxyLoggedException
      • clearRecordedTestData

        public void clearRecordedTestData(java.lang.String appName,
                                          java.lang.String libName,
                                          java.lang.String flowName)
                                   throws ConfigManagerProxyPropertyNotInitializedException
        Clear recorded test data for the specified resources.
        Parameters:
        appName - specifies the application to clear recorded data from
        libName - specifies the library to clear recorded data from
        flowName - specifies the message flow to clear recorded data from
        Throws:
        ConfigManagerProxyPropertyNotInitializedException
      • setDataCapturePolicyUriForRecording

        public void setDataCapturePolicyUriForRecording(java.lang.String dataCapturePolicyUriForRecording)
                                                 throws ConfigManagerProxyLoggedException
        Configures the data capture policy uri for recording for the integration server.
        Parameters:
        dataCapturePolicyUriForRecording - The uri of where the Data Capture policy for recording is defined.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • setDataCapturePolicyUriForViewing

        public void setDataCapturePolicyUriForViewing(java.lang.String dataCapturePolicyUriForViewing)
                                               throws ConfigManagerProxyLoggedException
        Configures the data capture policy uri for viewing for the integration server.
        Parameters:
        dataCapturePolicyUriForViewing - The uri of where the Data Capture policy for viewing is defined.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.