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

Interface AccessPointFacet

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:
AccessPointFacetImpl
@TypeMetadata(name="AccessPointFacet", description="AccessPointFacet captures information on an \'access point\' of a resource, i.e., any web-based endpoint to programmatically interact with the resource via a known protocol. For example, it is used to define the network endpoint to contact the service. The endpoint can expose a well-known high-level protocol.", version="1.0.0") @Change(version="1.0.0", description="First Version") public interface AccessPointFacet extends org.gcube.informationsystem.model.reference.entities.Facet
AccessPointFacet captures information on an 'access point' of a resource, i.e., any web-based endpoint to programmatically interact with the resource via a known protocol. For example, it is used to define the network endpoint to contact the service. The endpoint can expose a well-known high-level protocol. https://wiki.gcube-system.org/gcube/GCube_Model#Access_Point_Facet
Author:
Luca Frosini (ISTI - CNR)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUTHORIZATION_PROPERTY
    The name of 'authorization' property
    static final String
    ENDPOINT_PROPERTY
    The name of 'endpoint' property
    static final 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

    Modifier and Type
    Method
    Description
    org.gcube.informationsystem.model.reference.properties.Property
    getAuthorization()
    Contains authorisation information. e.g., a token, the couple username:password, etc.
    static AccessPointFacet
    getDefaultInstance()
    Returns a default instance of AccessPointFacet
    String
    getDescription()
    A human-oriented text accompanying the access point
    URI
    getEndpoint()
    The URI which characterises the specific endpoint instance.
    String
    getEntryName()
    A distinguishing string to be used by clients to identify the access point of interest.
    String
    getProtocol()
    The high-level protocol used by the access point.
    void
    setAuthorization(org.gcube.informationsystem.model.reference.properties.Property authorization)
    Sets the authorisation information. e.g., a token, the couple username:password, etc.
    void
    setDescription(String description)
    Sets a human-oriented text accompanying the access point.
    void
    setEndpoint(URI endpoint)
    Sets the URI which characterises the specific endpoint instance.
    void
    setEntryName(String entryName)
    Sets a distinguishing string to be used by clients to identify the access point of interest.
    void
    setProtocol(String protocol)
    Sets the high-level protocol used by the access point.

    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

  • Field Details

  • Method Details

    • getDefaultInstance

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

    • getEntryName

      @ISProperty(description="A distinguishing string to be used by clients to identify the access point of interest.") String getEntryName()
      A distinguishing string to be used by clients to identify the access point of interest.
      Returns:
      the entry name

    • setEntryName

      void setEntryName(String entryName)
      Sets a distinguishing string to be used by clients to identify the access point of interest.
      Parameters:
      entryName - the entry name

    • getEndpoint

      @ISProperty(name="endpoint", description="The URI which characterises the specific endpoint instance.", mandatory=true, readonly=true, nullable=false) URI getEndpoint()
      The URI which characterises the specific endpoint instance.
      Returns:
      the URI

    • setEndpoint

      void setEndpoint(URI endpoint)
      Sets the URI which characterises the specific endpoint instance.
      Parameters:
      endpoint -

    • getProtocol

      @ISProperty(description="The high-level protocol used by the access point. The String could contain the version if needed. e.g., Web Map Service (WMS) and not HyperText Transfer Protocol (HTTP) which is already contained in the URI.") String getProtocol()
      The high-level protocol used by the access point. The String could contain the version if needed. e.g., Web Map Service (WMS) and not HyperText Transfer Protocol (HTTP) which is already contained in the URI.
      Returns:
      the protocol

    • setProtocol

      void setProtocol(String protocol)
      Sets the high-level protocol used by the access point.
      Parameters:
      protocol - the protocol

    • getDescription

      @ISProperty(description="A human-oriented text accompanying the access point.") String getDescription()
      A human-oriented text accompanying the access point
      Returns:
      the description

    • setDescription

      void setDescription(String description)
      Sets a human-oriented text accompanying the access point.
      Parameters:
      description - the description

    • getAuthorization

      @ISProperty(name="authorization", description="Contains authorisation information. e.g., a token, the couple username:password, etc.") org.gcube.informationsystem.model.reference.properties.Property getAuthorization()
      Contains authorisation information. e.g., a token, the couple username:password, etc.
      Returns:
      the authorization

    • setAuthorization

      void setAuthorization(org.gcube.informationsystem.model.reference.properties.Property authorization)
      Sets the authorisation information. e.g., a token, the couple username:password, etc.
      Parameters:
      authorization - the authorization