com.day.cq.security.privileges.Privilege Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.security.privileges;

/**
 * A Privilege is a permission that is granted a given
 * {@link com.day.cq.security.Authorizable Authorizable}.
 * A Privilege is right, that is independant of a particular
 * {@link javax.jcr.Item Item-independant}.
 * Rights of Items are granted and enforced on by the
 * {@link javax.jcr.Repository Repository}.
 * It is still possible that the validity of a Privilege is restricted on
 * pathes within the Repository. In this case the Privilege is
 * {@link com.day.cq.security.privileges.Privilege#isPathDependent()} path depoendent}.
 *
 * @see com.day.cq.security.privileges.PrivilegeFactory
 * @deprecated CQ 5.5
 */
public interface Privilege {

    /**
     * getID.
     *
     * @return the ID of the current Privilege, should be a relative path
     */
    String getID();

    /**
     * isPathDependent.
     *
     * @return if the privilege is different for different repository locations
     */
    boolean isPathDependent();

    /**
     * isGranted.
     *
     * @param path repository path or null if this Privilege is
     *        {@link #isPathDependent() is path independent}
     * @return true if the privilige is granted on the given path
     *         or if the Privilege is path indedpendent
     */
    boolean isGranted(String path);
}