com.guiseframework.platform.web
Class GuiseHTTPServlet.DestinationResource

java.lang.Object
  com.globalmentor.net.DefaultResource
      com.guiseframework.platform.web.GuiseHTTPServlet.DestinationResource

All Implemented Interfaces:

com.globalmentor.net.Resource, java.lang.Comparable<com.globalmentor.net.Resource>

Enclosing class:

GuiseHTTPServlet

protected class GuiseHTTPServlet.DestinationResource
extends com.globalmentor.net.DefaultResource

A resource that is accessed through a Guise session's resource destination.

Author:

Garret Wilson

See Also:

ResourceReadDestination

Field Summary

Fields inherited from interface com.globalmentor.net.Resource

URI_PROPERTY_NAME

Constructor Summary

GuiseHTTPServlet.DestinationResource(java.net.URI referenceURI, com.globalmentor.urf.URFResource resourceDescription, HTTPServletGuiseContainer guiseContainer, GuiseApplication guiseApplication, GuiseSession guiseSession, ResourceReadDestination resourceDestination, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI)
Constructs a resource with a reference URI and resource description, along with the Guise container, application, session, and resource destination.

Method Summary

java.io.InputStream

getInputStream(HttpServletRequest request) Returns an input stream to the resource.

Methods inherited from class com.globalmentor.net.DefaultResource

compareTo, equals, getURI, hashCode, setURI, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.globalmentor.net.Resource

getURI

Constructor Detail

GuiseHTTPServlet.DestinationResource

public GuiseHTTPServlet.DestinationResource(java.net.URI referenceURI,
                                            com.globalmentor.urf.URFResource resourceDescription,
                                            HTTPServletGuiseContainer guiseContainer,
                                            GuiseApplication guiseApplication,
                                            GuiseSession guiseSession,
                                            ResourceReadDestination resourceDestination,
                                            com.globalmentor.net.URIPath navigationPath,
                                            Bookmark bookmark,
                                            java.net.URI referrerURI)

Constructs a resource with a reference URI and resource description, along with the Guise container, application, session, and resource destination.

Parameters:

referenceURI - The reference URI for the new resource.

resourceDescription - The description of the resource.

guiseContainer - The Guise container.

guiseApplication - The Guise application.

guiseSession - The Guise session.

resourceDestination - The Guise session resource destination being accessed.

navigationPath - The navigation path relative to the application context path.

bookmark - The bookmark for which navigation should occur at this navigation path, or null if there is no bookmark involved in navigation.

referrerURI - The URI of the referring navigation panel or other entity with no query or fragment, or null if no referring URI is known.

Throws:

java.lang.NullPointerException - if the reference URI, resource description, Guise container, Guise application, Guise session, resource destination, navigation path, and/or bookmark is null.

Method Detail

getInputStream

public java.io.InputStream getInputStream(HttpServletRequest request)
                                   throws java.io.IOException

Returns an input stream to the resource. This method delegates to ResourceReadDestination#getInputStream(String, Bookmark, URI), providing the Guise session by running in a separate thread group.

Parameters:

request - The HTTP request in response to which the input stream is being retrieved.

Returns:

The input stream to the resource.

Throws:

java.io.IOException - if there is an error getting an input stream to the resource.