org.apache.wicket.devutils.stateless.StatelessChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-devutils Show documentation
Wicket development utilities provide helpful features that are typically used during development only, but may be turned on for additional production debugging.
There is a newer version: 10.2.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.apache.wicket.devutils.stateless;

import org.apache.wicket.Component;
import org.apache.wicket.MarkupContainer;
import org.apache.wicket.Page;
import org.apache.wicket.Component.IVisitor;
import org.apache.wicket.application.IComponentOnBeforeRenderListener;

/**
 * Stateless checker. Checks if components with {@link StatelessComponent} annotation are really
 * stateless. This is a utility that is intended for use primarily during development. If you add an
 * instance of this class to your application, it will check all components or pages marked with the
 * StatelessComponent annotation to make sure that they are stateless as you intended.
 * 
 * This is useful when trying to maintain stateless pages since it is very easy to inadvertantly add
 * a component to a page that internally uses stateful links, etc.
 * 
 * @author Marat Radchenko
 * @see StatelessComponent
 */
public class StatelessChecker implements IComponentOnBeforeRenderListener
{
	/**
	 * Returns true if checker must check given component, false
	 * otherwise.
	 * 
	 * @param component
	 *            component to check.
	 * @return true if checker must check given component.
	 */
	private static boolean mustCheck(final Component component)
	{
		final StatelessComponent ann = component.getClass().getAnnotation(StatelessComponent.class);
		return ann != null && ann.enabled();
	}

	/**
	 * @see org.apache.wicket.application.IComponentOnBeforeRenderListener#onBeforeRender(org.apache.wicket.Component)
	 */
	public void onBeforeRender(final Component component)
	{
		if (StatelessChecker.mustCheck(component))
		{
			final IVisitor visitor = new Component.IVisitor()
			{
				public Object component(final Component comp)
				{
					if (component instanceof Page && StatelessChecker.mustCheck(comp))
					{
						// Do not go deeper, because this component will be checked by checker
						// itself.
						// Actually we could go deeper but that would mean we traverse it twice
						// (for current component and for inspected one).
						// We go deeper for Page because full tree will be inspected during
						// isPageStateless call.
						return IVisitor.CONTINUE_TRAVERSAL_BUT_DONT_GO_DEEPER;
					}
					else if (!comp.isStateless())
					{
						return comp;
					}
					else
					{
						return IVisitor.CONTINUE_TRAVERSAL;
					}
				}
			};

			final String msg = "'" + component + "' claims to be stateless but isn't.";
			if (!component.isStateless())
			{
				throw new IllegalArgumentException(msg +
					" Possible reasons: no stateless hint, statefull behaviors");
			}

			if (component instanceof MarkupContainer)
			{
				// Traverse children
				Component o = (Component)((MarkupContainer)component).visitChildren(visitor);
				if (o != null)
				{
				    throw new IllegalArgumentException(msg + " Offending component: " + o.toString(true));
				}
			}

			if (component instanceof Page)
			{
				final Page p = (Page)component;
				if (!p.isBookmarkable())
				{
					throw new IllegalArgumentException(msg +
						" Only bookmarkable pages can be stateless");
				}
				if (!p.isPageStateless())
				{
					throw new IllegalArgumentException(msg + " for unknown reason");
				}
			}
		}
	}
}