wicket-core/src/main/java/org/apache/wicket/protocol/http/servlet/ForwardAttributes.java

/*
 * 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.protocol.http.servlet;

import jakarta.servlet.RequestDispatcher;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.http.HttpServletRequest;

import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.string.Strings;

/**
 * Represents additional attributes present in a {@link ServletRequest} when the servlet
 * container is handling a forward to another path than the initially requested one.
 * 
 * See documentation for the following request attributes for the values stored in this object:
 * <ul>
 * <li>{@link jakarta.servlet.RequestDispatcher#FORWARD_CONTEXT_PATH}</li>
 * <li>{@link jakarta.servlet.RequestDispatcher#FORWARD_PATH_INFO}</li>
 * <li>{@link jakarta.servlet.RequestDispatcher#FORWARD_QUERY_STRING}</li>
 * <li>{@link jakarta.servlet.RequestDispatcher#FORWARD_REQUEST_URI}</li>
 * <li>{@link jakarta.servlet.RequestDispatcher#FORWARD_SERVLET_PATH}</li>
 * </ul>
 * 
 */
public class ForwardAttributes
{
	// jakarta.servlet.forward.request_uri
	private final String requestUri;

	// jakarta.servlet.forward.servlet_path
	private final String servletPath;

	// jakarta.servlet.forward.context_path
	private final String contextPath;

	// jakarta.servlet.forward.query_string
	private final String queryString;

	// jakarta.servlet.forward.path_info
	private final String pathInfo;

	/**
	 * Constructor.
	 * 
	 * @param requestUri
	 * @param servletPath
	 * @param contextPath
	 * @param queryString
	 * @param pathInfo
	 */
	private ForwardAttributes(String requestUri, String servletPath, String contextPath,
		String queryString, String pathInfo)
	{
		this.requestUri = requestUri;
		this.servletPath = servletPath;
		this.contextPath = contextPath;
		this.queryString = queryString;
		this.pathInfo = pathInfo;
	}

	/**
	 * Gets requestUri.
	 * 
	 * @return requestUri
	 */
	public String getRequestUri()
	{
		return requestUri;
	}

	/**
	 * Gets servletPath.
	 * 
	 * @return servletPath
	 */
	public String getServletPath()
	{
		return servletPath;
	}

	/**
	 * Gets contextPath.
	 * 
	 * @return contextPath
	 */
	public String getContextPath()
	{
		return contextPath;
	}

	/**
	 * Gets the query string.
	 * 
	 * @return the query string
	 */
	public String getQueryString()
	{
		return queryString;
	}

	/**
	 * @return the path info of the request before the forward dispatch
	 */
	public String getPathInfo() {
		return pathInfo;
	}

	/**
	 * Factory for creating instances of this class.
	 * 
	 * @param request
	 * @return instance of request contains forward attributes or {@code null} if it does not.
	 */
	public static ForwardAttributes of(HttpServletRequest request, String filterPrefix)
	{
		Args.notNull(request, "request");

		final String requestUri = DispatchedRequestUtils.getRequestUri(request, RequestDispatcher.FORWARD_REQUEST_URI, filterPrefix);
		final String servletPath = (String)request.getAttribute(RequestDispatcher.FORWARD_SERVLET_PATH);
		final String contextPath = (String)request.getAttribute(RequestDispatcher.FORWARD_CONTEXT_PATH);
		final String queryString = (String)request.getAttribute(RequestDispatcher.FORWARD_QUERY_STRING);
		final String pathInfo = (String)request.getAttribute(RequestDispatcher.FORWARD_PATH_INFO);

		if (!Strings.isEmpty(requestUri) || !Strings.isEmpty(servletPath) ||
			!Strings.isEmpty(contextPath) || !Strings.isEmpty(queryString) ||
			!Strings.isEmpty(pathInfo))
		{
			return new ForwardAttributes(requestUri, servletPath, contextPath, queryString, pathInfo);
		}
		return null;
	}

	@Override
	public String toString()
	{
		return "ForwardAttributes [requestUri=" + requestUri + ", servletPath=" + servletPath +
			", contextPath=" + contextPath + ", queryString=" + queryString +
			   ", pathInfo=" + pathInfo + "]";
	}
}