uk.ac.ed.epcc.webapp.session

Class SessionDataProducer

java.lang.Object

uk.ac.ed.epcc.webapp.session.SessionDataProducer

All Implemented Interfaces:

Contexed, ServeDataProducer, SettableServeDataProducer, Tagged

public class SessionDataProducer
extends java.lang.Object
implements SettableServeDataProducer

A serveDataProducer that stores the data in the Session This is stores as a serialised byte array to avoid any possibility of a class-loader leak.

Field Summary

Fields inherited from interface uk.ac.ed.epcc.webapp.model.serv.ServeDataProducer

DEFAULT_SERVE_DATA_TAG

Constructor Summary

Constructors

Constructor and Description
SessionDataProducer(AppContext conn, java.lang.String tag)

Method Summary

Modifier and Type	Method and Description
MimeStreamData	find(int id)
AppContext	getContext()
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.
java.lang.String	getTag() get the construction tag
java.util.List<java.lang.String>	setData(MimeStreamData data) Store a MimeStreamData object generating a new path location

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionDataProducer

public SessionDataProducer(AppContext conn,
                           java.lang.String tag)

Method Detail

find

public MimeStreamData find(int id)
                    throws DataException

Throws:

DataException

getTag

public java.lang.String getTag()

Description copied from interface: Tagged

get the construction tag

Specified by:

getTag in interface Tagged

Returns:

String tag

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

getData

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

Description copied from interface: ServeDataProducer

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.

Specified by:

getData in interface ServeDataProducer

Returns:

MimeStreamData or null

Throws:

java.lang.Exception

setData

public java.util.List<java.lang.String> setData(MimeStreamData data)

Description copied from interface: SettableServeDataProducer

Store a MimeStreamData object generating a new path location

Specified by:

setData in interface SettableServeDataProducer

Parameters:

data - Data to add

Returns:

path to stored data

getDownloadName

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

Description copied from interface: ServeDataProducer

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 ServeDataProducer.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

Specified by:

getDownloadName in interface ServeDataProducer

Returns:

Throws:

java.lang.Exception