com.ibm.broker.config.proxy

Class StaticLibraryProxy

  • All Implemented Interfaces:
    DeployableObject, DeployedObject


    public class StaticLibraryProxy
    extends LibraryProxy

    Each static library deployed to an execution group can be represented by a StaticLibraryProxy.

    In order to use StaticLibraryProxy 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");
         StaticLibraryProxy shlib = e.getStaticLibraryByName("aStaticLibrary");
     

    com.ibm.broker.config.proxy.StaticLibraryProxy extends com.ibm.broker.config.proxy.LibraryProxy extends com.ibm.broker.config.proxy.DeployedObjectGroupProxy implements com.ibm.broker.config.proxy.DeployedObject

    Responsibilities Acts as a container of deployed message flows. Provides the ability to deploy information to the static library represented by each instance.
    Internal Collaborators com.ibm.broker.config.proxy.MessageFlowProxy
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     80006.1  2011-04-10  HDCAB           Initial creation
    
     
    • Method Detail

      • 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.
      • 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.
      • 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 static library.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.

        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 static library.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.

        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 static library. 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.