com.nordija.tapestry.bayeux.stream
Interface StreamResourceSource

public interface StreamResourceSource

A source for resources that can be downloaded by the bayeux downloads service.

An implementation of this interface must be configured in the application using the bayeux downloads service as an extension. The downloads service will ask the defined implementation for a resource based on an id when links are clicked.

Version:

$Id: StreamResourceSource.java 119 2007-06-01 12:46:54Z jeyben $

Author:

Per Olesen www.nordija.com

See Also:

StreamService

Method Summary

StreamResource

getStreamResource(org.apache.tapestry.IRequestCycle cycle, java.lang.Object[] parameters) Called by downloads service when a download link has been clicked and the resource to be downloaded is to be obtained from somewhere.

Method Detail

getStreamResource

StreamResource getStreamResource(org.apache.tapestry.IRequestCycle cycle,
                                 java.lang.Object[] parameters)
                                 throws java.io.IOException

Called by downloads service when a download link has been clicked and the resource to be downloaded is to be obtained from somewhere.

Parameters:

cycle - the request cycle which originated the incoming request for a download resource

parameters - the parameters used to find and generate the needed stream resource

Returns:

an instance of the resource identified by the given id or null if resource not found

Throws:

java.io.IOException - if obtaining the resource fails with an exception (no resource on id should not result in this exception!)