Package io.guise.framework
Interface ResourceReadDestination
- All Superinterfaces:
Destination
,com.globalmentor.beans.PropertyBindable
A navigation point that retrieves a resource description and/or contents.
- Author:
- Garret Wilson
-
Method Summary
Modifier and TypeMethodDescriptiongetInputStream
(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI) Retrieves an input stream to the resource.io.urf.model.UrfResourceDescription
getResourceDescription
(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI) Returns a description of the resource.Methods inherited from interface io.guise.framework.Destination
exists, getCategories, getDescription, getPath, getPath, getPathPattern, isAuthorized, setCategories
Methods inherited from interface com.globalmentor.beans.PropertyBindable
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Method Details
-
getResourceDescription
io.urf.model.UrfResourceDescription getResourceDescription(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI) throws com.globalmentor.net.ResourceIOException Returns a description of the resource. The resource should include valid values for the following properties:Content.TYPE_PROPERTY_TAG
Content.LENGTH_PROPERTY_TAG
Content.MODIFIED_AT_PROPERTY_TAG
- 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, ornull
if there is no bookmark involved in navigation.referrerURI
- The URI of the referring component or other entity with no query or fragment, ornull
if no referring URI is known.- Returns:
- A description of the resource.
- Throws:
NullPointerException
- if the given navigation path isnull
.com.globalmentor.net.ResourceIOException
- if there is an error retrieving the resource description.
-
getInputStream
InputStream getInputStream(GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, 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, ornull
if there is no bookmark involved in navigation.referrerURI
- The URI of the referring component or other entity with no query or fragment, ornull
if no referring URI is known.- Returns:
- An input stream to the given resource.
- Throws:
NullPointerException
- if the given navigation path isnull
.com.globalmentor.net.ResourceIOException
- Thrown if there is an error accessing the resource, such as a missing file.
-