com.ibm.broker.connector

Interface AdminInterface



  • public interface AdminInterface
    AdminInterface is an interface that can be added to the OutputConnector or the EventInputConnector to provide administration to the system being connected to.

    It allows users to perform administration on the end system using the IBM Integration commands and Integration API.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String adminKey() 
      void changeAdminObject(java.lang.String adminFunction, java.util.Properties adminParamters, java.lang.String adminObjectType, java.lang.String adminObjectName)
      This is called by the integration node to execute an administration operation against the message provider.
      java.util.Properties listAdminObjectProperties(java.lang.String adminObjectType, java.lang.String adminObjectName)
      This is called by the integration node to get a list of properties for a given object name.
      java.lang.String[] listAdminObjectsForType(java.lang.String adminObjectType)
      This is called by the integration node to get a list of all objects that exist for the given object type.
      java.lang.String[] listAdminObjectTypes()
      This is called by the integration node to get a name to use this administered object.
    • Method Detail

      • adminKey

        java.lang.String adminKey()
                           throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
      • listAdminObjectTypes

        java.lang.String[] listAdminObjectTypes()
                                         throws com.ibm.broker.plugin.MbException
        This is called by the integration node to get a name to use this administered object. Return null to use default key.
        Returns:
        A list of valid object type names.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the reporting of the resource to fail.
      • listAdminObjectsForType

        java.lang.String[] listAdminObjectsForType(java.lang.String adminObjectType)
                                            throws com.ibm.broker.plugin.MbException
        This is called by the integration node to get a list of all objects that exist for the given object type. For example: object type might be "Queues": and a list of all queue names in the system would be returned.
        Parameters:
        adminObjectType - The name of the object type to retrieve data on.
        Returns:
        A list of names of all available objects of the type passed in.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the reporting of the resource to fail.
      • listAdminObjectProperties

        java.util.Properties listAdminObjectProperties(java.lang.String adminObjectType,
                                                       java.lang.String adminObjectName)
                                                throws com.ibm.broker.plugin.MbException
        This is called by the integration node to get a list of properties for a given object name. The properties can have complex structure denoted by a / in the property name. For example: properties.put("Field1/Field2/description", "test message 1");
        Parameters:
        adminObjectType - The name of the object type to retrieve data on.
        adminObjectName - The name of the object to retrieve data on.
        Returns:
        A properties object with all properties for the given object.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the reporting of the resource to fail.
      • changeAdminObject

        void changeAdminObject(java.lang.String adminFunction,
                               java.util.Properties adminParamters,
                               java.lang.String adminObjectType,
                               java.lang.String adminObjectName)
                        throws com.ibm.broker.plugin.MbException
        This is called by the integration node to execute an administration operation against the message provider. For example: to "delete" an object of type "Subscription" with the name "Sub1");
        Parameters:
        adminFunction - The administration function to execute.
        adminParamters - The administration parameters for the execute function.
        adminObjectType - The name of the object type to retrieve data on.
        adminObjectName - The name of the object to retrieve data on.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the changing of the resource to fail.
IBM Integration BusTM
JavaTM Connector API