com.ibm.broker.config.proxy

Class SharedLibraryProxy

  • All Implemented Interfaces:
    DeployableObject, DeployedObject


    public class SharedLibraryProxy
    extends LibraryProxy

    Each shared library deployed to an execution group can be represented by a SharedLibraryProxy.

    In order to use SharedLibraryProxy 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");
         SharedLibraryProxy shlib = e.getSharedLibraryByName("aSharedLibrary");
     

    com.ibm.broker.config.proxy.SharedLibraryProxy 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 shared 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.
      • getMessageFlow

        @Deprecated
        public MessageFlowProxy getMessageFlow(java.util.Properties props)
                                                    throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. Shared libraries do not support message flows - do not call this method.
        Shared libraries do not support message flows. Calling this method on a SharedLibraryProxy object will always return a null object.
        Overrides:
        getMessageFlow in class DeployedObjectGroupProxy
        Parameters:
        props - Filter to select the MessageFlowProxy 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 message flow deployed to this deployed object group.
        Returns:
        MessageFlowProxy a null object is always returned.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getMessageFlows

        @Deprecated
        public java.util.Enumeration<MessageFlowProxy> getMessageFlows(java.util.Properties filter)
                                                                            throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. Shared libraries do not support message flows - do not call this method.
        Shared libraries do not support message flows. Calling this method on a SharedLibraryProxy object will always return an empty enumeration.
        Overrides:
        getMessageFlows in class DeployedObjectGroupProxy
        Parameters:
        filter - Filter to select which message flows 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 message flows directly deployed to this deployed object group,
        Returns:
        Enumeration an empty enumeration is always returned.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • setAllMessageFlowsRuntimeProperty

        @Deprecated
        public void setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
                                                                  java.lang.String propertyValue)
                                                           throws ConfigManagerProxyLoggedException,
                                                                  java.lang.IllegalArgumentException
        Deprecated. Shared libraries do not support message flows - do not call this method.
        Shared libraries do not support message flows. Calling this method on a SharedLibraryProxy object will always throw an exception.
        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 - is always thrown as this method is unsupported on a SharedLibraryProxy object.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not a valid syntax.
      • setAllMessageFlowsRuntimeProperties

        @Deprecated
        public void setAllMessageFlowsRuntimeProperties(java.util.Properties props)
                                                             throws ConfigManagerProxyLoggedException,
                                                                    java.lang.IllegalArgumentException
        Deprecated. Shared libraries do not support message flows - do not call this method.
        Shared libraries do not support message flows. Calling this method on a SharedLibraryProxy object will always throw an exception.
        Specified by:
        setAllMessageFlowsRuntimeProperties in class DeployedObjectGroupProxy
        Parameters:
        props - A set of properties to set on all message flows owned by the object group. 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 - is always thrown as this method is unsupported on a SharedLibraryProxy object.
        java.lang.IllegalArgumentException - if objectAndPropertyName is not a valid syntax.