org.opencms.repository.I_CmsRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (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 GmbH & Co. KG, 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 org.opencms.repository;

import org.opencms.configuration.I_CmsConfigurationParameterHandler;
import org.opencms.file.CmsObject;
import org.opencms.main.CmsException;

/**
 * Represents a repository.
 *
 * Since different types of repositories have very different methods, this interface only
 * provides the bare minimum of methods which are necessary for configuration.

 *
 * @since 6.2.4
 */
public interface I_CmsRepository extends I_CmsConfigurationParameterHandler {

    /**
     * Gets the repository filter.

     *
     * @return the repository filter
     */
    CmsRepositoryFilter getFilter();

    /**
     * Returns the name of the repository.

     *
     * @return the name of the repository
     */
    String getName();

    /**
     * Initializes this repository with an admin CMS object.

     *
     * @param cms an admin CMS object
     * @throws CmsException if something goes wrong
     */
    void initializeCms(CmsObject cms) throws CmsException;

    /**
     * Sets the repository filter.

     *
     * @param filter the repository filter
     */
    void setFilter(CmsRepositoryFilter filter);

    /**
     * Sets the name for this repository.
     *
     * @param name the name to use for the repository
     */
    void setName(String name);
}