Class CacheKeyProvider

java.lang.Object
org.jolokia.server.core.service.api.AbstractJolokiaService<CacheKeyProvider>
org.jolokia.service.jmx.api.CacheKeyProvider
All Implemented Interfaces:
Comparable<CacheKeyProvider>, org.jolokia.server.core.service.api.JolokiaService<CacheKeyProvider>
Direct Known Subclasses:
JDKManagementCacheKeyProvider
public abstract class CacheKeyProvider extends org.jolokia.server.core.service.api.AbstractJolokiaService<CacheKeyProvider> implements org.jolokia.server.core.service.api.JolokiaService<CacheKeyProvider>
An SPI interface used by ListHandler that can be used to optimize the structure of list() operation.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.jolokia.server.core.service.api.JolokiaService

    org.jolokia.server.core.service.api.JolokiaService.Init

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CacheKeyProvider(int pOrderId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    determineKey(ObjectInstance objectInstance)
    By providing a non-null key for an ObjectInstance an extension may tell Jolokia that the JSON data for MBeanInfo can be shared with other instances that use the same cache key.

    Methods inherited from class org.jolokia.server.core.service.api.AbstractJolokiaService

    compareTo, destroy, getJolokiaContext, getOrder, getType, init, isEnabled, registerJolokiaMBean, unregisterJolokiaMBean

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface org.jolokia.server.core.service.api.JolokiaService

    destroy, getOrder, getType, init, isEnabled

  • Constructor Details

    • CacheKeyProvider

      protected CacheKeyProvider(int pOrderId)

  • Method Details

    • determineKey

      public abstract String determineKey(ObjectInstance objectInstance)
      By providing a non-null key for an ObjectInstance an extension may tell Jolokia that the JSON data for MBeanInfo can be shared with other instances that use the same cache key. This heavily optimizes memory usage and size of list() response.
      Parameters:
      objectInstance -
      Returns: