Package de.iip_ecosphere.platform.support.iip_aas

Class NameplateSetup.Service

java.lang.Object
de.iip_ecosphere.platform.support.iip_aas.NameplateSetup.Service
Enclosing class:
NameplateSetup
public static class NameplateSetup.Service extends Object
Represents a device-provided service.
Author:
Holger Eichelberger, SSE

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    host
     
    private String
    key
     
    private String
    netmask
     
    private int
    port
     
    private de.iip_ecosphere.platform.support.Version
    version
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Service()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHost()
    Returns the IP address/name of the hosting device.
    String
    getKey()
    Returns the unique logical key within this device to access this service.
    String
    getNetmask()
    Returns the optional netmask to enable a safe detection in getHost() if no host was given.
    int
    getPort()
    Return the port to address this service.
    de.iip_ecosphere.platform.support.Version
    getVersion()
    Returns the optional service/protocol version offered.
    void
    setHost(String host)
    Defines the IP address/name of the hosting device.
    void
    setKey(String key)
    Changes the unique logical key within this device to access this service.
    void
    setNetmask(String netmask)
    Defines the optional netmask.
    void
    setPort(int port)
    Changes the port to address this service.
    void
    setVersion(de.iip_ecosphere.platform.support.Version version)
    Defines the optional service/protocol version offered.
    void
    setVersion(String version)
    Defines the optional service/protocol version offered.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • key

      private String key

    • port

      private int port

    • host

      private String host

    • netmask

      private String netmask

    • version

      private de.iip_ecosphere.platform.support.Version version

  • Constructor Details

    • Service

      public Service()

  • Method Details

    • getKey

      public String getKey()
      Returns the unique logical key within this device to access this service.
      Returns:
      the key

    • setKey

      public void setKey(String key)
      Changes the unique logical key within this device to access this service. [snakeyaml]
      Parameters:
      key - the key

    • getPort

      public int getPort()
      Return the port to address this service.
      Returns:
      the port the port

    • setPort

      public void setPort(int port)
      Changes the port to address this service.
      Parameters:
      port - the port

    • getHost

      public String getHost()
      Returns the IP address/name of the hosting device. If none was specified, NetUtils.getOwnIP(String) is called with getNetmask().
      Returns:
      the IP address/name

    • setHost

      public void setHost(String host)
      Defines the IP address/name of the hosting device. [snakeyaml]
      Parameters:
      host - the IP address/name to set

    • getNetmask

      public String getNetmask()
      Returns the optional netmask to enable a safe detection in getHost() if no host was given.
      Returns:
      the netmask (may be null)

    • setNetmask

      public void setNetmask(String netmask)
      Defines the optional netmask.
      Parameters:
      netmask - the netmask to set

    • getVersion

      public de.iip_ecosphere.platform.support.Version getVersion()
      Returns the optional service/protocol version offered.
      Returns:
      the version (may be null)

    • setVersion

      public void setVersion(String version)
      Defines the optional service/protocol version offered.
      Parameters:
      version - the version to set

    • setVersion

      public void setVersion(de.iip_ecosphere.platform.support.Version version)
      Defines the optional service/protocol version offered.
      Parameters:
      version - the version to set