Interface ServiceDescription

  • All Superinterfaces:
    java.lang.Comparable<ServiceDescription>

    public interface ServiceDescription
    extends java.lang.Comparable<ServiceDescription>
    Describes an Arrowhead service that can, potentially, be communicated with.
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.time.Instant expiresAt()
      Gets time at which this service description should be renewed or refreshed.
      default java.util.Set<InterfaceDescriptor> interfaces()
      Gets interface triplets supported by the described service.
      java.util.Map<InterfaceDescriptor,​java.lang.String> interfaceTokens()
      Gets interface triplets supported by the described service.
      java.util.Map<java.lang.String,​java.lang.String> metadata()
      Gets metadata associated with this service.
      java.lang.String name()
      Gets name, or service definition, of this service
      SystemDescription provider()
      Gets description of service provider.
      java.time.Instant receivedAt()
      Gets time at which this service description was received or created.
      SecurityDescriptor security()
      Gets security schema used to authenticate and authorize service users.
      java.lang.String uri()
      Qualifier that distinguishes this service from other such provided by the same system.
      int version()
      Gets service version.
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • name

        java.lang.String name()
        Gets name, or service definition, of this service
        Returns:
        Service name.
      • provider

        SystemDescription provider()
        Gets description of service provider.
        Returns:
        Description of system providing this service.
      • uri

        java.lang.String uri()
        Qualifier that distinguishes this service from other such provided by the same system. How it is used depends on the application-level transport protocol employed by the service.

        For example, if this service uses HTTP, then the qualifier is a URL base path, such as "/base/path".

        Returns:
        Service qualifier.
      • receivedAt

        java.time.Instant receivedAt()
        Gets time at which this service description was received or created.
        Returns:
        Record creation time.
      • expiresAt

        java.time.Instant expiresAt()
        Gets time at which this service description should be renewed or refreshed.
        Returns:
        Record expiration time.
      • security

        SecurityDescriptor security()
        Gets security schema used to authenticate and authorize service users.
        Returns:
        Service security schema descriptor.
      • metadata

        java.util.Map<java.lang.String,​java.lang.String> metadata()
        Gets metadata associated with this service. Their significance and use depend on the service.
        Returns:
        Service metadata.
      • version

        int version()
        Gets service version.
        Returns:
        Service version.
      • interfaces

        default java.util.Set<InterfaceDescriptor> interfaces()
        Gets interface triplets supported by the described service. The returned list is unmodifiable.
        Returns:
        Service interface triplets.
      • interfaceTokens

        java.util.Map<InterfaceDescriptor,​java.lang.String> interfaceTokens()
        Gets interface triplets supported by the described service. Each triplet is either associated with an authorization token or an empty string. The returned map is unmodifiable.
        Returns:
        Service interface triplets mapped to authorization tokens.