com.ibm.broker.config.proxy

Class ServiceGroupProxyItem

  • java.lang.Object
    • com.ibm.broker.config.proxy.ServiceGroupProxyItem

  • Deprecated.

    public class ServiceGroupProxyItem
    extends java.lang.Object
    Provides access to a Service Federation Management "Service Group Proxy" Item.

    Instances are created or retrieved from an execution group's ServiceFederationManagerProxy and are not modified by the IBM Integration API (CMP) once they have been instantiated. If any Service Federation Management objects or properties are subsequently modified, change notifications will only be sent to AdministeredObjectListeners of the ServiceFederationManagerProxy, and this object will contain out-of-date information. At this point this object should be re-obtained.

    Given that 'sfmp' is a ServiceFederationManagerProxy obtain from a connected ExecutionGroupProxy instance, then to create a new ServiceGroupProxyItem instance use:

    ServiceGroupProxyItem sgpi = sfmp.createServiceGroupProxy(...);
    To retrieve an enumeration of all the ServiceGroupProxyItem objects:
    Enumeration sgpis = sfmp.getServiceGroupProxys();
    To retrieve a named ServiceGroupProxyItem object use:
    ServiceGroupProxyItem sgpi = sfmp.getServiceGroupProxyByName(groupProxyName);

    com.ibm.broker.config.proxy.ServiceGroupProxyItem
    Responsibilities Provides a Service Federation Management "Service Group Proxy" Item holding the properties of the Group and providing methods for creating and managing contained "Service Proxy" Items.
    Internal Collaborators com.ibm.broker.config.proxy.ServiceFederationManager
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     54148.n  2009-08-05  HDMJB           v7 Release
     
     
    • Method Detail

      • delete

        public void delete()
                    throws ConfigManagerProxyLoggedException
        Deprecated. 
        Asks the broker to delete this ServiceGroupProxyItem Note that deleting a ServiceGroupProxyItem implicitly deletes all ServiceProxyItems belonging to this group, and stops and removes their service proxy in the runtime
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • start

        public void start()
                   throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the adminState of the ServiceGroupProxyItem to true. If necessary, ServiceProxyItems are started. While in this state, any ServiceProxyItems that are created are started.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • stop

        public void stop()
                  throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the adminState of the ServiceGroupProxyItem to false. If necessary, ServiceProxyItems are stopped. While in this state, any ServiceProxyItems that are created are not started.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • setProperties

        public void setProperties(java.util.Properties suppliedProps)
                           throws ConfigManagerProxyLoggedException
        Deprecated. 
        Asks the broker to sets multiple ServiceGroupProxy 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 ServiceGroupProxy, using the same format as expected by the ServiceGroupProxy.setProperty() method.
        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.
      • createServiceProxyItem

        public ServiceProxyItem createServiceProxyItem(java.lang.String proxyName,
                                                       java.util.Properties suppliedProps)
                                                throws ConfigManagerProxyLoggedException,
                                                       ConfigManagerProxyPropertyNotInitializedException
        Deprecated. 
        Asks the broker to create a ServiceProxyItem of the supplied groupProxyName, with the passed properties in the Execution Group owning this ServiceGroupProxyItem. The runtime artifact for the ServiceProxyItem will be created and started dependent on the AdminState and Secured properties of the ServiceGroupProxyItem. If a ServiceProxyItem already exists in this ServiceGroupProxyItem with the supplied groupProxyName, the existing ServiceProxyItem is returned.
        Parameters:
        proxyName - Name of the service proxy
        suppliedProps - Additional properties for the service proxy
        Returns:
        ServiceProxyItem that represents the created object
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
        ConfigManagerProxyPropertyNotInitializedException, - ConfigManagerProxyLoggedException
        ConfigManagerProxyPropertyNotInitializedException
      • getName

        public java.lang.String getName()
        Deprecated. 
        Returns the Name of the Service Group Proxy Item
        Returns:
        the String groupProxyName of the ServiceGroupProxyItem
      • getUUID

        public java.lang.String getUUID()
        Deprecated. 
        Returns the UUID Summary of the Service Group Proxy Item
        Returns:
        the uuid string of the ServiceGroupProxyItem
      • getTitle

        public java.lang.String getTitle()
        Deprecated. 
        Returns the Title of the Service Group Proxy Item
        Returns:
        the title string of the ServiceGroupProxyItem
      • getAuthor

        public java.lang.String getAuthor()
        Deprecated. 
        Returns the Author of the Service Group Proxy Item
        Returns:
        theauthor string of the ServiceGroupProxyItem
      • getSummary

        public java.lang.String getSummary()
        Deprecated. 
        Returns the Summary of the Service Group Proxy Item
        Returns:
        the summary string of the ServiceGroupProxyItem
      • isRunEnabled

        public boolean isRunEnabled()
        Deprecated. 
        Returns true only if the service group proxy item is set to run when the broker is started. This method reports the logical AdminState of the service group proxy item, which means that it can return 'true' even if the the execution group in which it is defined is currently stopped. This state determines if service proxy items created in the service proxy group will be started. Use isRunning() to report whether the all service proxy items in the service group are currently running.
        Returns:
        boolean True if and only if the execution group is able to run when the broker is started.
      • isRunning

        public boolean isRunning()
                          throws ConfigManagerProxyPropertyNotInitializedException
        Deprecated. 
        Returns true only if all the service proxies in this service proxy group are currently running. This method reports the actual aggregate runstate of all of the service proxy items in this service proxy group. Use isRunEnabled() to report whether the service group proxy is configured start its service proxy items.
        Returns:
        boolean True if and only if all the service proxies in this service proxy group are currently running.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.
      • getSecured

        public java.lang.String getSecured()
        Deprecated. 
        Returns the secured property of this Service Group Proxy Item as one of SFM_ITEM_SECURED_INSECURE, SFM_ITEM_SECURED_SECURE or SFM_ITEM_SECURED_ASTARGET as defined in AttributeConstants
        Returns:
        the secured property of the ServiceGroupProxyItem
      • isValidating

        public boolean isValidating()
        Deprecated. 
        Returns true if this Service Group Proxy Item is validating, and false if it is not.
        Returns:
        the validating
      • getCreated

        public java.util.Date getCreated()
        Deprecated. 
        Returns the time when this Service Group Proxy Item was created in the runtime.
        Returns:
        the created time of the ServiceGroupProxyItem
      • getLastUpdated

        public java.util.Date getLastUpdated()
        Deprecated. 
        Returns the time when this Service Group Proxy Item was last updated in the runtime.
        Returns:
        the lastUpdated time of the ServiceGroupProxyItem
      • 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 java.lang.Object
        Returns:
        String Representation of the current object
      • setTitle

        public void setTitle(java.lang.String newValue)
                      throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the title field of the current ServiceGroupProxyItem. If this method returns successfully the request will have been sent to the broker, batched for sending if a batch is in progress, or successfully processed by the broker if synchronous updates have been enabled.
        Parameters:
        newValue - New value string.
        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.
      • setAuthor

        public void setAuthor(java.lang.String newValue)
                       throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the author field of the current ServiceGroupProxyItem. If this method returns successfully the request will have been sent to the broker, batched for sending if a batch is in progress, or successfully processed by the broker if synchronous updates have been enabled.
        Parameters:
        newValue - New value string.
        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.
      • setSummary

        public void setSummary(java.lang.String newValue)
                        throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the summary field of the current ServiceGroupProxyItem. If this method returns successfully the request will have been sent to the broker, batched for sending if a batch is in progress, or successfully processed by the broker if synchronous updates have been enabled.
        Parameters:
        newValue - New value string.
        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.
      • setAdminState

        public void setAdminState(boolean newState)
                           throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the adminState of the ServiceGroupProxyItem to the specified new value. Any ServiceProxyItems in the group will be stopped/started to match the new adminState. Any new ServiceProxyItems that are created will obey the new adminState.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.