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

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addContainerInitializer(javax.servlet.ServletContainerInitializer containerInitializer, Set<Class<?>> classes)
AccessControlContext	getAccessControllerContext() Getter.
String	getAuthMethod()
org.osgi.framework.Bundle	getBundle() Getter.
ClassLoader	getClassLoader()
Map<javax.servlet.ServletContainerInitializer,Set<Class<?>>>	getContainerInitializers()
String	getContextName() Getter.
Map<String,String>	getContextParams() Getter.
String	getFormErrorPage()
String	getFormLoginPage()
org.osgi.service.http.HttpContext	getHttpContext()
URL	getJettyWebXmlURL()
Map<javax.servlet.Servlet,String[]>	getJspServlets() Getter.
String	getRealmName()
String	getSessionCookie() Getter.
Boolean	getSessionCookieHttpOnly()
Boolean	getSessionCookieSecure() Getter.
String	getSessionDomain() Getter.
String	getSessionPath() Getter.
Integer	getSessionTimeout() Getter.
String	getSessionUrl() Getter.
String	getSessionWorkerName() Getter.
List<String>	getVirtualHosts()
boolean	isWebBundle()
void	setAuthMethod(String authMethod)
void	setContainerInitializers(Map<javax.servlet.ServletContainerInitializer,Set<Class<?>>> containerInitializers)
void	setContextParams(Dictionary contextParameters)
void	setFormErrorPage(String formErrorPage)
void	setFormLoginPage(String formLoginPage)
void	setJettyWebXmlUrl(URL jettyWebXmlUrl)
void	setRealmName(String realmName)
void	setSessionCookie(String sessionCookie) Setter.
void	setSessionCookieHttpOnly(Boolean sessionCookieHttpOnly)
void	setSessionCookieSecre(Boolean sessionCookieSecure) Setter.
void	setSessionDomain(String sessionDomain) Setter.
void	setSessionPath(String sessionPath) Setter.
void	setSessionTimeout(Integer sessionTimeout) Setter.
void	setSessionUrl(String sessionUrl) Setter.
void	setSessionWorkerName(String sessionWorkerName) Setter.
void	setVirtualHosts(List<String> virtualHosts)
void	setWebBundle(boolean webBundle)
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)

Parameters:

httpContext -

bundle -

classLoader -

Method Detail

getHttpContext

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

getClassLoader

public ClassLoader getClassLoader()

getFormLoginPage

public String getFormLoginPage()

Returns:

the formLoginPage

getFormErrorPage

public String getFormErrorPage()

Returns:

the formErrorPage

setContextParams

public void setContextParams(Dictionary contextParameters)

getContextParams

public Map<String,String> getContextParams()

Getter.

Returns:

map of context params

getContextName

public String getContextName()

Getter.

Returns:

context name

getJspServlets

public Map<javax.servlet.Servlet,String[]> getJspServlets()

Getter.

Returns:

jsp servlet

getAccessControllerContext

public AccessControlContext getAccessControllerContext()

Getter.

Returns:

the access controller context of the bundle that registred the context

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

getSessionDomain

public String getSessionDomain()

Getter.

Returns:

session cookie domain

setSessionDomain

public void setSessionDomain(String sessionDomain)

Setter.

Parameters:

sessionDomain - session cookie domain

getSessionPath

public String getSessionPath()

Getter.

Returns:

session cookie path

setSessionPath

public void setSessionPath(String sessionPath)

Setter.

Parameters:

sessionPath - session cookie path

getSessionUrl

public String getSessionUrl()

Getter.

Returns:

session url name

setSessionUrl

public void setSessionUrl(String sessionUrl)

Setter.

Parameters:

sessionUrl - session url name

getSessionCookieHttpOnly

public Boolean getSessionCookieHttpOnly()

Returns:

session cookie HTTP Only

setSessionCookieHttpOnly

public void setSessionCookieHttpOnly(Boolean sessionCookieHttpOnly)

getSessionCookieSecure

public Boolean getSessionCookieSecure()

Getter.

Returns:

session cookie secure

setSessionCookieSecre

public void setSessionCookieSecre(Boolean sessionCookieSecure)

Setter.

Parameters:

sessionCookieSecure - session cookie secure flag

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

getContainerInitializers

public Map<javax.servlet.ServletContainerInitializer,Set<Class<?>>> getContainerInitializers()

Returns:

the containerInitializers

setContainerInitializers

public void setContainerInitializers(Map<javax.servlet.ServletContainerInitializer,Set<Class<?>>> containerInitializers)

Parameters:

containerInitializers - the containerInitializers to set

addContainerInitializer

public void addContainerInitializer(javax.servlet.ServletContainerInitializer containerInitializer,
                                    Set<Class<?>> classes)

setVirtualHosts

public void setVirtualHosts(List<String> virtualHosts)

getVirtualHosts

public List<String> getVirtualHosts()

setJettyWebXmlUrl

public void setJettyWebXmlUrl(URL jettyWebXmlUrl)

getJettyWebXmlURL

public URL getJettyWebXmlURL()

isWebBundle

public boolean isWebBundle()

Returns:

the webBundle

setWebBundle

public void setWebBundle(boolean webBundle)

Parameters:

webBundle - the webBundle to set