javax.cache.mbeans.CacheMXBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.cache.wso2 Show documentation

OSGi Bundle for JCache API

The newest version!

/**
 *  Copyright (c) 2011 Terracotta, Inc.
 *  Copyright (c) 2011 Oracle and/or its affiliates.
 *
 *  All rights reserved. Use is subject to license terms.
 */
package javax.cache.mbeans;

import javax.cache.Status;
import javax.management.MXBean;

/**
 * A management bean for cache.
 * 
 * Each cache's statistics object must be registered with an ObjectName that is unique and has the following:
 * 

 * Type:
 * javax.cache:type=CacheStatistics
 * 

 * Required Attributes:
 * 

 * CacheManager Name
 * 
Cache Name
 * 
 *
 * @author Greg Luck
 * @author Yannis Cosmadopoulos
 * @since 1.0
 */
@MXBean
public interface CacheMXBean extends CacheStatisticsMXBean {
    /**
     * @return the name of the Cache these statistics are for
     */
    String getName();

    /**
     * Gets the {@link javax.cache.Status} attribute of the Cache.
     *
     * @return The status value from the Status enum class
     */
    Status getStatus();
}