|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebContainer
Method Summary | |
---|---|
SharedWebContainerContext |
getDefaultSharedHttpContext()
|
void |
registerConstraintMapping(java.lang.String constraintName,
java.lang.String mapping,
java.lang.String url,
java.lang.String dataConstraint,
boolean authentication,
java.util.List<java.lang.String> roles,
org.osgi.service.http.HttpContext m_httpContext)
Registers constraint mappings.... |
void |
registerErrorPage(java.lang.String error,
java.lang.String location,
org.osgi.service.http.HttpContext httpContext)
Registers an error page to customize the response sent back to the web client in case that an exception or error propagates back to the web container, or the servlet/filter calls sendError() on the response object for a specific status code. |
void |
registerEventListener(java.util.EventListener listener,
org.osgi.service.http.HttpContext httpContext)
Registers an event listener. |
void |
registerFilter(javax.servlet.Filter filter,
java.lang.String[] urlPatterns,
java.lang.String[] servletNames,
java.util.Dictionary initparams,
org.osgi.service.http.HttpContext httpContext)
Registers a servlet filter. |
void |
registerJsps(java.lang.String[] urlPatterns,
org.osgi.service.http.HttpContext httpContext)
Enable jsp support. |
void |
registerLoginConfig(java.lang.String authMethod,
java.lang.String realmName,
org.osgi.service.http.HttpContext httpContext)
Registers login configuration, with authorization method and realm name. |
void |
registerServlet(javax.servlet.Servlet servlet,
java.lang.String[] urlPatterns,
java.util.Dictionary initParams,
org.osgi.service.http.HttpContext httpContext)
Registers a servlet. |
void |
registerServlet(javax.servlet.Servlet servlet,
java.lang.String servletName,
java.lang.String[] urlPatterns,
java.util.Dictionary initParams,
org.osgi.service.http.HttpContext httpContext)
Registers a named servlet. A named servlet can then be referenced by name while registering a filter. |
void |
registerWelcomeFiles(java.lang.String[] welcomeFiles,
boolean redirect,
org.osgi.service.http.HttpContext httpContext)
Registers an ordered list of partial URIs. |
void |
setContextParam(java.util.Dictionary params,
org.osgi.service.http.HttpContext httpContext)
Sets context paramaters to be used in the servlet context corresponding to specified http context. |
void |
setSessionTimeout(java.lang.Integer minutes,
org.osgi.service.http.HttpContext httpContext)
Sets the session timeout of the servlet context corresponding to specified http context. |
void |
unregisterConstraintMapping(org.osgi.service.http.HttpContext httpContext)
Unregisters constraint mappings.... |
void |
unregisterErrorPage(java.lang.String error,
org.osgi.service.http.HttpContext httpContext)
Unregisters a previous registered error page. |
void |
unregisterEventListener(java.util.EventListener listener)
Unregisters a previously registered listener. |
void |
unregisterFilter(javax.servlet.Filter filter)
Unregisters a previously registered servlet filter. |
void |
unregisterJsps(org.osgi.service.http.HttpContext httpContext)
Unregister jsps and disable jsp support. |
void |
unregisterLoginConfig(org.osgi.service.http.HttpContext httpContext)
Unregisters login configuration .... |
void |
unregisterServlet(javax.servlet.Servlet servlet)
Unregisters a previously registered servlet. |
void |
unregisterWelcomeFiles(org.osgi.service.http.HttpContext httpContext)
Unregisters previous registered welcome files. |
Methods inherited from interface org.osgi.service.http.HttpService |
---|
createDefaultHttpContext, registerResources, registerServlet, unregister |
Method Detail |
---|
void registerServlet(javax.servlet.Servlet servlet, java.lang.String[] urlPatterns, java.util.Dictionary initParams, org.osgi.service.http.HttpContext httpContext) throws javax.servlet.ServletException
servlet
- a servlet. Cannot be null.urlPatterns
- url patterns this servlet maps toinitParams
- initialization arguments for the servlet or null if there are none. This argument is used by
the servlet���s ServletConfig object.httpContext
- the http context this servlet is for. If null a default http context will be used.
java.lang.IllegalArgumentException
- if servlet is null, urlPattern is null or empty, or urlPattern is invalid
javax.servlet.ServletException
- if servlet was already registeredvoid registerServlet(javax.servlet.Servlet servlet, java.lang.String servletName, java.lang.String[] urlPatterns, java.util.Dictionary initParams, org.osgi.service.http.HttpContext httpContext) throws javax.servlet.ServletException
servlet
- a servlet. Cannot be null.servletName
- servlet name. If null, acts as for the registration method that does not take a servlet nameurlPatterns
- url patterns this servlet maps toinitParams
- initialization arguments for the servlet or null if there are none. This argument is used by
the servlet���s ServletConfig object.httpContext
- the http context this servlet is for. If null a default http context will be used.
java.lang.IllegalArgumentException
- if servlet is null, urlPattern is null or empty, or urlPattern is invalid
javax.servlet.ServletException
- if servlet was already registeredvoid unregisterServlet(javax.servlet.Servlet servlet)
servlet
- the servlet to be unregistered
java.lang.IllegalArgumentException
- if the servlet is nullvoid registerEventListener(java.util.EventListener listener, org.osgi.service.http.HttpContext httpContext)
listener
- an event listener to be registered. If null an IllegalArgumentException is thrown.httpContext
- the http context this listener is for. If null a default http context will be used.void unregisterEventListener(java.util.EventListener listener)
listener
- the event listener to be unregistered.
java.lang.IllegalArgumentException
- if the listener is unknown to the http service (never registered or unregistered
before) or the listener is nullvoid registerFilter(javax.servlet.Filter filter, java.lang.String[] urlPatterns, java.lang.String[] servletNames, java.util.Dictionary initparams, org.osgi.service.http.HttpContext httpContext)
filter
- a servlet filter. If null an IllegalArgumentException is thrown.urlPatterns
- url patterns this filter maps toservletNames
- servlet names this filter maps toinitparams
- initialization arguments for the filter or null if there are none. This argument is used by
the filters���s FilterConfig object.httpContext
- the http context this filter is for. If null a default http context will be used.void unregisterFilter(javax.servlet.Filter filter)
filter
- the servlet filter to be unregistered
java.lang.IllegalArgumentException
- if the filter is unknown to the http service (never registered or unregistered
before) or the filter is nullvoid setContextParam(java.util.Dictionary params, org.osgi.service.http.HttpContext httpContext)
params
- context parameters for the servlet context corresponding to specified http contexthttpContext
- http context. Cannot be null.
java.lang.IllegalArgumentException
- if http context is null
java.lang.IllegalStateException
- if the call is made after the http context was already used into a registrationvoid setSessionTimeout(java.lang.Integer minutes, org.osgi.service.http.HttpContext httpContext)
minutes
- session timeout of the servlet context corresponding to specified http contexthttpContext
- http context. Cannot be null.
java.lang.IllegalArgumentException
- if http context is null
java.lang.IllegalStateException
- if the call is made after the http context was already used into a registrationvoid registerJsps(java.lang.String[] urlPatterns, org.osgi.service.http.HttpContext httpContext)
urlPatterns
- an array of url patterns this jsp support maps to. If null, a default "*.jsp" will be usedhttpContext
- the http context for which the jsp support should be enabled. If null a default http context
will be used.
java.lang.UnsupportedOperationException
- if optional org.ops4j.pax.web.jsp package is not resolvedvoid unregisterJsps(org.osgi.service.http.HttpContext httpContext)
httpContext
- the http context for which the jsp support should be disabled
java.lang.IllegalArgumentException
- if http context is null or jsp support was not enabled for the http context
java.lang.UnsupportedOperationException
- if optional org.ops4j.pax.web.jsp package is not resolvedvoid registerErrorPage(java.lang.String error, java.lang.String location, org.osgi.service.http.HttpContext httpContext)
error
- a fully qualified Exception class name or an error status codelocation
- the request path that will fill the response page. The location must start with an "/"httpContext
- the http context this error page is for. If null a default http context will be used.
java.lang.IllegalArgumentException
- if:
error is null or empty
location is null
location does not start with a slash "/"void unregisterErrorPage(java.lang.String error, org.osgi.service.http.HttpContext httpContext)
error
- a fully qualified Exception class name or an error status codehttpContext
- the http context from which the error page should be unregistered. Cannot be null.
java.lang.IllegalArgumentException
- if:
error is null or empty
error page was not registered before
httpContext is nullvoid registerWelcomeFiles(java.lang.String[] welcomeFiles, boolean redirect, org.osgi.service.http.HttpContext httpContext)
welcomeFiles
- an array of welcome files paths. Paths must not start or end with "/"redirect
- true if the client should be redirected to welcome file or false if forwardedhttpContext
- the http context this error page is for. If null a default http context will be used.
java.lang.IllegalArgumentException
- if:
welcome files param is null or empty
entries in array are null or empty
entries in array start or end with "/"
java.lang.IllegalStateException
- if welcome files are already registeredvoid unregisterWelcomeFiles(org.osgi.service.http.HttpContext httpContext)
httpContext
- the http context from which the welcome files should be unregistered. Cannot be null.
java.lang.IllegalArgumentException
- if httpContext is nullvoid registerLoginConfig(java.lang.String authMethod, java.lang.String realmName, org.osgi.service.http.HttpContext httpContext)
authMethod
- realmName
- httpContext
- void unregisterLoginConfig(org.osgi.service.http.HttpContext httpContext)
httpContext
- void registerConstraintMapping(java.lang.String constraintName, java.lang.String mapping, java.lang.String url, java.lang.String dataConstraint, boolean authentication, java.util.List<java.lang.String> roles, org.osgi.service.http.HttpContext m_httpContext)
constraintName
- mapping
- url
- dataConstraint
- authentication
- roles
- m_httpContext
- void unregisterConstraintMapping(org.osgi.service.http.HttpContext httpContext)
httpContext
- SharedWebContainerContext getDefaultSharedHttpContext()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |