org.apache.wicket.settings.IFrameworkSettings 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.settings;

import org.apache.wicket.IDetachListener;
import org.apache.wicket.IEventDispatcher;
import org.apache.wicket.serialize.ISerializer;

/**
 * Framework settings for retrieving and configuring framework settings.
 * 
 * @author Martijn Dashorst
 */
public interface IFrameworkSettings extends IEventDispatcher
{
	/**
	 * Gets the Wicket version. The Wicket version is in the same format as the version element in
	 * the pom.xml file (project descriptor). The version is generated by maven in the build/release
	 * cycle and put in the wicket.properties file located in the root folder of the Wicket jar.
	 * 
	 * The version usually follows one of the following formats:
	 * 
	 * major.minor[.bug] for stable versions. 1.1, 1.2, 1.2.1 are examples
	 * major.minor-state for development versions. 1.2-beta2, 1.3-SNAPSHOT are examples
	 * 
	 * 
	 * @return the Wicket version
	 */
	public String getVersion();

	/**
	 * @return detach listener or null if none
	 */
	public IDetachListener getDetachListener();

	/**
	 * Sets detach listener
	 * 
	 * @param listener
	 *            listener or null to remove
	 */
	public void setDetachListener(IDetachListener listener);

	/**
	 * Registers a new event dispatcher
	 * 
	 * @param dispatcher
	 */
	public void add(IEventDispatcher dispatcher);


	/**
	 * Sets the {@link ISerializer} that will be used to convert objects to/from byte arrays
	 * 
	 * @param serializer
	 *            the {@link ISerializer} to use
	 */
	void setSerializer(ISerializer serializer);

	/**
	 * @return the {@link ISerializer} that will be used to convert objects to/from byte arrays
	 */
	ISerializer getSerializer();
}