Package de.iip_ecosphere.platform.services.spring.descriptor

Interface Endpoint

  • All Known Implementing Classes:
    YamlEndpoint
    public interface Endpoint
    Represents a communication endpoint. The port must be given, the host may be empty.
    Author:
    Holger Eichelberger, SSE

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getHostArg()
      Returns the specified command line argument to set the host to communicate with for this relation upon service deployment/execution.
      java.lang.String getHostArg​(java.lang.String hostname)
      Returns the ready-to.use command line argument to set the host to communicate with for this relation upon service deployment/execution.
      java.lang.String getPortArg()
      Returns the specified command line argument to set the communication port for this relation upon service deployment/execution.
      java.lang.String getPortArg​(int port)
      Returns the ready-to-use command line argument to set the communication port for this relation upon service deployment/execution.
      boolean isHostArgGeneric()
      Returns the whether getHostArg() is generic through HOST_PLACEHOLDER.
      boolean isPortArgGeneric()
      Returns the whether getPortArg() is generic through PORT_PLACEHOLDER.

    • Method Detail

      • getPortArg

        java.lang.String getPortArg()
        Returns the specified command line argument to set the communication port for this relation upon service deployment/execution.
        Returns:
        the generic port argument

      • isPortArgGeneric

        boolean isPortArgGeneric()
        Returns the whether getPortArg() is generic through PORT_PLACEHOLDER.
        Returns:
        true for generic, false else

      • getPortArg

        java.lang.String getPortArg​(int port)
        Returns the ready-to-use command line argument to set the communication port for this relation upon service deployment/execution.
        Parameters:
        port - the actual port number
        Returns:
        the port argument, "${port}" is substituted by port

      • getHostArg

        java.lang.String getHostArg()
        Returns the specified command line argument to set the host to communicate with for this relation upon service deployment/execution.
        Returns:
        the generic host argument

      • isHostArgGeneric

        boolean isHostArgGeneric()
        Returns the whether getHostArg() is generic through HOST_PLACEHOLDER.
        Returns:
        true for generic, false else

      • getHostArg

        java.lang.String getHostArg​(java.lang.String hostname)
        Returns the ready-to.use command line argument to set the host to communicate with for this relation upon service deployment/execution.
        Parameters:
        hostname - the actual hostname, "${host}" is substituted by hostname, may be empty for localhost
        Returns:
        the host argument