org.anyframe.iam.core.intercept.web.RestrictedTimesFilterSecurityInterceptor.java Source code

Introduction

Here is the source code for org.anyframe.iam.core.intercept.web.RestrictedTimesFilterSecurityInterceptor.java

Source

/*
 * Copyright 2002-2008 the original author or 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.anyframe.iam.core.intercept.web;

import java.io.IOException;

import javax.servlet.ServletException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.security.web.FilterInvocation;
import org.springframework.security.web.access.intercept.FilterSecurityInterceptor;

/**
 * This class extends FilterSecurityInterceptor of Spring Security.
 * In pair of ReloadableRestrictedTimesFilterInvocationDefinitionSource and 
 * AnyframeRoleHierarchyRestrictedVoter, it calls alwaysTimeRoleCheck, 
 * dailyFilteredTimeRoleCheck, alwaysTimeResourceCheck and dailyFilteredTimeResourceCheck sequentially.
 * The order will be duplicated because of FilterSecurityInterceptor is included by default
 * in case of using Namespace of Spring Security, so register it as custom-filter, keep in mind about position
 * 
 * @author Byunghun Woo
 * 
 */
public class RestrictedTimesFilterSecurityInterceptor extends FilterSecurityInterceptor {
    protected static final Log logger = LogFactory.getLog(RestrictedTimesFilterSecurityInterceptor.class);

    /**
     * FILTER_APPLIED -
     * "__anyframe_iam_restrictedTimesFilterSecurityInterceptor_filterApplied"
     */
    private static final String FILTER_APPLIED = "__anyframe_iam_restrictedTimesFilterSecurityInterceptor_filterApplied";

    //   public int getOrder() {
    //      return super.getOrder() - 60;
    //   }

    /**
     * Main method of filter to check restricted times
     */
    public void invoke(FilterInvocation fi) throws IOException, ServletException {

        if ((fi.getRequest() != null) && (fi.getRequest().getAttribute(FILTER_APPLIED) != null)
                && isObserveOncePerRequest()) {

            fi.getChain().doFilter(fi.getRequest(), fi.getResponse());
        } else {

            if (fi.getRequest() != null) {
                fi.getRequest().setAttribute(FILTER_APPLIED, Boolean.TRUE);
            }

            // Role ? Resource ?  (Voter ? ACCESS/DENIED ? )
            // FilterInvocation ? wrapping 
            FilterInvocationWrapper fiWrapper = new FilterInvocationWrapper(fi);

            // alwaysTimeRoleCheck
            if (logger.isDebugEnabled())
                logger.debug("== alwaysTimeRoleCheck started ==");
            RestrictedResourceHolder.setPresentResource(RestrictedResourceHolder.RESTRICTED_RESOURCE_TYPE[0]);
            super.beforeInvocation(fiWrapper);

            // dailyFilteredTimeRoleCheck
            if (logger.isDebugEnabled())
                logger.debug("== dailyFilteredTimeRoleCheck started ==");
            RestrictedResourceHolder.setPresentResource(RestrictedResourceHolder.RESTRICTED_RESOURCE_TYPE[1]);
            super.beforeInvocation(fiWrapper);

            // alwaysTimeResourceCheck
            if (logger.isDebugEnabled())
                logger.debug("== alwaysTimeResourceCheck started ==");
            RestrictedResourceHolder.setPresentResource(RestrictedResourceHolder.RESTRICTED_RESOURCE_TYPE[2]);
            super.beforeInvocation(fi);

            // dailyFilteredTimeResourceCheck
            if (logger.isDebugEnabled())
                logger.debug("== dailyFilteredTimeResourceCheck started ==");
            RestrictedResourceHolder.setPresentResource(RestrictedResourceHolder.RESTRICTED_RESOURCE_TYPE[3]);
            super.beforeInvocation(fi);

            fi.getChain().doFilter(fi.getRequest(), fi.getResponse());

        }
    }
}