com.ibm.broker.config.proxy

Class ServiceProxyItem

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

  • Deprecated.

    public class ServiceProxyItem
    extends java.lang.Object
    Provides a ServiceProxyItem object for managing Service Federation Management Service proxy targets within a Service Group Proxy Item.

    Instances are created or retrieved from a ServiceGroupProxyItem which was obtained from an execution group's ServiceFederationManagerProxy object. Instances 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 that point this object should be re-obtained.

    Given that 'sgpi' is a ServiceGroupProxyItem object obtain from a ServiceFederationManagerProxy, which was itself obtained from a connected ExecutionGroupProxy instance, then to create a new ServiceProxyItem instance use:

    ServiceProxyItem spi = sgpi.createServiceProxyItem(...);
    To retrieve an enumeration of all the ServiceProxyItem objects within a ServiceGroupProxyItem use:
    Enumeration spis = sgpi.getServiceProxyItems();
    To retrieve a named ServiceProxyItem object within a ServiceGroupProxyItem use:
    ServiceProxyItem spi = sgpi.getServiceProxyByName(proxyName);

    com.ibm.broker.config.proxy.ServiceProxyItem
    Responsibilities Provides a ServiceProxyItem object for managing a Service Federation Management Service proxy targets in a ServiceGroupPoxyItem.
    Internal Collaborators com.ibm.broker.config.proxy.ServiceGroupProxyItem
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     54148.6  2009-08-06  HDMJB           v7 Release
     
     
    • Method Detail

      • delete

        public void delete()
                    throws ConfigManagerProxyLoggedException
        Deprecated. 
        Asks the broker to delete this ServiceProxyItem Note that deleting a ServiceGroupProxyItem stops and removes the service proxy target in the runtime
        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.
      • setProperties

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

        public java.lang.String getName()
        Deprecated. 
        Returns the name of the Service Proxy Item
        Returns:
        name string of the ServiceProxyItem
      • getUUID

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

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

        public java.lang.String getAuthor()
        Deprecated. 
        Returns the Author of the Service Proxy Item
        Returns:
        author String of the ServiceProxyItem
      • getSummary

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

        public java.lang.String getProxyUrl()
        Deprecated. 
        Returns the proxyUrl of the Service Proxy Item
        Returns:
        proxyUrl string of the ServiceProxyItem
      • getWsdlPort

        public java.lang.String getWsdlPort()
        Deprecated. 
        Returns the wsdlPort of the Service Proxy Item
        Returns:
        wsdlPort string of the ServiceProxyItem
      • getTargetUrl

        public java.lang.String getTargetUrl()
        Deprecated. 
        Returns the targetUrl of the Service Proxy Item
        Returns:
        targetUrl string of the ServiceProxyItem
      • isRunning

        public boolean isRunning()
        Deprecated. 
        This method reports the actual runstate of the ServiceProxyItem. Use ServiceGroupproxyItem.isRunEnabled() on this service proxy item to report whether it is configured start
        Returns:
        the running state of the ServiceProxyItem
      • getCreated

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

        public java.util.Date getLastUpdated()
        Deprecated. 
        Returns the time when this Service Proxy Item was last updated in the runtime.
        Returns:
        lastUpdated Date the ServiceProxyItem
      • 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
      • getOwningProxyGroupItem

        public ServiceGroupProxyItem getOwningProxyGroupItem()
        Deprecated. 
        Returns ServiceGroupProxyItem object that owns this ServiceProxyItem
        Returns:
        the owning of the ServiceGroupProxyItem
      • setTitle

        public void setTitle(java.lang.String newValue)
                      throws ConfigManagerProxyLoggedException
        Deprecated. 
        Sets the title field of the current ServiceProxyItem. 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 ServiceProxyItem. 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 ServiceProxyItem. 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.