Class ManagementInput

java.lang.Object
com.swiftmq.impl.streams.comp.io.ManagementInput
All Implemented Interfaces:
Input
public class ManagementInput extends Object implements Input
Consumes Messages from the Management Tree.
Author:
IIT Software GmbH, Muenster/Germany, (c) 2017, All Rights Reserved

  • Field Details

    • PROP_OPER

      public static String PROP_OPER

    • PROP_CTX

      public static String PROP_CTX

    • PROP_TIME

      public static String PROP_TIME

    • VAL_ADD

      public static String VAL_ADD

    • VAL_REMOVE

      public static String VAL_REMOVE

    • VAL_CHANGE

      public static String VAL_CHANGE

  • Method Details

    • getName

      public String getName()
      Description copied from interface: Input
      Returns the name of this Input.
      Specified by:
      getName in interface Input
      Returns:
      Name

    • hasAddCallback

      public boolean hasAddCallback()
      Internal use
      Returns:
      true/false

    • hasRemoveCallback

      public boolean hasRemoveCallback()
      Internal use
      Returns:
      true/false

    • hasChangeCallback

      public boolean hasChangeCallback()
      Internal use
      Returns:
      true/false

    • current

      public Input current(Message current)
      Description copied from interface: Input
      Sets the current Message on this Input.
      Specified by:
      current in interface Input
      Parameters:
      current - Message
      Returns:
      Input

    • current

      public Message current()
      Description copied from interface: Input
      Returns the current Message of this Input.
      Specified by:
      current in interface Input
      Returns:
      Message

    • getSelector

      public String getSelector()
      Internal use only.

    • context

      public Input context(String context)
      Sets a CLI context different from the name.
      Parameters:
      context - CLI context
      Returns:
      this

    • context

      public String context()
      Returns the CLI context
      Returns:
      CLI context

    • selector

      public Input selector(String selector)
      Sets a JMS Message selector
      Parameters:
      selector - JMS Message Selector
      Returns:
      this

    • include

      public ManagementInput include(String propInclude)
      Adds Property name(s) that must be addionally included in an onChange message. If multiple names are given, they must be separated by blank.
      Parameters:
      propInclude -
      Returns:
      this

    • getPropIncludes

      public List<String> getPropIncludes()
      Internal use only.

    • onAdd

      public ManagementInput onAdd(InputCallback addCallback)
      Registers a Callback that is executed when a new Entity is added
      Parameters:
      addCallback - callback
      Returns:
      ManagementInput

    • onRemove

      public ManagementInput onRemove(InputCallback removeCallback)
      Registers a Callback that is executed when a existing Entity is removed
      Parameters:
      removeCallback - callback
      Returns:
      ManagementInput

    • onChange

      public ManagementInput onChange(InputCallback changeCallback)
      Registers a Callback that is executed when a a Property of an Entity has changed
      Parameters:
      changeCallback - callback
      Returns:
      ManagementInput

    • executeCallback

      public void executeCallback() throws Exception
      Description copied from interface: Input
      Internal use.
      Specified by:
      executeCallback in interface Input
      Throws:
      Exception

    • getManagementProcessor

      public ManagementProcessor getManagementProcessor()
      Internal use.
      Returns:
      ManagementProcessor

    • setManagementProcessor

      public void setManagementProcessor(ManagementProcessor managementProcessor)
      Internal use.
      Parameters:
      managementProcessor - ManagementProcessor

    • collect

      public void collect(long interval)
      Description copied from interface: Input
      Internal use.
      Specified by:
      collect in interface Input

    • start

      public void start() throws Exception
      Description copied from interface: Input
      Starts this Input. This method is called automatically if an Input is created outside a callback. If it is created inside, it must be called explicitly.
      Specified by:
      start in interface Input
      Throws:
      Exception

    • close

      public void close()
      Description copied from interface: Input
      Closes this Input.
      Specified by:
      close in interface Input

    • toString

      public String toString()
      Overrides:
      toString in class Object