com.ibm.broker.connector

Class Connector

  • java.lang.Object
    • com.ibm.broker.connector.Connector
    • Field Summary

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

      Constructors 
      Constructor and Description
      Connector(ConnectorFactory connectorFactory, java.lang.String name, java.util.Properties properties) 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void deccrementStatValue(java.lang.String group, java.lang.String name, long value)
      Decrements the named statistic by the value given
      void decrementStatValue(java.lang.String group, java.lang.String name)
      Decrements the named statistic
      ConnectorFactory getConnectorFactory()
      Returns the ConnectionFactory that created this connector.
      java.lang.String getName() 
      java.util.Properties getProperties() 
      void incrementStatValue(java.lang.String group, java.lang.String name)
      Increments the named statistic
      void incrementStatValue(java.lang.String group, java.lang.String name, long value)
      Increments the named statistic by the value given
      void initialize()
      This is called by the integration node when a node using this connector is started.
      void setLocalCF(ConnectorFactory cf) 
      void terminate()
      This is called by the integration node when the node using the connector is being stopped or deleted.
      void writeActivityLog(java.lang.String messageNumber, java.lang.String[] inserts)
      Writes an entry to activity log using the context that this connector is being run in.
      void writeActivityLog(java.lang.String messageNumber, java.lang.String[] inserts, java.util.Properties extraTags)
      Writes an entry to activity log using the context that this connector is being run in.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Connector

        public Connector(ConnectorFactory connectorFactory,
                         java.lang.String name,
                         java.util.Properties properties)
                  throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
    • Method Detail

      • initialize

        public void initialize()
                        throws com.ibm.broker.plugin.MbException
        This is called by the integration node when a node using this connector is started. Throwing an exception will cause the message flow being deployed or started to fail.
        Throws:
        com.ibm.broker.plugin.MbException
      • terminate

        public void terminate()
                       throws com.ibm.broker.plugin.MbException
        This is called by the integration node when the node using the connector is being stopped or deleted.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause an error to be written to the system log but will not prevent the flow being stopped.
      • getConnectorFactory

        public final ConnectorFactory getConnectorFactory()
                                                   throws com.ibm.broker.plugin.MbException
        Returns the ConnectionFactory that created this connector.
        Throws:
        com.ibm.broker.plugin.MbException
      • writeActivityLog

        public final void writeActivityLog(java.lang.String messageNumber,
                                           java.lang.String[] inserts)
                                    throws com.ibm.broker.plugin.MbException
        Writes an entry to activity log using the context that this connector is being run in.
        Parameters:
        messageNumber - message number for the catalog to use.
        inserts - the inserts to include in the message
        Throws:
        com.ibm.broker.plugin.MbException
      • writeActivityLog

        public final void writeActivityLog(java.lang.String messageNumber,
                                           java.lang.String[] inserts,
                                           java.util.Properties extraTags)
                                    throws com.ibm.broker.plugin.MbException
        Writes an entry to activity log using the context that this connector is being run in.
        Parameters:
        messageNumber - message number for the catalog to use.
        inserts - the inserts to include in the message
        extraTags - a map of tags to values which will be used to tag this log message.
        Throws:
        com.ibm.broker.plugin.MbException
      • getProperties

        public final java.util.Properties getProperties()
                                                 throws com.ibm.broker.plugin.MbException
        Returns:
        the properties that this connector has.
        Throws:
        com.ibm.broker.plugin.MbException
      • getName

        public final java.lang.String getName()
                                       throws com.ibm.broker.plugin.MbException
        Returns:
        the name of the connector.
        Throws:
        com.ibm.broker.plugin.MbException
      • incrementStatValue

        public void incrementStatValue(java.lang.String group,
                                       java.lang.String name)
                                throws com.ibm.broker.plugin.MbException
        Increments the named statistic
        Parameters:
        group -
        name -
        Throws:
        com.ibm.broker.plugin.MbException
      • incrementStatValue

        public void incrementStatValue(java.lang.String group,
                                       java.lang.String name,
                                       long value)
                                throws com.ibm.broker.plugin.MbException
        Increments the named statistic by the value given
        Parameters:
        group -
        name -
        value -
        Throws:
        com.ibm.broker.plugin.MbException
      • decrementStatValue

        public void decrementStatValue(java.lang.String group,
                                       java.lang.String name)
                                throws com.ibm.broker.plugin.MbException
        Decrements the named statistic
        Parameters:
        group -
        name -
        Throws:
        com.ibm.broker.plugin.MbException
      • deccrementStatValue

        public void deccrementStatValue(java.lang.String group,
                                        java.lang.String name,
                                        long value)
                                 throws com.ibm.broker.plugin.MbException
        Decrements the named statistic by the value given
        Parameters:
        group -
        name -
        value -
        Throws:
        com.ibm.broker.plugin.MbException
IBM Integration BusTM
JavaTM Connector API