Package hudson

Class WebAppMain

java.lang.Object

hudson.WebAppMain

All Implemented Interfaces:

jakarta.servlet.ServletContextListener, EventListener

public class WebAppMain
extends Object
implements jakarta.servlet.ServletContextListener

Entry point when Hudson is used as a webapp.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebAppMain.FileAndDescription	Add some metadata to a File, allowing to trace setup issues

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORCE_SESSION_TRACKING_BY_COOKIE_PROP	System property name to force the session tracking by cookie.

Constructor Summary

Constructors

Constructor	Description
WebAppMain()

Method Summary

Modifier and Type	Method	Description
void	contextDestroyed(jakarta.servlet.ServletContextEvent event)
void	contextInitialized(jakarta.servlet.ServletContextEvent event)	Creates the sole instance of Jenkins and register it to the ServletContext.
static int	getDefaultRingBufferSize()	This getter returns the int DEFAULT_RING_BUFFER_SIZE from the class RingBufferLogHandler from a static context.
WebAppMain.FileAndDescription	getHomeDir(jakarta.servlet.ServletContextEvent event)	Determines the home directory for Jenkins.
static void	installExpressionFactory(jakarta.servlet.ServletContextEvent event)
static void	installExpressionFactory(javax.servlet.ServletContextEvent event)	Deprecated. use installExpressionFactory(ServletContextEvent)
void	joinInit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORCE_SESSION_TRACKING_BY_COOKIE_PROP

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String FORCE_SESSION_TRACKING_BY_COOKIE_PROP

System property name to force the session tracking by cookie. This prevents Tomcat to use the URL tracking in addition to the cookie by default. This could be useful for instances that requires to have the SuspiciousRequestFilter.allowSemicolonsInPath turned off.

If you allow semicolon in URL and the session to be tracked by URL and you have a SecurityRealm that does not invalidate session after authentication, your instance is vulnerable to session hijacking.

The SecurityRealm should be corrected but this is a hardening in Jenkins core.

As this property is read during startup, you will not be able to change it at runtime depending on your application server (not possible with Jetty nor Tomcat)

When running hpi:run, the default tracking is COOKIE+URL. When running java -jar with Winstone/Jetty, the default setting is set to COOKIE only. When running inside Tomcat, the default setting is COOKIE+URL.

Constructor Details

WebAppMain

public WebAppMain()

Method Details

getDefaultRingBufferSize

public static int getDefaultRingBufferSize()

This getter returns the int DEFAULT_RING_BUFFER_SIZE from the class RingBufferLogHandler from a static context. Exposes access from RingBufferLogHandler.DEFAULT_RING_BUFFER_SIZE to WebAppMain. Written for the requirements of JENKINS-50669

Returns:

int This returns DEFAULT_RING_BUFFER_SIZE

Since:

2.259

See Also:

• JENKINS-50669

contextInitialized

public void contextInitialized(jakarta.servlet.ServletContextEvent event)

Creates the sole instance of Jenkins and register it to the ServletContext.

Specified by:

contextInitialized in interface jakarta.servlet.ServletContextListener

joinInit

public void joinInit()
              throws InterruptedException

Throws:

InterruptedException

installExpressionFactory

public static void installExpressionFactory(jakarta.servlet.ServletContextEvent event)

Since:

2.475

installExpressionFactory

@Deprecated
public static void installExpressionFactory(javax.servlet.ServletContextEvent event)

Deprecated.

use installExpressionFactory(ServletContextEvent)

getHomeDir

public WebAppMain.FileAndDescription getHomeDir(jakarta.servlet.ServletContextEvent event)

Determines the home directory for Jenkins.

We look for a setting that affects the smallest scope first, then bigger ones later.

People make configuration mistakes, so we are trying to be nice with those by doing String.trim().

Returns:

the File alongside with some description to help the user troubleshoot issues

contextDestroyed

public void contextDestroyed(jakarta.servlet.ServletContextEvent event)

Specified by:

contextDestroyed in interface jakarta.servlet.ServletContextListener