Package org.ikasan.spec.module

Interface Module<FLOW>

  • public interface Module<FLOW>
    Ikasan module contracts.
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getContext()
      Get the root context of the module.
      java.lang.String getDescription()
      Returns a human readable description of this module
      FLOW getFlow​(java.lang.String name)
      Returns a Flow with this name.
      java.util.List<FLOW> getFlows()
      Returns a List of this module's Flows
      java.lang.String getHost()
      Get the host that the module is running on
      java.lang.String getName()
      Returns the name of the module
      java.lang.Integer getPort()
      Get the port that the module is bound to.
      java.lang.String getProtocol()
      Get the protocol under which the module is running.
      ModuleType getType()
      Get the module type.
      java.lang.String getUrl()
      Returns the url of the module.
      java.lang.String getVersion()
      Returns the runtime version of the module
      void setContext​(java.lang.String context)
      Set the root context of the module.
      void setDescription​(java.lang.String description)
      Sets a human readable description of this module
      void setHost​(java.lang.String host)
      Set the host that the module is running on.
      void setPort​(java.lang.Integer port)
      Set the port that the module is bound to.
      void setProtocol​(java.lang.String protocol)
      Set the protocol that the module will run under.
      void setType​(ModuleType moduleType)
      Set the module type on the metadata.
      void setUrl​(java.lang.String url)
      Set the url of the module.

    • Method Detail

      • setType

        void setType​(ModuleType moduleType)
        Set the module type on the metadata.
        Parameters:
        moduleType -

      • getType

        ModuleType getType()
        Get the module type.
        Returns:

      • getUrl

        java.lang.String getUrl()
        Returns the url of the module.
        Returns:

      • setUrl

        void setUrl​(java.lang.String url)
        Set the url of the module.
        Parameters:
        url -

      • getVersion

        java.lang.String getVersion()
        Returns the runtime version of the module
        Returns:
        version of the module

      • getName

        java.lang.String getName()
        Returns the name of the module
        Returns:
        name of the module

      • getFlows

        java.util.List<FLOW> getFlows()
        Returns a List of this module's Flows
        Returns:
        a List of FLOW.

      • getFlow

        FLOW getFlow​(java.lang.String name)
        Returns a Flow with this name. If no flow of this name exists then it returns null.
        Returns:
        a the Flow corresponding to the given name

      • getDescription

        java.lang.String getDescription()
        Returns a human readable description of this module
        Returns:
        String description

      • setDescription

        void setDescription​(java.lang.String description)
        Sets a human readable description of this module
        Parameters:
        description -

      • getHost

        java.lang.String getHost()
        Get the host that the module is running on
        Returns:

      • setHost

        void setHost​(java.lang.String host)
        Set the host that the module is running on.
        Parameters:
        host -

      • getPort

        java.lang.Integer getPort()
        Get the port that the module is bound to.
        Returns:

      • setPort

        void setPort​(java.lang.Integer port)
        Set the port that the module is bound to.
        Parameters:
        port -

      • getContext

        java.lang.String getContext()
        Get the root context of the module.
        Returns:

      • setContext

        void setContext​(java.lang.String context)
        Set the root context of the module.
        Parameters:
        context -

      • getProtocol

        java.lang.String getProtocol()
        Get the protocol under which the module is running.
        Returns:

      • setProtocol

        void setProtocol​(java.lang.String protocol)
        Set the protocol that the module will run under.
        Parameters:
        protocol -