001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.arg;
018
019import org.apache.juneau.reflect.*;
020import org.apache.juneau.rest.annotation.*;
021import org.apache.juneau.utils.*;
022
023import jakarta.servlet.http.*;
024
025/**
026 * Resolves method parameters on {@link RestOp}-annotated Java methods of types found on the {@link HttpSession} object.
027 *
028 * <ul class='javatree'>
029 *    <li class='jc'>{@link HttpSession}
030 * </ul>
031 *
032 * <h5 class='section'>See Also:</h5><ul>
033 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JavaMethodParameters">Java Method Parameters</a>
034 * </ul>
035 */
036public class HttpSessionArgs extends SimpleRestOperationArg {
037
038   /**
039    * Static creator.
040    *
041    * @param paramInfo The Java method parameter being resolved.
042    * @return A new arg, or <jk>null</jk> if the parameter type is not one of the supported types.
043    */
044   public static HttpSessionArgs create(ParamInfo paramInfo) {
045      if (paramInfo.isType(HttpSession.class))
046         return new HttpSessionArgs(x->x);
047      return null;
048   }
049
050   /**
051    * Constructor.
052    *
053    * @param <T> The function return type.
054    * @param function The function for finding the arg.
055    */
056   protected <T> HttpSessionArgs(ThrowingFunction<HttpSession,T> function) {
057      super(session -> function.apply(session.getRestSession().getRequest().getSession()));
058   }
059}