gistfile1.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.jboss.aerogear.security.authz;

import org.jboss.aerogear.security.model.AeroGearUser;

/**
 * <i>IdentityManagement</i> allows to assign a set of roles to {@link AeroGearUser} on Identity Manager provider
 */
public interface IdentityManagement {

    /**
     * new CRUD methods
     */
     
    void get(String id);
    
    void create(AeroGearUser aeroGearUser);
    
    void remove(AeroGearUser aeroGearUser);
    
    void update(AeroGearUser aeroGearUser);
    
    void List getAll();
    
    
    
    /**
     * This method allows to specify which <i>roles</i> must be assigned to {@link AeroGearUser}
     * @param roles The list of roles.
     * @return {@link GrantMethods} is a builder which a allows to apply a list of roles to the specified {@link AeroGearUser}.
     */
    GrantMethods grant(String... roles);

    

    /**
     * <i>GrantMethods</i> is a builder to apply roles to {@link AeroGearUser}
     */
    static interface GrantMethods {
        /**
         * This method applies roles specified on {@link IdentityManagement#grant(String...)}
         * @param aeroGearUser represents a simple user's implementation to hold credentials.
         */
        void to(AeroGearUser aeroGearUser);
    }
}