org.xlcloud.iam.EntitlementContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iam-utils Show documentation

This module is provides set of base IAM utilities.

The newest version!

/*
 * Copyright 2012 AMG.lab, a Bull Group Company
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *    http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.xlcloud.iam;

/**
 * Context that stores current HTTP action and path and user's access token, so that user entitlements can be evaluated
 *
 * @author Tomek Adamczewski, AMG.net
 */
public interface EntitlementContext {

    /**
     * Gets the value of {@link #action}.
     * 
     * @return value of {@link #action}
     */
    public String getAction();

    /**
     * Sets the value of {@link #action}.
     * 
     * @param action
     *            - value
     */
    public void setAction(String action);

    /**
     * Gets the value of {@link #resource}.
     * 
     * @return value of {@link #resource}
     */
    public String getResource();

    /**
     * Sets the value of {@link #resource}.
     * 
     * @param resource
     *            - value
     */
    public void setResource(String resource);

    /**
     * Gets the value of {@link #accessToken}.
     * 
     * @return value of {@link #accessToken}
     */
    public String getAccessToken();

    /**
     * Sets the value of {@link #accessToken}.
     * 
     * @param accessToken
     *            - value
     */
    public void setAccessToken(String accessToken);
}