org.wicketstuff.security.checks.AbstractSecurityCheck.java Source code

Introduction

Here is the source code for org.wicketstuff.security.checks.AbstractSecurityCheck.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.wicketstuff.security.checks;

import org.apache.wicket.Application;
import org.apache.wicket.Page;
import org.apache.wicket.WicketRuntimeException;
import org.wicketstuff.security.WaspApplication;
import org.wicketstuff.security.WaspSession;
import org.wicketstuff.security.actions.ActionFactory;
import org.wicketstuff.security.actions.WaspAction;
import org.wicketstuff.security.strategies.WaspAuthorizationStrategy;

/**
 * Basic check providing some utility methods.
 * 
 * @author marrink
 * @see ISecurityCheck
 */
public abstract class AbstractSecurityCheck implements ISecurityCheck {
    private static final long serialVersionUID = 1L;

    /**
     * Noop constructor for Serialization.
     * 
     */
    protected AbstractSecurityCheck() {
    }

    /**
     * Utility method to get the factory to create {@link WaspAction}s.
     * 
     * @return the factory
     * @see WaspApplication#getActionFactory()
     */
    protected ActionFactory getActionFactory() {
        return ((WaspApplication) Application.get()).getActionFactory();
    }

    /**
     * Utility method to get to the {@link WaspAuthorizationStrategy}.
     * 
     * @return the strategy
     * @see WaspSession#getAuthorizationStrategy()
     */
    protected WaspAuthorizationStrategy getStrategy() {
        return WaspAuthorizationStrategy.get();
    }

    /**
     * Utility method to get the class of the loginpage.
     * 
     * @return the login page
     * @see WaspApplication#getLoginPage()
     */
    protected final Class<? extends Page> getLoginPage() {
        return ((WaspApplication) Application.get()).getLoginPage();
    }

    /**
     * Shortcut to {@link ISecurityCheck#isActionAuthorized(WaspAction)} if you quickly want to
     * check an action. Note that this is the same as doing something like </br> <code>
     * check.isActionAuthorized(((WaspApplication)Application.get()).getActionFactory().getAction(Render.class));
     * </code>
     * 
     * @param waspAction
     * @return true if the action is authorized, false otherwise
     * @throws WicketRuntimeException
     *             if the class is not an instance of {@link WaspAction}
     */
    public boolean isActionAuthorized(Class<? extends WaspAction> waspAction) {
        if (!WaspAction.class.isAssignableFrom(waspAction))
            throw new WicketRuntimeException("The class: " + waspAction + " is not a valid " + WaspAction.class);
        return isActionAuthorized(getActionFactory().getAction(waspAction));
    }
}