com.adobe.granite.oauth.server.Scope 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

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2014 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.granite.oauth.server;

import javax.servlet.http.HttpServletRequest;
import org.apache.jackrabbit.api.security.user.User;

/**
 * The Scope provides a simple API to 
 * handle scopes 
 *  
 * @deprecated Deprecated in favor of Adobe IMS integration.
 */
@Deprecated
public interface Scope {
    
    /**
     * Get the scope name
     * 
     * @return the scope name
     */
    public String getName();
    
    /**
     * Get the resource path associated with the scope
     * 
     * @param user The authenticated user
     * @return The resource path associated to the scope
     */
    public String getResourcePath(User user);
    
    /**
     * Get the endpoint associated with the scope
     * 
     * @return the endpoint associated to the scope
     */
    public String getEndpoint();
    
    /**
     * Get the description associated with the scope
     * 
     * @param request The HttpServletRequest request
     * @return the scope description
     */
    public String getDescription(HttpServletRequest request);
}