TomcatWebAppBuilder

java.lang.Object
- org.apache.tomee.catalina.TomcatWebAppBuilder

All Implemented Interfaces:: WebAppBuilder, ParentClassLoaderFinder, ContextListener

public class TomcatWebAppBuilder
extends java.lang.Object
implements WebAppBuilder, ContextListener, ParentClassLoaderFinder

Web application builder.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TomcatWebAppBuilder.ContextInfo

class TomcatWebAppBuilder.StandardContextInfo
- Nested classes/interfaces inherited from interface org.apache.openejb.core.ParentClassLoaderFinder
  ParentClassLoaderFinder.Helper

Nested Classes
Modifier and Type	Class and Description
`static class`	`TomcatWebAppBuilder.ContextInfo`
`class`	`TomcatWebAppBuilder.StandardContextInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Map<java.lang.ClassLoader,ServletContext>`	`CONTEXTS`
`static java.lang.String`	`DEFAULT_J2EE_SERVER`
`static java.lang.String`	`IGNORE_CONTEXT` Flag for ignore context
`static java.lang.String`	`OPENEJB_CROSSCONTEXT_PROPERTY`
`static java.lang.String`	`OPENEJB_JSESSION_ID_SUPPORT`
`static java.lang.String`	`OPENEJB_MYFACES_DISABLE_DEFAULT_VALUES`
`static java.lang.String`	`OPENEJB_SESSION_MANAGER_PROPERTY`
`static java.lang.String`	`OPENEJB_WEBAPP_MODULE_ID`

Fields inherited from interface org.apache.openejb.core.ParentClassLoaderFinder
FALLBACK

Constructor Summary

Constructors
Constructor and Description

TomcatWebAppBuilder()
Creates a new web application builder instance.

Constructors
Constructor and Description
`TomcatWebAppBuilder()` Creates a new web application builder instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TomcatWebAppBuilder.ContextInfo`	`addContextInfo(java.lang.String host, StandardContext standardContext)` Add new context info.
`void`	`afterStart(StandardContext standardContext)` Called after starting context.
`void`	`afterStop(StandardContext standardContext)` Called after starting context.
`void`	`afterStop(StandardServer standardServer)` Called after starting context.
`protected java.io.File`	`appBase(StandardHost standardHost)` Returns application base of the given host.
`java.util.Collection<java.lang.String>`	`availableApps()`
`void`	`beforeStart(StandardContext standardContext)` Called before starting context.
`void`	`beforeStop(StandardContext standardContext)` Called before stopping context.
`void`	`checkHost(StandardHost standardHost)` Called on periodic events.
`void`	`configureStart(LifecycleEvent event, StandardContext standardContext)`
`void`	`deployWar(StandardContext standardContext, java.lang.String host, AppInfo info)`
`void`	`deployWebApps(AppInfo appInfo, java.lang.ClassLoader classLoader)`
`void`	`destroy(StandardContext standardContext)` Called when destroying context.
`TomcatWebAppBuilder.ContextInfo`	`getContextInfo(StandardContext standardContext)` Gets context info for given context.
`TomcatWebAppBuilder.ContextInfo`	`getContextInfo(java.lang.String appName)`
`java.util.Map<java.lang.ClassLoader,InstanceManager>`	`getInstanceManagers()`
`java.util.Map<java.lang.ClassLoader,java.util.Map<java.lang.String,java.util.Set<java.lang.String>>>`	`getJsfClasses()`
`java.lang.ClassLoader`	`getParentClassLoader(java.lang.ClassLoader fallback)`
`java.util.Map<java.lang.String,Realm>`	`getRealms()`
`void`	`init(StandardContext standardContext)` Web context is initialized.
`void`	`initJ2EEInfo(StandardContext standardContext)`
`void`	`setFinderOnContextConfig(StandardContext standardContext, AppModule appModule)`
`TomcatWebAppBuilder.ContextInfo`	`standaAloneWebAppInfo(java.io.File file)`
`void`	`start()` Start operation.
`void`	`start(StandardContext standardContext)` Called when starting context.
`void`	`start(StandardServer server)` Called when starting context.
`void`	`stop()` Stop operation.
`void`	`stop(StandardContext standardContext)` Called when stopping context.
`protected Realm`	`tomeeRealm(Realm realm)`
`void`	`undeployWebApps(AppInfo appInfo)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPENEJB_CROSSCONTEXT_PROPERTY

public static final java.lang.String OPENEJB_CROSSCONTEXT_PROPERTY

See Also:: Constant Field Values

OPENEJB_SESSION_MANAGER_PROPERTY

public static final java.lang.String OPENEJB_SESSION_MANAGER_PROPERTY

See Also:: Constant Field Values

OPENEJB_JSESSION_ID_SUPPORT

public static final java.lang.String OPENEJB_JSESSION_ID_SUPPORT

See Also:: Constant Field Values

OPENEJB_MYFACES_DISABLE_DEFAULT_VALUES

public static final java.lang.String OPENEJB_MYFACES_DISABLE_DEFAULT_VALUES

See Also:: Constant Field Values

IGNORE_CONTEXT

public static final java.lang.String IGNORE_CONTEXT

Flag for ignore context

DEFAULT_J2EE_SERVER

public static final java.lang.String DEFAULT_J2EE_SERVER

See Also:: Constant Field Values

OPENEJB_WEBAPP_MODULE_ID

public static final java.lang.String OPENEJB_WEBAPP_MODULE_ID

See Also:: Constant Field Values

CONTEXTS

public static final java.util.Map<java.lang.ClassLoader,ServletContext> CONTEXTS

Constructor Detail
- TomcatWebAppBuilder
```
public TomcatWebAppBuilder()
```
  Creates a new web application builder instance.

Method Detail
- tomeeRealm
```
protected Realm tomeeRealm(Realm realm)
```
- start
```
public void start()
```
  Start operation.
- stop
```
public void stop()
```
  Stop operation.
- start
```
public void start(StandardServer server)
```
  Description copied from interface: ContextListener
  
  Called when starting context.
  
  Specified by:
  
  start in interface ContextListener
  
  Parameters:
  
  server - web context
- deployWebApps
```
public void deployWebApps(AppInfo appInfo,
                          java.lang.ClassLoader classLoader)
                   throws java.lang.Exception
```
  Specified by:
  
  deployWebApps in interface WebAppBuilder
  
  Throws:
  
  java.lang.Exception
- deployWar
```
public void deployWar(StandardContext standardContext,
                      java.lang.String host,
                      AppInfo info)
```
- standaAloneWebAppInfo
```
public TomcatWebAppBuilder.ContextInfo standaAloneWebAppInfo(java.io.File file)
```
- availableApps
```
public java.util.Collection<java.lang.String> availableApps()
```
- undeployWebApps
```
public void undeployWebApps(AppInfo appInfo)
                     throws java.lang.Exception
```
  Specified by:
  
  undeployWebApps in interface WebAppBuilder
  
  Throws:
  
  java.lang.Exception
- init
```
public void init(StandardContext standardContext)
```
  Web context is initialized.
  
  Specified by:
  
  init in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- initJ2EEInfo
```
public void initJ2EEInfo(StandardContext standardContext)
```
- getContextInfo
```
public TomcatWebAppBuilder.ContextInfo getContextInfo(java.lang.String appName)
```
- beforeStart
```
public void beforeStart(StandardContext standardContext)
```
  Called before starting context.
  
  Specified by:
  
  beforeStart in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- configureStart
```
public void configureStart(LifecycleEvent event,
                           StandardContext standardContext)
```
  Specified by:
  
  configureStart in interface ContextListener
- start
```
public void start(StandardContext standardContext)
```
  Description copied from interface: ContextListener
  
  Called when starting context.
  
  Specified by:
  
  start in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- setFinderOnContextConfig
```
public void setFinderOnContextConfig(StandardContext standardContext,
                                     AppModule appModule)
```
- afterStart
```
public void afterStart(StandardContext standardContext)
```
  Called after starting context.
  
  Specified by:
  
  afterStart in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- beforeStop
```
public void beforeStop(StandardContext standardContext)
```
  Called before stopping context.
  
  Specified by:
  
  beforeStop in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- stop
```
public void stop(StandardContext standardContext)
```
  Called when stopping context.
  
  Specified by:
  
  stop in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- afterStop
```
public void afterStop(StandardContext standardContext)
```
  Called after starting context.
  
  Specified by:
  
  afterStop in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- destroy
```
public void destroy(StandardContext standardContext)
```
  Called when destroying context.
  
  Specified by:
  
  destroy in interface ContextListener
  
  Parameters:
  
  standardContext - web context
- afterStop
```
public void afterStop(StandardServer standardServer)
```
  Called after starting context.
  
  Specified by:
  
  afterStop in interface ContextListener
  
  Parameters:
  
  standardServer - web context
- checkHost
```
public void checkHost(StandardHost standardHost)
```
  Called on periodic events.
  
  Specified by:
  
  checkHost in interface ContextListener
  
  Parameters:
  
  standardHost - host
- appBase
```
protected java.io.File appBase(StandardHost standardHost)
```
  Returns application base of the given host.
  
  Parameters:
  
  standardHost - tomcat host
  
  Returns:
  
  application base of the given host
- getContextInfo
```
public TomcatWebAppBuilder.ContextInfo getContextInfo(StandardContext standardContext)
```
  Gets context info for given context.
  
  Parameters:
  
  standardContext - context
  
  Returns:
  
  context info
- addContextInfo
```
public TomcatWebAppBuilder.ContextInfo addContextInfo(java.lang.String host,
                                                      StandardContext standardContext)
```
  Add new context info.
  
  Parameters:
  
  host - host name
  
  standardContext - context
  
  Returns:
  
  context info
- getJsfClasses
```
public java.util.Map<java.lang.ClassLoader,java.util.Map<java.lang.String,java.util.Set<java.lang.String>>> getJsfClasses()
```
  Specified by:
  
  getJsfClasses in interface WebAppBuilder
- getParentClassLoader
```
public java.lang.ClassLoader getParentClassLoader(java.lang.ClassLoader fallback)
```
  Specified by:
  
  getParentClassLoader in interface ParentClassLoaderFinder
- getRealms
```
public java.util.Map<java.lang.String,Realm> getRealms()
```
- getInstanceManagers
```
public java.util.Map<java.lang.ClassLoader,InstanceManager> getInstanceManagers()
```

Class TomcatWebAppBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.openejb.core.ParentClassLoaderFinder

Field Summary

Fields inherited from interface org.apache.openejb.core.ParentClassLoaderFinder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPENEJB_CROSSCONTEXT_PROPERTY

OPENEJB_SESSION_MANAGER_PROPERTY

OPENEJB_JSESSION_ID_SUPPORT

OPENEJB_MYFACES_DISABLE_DEFAULT_VALUES

IGNORE_CONTEXT

DEFAULT_J2EE_SERVER

OPENEJB_WEBAPP_MODULE_ID

CONTEXTS

Constructor Detail

TomcatWebAppBuilder

Method Detail

tomeeRealm

start

stop

start

deployWebApps

deployWar

standaAloneWebAppInfo

availableApps

undeployWebApps

init

initJ2EEInfo

getContextInfo

beforeStart

configureStart

start

setFinderOnContextConfig

afterStart

beforeStop

stop

afterStop

destroy

afterStop

checkHost

appBase

getContextInfo

addContextInfo

getJsfClasses

getParentClassLoader

getRealms

getInstanceManagers