uk.ac.cam.caret.sakai.rwiki.service.api

Interface EntityHandler

public interface EntityHandler

An entity handler matches resource references and handles how those resource references interact witht he Entity provider. One Entity provider may have one or more Entity handlers. Entity Handlers are in general singletons, that are thread safe and operate on oobjects passed in through the stack or thread local.

Author:

ieb

Method Summary

Modifier and Type	Method and Description
Collection	getAuthzGroups(Reference entity, String userId) Gets the AuthZGroups associated with this entity
String	getDescription(Entity entity) Get the description of the Rwiki Object based on the inbound Entity object
String	getHTML(Entity e) Generate a HTML link for the entity handler
ResourceProperties	getProperties(Entity e) Gets the resource properties for the id
int	getRevision(Reference reference) Get the revision based on the referenece string, if there is no version, then it is implementation specific what is returned (eg -1)
String	getUrl(Entity entity) get a url for the entity
boolean	matches(String reference) Retruns true if the entity matches the reference
void	outputContent(Entity entity, Entity sidebar, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse res) output the entity to the output stream
void	setReference(String majorType, Reference ref, String reference) This sets the reference using this entity handler

Method Detail

setReference

void setReference(String majorType,
                  Reference ref,
                  String reference)

This sets the reference using this entity handler

Parameters:

majorType - The mojor type to bind this reference to

ref - the reference object

reference - the reference string

getDescription

String getDescription(Entity entity)

Get the description of the Rwiki Object based on the inbound Entity object

Parameters:

entity -

Returns:

the description of this entity

matches

boolean matches(String reference)

Retruns true if the entity matches the reference

Parameters:

reference -

Returns:

true if this entity handler matches this

getRevision

int getRevision(Reference reference)

Get the revision based on the referenece string, if there is no version, then it is implementation specific what is returned (eg -1)

Parameters:

reference -

Returns:

the revision number

getUrl

String getUrl(Entity entity)

get a url for the entity

Parameters:

entity - the entity object

Returns:

a url that represents the entity

outputContent

void outputContent(Entity entity,
                   Entity sidebar,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse res)

output the entity to the output stream

Parameters:

entity - the Entity to output

rrequest - the servlet request object

res - the servlet response object

getProperties

ResourceProperties getProperties(Entity e)

Gets the resource properties for the id

Parameters:

e - The entity

Returns:

getAuthzGroups

Collection getAuthzGroups(Reference entity,
                          String userId)

Gets the AuthZGroups associated with this entity

Parameters:

entity -

userId -

Returns:

getHTML

String getHTML(Entity e)

Generate a HTML link for the entity handler

Parameters:

e -

Returns: