org.sakaiproject.entitybroker.entityprovider.extension
Interface Formats

All Known Subinterfaces:

AccessFormats, Inputable, InputTranslatable, Outputable, OutputFormattable, OutputSerializable, RESTful

public interface Formats

Defines a list of possible format types (extensions) which can be handled and indicates which are handled internally

Author:

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

Field Summary

static String[]	ALL_KNOWN_FORMATS the array of all the known formats in this file
static String	ATOM ATOM XML feed (application/atom+xml) http://en.wikipedia.org/wiki/ATOM INPUT: -not supported- OUTPUT: -not supported-
static String[]	ATOM_EXTENSIONS
static String	ATOM_MIME_TYPE
static String	FORM Special output format which indicates this entity will use internally generated forms for input data, the output simply produces very simple html forms, this is handled internally INPUT: none OUTPUT: XHTML text (forms for submitting data)
static String[]	FORM_EXTENSIONS
static String	FORM_MIME_TYPE
static String	HTML HTML formatted text (text/html or application/xhtml+xml) http://en.wikipedia.org/wiki/HTML INPUT: POST or GET form data OUTPUT: (X)HTML text
static String[]	HTML_EXTENSIONS
static String	HTML_MIME_TYPE
static String	JSON JSON formatted text (application/json or text/javascript) http://en.wikipedia.org/wiki/JSON INPUT: JSON text OUTPUT: JSON text
static String[]	JSON_EXTENSIONS
static String	JSON_MIME_TYPE
static String	JSONP JSON formatted text with JSONP callback (application/javascript) http://en.wikipedia.org/wiki/JSON INPUT: -not supported, see JSON- OUTPUT: JSON text with callback (jsonEntityFeed({...}) by default)
static String[]	JSONP_EXTENSIONS
static String	JSONP_MIME_TYPE
static String	RSS RSS 2 XML feed (application/rss+xml) http://en.wikipedia.org/wiki/RSS INPUT: -not supported- OUTPUT: -not supported-
static String[]	RSS_EXTENSIONS
static String	RSS_MIME_TYPE
static String	TXT Plain text (text/plain) http://en.wikipedia.org/wiki/Plain_text INPUT: -not supported- OUTPUT: text
static String[]	TXT_EXTENSIONS
static String	TXT_MIME_TYPE
static String	UTF_8 All character data should be encoded and decoded as UTF-8, this constant is the proper encoding string to use
static String	XML XML formatted text (application/xml or text/xml) http://en.wikipedia.org/wiki/XML INPUT: XML text OUTPUT: XML text
static String[]	XML_EXTENSIONS
static String	XML_MIME_TYPE

Field Detail

HTML

static final String HTML

HTML formatted text (text/html or application/xhtml+xml)
http://en.wikipedia.org/wiki/HTML
INPUT: POST or GET form data
OUTPUT: (X)HTML text

See Also:

Constant Field Values

HTML_MIME_TYPE

static final String HTML_MIME_TYPE

See Also:

Constant Field Values

HTML_EXTENSIONS

static final String[] HTML_EXTENSIONS

FORM

static final String FORM

Special output format which indicates this entity will use internally generated forms for input data, the output simply produces very simple html forms, this is handled internally
INPUT: none
OUTPUT: XHTML text (forms for submitting data)

See Also:

Constant Field Values

FORM_MIME_TYPE

static final String FORM_MIME_TYPE

See Also:

Constant Field Values

FORM_EXTENSIONS

static final String[] FORM_EXTENSIONS

XML

static final String XML

XML formatted text (application/xml or text/xml)
http://en.wikipedia.org/wiki/XML
INPUT: XML text
OUTPUT: XML text

See Also:

Constant Field Values

XML_MIME_TYPE

static final String XML_MIME_TYPE

See Also:

Constant Field Values

XML_EXTENSIONS

static final String[] XML_EXTENSIONS

JSON

static final String JSON

JSON formatted text (application/json or text/javascript)
http://en.wikipedia.org/wiki/JSON
INPUT: JSON text
OUTPUT: JSON text

See Also:

Constant Field Values

JSON_MIME_TYPE

static final String JSON_MIME_TYPE

See Also:

Constant Field Values

JSON_EXTENSIONS

static final String[] JSON_EXTENSIONS

JSONP

static final String JSONP

JSON formatted text with JSONP callback (application/javascript)
http://en.wikipedia.org/wiki/JSON
INPUT: -not supported, see JSON- OUTPUT: JSON text with callback (jsonEntityFeed({...}) by default)

See Also:

Constant Field Values

JSONP_MIME_TYPE

static final String JSONP_MIME_TYPE

See Also:

Constant Field Values

JSONP_EXTENSIONS

static final String[] JSONP_EXTENSIONS

TXT

static final String TXT

Plain text (text/plain)
http://en.wikipedia.org/wiki/Plain_text
INPUT: -not supported-
OUTPUT: text

See Also:

Constant Field Values

TXT_MIME_TYPE

static final String TXT_MIME_TYPE

See Also:

Constant Field Values

TXT_EXTENSIONS

static final String[] TXT_EXTENSIONS

RSS

static final String RSS

RSS 2 XML feed (application/rss+xml)
http://en.wikipedia.org/wiki/RSS
INPUT: -not supported-
OUTPUT: -not supported-

See Also:

Constant Field Values

RSS_MIME_TYPE

static final String RSS_MIME_TYPE

See Also:

Constant Field Values

RSS_EXTENSIONS

static final String[] RSS_EXTENSIONS

ATOM

static final String ATOM

ATOM XML feed (application/atom+xml)
http://en.wikipedia.org/wiki/ATOM
INPUT: -not supported-
OUTPUT: -not supported-

See Also:

Constant Field Values

ATOM_MIME_TYPE

static final String ATOM_MIME_TYPE

See Also:

Constant Field Values

ATOM_EXTENSIONS

static final String[] ATOM_EXTENSIONS

UTF_8

static final String UTF_8

All character data should be encoded and decoded as UTF-8, this constant is the proper encoding string to use

See Also:

Constant Field Values

ALL_KNOWN_FORMATS

static final String[] ALL_KNOWN_FORMATS

the array of all the known formats in this file