Interface ServiceRegistration


  • public interface ServiceRegistration
    A service registration request.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static se.arkalix.core.plugin.sr.ServiceRegistrationDto from​(se.arkalix.description.ServiceDescription description)  
      java.util.List<se.arkalix.descriptor.InterfaceDescriptor> interfaces()
      Interface triplets supported by the service.
      java.util.Map<java.lang.String,​java.lang.String> metadata()
      Arbitrary metadata to associate with registered service.
      java.lang.String name()
      Unique service name.
      SystemDetails provider()
      The system providing the service.
      java.util.Optional<se.arkalix.descriptor.SecurityDescriptor> security()
      The access policy employed by the service.
      java.lang.String uri()
      Qualifier that distinguishes this service from other such provided by the same system.
      java.util.Optional<java.lang.Integer> version()
      Service version.
    • Method Detail

      • name

        java.lang.String name()
        Unique service name.
      • provider

        SystemDetails provider()
        The system providing the 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".

      • security

        java.util.Optional<se.arkalix.descriptor.SecurityDescriptor> security()
        The access policy employed by the service.
      • metadata

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

        java.util.Optional<java.lang.Integer> version()
        Service version.
      • interfaces

        java.util.List<se.arkalix.descriptor.InterfaceDescriptor> interfaces()
        Interface triplets supported by the service.

        If the service is provided securely over HTTP and supports JSON and XML, then its two triplets would be "HTTP-SECURE-JSON" and "HTTP-SECURE-XML".

      • from

        static se.arkalix.core.plugin.sr.ServiceRegistrationDto from​(se.arkalix.description.ServiceDescription description)