Package org.jolokia.server.core.service.notification

Interface NotificationSubscription

public interface NotificationSubscription
Interface for offering registration information to the backend and means for refreshing a client.
Since:
21.03.13
Author:
roland

  • Method Summary

    Modifier and Type
    Method
    Description
    Client
    getClient()
    Get the client id which registered this notification
    Map<String,?>
    getConfig()
    Extra configuration for this registration request (can be null or empty)
    List<String>
    getFilter()
    List of filters on notification types, can be null
    Object
    getHandback()
    Optional handback object (can be null)
    String
    getHandle()
    Get the handle of the registration.
    ObjectName
    getMBean()
    MBean on which the notification listener is registered
    void
    ping()
    Method which should be called if a client could be reached.

  • Method Details

    • ping

      void ping()
      Method which should be called if a client could be reached. This will update the freshness of the client itself. Clients which are not active within a certain period are considered as 'stale' and are removed.

    • getClient

      Client getClient()
      Get the client id which registered this notification
      Returns:
      client id

    • getHandle

      String getHandle()
      Get the handle of the registration. Required for retreiving the stored notifications

    • getMBean

      ObjectName getMBean()
      MBean on which the notification listener is registered
      Returns:
      mbean name

    • getFilter

      List<String> getFilter()
      List of filters on notification types, can be null
      Returns:
      filters

    • getHandback

      Object getHandback()
      Optional handback object (can be null)
      Returns:
      handback or null;

    • getConfig

      Map<String,?> getConfig()
      Extra configuration for this registration request (can be null or empty)
      Returns:
      config map or null