Module com.aoapps.tempfiles.servlet

Package com.aoapps.tempfiles.servlet

Class TempFileContextEE

java.lang.Object

com.aoapps.tempfiles.servlet.TempFileContextEE

public final class TempFileContextEE
extends Object

Provides temp file contexts for ServletContext, ServletRequest, and HttpSession.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopeEE.Session.Attribute<?>	SESSION_ATTRIBUTE	The session attribute.

Method Summary

Modifier and Type	Method	Description
static TempFileContext	get(HttpSession session)	Gets the temp file context for the given session.
static TempFileContext	get(ServletContext servletContext)	Gets the temp file context for the given servlet context.
static TempFileContext	get(ServletRequest request)	Gets the temp file context for the given servlet request.

Methods inherited from class java.lang.Object

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

Field Details

SESSION_ATTRIBUTE

public static final ScopeEE.Session.Attribute<?> SESSION_ATTRIBUTE

The session attribute.

Method Details

get

public static TempFileContext get(ServletContext servletContext)
                           throws IllegalStateException

Gets the temp file context for the given servlet context.

Throws:

IllegalStateException - if the temp files have not been added to the servlet context.

get

public static TempFileContext get(ServletRequest request)
                           throws IllegalStateException

Gets the temp file context for the given servlet request.

Throws:

IllegalStateException - if the temp files have not been added to the servlet request.

get

public static TempFileContext get(HttpSession session)
                           throws IllegalStateException

Gets the temp file context for the given session.

At this time, temporary files put into the session are deleted when the session is passivated, at the end of the session, or on JVM shutdown. The temporary files are not serialized with the session.

TODO: TempFileContext is not currently Serializable. What would it mean to serialize temp files? Would the files themselves be wrapped-up into the serialized form? Would just the filenames be serialized, assuming the underlying temp files are available to all servlet containers that might get the session?

Throws:

IllegalStateException - if the temp files have not been added to the session.