org.apache.juneau.rest.arg.HttpServletRequestArgs Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * 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.juneau.rest.arg;

import java.security.*;

import jakarta.servlet.*;
import jakarta.servlet.http.*;

import org.apache.juneau.reflect.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.utils.*;

/**
 * Resolves method parameters on {@link RestOp}-annotated Java methods of types found on the {@link HttpServletRequest} object.
 *
 * 
 * 	{@link AsyncContext}
 * 	
{@link Cookie}[]
 * 	
{@link DispatcherType}
 * 	
{@link HttpServletRequest}
 * 	
{@link Principal}
 * 
 *
 * See Also:

 * 	Java Method Parameters
 * 
 */
public class HttpServletRequestArgs extends SimpleRestOperationArg {

	/**
	 * Static creator.
	 *
	 * @param paramInfo The Java method parameter being resolved.
	 * @return A new arg, or null if the parameter type is not one of the supported types.
	 */
	public static HttpServletRequestArgs create(ParamInfo paramInfo) {
		if (paramInfo.isType(AsyncContext.class))
			return new HttpServletRequestArgs(HttpServletRequest::getAsyncContext);
		if (paramInfo.isType(CookieList.class))
			return new HttpServletRequestArgs(x->CookieList.of(x.getCookies()));
		if (paramInfo.isType(DispatcherType.class))
			return new HttpServletRequestArgs(HttpServletRequest::getDispatcherType);
		if (paramInfo.isType(HttpServletRequest.class))
			return new HttpServletRequestArgs(x->x);
		if (paramInfo.isType(Principal.class))
			return new HttpServletRequestArgs(HttpServletRequest::getUserPrincipal);
		return null;
	}

	/**
	 * Constructor.
	 *
	 * @param  The function return type.
	 * @param function The function for finding the arg.
	 */
	protected  HttpServletRequestArgs(ThrowingFunction function) {
		super(session -> function.apply(session.getRequest().getHttpServletRequest()));
	}
}