org.wicketstuff.security.WaspWebApplication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-security-wasp Show documentation
Wicket Abstract Security Platform
There is a newer version: 10.3.0
Show newest version
/*
 * 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;

import org.apache.wicket.Application;
import org.apache.wicket.Session;
import org.apache.wicket.protocol.http.WebApplication;
import org.apache.wicket.request.Request;
import org.apache.wicket.request.Response;
import org.wicketstuff.security.actions.ActionFactory;
import org.wicketstuff.security.strategies.StrategyFactory;

/**
 * Base class for WebAplications with a wasp security framework.
 * 
 * @author marrink
 * @author Olger Warnier
 */
public abstract class WaspWebApplication extends WebApplication implements WaspApplication
{
	/**
	 * creates a new secure webapplication.
	 */
	public WaspWebApplication()
	{
		super();
	}

	/**
	 * Initializes the actionfactory and the strategyfactory. If you override this method you must
	 * either call super.init() or setup the actionfactory and the strategyfactory yourself. In that
	 * order.
	 * 
	 * @see WebApplication#init()
	 */
	@Override
	protected void init()
	{
		setupActionFactory();
		setupStrategyFactory();
	}

	/**
	 * Creates a new WaspSession. If you override this method make sure you return a subclass of
	 * {@link WaspSession}.
	 */
	@Override
	public Session newSession(Request request, Response response)
	{
		return new WaspSession(this, request);
	}

	/**
	 * Called by the {@link WaspWebApplication#init()}. use this to create and initialize your
	 * factory. The factory created here should be returned when calling
	 * {@link WaspApplication#getStrategyFactory()}.
	 * 
	 * @see WaspApplication#getStrategyFactory()
	 */
	protected abstract void setupStrategyFactory();

	/**
	 * Called by the {@link WaspWebApplication#init()}. use this to create and initialize your
	 * factory. The factory created here should be returned when calling
	 * {@link WaspApplication#getActionFactory()}.
	 * 
	 * @see WaspApplication#getActionFactory()
	 */
	protected abstract void setupActionFactory();

	/**
	 * Destroys the strategy factory and the action factory. In that order. If you override this
	 * method you must call super.onDestroy().
	 * 
	 * @see Application#onDestroy()
	 */
	@Override
	protected void onDestroy()
	{
		StrategyFactory factory = getStrategyFactory();
		if (factory != null)
			factory.destroy();
		// because we destroy the actionfactory with the wicket app it is not
		// recommended to share actionfactories.
		ActionFactory factory2 = getActionFactory();
		if (factory2 != null)
			factory2.destroy();
	}
}