com.guiseframework
Interface ResourceReadDestination

All Superinterfaces:

Destination, com.globalmentor.beans.PropertyBindable

public interface ResourceReadDestination
extends Destination

A navigation point that retrieves a resource description and/or contents.

Author:

Garret Wilson

Method Summary

java.io.InputStream	getInputStream(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI) Retrieves an input stream to the resource.
com.globalmentor.urf.URFResource	getResourceDescription(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI) Returns a description of the resource.

Methods inherited from interface com.guiseframework.Destination

exists, getCategories, getPath, getPath, getPathPattern, isAuthorized, setCategories

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getResourceDescription

com.globalmentor.urf.URFResource getResourceDescription(GuiseSession session,
                                                        com.globalmentor.net.URIPath navigationPath,
                                                        Bookmark bookmark,
                                                        java.net.URI referrerURI)
                                                        throws com.globalmentor.net.ResourceIOException

Returns a description of the resource. The resource should include valid values for the following properties:

Parameters:

session - The current Guise Session.

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 component or other entity with no query or fragment, or null if no referring URI is known.

Returns:

A description of the resource.

Throws:

java.lang.NullPointerException - if the given navigation path is null.

com.globalmentor.net.ResourceIOException - if there is an error retrieving the resource description.

getInputStream

java.io.InputStream getInputStream(GuiseSession session,
                                   com.globalmentor.net.URIPath navigationPath,
                                   Bookmark bookmark,
                                   java.net.URI referrerURI)
                                   throws com.globalmentor.net.ResourceIOException

Retrieves an input stream to the resource.

Parameters:

session - The current Guise Session.

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 component or other entity with no query or fragment, or null if no referring URI is known.

Returns:

An input stream to the given resource.

Throws:

java.lang.NullPointerException - if the given navigation path is null.

com.globalmentor.net.ResourceIOException - Thrown if there is an error accessing the resource, such as a missing file.