org.sakaiproject.entitybroker.access
Interface AccessFormats

All Superinterfaces:

EntityViewAccessProvider, Formats

public interface AccessFormats
extends EntityViewAccessProvider, Formats

Indicates that entity requests can be handled for certain formats which are indicated

NOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider if nothing is specified here or this interface is not implemented

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Field Summary

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Method Summary

String[]

getHandledAccessFormats() Defines the access format types (extensions) handled by this access provider The default if this interface is not implemented is to pass through all requests to the access provider that is defined

Methods inherited from interface org.sakaiproject.entitybroker.access.EntityViewAccessProvider

handleAccess

Method Detail

getHandledAccessFormats

String[] getHandledAccessFormats()

Defines the access format types (extensions) handled by this access provider
The default if this interface is not implemented is to pass through all requests to the access provider that is defined

Returns:

an array containing the format types (from Formats) handled
OR empty array to indicate all are handled (same as not implementing AccessFormats)
OR null to indicate none are handled (same as not implementing EntityViewAccessProvider)
NOTE: use the constants (example: Formats.HTML) or feel free to make up your own if you like