SecurityContext.java

/**
 * Copyright 2014 David L. Whitehurst
 * 
 * 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.musicrecital.webapp.services;

import org.musicrecital.model.User;
import org.springframework.security.core.userdetails.UserDetails;


public interface SecurityContext {
    /**
     * Return true if user is authenticated, false otherwise
     */
    boolean isLoggedIn();
    UserDetails getUserDetails();

    /**
     * Logged in user
     * @return
     */
    User getUser();

    String getUsername();

    /**
     * Check if user has a role
     * @param roleName
     * @return
     */
    boolean hasRoles(String roleName);

    /**
     * Verify if user has admin role
     * @return
     */
    boolean isAdmin();

    /**
     * Authenticates user
     * @param user
     */
    void login(User user);

    /**
     * logs user out
     */
    void logout();

    /**
     *
     * @return
     */
    boolean isRememberMe();
}