uk.ac.ed.epcc.webapp.model.serv

Interface ServeDataProducer

All Superinterfaces:

Contexed, Tagged

All Known Subinterfaces:

SettableServeDataProducer

All Known Implementing Classes:

AvatarServeDataProducer, DataObjectDataProducer, DynamicFormManager, PersonalResponseManager, ResponseManager, SessionDataProducer

public interface ServeDataProducer
extends Contexed, Tagged

Class that can produce data to be provided to the user. It is up to the implementing class how much of the path is significant when locating the data. By convention the tag ServeData should retrieve a default ServeDataProducer for the application.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVE_DATA_TAG

Method Summary

Modifier and Type	Method and Description
MimeStreamData	getData(SessionService user, java.util.List<java.lang.String> path) Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied.
java.lang.String	getDownloadName(SessionService user, java.util.List<java.lang.String> path) get a download file-name to be added to a download link.

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Field Detail

DEFAULT_SERVE_DATA_TAG

static final java.lang.String DEFAULT_SERVE_DATA_TAG

See Also:

Constant Field Values

Method Detail

getData

MimeStreamData getData(SessionService user,
                       java.util.List<java.lang.String> path)
                throws java.lang.Exception

Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied. Note that the SessionService may not have a current person set so you have to check for null SessionService and null AppUser as well as the users permissions.

Parameters:

user -

path -

Returns:

MimeStreamData or null

Throws:

java.lang.Exception

getDownloadName

java.lang.String getDownloadName(SessionService user,
                                 java.util.List<java.lang.String> path)
                          throws java.lang.Exception

get a download file-name to be added to a download link. This should be the same as the value returned by MimeStreamData.getName() if getData(SessionService, List) returns a non-null value. However this method may be called by display content generation code so if the result is generated on the fly it might be possible to generate the download name in a more lightweight fashion. It should also work to always return null thought he browser will use the last part of the selection path as the download

Parameters:

user -

path -

Returns:

Throws:

java.lang.Exception