All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.wicket.Request Maven / Gradle / Ivy

Go to download

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;

import java.util.Locale;
import java.util.Map;

import org.apache.wicket.request.IRequestCodingStrategy;
import org.apache.wicket.request.IRequestCycleProcessor;
import org.apache.wicket.request.RequestParameters;


/**
 * Base class for page request implementations allowing access to request parameters. A Request has
 * a URL and a parameter map. You can retrieve the URL of the request with getURL(). The entire
 * parameter map can be retrieved via getParameterMap(). Individual parameters can be retrieved via
 * getParameter(String). If multiple values are available for a given parameter, they can be
 * retrieved via getParameters(String).
 * 
 * @author Jonathan Locke
 */
public abstract class Request
{
	/** Any Page decoded for this request */
	private Page page;

	/** the type safe request parameters object for this request. */
	private RequestParameters requestParameters;

	/**
	 * Construct.
	 */
	public Request()
	{
	}

	/**
	 * An implementation of this method is only required if a subclass wishes to support sessions
	 * via URL rewriting. This default implementation simply returns the URL String it is passed.
	 * 
	 * @param url
	 *            The URL to decode
	 * @return The decoded url
	 */
	public String decodeURL(final String url)
	{
		return url;
	}

	/**
	 * @return The locale for this request
	 */
	public abstract Locale getLocale();

	/**
	 * @return Any Page for this request
	 */
	public Page getPage()
	{
		return page;
	}

	/**
	 * Gets a given (query) parameter by name.
	 * 
	 * @param key
	 *            Parameter name
	 * @return Parameter value
	 */
	public abstract String getParameter(final String key);

	/**
	 * Gets a map of (query) parameters sent with the request.
	 * 
	 * @return Map of parameters
	 */
	public abstract Map getParameterMap();

	/**
	 * Gets an array of multiple parameters by name.
	 * 
	 * @param key
	 *            Parameter name
	 * @return Parameter values
	 */
	public abstract String[] getParameters(final String key);

	/**
	 * @return Path info for request
	 */
	public abstract String getPath();

	/**
	 * Gets a prefix to make this relative to the context root.
	 * 

* For example, if your context root is http://server.com/myApp/ and the request is for * /myApp/mountedPage/, then the prefix returned might be "../../". *

* For a particular technology, this might return either an absolute prefix or a relative one. * * @return Prefix relative to this request required to back up to context root. */ public abstract String getRelativePathPrefixToContextRoot(); /** * Gets a prefix to make this relative to the Wicket Servlet/Filter. *

* For example, if your context root is http://server.com/myApp/ and the request is for * /myApp/mountedPage/, then the prefix returned might be "../". *

* For a particular technology, this might return either an absolute prefix or a relative one. * * @return Prefix relative to this request required to back up to context root. */ public abstract String getRelativePathPrefixToWicketHandler(); /** * Gets the relative (to some root) url (e.g. in a servlet environment, the url without the * context path and without a leading '/'). Use this method e.g. to load resources using the * servlet context. * * @return Request URL * @deprecated Use {@link #getURL()} instead. */ @Deprecated public String getRelativeURL() { return getURL(); } /** * Sets request parameters. Should only be used when one request is being created as a * replacement for another. * * @param requestParameters */ public final void setRequestParameters(RequestParameters requestParameters) { this.requestParameters = requestParameters; } /** * Gets the request parameters object using the instance of {@link IRequestCodingStrategy} of * the provided request cycle processor. * * @return the request parameters object */ public final RequestParameters getRequestParameters() { // reused cached parameters if (requestParameters != null) { return requestParameters; } // get the request encoder to decode the request parameters IRequestCycleProcessor processor = RequestCycle.get().getProcessor(); final IRequestCodingStrategy encoder = processor.getRequestCodingStrategy(); if (encoder == null) { throw new WicketRuntimeException("request encoder must be not-null (provided by " + processor + ")"); } // decode the request parameters into a strongly typed parameters // object that is to be used by the target resolving try { requestParameters = encoder.decode(this); } catch (RuntimeException re) { // do set the parameters as it was parsed. // else the error page will also error again (infinite loop) requestParameters = new RequestParameters(); throw re; } if (requestParameters == null) { throw new WicketRuntimeException("request parameters must be not-null (provided by " + encoder + ")"); } return requestParameters; } /** * Retrieves the relative URL of this request for local use. This is relative to the context * root. * * @return The relative request URL for local use */ public abstract String getURL(); /** * THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT. * * @param page * The Page for this request */ public void setPage(final Page page) { this.page = page; } /** * A request can say if the current request should generated a new version number. If this * returns true, then all the changes on a page that has versioning enabled is merged with the * latest version. Else it will just create a new version. * * @return true if the version must be merged with the previous latest. */ public boolean mergeVersion() { return false; } /** * @see java.lang.Object#toString() */ @Override public String toString() { return "Request[url=" + getURL() + "]"; } /** * Returns the query string (part after ?) of this request. * * @return request query string */ public abstract String getQueryString(); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy