Package org.gatein.wci.spi

Class SimpleWebAppContext

java.lang.Object

org.gatein.wci.spi.SimpleWebAppContext

All Implemented Interfaces:

WebAppContext

public class SimpleWebAppContext
extends Object
implements WebAppContext

Constructor Summary

Constructors

Constructor	Description
SimpleWebAppContext(jakarta.servlet.ServletContext servletContext)

Method Summary

Modifier and Type	Method	Description
void	fireRequestDestroyed(jakarta.servlet.ServletRequest servletRequest)
void	fireRequestInitialized(jakarta.servlet.ServletRequest servletRequest)
ClassLoader	getClassLoader()	Returns the class loader of the web application.
String	getContextPath()	Returns the context path of the web application.
jakarta.servlet.http.HttpSession	getHttpSession(String sessId)	Returns Http session in case that session with sessId exists for this web application
jakarta.servlet.ServletContext	getServletContext()	Returns the servlet context of the web application.
boolean	importFile(String parentDirRelativePath, String name, InputStream source, boolean overwrite)	Import a file in the war file.
void	start()	Start the web application context usage from a client point of view.
void	stop()	Stop the web application context usage.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleWebAppContext

public SimpleWebAppContext(jakarta.servlet.ServletContext servletContext)

Method Details

start

public void start()
           throws Exception

Description copied from interface: WebAppContext

Start the web application context usage from a client point of view. The life cycle is not related to the web application deployment life cycle. The invocation means that the servlet container spi framework want to start to use the web application.

Specified by:

start in interface WebAppContext

Throws:

Exception - any exception that would veto the usage of the web application

stop

public void stop()

Description copied from interface: WebAppContext

Stop the web application context usage.

Specified by:

stop in interface WebAppContext

getServletContext

public jakarta.servlet.ServletContext getServletContext()

Description copied from interface: WebAppContext

Returns the servlet context of the web application.

Specified by:

getServletContext in interface WebAppContext

Returns:

the servlet context

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: WebAppContext

Returns the class loader of the web application.

Specified by:

getClassLoader in interface WebAppContext

Returns:

the web application class loader

getContextPath

public String getContextPath()

Description copied from interface: WebAppContext

Returns the context path of the web application.

Specified by:

getContextPath in interface WebAppContext

Returns:

the web application context path

importFile

public boolean importFile(String parentDirRelativePath,
 String name,
 InputStream source,
 boolean overwrite)
                   throws IOException

Description copied from interface: WebAppContext

Import a file in the war file. The file could not be created for some reasons which are :

• The parent dir exists and is a file
• The parent dir does not exist and its creation failed
• An underlying exception occurs when writing bytes from the source Inputstream to the target OutputStream

Specified by:

importFile in interface WebAppContext

Parameters:

parentDirRelativePath - the parent relative path in the web app starting from the app root

name - the name the created file should have

source - the data of the target file

overwrite - if false and the file already exists nothing is done

Returns:

true if the file has been created

Throws:

IOException - if the file cannot be created

getHttpSession

public jakarta.servlet.http.HttpSession getHttpSession(String sessId)

Description copied from interface: WebAppContext

Returns Http session in case that session with sessId exists for this web application

Specified by:

getHttpSession in interface WebAppContext

Parameters:

sessId -

Returns:

session with given ID or null if session with this ID doesn't exist

fireRequestInitialized

public void fireRequestInitialized(jakarta.servlet.ServletRequest servletRequest)

Specified by:

fireRequestInitialized in interface WebAppContext

fireRequestDestroyed

public void fireRequestDestroyed(jakarta.servlet.ServletRequest servletRequest)

Specified by:

fireRequestDestroyed in interface WebAppContext