org.xlcloud.console.context.AccessEngineClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation

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.console.context;

import org.xlcloud.service.HttpAction;
import com.iplanet.sso.SSOToken;

/**
 * Engine responsible for checking access permission basing on user's or subject entitlements
 * @author Ksiazczyk Grzegorz, AMG.net
 */
public interface AccessEngineClient {

    /**
     * Verifies whether user with specified token has access to specified action and path
     * @param action action
     * @param path path
     * @return {@code true} if user has access, {@code false} otherwise
     */
    boolean hasAccess(SSOToken userToken, HttpAction action, String path);
    
    /**
     * Verifies whether subject described by specified policy name has access to specified action and path.
     * @param policyName policy name
     * @param action action
     * @param path path
     * @return {@code true} if subject has access, {@code false} otherwise
     */
    boolean subjectHasAccess(String policyName, HttpAction action, String path);
    
    /**
     * Verifies if access token is valid
     * 
     * @param accessToken
     * @return
     */
    boolean isTokenValid(String accessToken);
}