GaeEnroler.java

/**
 * Copyright 2005-2014 Restlet
 * 
 * The contents of this file are subject to the terms of one of the following
 * open source licenses: Apache 2.0 or or EPL 1.0 (the "Licenses"). You can
 * select the license that you prefer but you may not use this file except in
 * compliance with one of these Licenses.
 * 
 * You can obtain a copy of the Apache 2.0 license at
 * http://www.opensource.org/licenses/apache-2.0
 * 
 * You can obtain a copy of the EPL 1.0 license at
 * http://www.opensource.org/licenses/eclipse-1.0
 * 
 * See the Licenses for the specific language governing permissions and
 * limitations under the Licenses.
 * 
 * Alternatively, you can obtain a royalty free commercial license with less
 * limitations, transferable or non-transferable, directly at
 * http://restlet.com/products/restlet-framework
 * 
 * Restlet is a registered trademark of Restlet S.A.S.
 */

package org.restlet.ext.gae;

import org.restlet.Application;
import org.restlet.data.ClientInfo;
import org.restlet.security.Enroler;
import org.restlet.security.Role;

import com.google.appengine.api.users.UserServiceFactory;

/**
 * Enroler that adds a Restlet {@link Role} object to the request's
 * {@link ClientInfo} if the GAE API reports that the user is an administrator.
 * 
 * @author Matt Kennedy
 */
public class GaeEnroler implements Enroler {

    /** The Administrator role. */
    private Role adminRole;

    /**
     * Default constructor. It defines an administrator role, which name is
     * "admin".
     */
    public GaeEnroler() {
        this("admin", "Administrator of the current application.");
    }

    /**
     * Constructor.
     * 
     * @param application
     *            The parent application.
     * @param adminRoleName
     *            The name of the administrator role.
     */
    public GaeEnroler(Application application, String adminRoleName) {
        this(Role.get(application, adminRoleName,
                "Administrator of the current application."));
    }

    /**
     * Constructor.
     * 
     * @param application
     *            The parent application.
     * @param adminRoleName
     *            The name of the administrator role.
     * @param adminRoleDescription
     *            The description of the administrator role.
     */
    public GaeEnroler(Application application, String adminRoleName,
            String adminRoleDescription) {
        this(Role.get(application, adminRoleName, adminRoleDescription));
    }

    /**
     * Constructor.
     * 
     * @param adminRole
     *            The administrator role.
     */
    public GaeEnroler(Role adminRole) {
        setAdminRole(adminRole);
    }

    /**
     * Constructor.
     * 
     * @param adminRoleName
     *            The name of the administrator role.
     * @deprecated Use {@link #GaeEnroler(Application, String)} instead.
     */
    @Deprecated
    public GaeEnroler(String adminRoleName) {
        this(adminRoleName, "Administrator of the current application.");
    }

    /**
     * Constructor.
     * 
     * @param adminRoleName
     *            The name of the administrator role.
     * @param adminRoleDescription
     *            The description of the administrator role.
     * @deprecated Use {@link #GaeEnroler(Application, String, String)} instead.
     */
    @Deprecated
    public GaeEnroler(String adminRoleName, String adminRoleDescription) {
        this(new Role(adminRoleName, adminRoleDescription));
    }

    /**
     * Adds admin role object if user is an administrator according to Google
     * App Engine UserService.
     * 
     * @see org.restlet.security.Enroler#enrole(org.restlet.data.ClientInfo)
     */
    public void enrole(ClientInfo info) {
        if (UserServiceFactory.getUserService().isUserAdmin()
                && getAdminRole() != null) {
            info.getRoles().add(getAdminRole());
        }
    }

    /**
     * Returns the administrator role.
     * 
     * @return The administrator role.
     */
    public Role getAdminRole() {
        return adminRole;
    }

    /**
     * Sets the administrator role.
     * 
     * @param adminRole
     *            The administrator role.
     */
    public void setAdminRole(Role adminRole) {
        this.adminRole = adminRole;
    }

}