org.xwiki.environment.internal.EnvironmentConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-environment-common Show documentation

Common implementation classes for all Environment implementations

There is a newer version: 16.10.2

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 software 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.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.environment.internal;

import org.xwiki.component.annotation.Role;

/**
 * Configuration properties for the Environment module.
 *
 * @version $Id: 9fbcf41526d7f39621c58e3dc0bffa454ba67ad0 $
 * @since 3.5M1
 */
@Role
public interface EnvironmentConfiguration
{
    /**
     * @return the path to the directory used to store persistent data
     *         (data that should persist across server restarts). This is an important directory
     *         containing important data and thus it should never be deleted (it should be backed-up
     *         along with the database), or null if the user hasn't specified any permanent directory
     */
    String getPermanentDirectoryPath();
}