Package org.gcube.resourcemanagement.model.reference.entities.facets

Interface NetworkingFacet

  • All Superinterfaces:
    org.gcube.informationsystem.base.reference.Element, org.gcube.informationsystem.model.reference.entities.Entity, org.gcube.informationsystem.base.reference.entities.EntityElement, org.gcube.informationsystem.model.reference.ERElement, org.gcube.informationsystem.model.reference.entities.Facet, org.gcube.informationsystem.base.reference.IdentifiableElement, org.gcube.informationsystem.model.reference.ModelElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable
    All Known Implementing Classes:
    NetworkingFacetImpl
    @TypeMetadata(name="NetworkingFacet",
              description="NetworkingFacet captures information on any (computer) network interface associated with the resource.It is mainly used to describe the network interface of a host. It should not be confused with the {@link AccessPointFacet} which instead describes the protocol and the endpoint of a web-based service.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface NetworkingFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
    NetworkingFacet captures information on any (computer) network interface associated with the resource. It is mainly used to describe the network interface of a host. It should not be confused with the AccessPointFacet which instead describes the protocol and the endpoint of a web-based service. https://wiki.gcube-system.org/gcube/GCube_Model#Networking_Facet
    Author:
    Luca Frosini (ISTI - CNR)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String IP_ADDRESS
      The name of 'IPAddress' property
      static String IP_ADDRESS_REGEX
      The regular expression for validating an IP address (IPv4 or IPv6)
      static String NAME
      The name associated with this facet

      • Fields inherited from interface org.gcube.informationsystem.base.reference.Element

        DATETIME_PATTERN, TYPE_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

        CONTEXTS_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

        ID_PROPERTY, METADATA_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBroadcastAddress()
      Broadcast Address
      static NetworkingFacet getDefaultInstance()
      Returns a default instance of NetworkingFacet
      String getDomainName()
      The Domain Name
      String getHostName()
      The Host Name
      String getIPAddress()
      Internet Protocol (IP) Address
      String getMask()
      Network Mask
      void setBroadcastAddress​(String broadcastAddress)
      Sets the Broadcast Address
      void setDomainName​(String domainName)
      Sets the Domain Name
      void setHostName​(String hostName)
      Sets the Host Name
      void setIPAddress​(String ipAddress)
      Sets the Internet Protocol (IP) Address
      void setMask​(String mask)
      Sets the Network Mask

      • Methods inherited from interface org.gcube.informationsystem.base.reference.Element

        getTypeName

      • Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

        getID, getMetadata, setID, setMetadata

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ERElement

        getContexts

      • Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

        getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        getExpectedtype, getSupertypes

    • Method Detail

      • getDefaultInstance

        static NetworkingFacet getDefaultInstance()
        Returns a default instance of NetworkingFacet
        Returns:
        a default instance of NetworkingFacet

      • getHostName

        @ISProperty(description="Host Name")
String getHostName()
        The Host Name
        Returns:
        the host name

      • setHostName

        void setHostName​(String hostName)
        Sets the Host Name
        Parameters:
        hostName - the host name

      • getDomainName

        @ISProperty(description="Domain Name")
String getDomainName()
        The Domain Name
        Returns:
        the domain name

      • setDomainName

        void setDomainName​(String domainName)
        Sets the Domain Name
        Parameters:
        domainName - the domain name

      • getIPAddress

        @ISProperty(name="IPAddress",
            description="Internet Protocol (IP) Address",
            mandatory=true,
            nullable=false,
            regexpr="^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|(([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|([0-9A-Fa-f]{1,4}:){1,7}:|:(:[0-9A-Fa-f]{1,4}){1,7}|([0-9A-Fa-f]{1,4}:){1,6}:[0-9A-Fa-f]{1,4}|([0-9A-Fa-f]{1,4}:){1,5}(:[0-9A-Fa-f]{1,4}){1,2}|([0-9A-Fa-f]{1,4}:){1,4}(:[0-9A-Fa-f]{1,4}){1,3}|([0-9A-Fa-f]{1,4}:){1,3}(:[0-9A-Fa-f]{1,4}){1,4}|([0-9A-Fa-f]{1,4}:){1,2}(:[0-9A-Fa-f]{1,4}){1,5}|[0-9A-Fa-f]{1,4}:(:[0-9A-Fa-f]{1,4}){1,6}|:(:[0-9A-Fa-f]{1,4}){1,6}))$")
String getIPAddress()
        Internet Protocol (IP) Address
        Returns:
        the IP address

      • setIPAddress

        void setIPAddress​(String ipAddress)
        Sets the Internet Protocol (IP) Address
        Parameters:
        ipAddress - the IP address

      • getMask

        @ISProperty(description="Network Mask")
String getMask()
        Network Mask
        Returns:
        the network mask

      • setMask

        void setMask​(String mask)
        Sets the Network Mask
        Parameters:
        mask - the network mask

      • getBroadcastAddress

        @ISProperty(description="Broadcast Address")
String getBroadcastAddress()
        Broadcast Address
        Returns:
        the broadcast address

      • setBroadcastAddress

        void setBroadcastAddress​(String broadcastAddress)
        Sets the Broadcast Address
        Parameters:
        broadcastAddress - the broadcast address