Package io.guise.framework

Interface ResourceWriteDestination

All Superinterfaces:

Destination, com.globalmentor.beans.PropertyBindable

public interface ResourceWriteDestination
extends Destination

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

Author:

Garret Wilson

Method Summary

Modifier and Type	Method	Description
java.io.OutputStream	getOutputStream(io.urf.model.UrfResourceDescription resourceDescription, GuiseSession session, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI)	Retrieves an output stream to 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 Detail

getOutputStream

java.io.OutputStream getOutputStream(io.urf.model.UrfResourceDescription resourceDescription,
                                     GuiseSession session,
                                     com.globalmentor.net.URIPath navigationPath,
                                     Bookmark bookmark,
                                     java.net.URI referrerURI)
                              throws com.globalmentor.net.ResourceIOException

Retrieves an output stream to the resource. The resource may include any of the following properties:

• TODO add urf-name property to spec
• Content.TYPE_PROPERTY_TAG
• Content.LENGTH_PROPERTY_TAG
• Content.MODIFIED_AT_PROPERTY_TAG

Parameters:

resourceDescription - The description of the resource.

session - The current Guise Session.

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

bookmark - The bookmark for 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 output 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 writing to the resource.