i_cmscheckresource.java

内容管理

/*
 * File   : $Source: /usr/local/cvs/opencms/src/com/opencms/core/Attic/I_CmsCheckResource.java,v $
 * Date   : $Date: 2003/05/05 08:06:24 $
 * Version: $Revision: 1.1 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Mananagement System
 *
 * Copyright (C) 2002 - 2003 Alkacon Software (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
package com.opencms.core;

import com.opencms.core.exceptions.CmsCheckResourceException;
import com.opencms.file.CmsFile;
import com.opencms.file.CmsObject;

/**
 * This interface checks the requested resource from the OpenCms request context
 * and returns it to the calling method, which will usually be 
 * OpenCms.initResource(cms).<p>
 * 
 * @author  Andreas Zahner ([e-mail])
 * @version $Revision: 1.1 $
 */
public interface I_CmsCheckResource {

/**
 * Possibility to modify or change the CmsFile with the CmsObject.<p>
 * 
 * @param file the requested file
 * @param cms the current CmsObject
 * @return CmsFile a file in the OpenCms VFS
 * @throws CmsCheckResourceException throw this exception if other implementations of the interface should not be executed
 */
public CmsFile checkResource(CmsFile file, CmsObject cms) throws CmsCheckResourceException;

}