org.ops4j.pax.web.service.spi.model
Class ContextModel

java.lang.Object
  org.ops4j.pax.web.service.spi.model.Identity
      org.ops4j.pax.web.service.spi.model.ContextModel

public class ContextModel
extends Identity

Models a servlet context related to an http context.

Since:

0.3.0, December 29, 2007

Author:

Alin Dreghiciu

Constructor Summary

ContextModel(org.osgi.service.http.HttpContext httpContext, org.osgi.framework.Bundle bundle, ClassLoader classLoader)

Method Summary

AccessControlContext	getAccessControllerContext() Getter.
String	getAuthMethod()
org.osgi.framework.Bundle	getBundle() Getter.
ClassLoader	getClassLoader()
String	getContextName() Getter.
Map<String,String>	getContextParams() Getter.
String	getFormErrorPage()
String	getFormLoginPage()
org.osgi.service.http.HttpContext	getHttpContext()
javax.servlet.Servlet	getJspServlet() Getter.
String	getRealmName()
String	getSessionCookie() Getter.
Integer	getSessionTimeout() Getter.
String	getSessionUrl() Getter.
String	getSessionWorkerName() Getter.
javax.servlet.Filter	getWelcomeFilesFilter() Getter.
void	setAuthMethod(String authMethod)
void	setContextParams(Dictionary contextParams)
void	setFormErrorPage(String formErrorPage)
void	setFormLoginPage(String formLoginPage)
void	setJspServlet(javax.servlet.Servlet jspServlet) Setter.
void	setRealmName(String realmName)
void	setSessionCookie(String sessionCookie) Setter.
void	setSessionTimeout(Integer sessionTimeout) Setter.
void	setSessionUrl(String sessionUrl) Setter.
void	setSessionWorkerName(String sessionWorkerName) Setter.
void	setWelcomeFilesFilter(javax.servlet.Filter welcomeFilesFilter) Setter.
String	toString()

Methods inherited from class org.ops4j.pax.web.service.spi.model.Identity

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextModel

public ContextModel(org.osgi.service.http.HttpContext httpContext,
                    org.osgi.framework.Bundle bundle,
                    ClassLoader classLoader)

Method Detail

getFormLoginPage

public String getFormLoginPage()

Returns:

the formLoginPage

getFormErrorPage

public String getFormErrorPage()

Returns:

the formErrorPage

getHttpContext

public org.osgi.service.http.HttpContext getHttpContext()

getClassLoader

public ClassLoader getClassLoader()

setContextParams

public void setContextParams(Dictionary contextParams)

getContextParams

public Map<String,String> getContextParams()

Getter.

Returns:

map of context params

getContextName

public String getContextName()

Getter.

Returns:

context name

getJspServlet

public javax.servlet.Servlet getJspServlet()

Getter.

Returns:

jsp servlet

setJspServlet

public void setJspServlet(javax.servlet.Servlet jspServlet)

Setter.

Parameters:

jspServlet - value to set

getAccessControllerContext

public AccessControlContext getAccessControllerContext()

Getter.

Returns:

the access controller context of the bundle that registred the context

getWelcomeFilesFilter

public javax.servlet.Filter getWelcomeFilesFilter()

Getter.

Returns:

welcome files filter

setWelcomeFilesFilter

public void setWelcomeFilesFilter(javax.servlet.Filter welcomeFilesFilter)

Setter.

Parameters:

welcomeFilesFilter - value to set

getSessionTimeout

public Integer getSessionTimeout()

Getter.

Returns:

session timeout

setSessionTimeout

public void setSessionTimeout(Integer sessionTimeout)

Setter.

Parameters:

sessionTimeout - value to set

getSessionCookie

public String getSessionCookie()

Getter.

Returns:

session cookie name

setSessionCookie

public void setSessionCookie(String sessionCookie)

Setter.

Parameters:

sessionCookie - session cookie name

getSessionUrl

public String getSessionUrl()

Getter.

Returns:

session url name

setSessionUrl

public void setSessionUrl(String sessionUrl)

Setter.

Parameters:

sessionUrl - session url name

getSessionWorkerName

public String getSessionWorkerName()

Getter.

Returns:

session worker name

setSessionWorkerName

public void setSessionWorkerName(String sessionWorkerName)

Setter.

Parameters:

sessionWorkerName - session worker name

getBundle

public org.osgi.framework.Bundle getBundle()

Getter.

Returns:

bundle associated with this context

toString

public String toString()

Overrides:

toString in class Identity

setRealmName

public void setRealmName(String realmName)

setAuthMethod

public void setAuthMethod(String authMethod)

setFormLoginPage

public void setFormLoginPage(String formLoginPage)

setFormErrorPage

public void setFormErrorPage(String formErrorPage)

getRealmName

public String getRealmName()

Returns:

the realmName

getAuthMethod

public String getAuthMethod()

Returns:

the authMethod