| Package | Description |
|---|---|
| org.apache.wiki.api.core |
JSPWiki's central API.
|
| org.apache.wiki.api.engine |
JSPWiki's Engine's component related classes.
|
| org.apache.wiki.api.filters |
Filter's API package of JSPWiki.
|
| org.apache.wiki.api.plugin |
Plugin's API package of JSPWiki.
|
| org.apache.wiki.api.providers |
Page Providers' API package of JSPWiki.
|
| org.apache.wiki.api.spi |
JSPWiki's SPI package.
|
| Modifier and Type | Method and Description |
|---|---|
default <E extends Engine> |
Engine.adapt(java.lang.Class<E> cls)
Adapt Engine to a concrete type.
|
default <E extends Engine> |
Engine.adapt(java.lang.Class<E> cls)
Adapt Engine to a concrete type.
|
| Modifier and Type | Method and Description |
|---|---|
Engine |
Context.getEngine()
Returns the handling engine.
|
Engine |
Context.getEngine()
Returns the handling engine.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Initializable.initialize(Engine engine,
java.util.Properties props)
Initializes this Engine component.
|
void |
Initializable.initialize(Engine engine,
java.util.Properties props)
Initializes this Engine component.
|
| Modifier and Type | Field and Description |
|---|---|
protected Engine |
BasePageFilter.m_engine |
protected Engine |
BasePageFilter.m_engine |
| Modifier and Type | Method and Description |
|---|---|
default void |
PageFilter.destroy(Engine engine)
Called for every filter, e.g. on wiki engine shutdown.
|
default void |
PageFilter.destroy(Engine engine)
Called for every filter, e.g. on wiki engine shutdown.
|
void |
BasePageFilter.initialize(Engine engine,
java.util.Properties properties)
If you override this, you should call super.initialize() first.
|
void |
PageFilter.initialize(Engine engine,
java.util.Properties properties)
Is called whenever the a new PageFilter is instantiated and reset.
|
void |
PageFilter.initialize(Engine engine,
java.util.Properties properties)
Is called whenever the a new PageFilter is instantiated and reset.
|
void |
BasePageFilter.initialize(Engine engine,
java.util.Properties properties)
If you override this, you should call super.initialize() first.
|
| Modifier and Type | Method and Description |
|---|---|
void |
InitializablePlugin.initialize(Engine engine)
Called whenever the plugin is being instantiated for the first time.
|
void |
InitializablePlugin.initialize(Engine engine)
Called whenever the plugin is being instantiated for the first time.
|
| Modifier and Type | Method and Description |
|---|---|
void |
WikiProvider.initialize(Engine engine,
java.util.Properties properties)
Initializes the page provider.
|
void |
WikiProvider.initialize(Engine engine,
java.util.Properties properties)
Initializes the page provider.
|
| Modifier and Type | Method and Description |
|---|---|
Engine |
EngineDSL.find(javax.servlet.ServletConfig config)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineDSL.find(javax.servlet.ServletConfig config)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineDSL.find(javax.servlet.ServletConfig config,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineDSL.find(javax.servlet.ServletConfig config,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineDSL.find(javax.servlet.ServletContext context,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineSPI.find(javax.servlet.ServletContext context,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineSPI.find(javax.servlet.ServletContext context,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
Engine |
EngineDSL.find(javax.servlet.ServletContext context,
java.util.Properties props)
Locate, or build if necessary, a configured
Engine instance. |
| Modifier and Type | Method and Description |
|---|---|
Attachment |
ContentsDSL.attachment(Engine engine,
java.lang.String parentPage,
java.lang.String fileName)
Creates a new
Attachment. |
Attachment |
ContentsSPI.attachment(Engine engine,
java.lang.String parentPage,
java.lang.String fileName)
Creates a new
Attachment. |
Attachment |
ContentsSPI.attachment(Engine engine,
java.lang.String parentPage,
java.lang.String fileName)
Creates a new
Attachment. |
Attachment |
ContentsDSL.attachment(Engine engine,
java.lang.String parentPage,
java.lang.String fileName)
Creates a new
Attachment. |
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Command command)
Creates a new Context for the given Engine, Command and HttpServletRequest.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Command command)
Creates a new Context for the given Engine, Command and HttpServletRequest.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Command command)
Creates a new Context for the given Engine, Command and HttpServletRequest.
|
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Command command)
Creates a new Context for the given Engine, Command and HttpServletRequest.
|
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Page page)
Creates a new Context for the given Engine, Page and HttpServletRequest.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Page page)
Creates a new Context for the given Engine, Page and HttpServletRequest.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Page page)
Creates a new Context for the given Engine, Page and HttpServletRequest.
|
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
Page page)
Creates a new Context for the given Engine, Page and HttpServletRequest.
|
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
java.lang.String requestContext)
Creates a new Context from a supplied HTTP request, using a default wiki context.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
java.lang.String requestContext)
Creates a new Context from a supplied HTTP request, using a default wiki context.
|
Context |
ContextSPI.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
java.lang.String requestContext)
Creates a new Context from a supplied HTTP request, using a default wiki context.
|
Context |
ContextDSL.create(Engine engine,
javax.servlet.http.HttpServletRequest request,
java.lang.String requestContext)
Creates a new Context from a supplied HTTP request, using a default wiki context.
|
Context |
ContextDSL.create(Engine engine,
Page page)
Create a new Context for the given Page.
|
Context |
ContextSPI.create(Engine engine,
Page page)
Create a new Context for the given Page.
|
Context |
ContextSPI.create(Engine engine,
Page page)
Create a new Context for the given Page.
|
Context |
ContextDSL.create(Engine engine,
Page page)
Create a new Context for the given Page.
|
Session |
SessionDSL.find(Engine engine,
javax.servlet.http.HttpServletRequest request)
Returns the Session object associated with the current HTTP request.
|
Session |
SessionSPI.find(Engine engine,
javax.servlet.http.HttpServletRequest request)
Returns the Session object associated with the current HTTP request.
|
Session |
SessionSPI.find(Engine engine,
javax.servlet.http.HttpServletRequest request)
Returns the Session object associated with the current HTTP request.
|
Session |
SessionDSL.find(Engine engine,
javax.servlet.http.HttpServletRequest request)
Returns the Session object associated with the current HTTP request.
|
Session |
SessionDSL.guest(Engine engine)
Creates a new "guest" session containing a single user Principal
org.apache.wiki.auth.WikiPrincipal#GUEST, plus the role
principals Role#ALL and Role#ANONYMOUS. |
Session |
SessionSPI.guest(Engine engine)
Creates a new "guest" session containing a single user Principal
org.apache.wiki.auth.WikiPrincipal#GUEST, plus the role
principals Role#ALL and Role#ANONYMOUS. |
Session |
SessionSPI.guest(Engine engine)
Creates a new "guest" session containing a single user Principal
org.apache.wiki.auth.WikiPrincipal#GUEST, plus the role
principals Role#ALL and Role#ANONYMOUS. |
Session |
SessionDSL.guest(Engine engine)
Creates a new "guest" session containing a single user Principal
org.apache.wiki.auth.WikiPrincipal#GUEST, plus the role
principals Role#ALL and Role#ANONYMOUS. |
Page |
ContentsDSL.page(Engine engine,
java.lang.String name)
Creates a
Page instance. |
Page |
ContentsSPI.page(Engine engine,
java.lang.String name)
Creates a
Page instance. |
Page |
ContentsSPI.page(Engine engine,
java.lang.String name)
Creates a
Page instance. |
Page |
ContentsDSL.page(Engine engine,
java.lang.String name)
Creates a
Page instance. |
void |
SessionDSL.remove(Engine engine,
javax.servlet.http.HttpServletRequest request)
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
|
void |
SessionSPI.remove(Engine engine,
javax.servlet.http.HttpServletRequest request)
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
|
void |
SessionSPI.remove(Engine engine,
javax.servlet.http.HttpServletRequest request)
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
|
void |
SessionDSL.remove(Engine engine,
javax.servlet.http.HttpServletRequest request)
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
|
Copyright (c) 2001-2022 The Apache Software Foundation. All rights reserved.