001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019package lucee.runtime.functions.cache;
020
021import java.io.IOException;
022
023import lucee.commons.io.cache.Cache;
024import lucee.runtime.PageContext;
025import lucee.runtime.config.ConfigImpl;
026import lucee.runtime.exp.ApplicationException;
027import lucee.runtime.exp.PageException;
028import lucee.runtime.ext.function.Function;
029import lucee.runtime.op.Caster;
030
031/**
032 * 
033 */
034public final class CacheDelete implements Function {
035        
036        private static final long serialVersionUID = 4148677299207997607L;
037
038        public static String call(PageContext pc, String id) throws PageException {
039                return call(pc, id, false,null);
040        }
041        public static String call(PageContext pc, String id, boolean throwOnError) throws PageException {
042                return call(pc, id, throwOnError, null);
043        }
044        
045        public static String call(PageContext pc, String id, boolean throwOnError, String cacheName) throws PageException {
046                try {
047                        Cache cache = Util.getCache(pc,cacheName,ConfigImpl.CACHE_DEFAULT_OBJECT);
048                        if(!cache.remove(Util.key(id)) && throwOnError){
049                                throw new ApplicationException("can not remove the element with the following id ["+id+"]");
050                        }       
051                } 
052                catch (IOException e) {
053                        throw Caster.toPageException(e);
054                }
055                return null;
056        }
057        
058}