com.sun.enterprise.admin.util.cache.AdminCache Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.util.cache;
import java.util.Date;
/** Simple cache for administration framework.
*
* @author mmares
*/
public interface AdminCache {
/** Retrieve data from cache.
*
* @param key in the cache
* @param clazz Cache data will be converted to requested type using
* appropriate {@code AdminCacheObjectProvider}
* @return Cached data converted to requested type or {@code null} if not cached
*/
public A get(String key, Class clazz);
/** Puts data to cache.
*
* @param key in the cache
* @param data Cached data will be converted to raw bytes using
* appropriate {@code AdminCacheObjectProvider}
* @return Cached data converted to requested type or {@code null} if not cached
*/
public void put(String key, Object data);
/** Checked if content is in the cache.
*
* @param key in the cache
*/
public boolean contains(String key);
/** Date when was cached data last updated.
*
* @param key in the cache
* @return {@code Date} of last update or null if does not exist in cache
*/
public Date lastUpdated(String key);
}