Interface ServiceConsumable


  • public interface ServiceConsumable
    Details about some service with additional information related to how it can be accessed.
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> expiresAt()
      The date and time at which the service definition entry expires, if ever.
      java.util.List<InterfaceName> interfaces()
      List of supported network interface triplets.
      java.util.Map<java.lang.String,​java.lang.String> metadata()
      Arbitrary service metadata.
      ServiceName name()
      Service name.
      SystemDetails provider()
      Service provider.
      se.arkalix.descriptor.SecurityDescriptor security()
      The security/authentication mode supported by the service.
      java.util.Map<se.arkalix.descriptor.InterfaceDescriptor,​java.lang.String> tokens()
      Authorization tokens useful for consuming this service.
      default se.arkalix.description.ServiceDescription toServiceDescription()
      Converts this objects into a ServiceDescription.
      java.lang.String uri()
      Service qualifier, also referred to as service URI.
      int version()
      Service version.
      java.util.List<OrchestrationWarning> warnings()
      Any notifications about the state of the service that might have bearing on whether or not the service will be consumed.
    • Method Detail

      • uri

        java.lang.String uri()
        Service qualifier, also referred to as service URI.

        The significance of this value depends on the application-level transport protocol employed by the service. If, for example, HTTP is used, then this is a base path.

      • expiresAt

        java.util.Optional<java.lang.String> expiresAt()
        The date and time at which the service definition entry expires, if ever.
      • security

        se.arkalix.descriptor.SecurityDescriptor security()
        The security/authentication mode supported by the service.
      • metadata

        java.util.Map<java.lang.String,​java.lang.String> metadata()
        Arbitrary service metadata.
      • version

        int version()
        Service version.
      • interfaces

        java.util.List<InterfaceName> interfaces()
        List of supported network interface triplets.
        See Also:
        InterfaceDescriptor
      • tokens

        java.util.Map<se.arkalix.descriptor.InterfaceDescriptor,​java.lang.String> tokens()
        Authorization tokens useful for consuming this service.

        One token is provided for each interface triplet supported by the service.

      • warnings

        java.util.List<OrchestrationWarning> warnings()
        Any notifications about the state of the service that might have bearing on whether or not the service will be consumed.
      • toServiceDescription

        default se.arkalix.description.ServiceDescription toServiceDescription()
        Converts this objects into a ServiceDescription.
        Returns:
        New ServiceDescription.
        Throws:
        java.lang.RuntimeException - If the type of public key held by provider(), if any, is not supported.