org.apache.openjpa.instrumentation.DataCacheInstrument Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.openjpa.instrumentation;
import java.util.Date;
import java.util.Map;
/**
* Interface for providing instrumented data cache metrics and operations.
*/
public interface DataCacheInstrument {
/**
* Gets number of total read requests for the given class since last reset.
*/
long getReadCount(String className);
/**
* Gets number of total read requests that has been found in cache for the given class since last reset.
*/
long getHitCount(String className);
/**
* Gets number of total write requests for the given class since last reset.
*/
long getWriteCount(String className);
/**
* Gets number of total read requests for the given class since start.
*/
long getTotalReadCount(String className);
/**
* Gets number of total read requests that has been found in cache for the given class since start.
*/
long getTotalHitCount(String className);
/**
* Gets number of total write requests for the given class since start.
*/
long getTotalWriteCount(String className);
/**
* Returns the name of the cache
*/
String getCacheName();
/**
* Returns the hit count since cache statistics were last reset
*/
long getHitCount();
/**
* Returns the read count since cache statistics were last reset
*/
long getReadCount();
/**
* Returns the total hits since start.
*/
long getTotalHitCount();
/**
* Returns the total reads since start.
*/
long getTotalReadCount();
/**
* Returns the total writes since start.
*/
long getTotalWriteCount();
/**
* Returns the write count since cache statistics were last reset
*/
long getWriteCount();
/**
* Resets cache statistics
*/
void reset();
/**
* Returns date since cache statistics collection were last reset.
*/
Date sinceDate();
/**
* Returns date cache statistics collection started.
*/
Date startDate();
/**
* Returns the names of classes that are known to the cache and whether or not they are currently being cached.
*/
Map listKnownTypes();
/**
* Returns true if cache statistics are currently being calculated. False otherwise.
*/
Boolean getStatisticsEnabled();
/**
*
* @param enable - If true, the cache will start collecting statistics. Else cache statistics will not be collected.
*/
void collectStatistics(boolean enable);
/**
* This method is used to enable/disable caching for the specified className.
*/
void cache(String className, boolean enable);
/**
* Returns the CacheStatistics for the cache.
* The format for this map is:
* Type(String) => Enabled(Boolean),Read(Long),Hit(Long),Write(Long)
*/
Map getCacheStatistics();
/**
* Clears all data from the DataCache.
*/
void clear();
}