org.vaadin.spring.security.VaadinSecurityContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-vaadin-security Show documentation
The newest version!
/*
 * Copyright 2015 The original authors
 *
 * 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.vaadin.spring.security;

import org.springframework.context.ApplicationContext;
import org.springframework.security.access.AccessDecisionManager;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.web.authentication.AuthenticationFailureHandler;
import org.springframework.security.web.authentication.AuthenticationSuccessHandler;
import org.springframework.security.web.authentication.session.SessionAuthenticationStrategy;
import org.vaadin.spring.security.web.authentication.VaadinAuthenticationFailureHandler;
import org.vaadin.spring.security.web.authentication.VaadinAuthenticationSuccessHandler;

/**
 * Interface which provides access to basic Security Context objects.
 * 
 * @author Gert-Jan Timmer ([email protected])
 *
 */
public interface VaadinSecurityContext {

    /**
     * Get the current Spring ApplicationContext
     * 
     * @return {@link org.springframework.context.ApplicationContext}
     */
    ApplicationContext getApplicationContext();

    /**
     * Get the configured {@link org.springframework.security.authentication.AuthenticationManager}
     * return {@code null} if not available.
     * 
     * @return {@link org.springframework.security.authentication.AuthenticationManager}
     */
    AuthenticationManager getAuthenticationManager();

    /**
     * Get the configured {@link org.springframework.security.access.AccessDecisionManager}
     * return {@code null} if not available.
     * 
     * @return {@link org.springframework.security.access.AccessDecisionManager}
     */
    AccessDecisionManager getAccessDecisionManager();

    /**
     * Get the configured {@link SessionAuthenticationStrategy}
     * return {@link org.springframework.security.web.authentication.session.NullAuthenticatedSessionStrategy} if not configured
     * 
     * @return {@link SessionAuthenticationStrategy}
     */
    SessionAuthenticationStrategy getSessionAuthenticationStrategy();
    
    /** 
     * Checks if the Security bean has an accessDecisionManager
     * 
     * @return true if the Security bean has an accessDecisionManager
     */
    boolean hasAccessDecisionManager();
    
    /**
     * Add {@link AuthenticationSuccessHandler}
     * 


     * Set to null to deactivate
     */
    void addAuthenticationSuccessHandler(VaadinAuthenticationSuccessHandler handler);
    
    /**
     * Check if {@link AuthenticationSuccessHandler} is configured
     * 


     * @return true if configured, else false
     */
    boolean hasAuthenticationSuccessHandlerConfigured();
    
    /**
     * Add {@link AuthenticationFailureHandler}
     * 


     * Set to null to deactivate
     */
    void addAuthenticationFailureHandler(VaadinAuthenticationFailureHandler handler);
    
    /**
     * Check if {@link AuthenticationFailureHandler} is configured
     * 


     * @return true if configured, else false
     */
    boolean hasAuthenticationFailureHandlerConfigured();
}