/*
* 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.catalina.util;
import jakarta.servlet.SessionCookieConfig;
import org.apache.catalina.Context;
public class SessionConfig {
private static final String DEFAULT_SESSION_COOKIE_NAME = "JSESSIONID";
private static final String DEFAULT_SESSION_PARAMETER_NAME = "jsessionid";
/**
* Determine the name to use for the session cookie for the provided context.
*
* @param context The context
*
* @return the cookie name for the context
*/
public static String getSessionCookieName(Context context) {
return getConfiguredSessionCookieName(context, DEFAULT_SESSION_COOKIE_NAME);
}
/**
* Determine the name to use for the session path parameter for the provided context.
*
* @param context The context
*
* @return the parameter name for the session
*/
public static String getSessionUriParamName(Context context) {
return getConfiguredSessionCookieName(context, DEFAULT_SESSION_PARAMETER_NAME);
}
private static String getConfiguredSessionCookieName(Context context, String defaultName) {
// Priority is:
// 1. Cookie name defined in context
// 2. Cookie name configured for app
// 3. Default defined by spec
if (context != null) {
String cookieName = context.getSessionCookieName();
if (cookieName != null && !cookieName.isEmpty()) {
return cookieName;
}
SessionCookieConfig scc = context.getServletContext().getSessionCookieConfig();
cookieName = scc.getName();
if (cookieName != null && !cookieName.isEmpty()) {
return cookieName;
}
}
return defaultName;
}
/**
* Determine the value to use for the session cookie path for the provided context.
*
* @param context The context
*
* @return the parameter name for the session
*/
public static String getSessionCookiePath(Context context) {
SessionCookieConfig scc = context.getServletContext().getSessionCookieConfig();
String contextPath = context.getSessionCookiePath();
if (contextPath == null || contextPath.isEmpty()) {
contextPath = scc.getPath();
}
if (contextPath == null || contextPath.isEmpty()) {
contextPath = context.getEncodedPath();
}
if (context.getSessionCookiePathUsesTrailingSlash()) {
// Handle special case of ROOT context where cookies require a path of
// '/' but the servlet spec uses an empty string
// Also ensure the cookies for a context with a path of /foo don't get
// sent for requests with a path of /foobar
if (!contextPath.endsWith("/")) {
contextPath = contextPath + "/";
}
} else {
// Only handle special case of ROOT context where cookies require a
// path of '/' but the servlet spec uses an empty string
if (contextPath.isEmpty()) {
contextPath = "/";
}
}
return contextPath;
}
private SessionConfig() {
// Utility class. Hide default constructor.
}
}