/* dCache - http://www.dcache.org/
 *
 * Copyright (C) 2015 Deutsches Elektronen-Synchrotron
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.dcache.auth.attributes;

/**
 * The Activity class provides a very course-grain set of actions that
 * a user may attempt.  It is intended to be used when making course-grain
 * authorisation decisions, with the target being objects in the namespace.
 */
public enum Activity
{
    /**
     * List the contents of a directory.  For each directory item,
     * if {@code #READ_METADATA} is denied then that directory item is
     * excluded from the list.
     * <p>
     * This Activity is undefined against a non-directory item.
     */
    LIST,

    /**
     * Read the contents of the target.  For files, this represents the
     * attempts to read the contents of that file.  For sym-link, this
     * represents the ability to know the target of the sym-link; at least one
     * additional DOWNLOAD permission is needed to read the actual content.
     * <p>
     * This Activity is undefined against a directory.
     */
    DOWNLOAD,

    /**
     * Manage existing content.  The target of this action is always a
     * directory.  This represents renaming an item, moving an item into another
     * directory, or create a new (sub-)directory.  Unlike CREATE+DELETE, MANAGE
     * does not allow arbitrary changes to existing content.  A rename that
     * overwrites some existing content is allowed only if a corresponding
     * DELETE of the target is allowed.
     * <p>
     * This Activity is undefined against a non-directory item.
     */
    MANAGE,

    /**
     * Create a new file within dCache.  Note that creating new directory or a
     * new sym-link is the MANAGE Activity.
     * <p>
     * There are two kinds of UPLOAD activity: a specific upload and querying
     * support for uploading.  For the former, the target is the path of the
     * desired file; for the latter, the target is the parent directory of the
     * file.
     */
    UPLOAD,

    /**
     * Remove the target.  The target can be any directory item: file, symbolic
     * link or directory.  Note that if a user has MANAGE and limited DELETE
     * then they can DELETE all items they can MANAGE.
     */
    DELETE,

    /**
     * Read any metadata associated with the target.  For a directory, this
     * also represents attempts for that user to change directory.
     */
    READ_METADATA,

    /**
     * Update metadata about the target.  This includes modifying a file's
     * permissions, ownership, ACL, etc.
     */
    UPDATE_METADATA
}