org.ops4j.pax.web.service.spi.context

Class DefaultHttpContext

java.lang.Object

org.ops4j.pax.web.service.spi.context.DefaultHttpContext

All Implemented Interfaces:

org.ops4j.pax.web.service.WebContainerContext, org.osgi.service.http.HttpContext

Direct Known Subclasses:

WebContainerContextWrapper

public class DefaultHttpContext
extends Object
implements org.ops4j.pax.web.service.WebContainerContext

Default implementation of HttpContext that uses the bundle to lookup resources (as specified in 102.10.2 "public interface HttpContext").

Note that OSGi CMPN "128.3.5 Static Content" chapter is the only place where "protected directories" are mentioned, so only the implementation of HttpContext specific to pax-web-extender-war may contain such protection. Besides Undertow's default servlet, Tomcat's StandardContextValve and Jetty's ContextHandler provide such protection so we'll leverage those.

Actually we should not restrict access to the protected directories, because they usually contain important configuration files for e.g., JSF.

Author:

Alin Dreghiciu (adreghiciu@gmail.com), Grzegorz Grzybek

Nested Class Summary

Nested classes/interfaces inherited from interface org.ops4j.pax.web.service.WebContainerContext

org.ops4j.pax.web.service.WebContainerContext.DefaultContextIds

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.Bundle	bundle Bundle using the HttpService.
protected String	contextId Name of the context - together with Bundle it's part of context's identity

Fields inherited from interface org.osgi.service.http.HttpContext

AUTHENTICATION_TYPE, AUTHORIZATION, REMOTE_USER

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultHttpContext(org.osgi.framework.Bundle bundle) Constructor for bundle-scoped context
	DefaultHttpContext(org.osgi.framework.Bundle bundle, String contextId) Constructor for bundle-scoped context with user-provided name
protected	DefaultHttpContext(String contextId) Constructor for bundle-agnostic contexts.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
void	finishSecurity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.osgi.framework.Bundle	getBundle()
String	getContextId()
String	getMimeType(String name) Allways returns null as there is no default way to find out the mime type.
protected URL	getResource(org.osgi.framework.Bundle bundle, String name) This method supports ServletContext.getResource(String) and in default implementation of HttpContext interface, according to "102.10.2 public interface HttpContext", "The behavior of the methods on the default HttpContext is defined as follows:[...] This method calls the servlet bundle's Bundle.getResource method, and returns the appropriate URL to access the resource"
URL	getResource(String name)
protected Set<String>	getResourcePaths(org.osgi.framework.Bundle bundle, String name) This method is invoked by default when calling ServletContext.getResourcePaths(String) in OSGi context backed by HttpContext.
Set<String>	getResourcePaths(String name)
boolean	handleSecurity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) There is no security by default, so always return "true".
int	hashCode()
boolean	isShared()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ops4j.pax.web.service.WebContainerContext

getRealPath

Field Detail

bundle

protected final org.osgi.framework.Bundle bundle

Bundle using the HttpService.

contextId

protected final String contextId

Name of the context - together with Bundle it's part of context's identity

Constructor Detail

DefaultHttpContext

public DefaultHttpContext(org.osgi.framework.Bundle bundle)

Constructor for bundle-scoped context

Parameters:

bundle -

DefaultHttpContext

public DefaultHttpContext(org.osgi.framework.Bundle bundle,
                          String contextId)

Constructor for bundle-scoped context with user-provided name

Parameters:

bundle -

contextId -

DefaultHttpContext

protected DefaultHttpContext(String contextId)

Constructor for bundle-agnostic contexts.

Parameters:

contextId -

Method Detail

isShared

public boolean isShared()

Specified by:

isShared in interface org.ops4j.pax.web.service.WebContainerContext

getBundle

public org.osgi.framework.Bundle getBundle()

Specified by:

getBundle in interface org.ops4j.pax.web.service.WebContainerContext

handleSecurity

public boolean handleSecurity(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws IOException

There is no security by default, so always return "true".

Specified by:

handleSecurity in interface org.osgi.service.http.HttpContext

Throws:

IOException

finishSecurity

public void finishSecurity(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)

Specified by:

finishSecurity in interface org.ops4j.pax.web.service.WebContainerContext

getResource

public URL getResource(String name)

Specified by:

getResource in interface org.osgi.service.http.HttpContext

getMimeType

public String getMimeType(String name)

Allways returns null as there is no default way to find out the mime type.

Specified by:

getMimeType in interface org.osgi.service.http.HttpContext

getResourcePaths

public Set<String> getResourcePaths(String name)

Specified by:

getResourcePaths in interface org.ops4j.pax.web.service.WebContainerContext

getContextId

public String getContextId()

Specified by:

getContextId in interface org.ops4j.pax.web.service.WebContainerContext

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getResource

protected URL getResource(org.osgi.framework.Bundle bundle,
                          String name)

This method supports ServletContext.getResource(String) and in default implementation of HttpContext interface, according to "102.10.2 public interface HttpContext", "The behavior of the methods on the default HttpContext is defined as follows:[...] This method calls the servlet bundle's Bundle.getResource method, and returns the appropriate URL to access the resource"

Parameters:

bundle -

name -

Returns:

getResourcePaths

protected Set<String> getResourcePaths(org.osgi.framework.Bundle bundle,
                                       String name)

This method is invoked by default when calling ServletContext.getResourcePaths(String) in OSGi context backed by HttpContext. Just as the Servlet API method, here we list only one level of entries (no recursive searching).

Chapter 140.2.4 "Set getResourcePaths(String)" of CMPN spec says:

Default Behavior - Assumes the resources are in the bundle registering the Whiteboard service. Its Bundle.findEntries method is called to obtain the listing.

Chapter 128.6.3 "Resource Lookup" says:

The getResourcePaths method must map to the Bundle getEntryPaths method, its return type is a Set and can not handle multiples. However, the paths from the getEntryPaths method are relative while the methods of the getResourcePaths must be absolute.

That's a bit contradictive... Bundle.findEntries(java.lang.String, java.lang.String, boolean) returns URLs (and checks fragments and lets us choose recurse flag), while Bundle.getEntryPaths(java.lang.String) returns names (and doesn't check fragments).... In Felix:

• findEntries: new EntryFilterEnumeration(revision, always-fragments, path, filePattern, recurse, url-values) and (resolves a bundle if not resolved)
• getEntryPaths: new EntryFilterEnumeration(revision, no-fragments, path, "*", no-recurse, no-url-values)

The contradiction is resolved like this: DefaultHttpContext will implement this method based on the Whiteboard behavior because Http Service specification doesn't mention this method at all and Web Applications specification doesn't introduce any special support interface to be used under ServletContext.

Parameters:

bundle -

name -

Returns: