org.ops4j.pax.web.service.internal
Class HttpServiceProxy

java.lang.Object
  extended by org.ops4j.pax.web.service.internal.HttpServiceProxy
All Implemented Interfaces:
StoppableHttpService, WebContainer, org.osgi.service.http.HttpService

public class HttpServiceProxy
extends java.lang.Object
implements StoppableHttpService


Constructor Summary
HttpServiceProxy(StoppableHttpService delegate)
           
 
Method Summary
 org.osgi.service.http.HttpContext createDefaultHttpContext()
           
 SharedWebContainerContext getDefaultSharedHttpContext()
           
 void registerConstraintMapping(java.lang.String constraintName, java.lang.String url, java.lang.String mapping, java.lang.String dataConstraint, boolean authentication, java.util.List<java.lang.String> roles, org.osgi.service.http.HttpContext 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[] aliases, 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 registerResources(java.lang.String alias, java.lang.String name, org.osgi.service.http.HttpContext httpContext)
           
 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 registerServlet(java.lang.String alias, javax.servlet.Servlet servlet, java.util.Dictionary initParams, org.osgi.service.http.HttpContext httpContext)
           
 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 stop()
           
 void unregister(java.lang.String alias)
           
 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HttpServiceProxy

public HttpServiceProxy(StoppableHttpService delegate)
Method Detail

registerServlet

public void registerServlet(java.lang.String alias,
                            javax.servlet.Servlet servlet,
                            java.util.Dictionary initParams,
                            org.osgi.service.http.HttpContext httpContext)
                     throws javax.servlet.ServletException,
                            org.osgi.service.http.NamespaceException
Specified by:
registerServlet in interface org.osgi.service.http.HttpService
Throws:
javax.servlet.ServletException
org.osgi.service.http.NamespaceException

registerResources

public void registerResources(java.lang.String alias,
                              java.lang.String name,
                              org.osgi.service.http.HttpContext httpContext)
                       throws org.osgi.service.http.NamespaceException
Specified by:
registerResources in interface org.osgi.service.http.HttpService
Throws:
org.osgi.service.http.NamespaceException

unregister

public void unregister(java.lang.String alias)
Specified by:
unregister in interface org.osgi.service.http.HttpService

createDefaultHttpContext

public org.osgi.service.http.HttpContext createDefaultHttpContext()
Specified by:
createDefaultHttpContext in interface org.osgi.service.http.HttpService

stop

public void stop()
Specified by:
stop in interface StoppableHttpService

registerServlet

public void registerServlet(javax.servlet.Servlet servlet,
                            java.lang.String[] urlPatterns,
                            java.util.Dictionary initParams,
                            org.osgi.service.http.HttpContext httpContext)
                     throws javax.servlet.ServletException
Description copied from interface: WebContainer
Registers a servlet.

Specified by:
registerServlet in interface WebContainer
Parameters:
servlet - a servlet. Cannot be null.
urlPatterns - url patterns this servlet maps to
initParams - 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.
Throws:
javax.servlet.ServletException - if servlet was already registered
See Also:
WebContainer.registerServlet(Servlet, String[], Dictionary, HttpContext)

registerServlet

public void 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
Description copied from interface: WebContainer
Registers a named servlet.
A named servlet can then be referenced by name while registering a filter.

Specified by:
registerServlet in interface WebContainer
Parameters:
servlet - a servlet. Cannot be null.
servletName - servlet name. If null, acts as for the registration method that does not take a servlet name
urlPatterns - url patterns this servlet maps to
initParams - 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.
Throws:
javax.servlet.ServletException - if servlet was already registered
See Also:
WebContainer.registerServlet(javax.servlet.Servlet, String, String[],java.util.Dictionary,org.osgi.service.http.HttpContext)

unregisterServlet

public void unregisterServlet(javax.servlet.Servlet servlet)
Description copied from interface: WebContainer
Unregisters a previously registered servlet.

Specified by:
unregisterServlet in interface WebContainer
Parameters:
servlet - the servlet to be unregistered
See Also:
WebContainer.unregisterServlet(Servlet)

registerEventListener

public void registerEventListener(java.util.EventListener listener,
                                  org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Registers an event listener. Depending on the listener type, the listener will be notified on different life cycle events. The following listeners are supported:
HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener, HttpSessionListener, ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener. Check out Servlet specification for details on what type of event the registered listener will be notified.

Specified by:
registerEventListener in interface WebContainer
Parameters:
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.
See Also:
)

unregisterEventListener

public void unregisterEventListener(java.util.EventListener listener)
Description copied from interface: WebContainer
Unregisters a previously registered listener.

Specified by:
unregisterEventListener in interface WebContainer
Parameters:
listener - the event listener to be unregistered.
See Also:
WebContainer.unregisterEventListener(EventListener)

registerFilter

public void registerFilter(javax.servlet.Filter filter,
                           java.lang.String[] urlPatterns,
                           java.lang.String[] aliases,
                           java.util.Dictionary initParams,
                           org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Registers a servlet filter.

Specified by:
registerFilter in interface WebContainer
Parameters:
filter - a servlet filter. If null an IllegalArgumentException is thrown.
urlPatterns - url patterns this filter maps to
aliases - servlet names this filter maps to
initParams - 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.
See Also:
WebContainer.registerFilter(Filter, String[], String[], Dictionary, HttpContext)

unregisterFilter

public void unregisterFilter(javax.servlet.Filter filter)
Description copied from interface: WebContainer
Unregisters a previously registered servlet filter.

Specified by:
unregisterFilter in interface WebContainer
Parameters:
filter - the servlet filter to be unregistered
See Also:
WebContainer.unregisterFilter(Filter)

setContextParam

public void setContextParam(java.util.Dictionary params,
                            org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Sets context paramaters to be used in the servlet context corresponding to specified http context. This method must be used before any register method that uses the specified http context, otherwise an IllegalStateException will be thrown.

Specified by:
setContextParam in interface WebContainer
Parameters:
params - context parameters for the servlet context corresponding to specified http context
httpContext - http context. Cannot be null.
See Also:
WebContainer.setContextParam(Dictionary, HttpContext)

setSessionTimeout

public 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. This method must be used before any register method that uses the specified http context, otherwise an IllegalStateException will be thrown.

Specified by:
setSessionTimeout in interface WebContainer
Parameters:
minutes - session timeout of the servlet context corresponding to specified http context
httpContext - http context. Cannot be null.

registerJsps

public void registerJsps(java.lang.String[] urlPatterns,
                         org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Enable jsp support.

Specified by:
registerJsps in interface WebContainer
Parameters:
urlPatterns - an array of url patterns this jsp support maps to. If null, a default "*.jsp" will be used
httpContext - the http context for which the jsp support should be enabled. If null a default http context will be used.
See Also:
WebContainer.registerJsps(String[], HttpContext)

unregisterJsps

public void unregisterJsps(org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Unregister jsps and disable jsp support.

Specified by:
unregisterJsps in interface WebContainer
Parameters:
httpContext - the http context for which the jsp support should be disabled
See Also:
WebContainer.unregisterJsps(HttpContext)

registerErrorPage

public void registerErrorPage(java.lang.String error,
                              java.lang.String location,
                              org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
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.

Specified by:
registerErrorPage in interface WebContainer
Parameters:
error - a fully qualified Exception class name or an error status code
location - 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.
See Also:
WebContainer.registerErrorPage(String, String, HttpContext)

unregisterErrorPage

public void unregisterErrorPage(java.lang.String error,
                                org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Unregisters a previous registered error page.

Specified by:
unregisterErrorPage in interface WebContainer
Parameters:
error - a fully qualified Exception class name or an error status code
httpContext - the http context from which the error page should be unregistered. Cannot be null.
See Also:
WebContainer.unregisterErrorPage(String, HttpContext)

registerWelcomeFiles

public void registerWelcomeFiles(java.lang.String[] welcomeFiles,
                                 boolean redirect,
                                 org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Registers an ordered list of partial URIs. The purpose of this mechanism is to allow the deployer to specify an ordered list of partial URIs for the container to use for appending to URIs when there is a request for a URI that corresponds to a directory entry in the WAR not mapped to a Web component

Specified by:
registerWelcomeFiles in interface WebContainer
Parameters:
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 forwarded
httpContext - the http context this error page is for. If null a default http context will be used.
See Also:
WebContainer.registerWelcomeFiles(String[], boolean, HttpContext)

unregisterWelcomeFiles

public void unregisterWelcomeFiles(org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Unregisters previous registered welcome files.

Specified by:
unregisterWelcomeFiles in interface WebContainer
Parameters:
httpContext - the http context from which the welcome files should be unregistered. Cannot be null.
See Also:
WebContainer.unregisterWelcomeFiles(HttpContext)

registerLoginConfig

public void registerLoginConfig(java.lang.String authMethod,
                                java.lang.String realmName,
                                org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Registers login configuration, with authorization method and realm name.

Specified by:
registerLoginConfig in interface WebContainer

unregisterLoginConfig

public void unregisterLoginConfig(org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Unregisters login configuration ....

Specified by:
unregisterLoginConfig in interface WebContainer

registerConstraintMapping

public void registerConstraintMapping(java.lang.String constraintName,
                                      java.lang.String url,
                                      java.lang.String mapping,
                                      java.lang.String dataConstraint,
                                      boolean authentication,
                                      java.util.List<java.lang.String> roles,
                                      org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Registers constraint mappings....

Specified by:
registerConstraintMapping in interface WebContainer

unregisterConstraintMapping

public void unregisterConstraintMapping(org.osgi.service.http.HttpContext httpContext)
Description copied from interface: WebContainer
Unregisters constraint mappings....

Specified by:
unregisterConstraintMapping in interface WebContainer

getDefaultSharedHttpContext

public SharedWebContainerContext getDefaultSharedHttpContext()
Specified by:
getDefaultSharedHttpContext in interface WebContainer


Copyright © 2006-2011 OPS4J - Open Participation Software for Java. All Rights Reserved.