org.apache.wicket.session.pagemap.IPageMapEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.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.session.pagemap;

import org.apache.wicket.IClusterable;
import org.apache.wicket.Page;

/**
 * Some source which produces a page. Page implements IPageMapEntry by simply returning "this", but
 * other implementations are possible as well, allowing users to create IPageMapEntry
 * implementations that reconstruct full blown Page objects from a limited set of data (for example,
 * a details page from an id). The advantage of doing this is that you can save session memory (by
 * trading off against the processing power required to reconstruct the page).
 * 
 * @see org.apache.wicket.session.pagemap.AbstractPageMapEntry
 * @author Jonathan Locke
 */
public interface IPageMapEntry extends IClusterable
{
	/**
	 * @return A stable identifier for this page map entry
	 */
	int getNumericId();

	/**
	 * @return Gets the page, possibly creating it on the fly.
	 */
	Page getPage();

	/**
	 * @return The class of page stored in this page map entry (which can be used by an eviction
	 *         strategy to prioritize evictions)
	 */
	Class getPageClass();

	/**
	 * @param id
	 *            The numeric id for this entry
	 */
	void setNumericId(int id);
}