com.ibm.broker.config.proxy

Class ServiceFederationManagerProxy


  • Deprecated.

    public class ServiceFederationManagerProxy
    extends AdministeredObject
    Provides access to Service Federation Management specific objects and methods within an execution group.

    Single instance per execution group is retrieved by using ExecutionGroupProxy.getServiceFederationManagerProxy() Note that this will return null if Service Federation Management not configured to be enabled in the Broker.

    Given that 'eg' is a connected ExecutionGroupProxy instance, then to return the ServiceFederationManagerProxy for that execution group:

    ServiceFederationManagerProxy sfmProxy = eg.getServiceFederationManagerProxy();
    if (null != sfmProxy) { ... }

    com.ibm.broker.config.proxy.ServiceFederationManagerProxy

    Responsibilities Provides a container of all Service Federation Manager objects within an execution group, including ServiceGroupProxyItem and ServiceProxyItem.
    Internal Collaborators com.ibm.broker.config.proxy.ExecutionGroupProxy
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     54148.6  2009-08-11  HDMJB           v7 Release
     
     
    • Method Detail

      • getConfigurationObjectTypeOfParent

        public ConfigurationObjectType getConfigurationObjectTypeOfParent()
        Deprecated. 
        Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
        Specified by:
        getConfigurationObjectTypeOfParent in class AdministeredObject
        Returns:
        ConfigurationObjectType associated with the logical parent of this class.
      • toString

        public java.lang.String toString()
        Deprecated. 
        Displays the name of the current object. The format is not guaranteed, and therefore should not be parsed programatically.
        Overrides:
        toString in class AdministeredObject
        Returns:
        String Representation of the current object
      • setShortDescription

        public void setShortDescription(java.lang.String desc)
                                 throws ConfigManagerProxyLoggedException
        Deprecated. 
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the short description of the Service Federation Manager.
        Overrides:
        setShortDescription in class AdministeredObject
        Parameters:
        desc - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.
      • setLongDescription

        public void setLongDescription(java.lang.String desc)
                                throws ConfigManagerProxyLoggedException
        Deprecated. 
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the long description of the Service Federation Manager.
        Overrides:
        setLongDescription in class AdministeredObject
        Parameters:
        desc - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.
      • getRuntimePropertyNames

        public java.lang.String[] getRuntimePropertyNames()
        Deprecated. 
        Returns a string array of all runtime 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
        Deprecated. 
        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.
      • setRuntimeProperty

        public void setRuntimeProperty(java.lang.String objectAndPropertyName,
                                       java.lang.String propertyValue)
                                throws ConfigManagerProxyLoggedException,
                                       java.lang.IllegalArgumentException
        Deprecated. 
        Asks the broker to configure an arbitrary service federation manager 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 properties the objectAndPropertyName parameter must 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, "This/maxWaitTime" would request a change to the Service Federation Managers maxWaitTime 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.
      • createServiceGroupProxyItem

        public ServiceGroupProxyItem createServiceGroupProxyItem(java.lang.String groupProxyName,
                                                                 java.util.Properties suppliedProps)
                                                          throws ConfigManagerProxyLoggedException,
                                                                 ConfigManagerProxyPropertyNotInitializedException
        Deprecated. 
        Asks the broker to create a Service Group Proxy of the supplied name, with the passed properties in the ServiceFederationManagerProxy for the owning Execution Group. If a ServiceGroupProxyItem already exists in the owning execution group with the supplied name, the existing ServiceGroupProxyItem is returned.
        Parameters:
        groupProxyName -
        suppliedProps -
        Returns:
        ServiceGroupProxyItem that represents the created Service Group Proxy
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker. 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. The user can override the timeout via BrokerProxy.setSynchronous(t)
        ConfigManagerProxyPropertyNotInitializedException
      • setProperties

        public void setProperties(java.util.Properties suppliedProps)
                           throws ConfigManagerProxyLoggedException
        Deprecated. 
        Asks the broker to sets multiple ServiceFederationManagerProxy properties in single request to the broker. Each key/value pair of the supplied Properties object must be a property name and value that can be set on the current ServiceFederationManagerProxy, using the same format as expected by the ServiceFederationManagerProxy.setProperty() method.
        Overrides:
        setProperties in class AdministeredObject
        Parameters:
        suppliedProps - Object containing the key/value pair of properties to set.
        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.