Package org.jolokia.server.core.service.api

Interface JolokiaService<T extends JolokiaService<?>>

All Superinterfaces:
Comparable<T>
All Known Subinterfaces:
JolokiaService.Init, NotificationBackend, RequestHandler, RequestInterceptor, Serializer, ServerDetector
All Known Implementing Classes:
AbstractJolokiaService, AbstractRequestHandler, DebugStore, VersionRequestHandler
public interface JolokiaService<T extends JolokiaService<?>> extends Comparable<T>
Interface describing a Jolokia Service. Jolokia Services are used within Jolokia for various tasks. Each service has a specific type describing its API. Also, it has an order which is used when multiple services exist. Services can be created in many ways, either statically (and then registered at the JolokiaServiceManager) or dynamically via a JolokiaServiceLookup (which is especially suited for looking up OSGi services).
Since:
28.03.13
Author:
roland

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    JolokiaService.Init
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroy()
    Lifecycle method called when agent goes down.
    int
    getOrder()
    Order of the service.
    Class<T>
    getType()
    The service type which is used to distinguish the various services.
    void
    init(JolokiaContext pJolokiaContext)
    Lifecycle method called when the services are initialized

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • getOrder

      int getOrder()
      Order of the service. The higher the number, the later in the list of services this service appears. Default order is 100.
      Returns:
      the order of this service

    • getType

      Class<T> getType()
      The service type which is used to distinguish the various services. The service type is an extension of this base interface and add service specific methods to it
      Returns:
      service type

    • destroy

      void destroy() throws Exception
      Lifecycle method called when agent goes down.
      Throws:
      Exception

    • init

      void init(JolokiaContext pJolokiaContext)
      Lifecycle method called when the services are initialized
      Parameters:
      pJolokiaContext - the jolokia context used