Package se.arkalix

Interface ArService

  • All Known Implementing Classes:
    HttpService

    public interface ArService
    An Arrowhead Framework service that can be provided by an ArSystem.
    • Method Detail

      • name

        java.lang.String name()
        Gets service name.
        Returns:
        Service name.
      • uri

        java.lang.String uri()
        Gets service URI.
        Returns:
        Service URI.
      • transport

        TransportDescriptor transport()
        Gets descriptor for application-level transport protocol through which service is made available to other systems.
        Returns:
        Service transport descriptor.
      • accessPolicy

        AccessPolicy accessPolicy()
        Gets access policy enforced by this service.
        Returns:
        Service access policy.
      • encodings

        java.util.List<EncodingDescriptor> encodings()
        Gets encodings the service can read and write.
        Returns:
        Unmodifiable list of supported encodings.
      • metadata

        java.util.Map<java.lang.String,​java.lang.String> metadata()
        Gets service metadata.
        Returns:
        Unmodifiable map of service metadata.
      • metadata

        default java.util.Optional<java.lang.String> metadata​(java.lang.String key)
        Gets value from service metadata map associated with given key, if any.
        Parameters:
        key - Key associated with desired metadata value.
        Returns:
        Value associated with key, if any.
      • version

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

        default ServiceDescription describeAsIfProvidedBy​(ArSystem system)
        Creates a new description of this service.
        Returns:
        New description.