com.ibm.broker.config.proxy

Interface DeployedObject

  • All Superinterfaces:
    DeployableObject
    All Known Implementing Classes:
    ApplicationProxy, FlowProxy, LibraryProxy, MessageFlowDependency, MessageFlowProxy, RestApiProxy, SharedLibraryProxy, StaticLibraryProxy, SubFlowProxy


    public interface DeployedObject
    extends DeployableObject
    Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.

    DeployedObject is a specialization of the DeployableObject interface in that DeployedObject refers to a specific instance of a DeployableObject that exists on an execution group. Because of this, the DeployedObject interface extends its DeployableObject parent by adding methods to interrogate the deploy time, the execution group and the BAR file information that is specific to the deployment.

    There are currently two classes that directly implement this interface, both of which live in the com.ibm.broker.config.proxy package:

    User-written classes do not need to implement this interface.

    Classes that implement this interface are able to describe lists of keywords and their values that may be associated with the deployed object. For a detailed discussion of the eyecatchers used when describing keywords, see the documentation for the DeployableObject interface.

    interface com.ibm.broker.config.proxy.DeployedObject extends com.ibm.broker.config.proxy.DeployableObject

    Responsibilities States that implementing classes represent objects that have been deployed to execution groups.
    Internal Collaborators None
    
     Change Activity:
     --------  ----------- -------------   ------------------------------------
     Reason:   Date:       Originator:     Comments:
     --------  ----------- -------------   ------------------------------------
     f35474    2004-07-15  HDMPL           v6 Release
     f45166    2007-06-11  HDMPL           v6.1 Release:
                                               Now extends DeployableObject
     51619.8   2008-12-16  HDMPL           v7 Release (no changes)
    
     
    • Method Detail

      • getDeployProperties

        java.util.Properties getDeployProperties()
                                          throws ConfigManagerProxyPropertyNotInitializedException
        Returns a list of the properties associated with the deployment of this deployed object.

        This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will be null.

        Returns:
        Properties where each key is a deploy related property with its associated value. Keywords are not returned as part of the returned properties. Returns null if no deploy related properties are found.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException
      • getDeployTime

        java.util.Date getDeployTime()
        Returns the time that the current deployed object was last received by the broker for deployment to the execution group.
        Returns:
        Date the time of the most recent deployment.
      • getBARFileName

        java.lang.String getBARFileName()
                                 throws ConfigManagerProxyPropertyNotInitializedException
        Returns the name of the Bar file that was used to deploy the object to the execution group. This method will return null if the Bar file was deployed by specifying an InputStream parameter to ExecutionGroupProxy.deploy() and a valid Bar file label was not supplied.
        Returns:
        String name of the Bar file that deployed the object
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • fullNameMatches

        boolean fullNameMatches(java.lang.String fileName)
                         throws ConfigManagerProxyPropertyNotInitializedException
        Tests if the name of this deployed object matches the fileName passed in. This method returns true if the deployed object name matches either with the source extension or the compiled resource extension
        Returns:
        boolean true if the fileName matches the deployed resource name
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the parent object is not immediately available and has to be requested from the broker, but the request could not be sent to the broker.