org.sakaiproject.citation.impl

Class CitationListAccessServlet

java.lang.Object

org.sakaiproject.citation.impl.CitationListAccessServlet

All Implemented Interfaces:

org.sakaiproject.entity.api.HttpAccess

public class CitationListAccessServlet
extends Object
implements org.sakaiproject.entity.api.HttpAccess

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIST_TEMPLATE
protected static org.sakaiproject.util.ResourceLoader	rb Messages, for the http access.

Constructor Summary

Constructors

Constructor and Description
CitationListAccessServlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	handleAccess(HttpServletRequest req, HttpServletResponse res, org.sakaiproject.entity.api.Reference ref, Collection copyrightAcceptedRefs) Handle an HTTP request for access.
protected void	handleExportRequest(HttpServletRequest req, HttpServletResponse res, org.sakaiproject.entity.api.Reference ref, String format, String subtype)
protected void	handleViewRequest(HttpServletRequest req, HttpServletResponse res, org.sakaiproject.entity.api.Reference ref)

Methods inherited from class java.lang.Object

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

Field Detail

LIST_TEMPLATE

public static final String LIST_TEMPLATE

See Also:

Constant Field Values

rb

protected static org.sakaiproject.util.ResourceLoader rb

Messages, for the http access.

Constructor Detail

CitationListAccessServlet

public CitationListAccessServlet()

Method Detail

handleAccess

public void handleAccess(HttpServletRequest req,
                HttpServletResponse res,
                org.sakaiproject.entity.api.Reference ref,
                Collection copyrightAcceptedRefs)
                  throws org.sakaiproject.entity.api.EntityPermissionException,
                         org.sakaiproject.entity.api.EntityNotDefinedException,
                         org.sakaiproject.entity.api.EntityAccessOverloadException,
                         org.sakaiproject.entity.api.EntityCopyrightException

Handle an HTTP request for access. The request and response objects are provider.
The access is for the referenced entity.
Use the response object to send the headers, length, content type, and bytes of the response in whatever manner needed.
Make the response ONLY if it is permitted and exists and otherwise valid. Use the exceptions for any error handling.

Specified by:

handleAccess in interface org.sakaiproject.entity.api.HttpAccess

Parameters:

req - The request object.

res - The response object.

ref - The entity reference

copyrightAcceptedRefs - The collection (entity reference String) of entities that the end user in this session have already accepted the copyright for.

Throws:

org.sakaiproject.entity.api.EntityPermissionException - Throw this if the current user does not have permission for the access.

org.sakaiproject.entity.api.EntityNotDefinedException - Throw this if the ref is not supported or the entity is not available for access in any way.

org.sakaiproject.entity.api.EntityAccessOverloadException - Throw this if you are rejecting an otherwise valid request because of some sort of server resource shortage or limit.

org.sakaiproject.entity.api.EntityCopyrightException - Throw this if you are rejecting an otherwise valid request because the user needs to agree to the copyright and has not yet done so.

handleExportRequest

protected void handleExportRequest(HttpServletRequest req,
                       HttpServletResponse res,
                       org.sakaiproject.entity.api.Reference ref,
                       String format,
                       String subtype)
                            throws org.sakaiproject.entity.api.EntityNotDefinedException,
                                   org.sakaiproject.entity.api.EntityAccessOverloadException,
                                   org.sakaiproject.entity.api.EntityPermissionException

Throws:

org.sakaiproject.entity.api.EntityNotDefinedException

org.sakaiproject.entity.api.EntityAccessOverloadException

org.sakaiproject.entity.api.EntityPermissionException

handleViewRequest

protected void handleViewRequest(HttpServletRequest req,
                     HttpServletResponse res,
                     org.sakaiproject.entity.api.Reference ref)
                          throws org.sakaiproject.entity.api.EntityPermissionException,
                                 org.sakaiproject.entity.api.EntityAccessOverloadException,
                                 org.sakaiproject.entity.api.EntityNotDefinedException

Throws:

org.sakaiproject.entity.api.EntityPermissionException

org.sakaiproject.entity.api.EntityAccessOverloadException

org.sakaiproject.entity.api.EntityNotDefinedException