com.ibm.portal.resolver.atom
Interface AtomPublishingContentHandler

All Superinterfaces:

org.xml.sax.ContentHandler, ResettableContentHandler

All Known Subinterfaces:

DefaultAtomPublishingContentHandler, ResettableAtomPublishingContentHandler

public interface AtomPublishingContentHandler
extends ResettableContentHandler

http://tools.ietf.org/html/rfc5023 (October 2007) The Atom Publishing Protocol (introspection document)

Please not that as of this writing the The Atom Publishing Protocol is still in draft state. As a result this JAVA API will adapt to the latest state of the draft and will be final only after the The Atom Publishing Protocol has been approved as a final standard.

JAXP content handler extension that defines semantic callbacks for ATOM specific events. For each event in the ATOM namespace these semantic events should be called instead of the untyped SAX events. For all events outside of the ATOM namespace the methods on ContentHandler should be called.

Since:

6.0.1

See Also:

DefaultAtomPublishingContentHandler

Method Summary

void	endAccept() Indicates the end of an app:accept entry.
void	endCategories() Indicates the end of an app:categories entry.
void	endCollection() Indicates the end of an app:collection entry.
void	endControl() Indicates the end of an app:control entry.
void	endDraft() Indicates the end of an app:draft entry.
void	endEdited() Indicates the end of an app:edited entry.
void	endService() Indicates the end of an app:service entry.
void	endWorkspace() Indicates the end of an app:workspace entry.
void	startAccept(org.xml.sax.Attributes attrs) Indicates the start of an app:accept entry.
void	startCategories(java.lang.String oFixed, java.lang.String oScheme, java.lang.String oHref, org.xml.sax.Attributes attrs) Indicates the start of an app:categories entry.
void	startCollection(java.lang.String rHref, org.xml.sax.Attributes attrs) Indicates the start of an app:collection entry.
void	startControl(org.xml.sax.Attributes attrs) Indicates the start of an app:control entry.
void	startDraft(org.xml.sax.Attributes attrs) Indicates the start of an app:draft entry.
void	startEdited(org.xml.sax.Attributes attrs) Indicates the start of an app:edited entry.
void	startService(org.xml.sax.Attributes attrs) Indicates the start of an app:service entry.
void	startWorkspace(org.xml.sax.Attributes attrs) Indicates the start of an app:workspace entry.

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

startService

void startService(org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException

Indicates the start of an app:service entry.

The root of a Service Document is the "app:service" element. The "app:service" element is the container for service information associated with one or more workspaces. An app:service element MUST contain one or more app:workspace elements.

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endService

void endService()
                throws org.xml.sax.SAXException

Indicates the end of an app:service entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startWorkspace

void startWorkspace(org.xml.sax.Attributes attrs)
                    throws org.xml.sax.SAXException

Indicates the start of an app:workspace entry.

The "app:workspace" element contains information elements about the collections of resources available for editing. The app:workspace element contains zero or more app:collection elements.

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endWorkspace

void endWorkspace()
                  throws org.xml.sax.SAXException

Indicates the end of an app:workspace entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startCollection

void startCollection(java.lang.String rHref,
                     org.xml.sax.Attributes attrs)
                     throws org.xml.sax.SAXException

Indicates the start of an app:collection entry.

The "app:collection" element describes a Collection. The app: collection element MAY contain one app:accept element and MAY contain any number of app:categories elements. The app:collection element MUST NOT contain more than one app:accept element.

Parameters:

rHref - Mandatory href attribute, must not be null.

The app:collection element MUST contain an "href" attribute, whose value gives the IRI of the Collection.

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endCollection

void endCollection()
                   throws org.xml.sax.SAXException

Indicates the end of an app:collection entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startAccept

void startAccept(org.xml.sax.Attributes attrs)
                 throws org.xml.sax.SAXException

Indicates the start of an app:accept entry.

The "app:accept" element value specifies a comma-separated list of media-ranges (see [RFC2616]) identifying the types of representations that can be POSTed to the URI of a Collection. Whitespace around and between media-range values is considered insignificant and MUST be ignored.

The app:accept element is similar to the HTTP Accept request-header [RFC2616] with the exception that app:accept has no notion of preference. As a result, the value syntax of app:accept does not use "accept-params" or "q" arguments as specified in [RFC2616], section 14.1.

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endAccept

void endAccept()
               throws org.xml.sax.SAXException

Indicates the end of an app:accept entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startCategories

void startCategories(java.lang.String oFixed,
                     java.lang.String oScheme,
                     java.lang.String oHref,
                     org.xml.sax.Attributes attrs)
                     throws org.xml.sax.SAXException

Indicates the start of an app:categories entry.

The "app:categories" element provides a listing of the categories that can be applied to the members of a Collection.

Parameters:

oFixed - Optional fixed attribute, may be null.

The app:categories element MAY contain a "fixed" attribute, with a value of either "yes" or "no", indicating whether or not the listing of categories is considered to be a fixed, or closed set. The absence of the "fixed" attribute is equivalent to the presence of a "fixed" attribute with a value of "no". Collections that indicate a fixed set MAY reject members that include categories not specified in the provided listing. Collections that indicate an open set SHOULD NOT reject otherwise acceptable members whose categories are not present in the provided list.

oScheme - Optional scheme attribute, may be null.

The app:categories element MAY contain an "href" attribute, whose value MUST be an IRI reference identifying a Category Document. If the "href" attribute is provided, the app:categories element MUST be empty and the "fixed" and "scheme" attributes MUST NOT be present.

oHref - Optional href attribute, may be null.

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endCategories

void endCategories()
                   throws org.xml.sax.SAXException

Indicates the end of an app:categories entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startControl

void startControl(org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException

Indicates the start of an app:control entry.

The "app:control" element MAY appear as a child of an atom:entry which is being created or updated via the Atom Publishing Protocol. The app:control element MUST appear only once in an Entry. The app: control element is considered foreign markup as defined in Section 6 of [RFC4287].

The app:control element and its child elements MAY be included in Atom Feed or Entry Documents.

The app:control element can contain an optional "app:draft" element as defined below, and can contain extension elements as defined in Section 6 of [RFC4287].

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endControl

void endControl()
                throws org.xml.sax.SAXException

Indicates the end of an app:control entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startDraft

void startDraft(org.xml.sax.Attributes attrs)
                throws org.xml.sax.SAXException

Indicates the start of an app:draft entry.

The number of app:draft elements in app:control MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" indicates a client request that the Member Resource be made publicly visible. If the app:draft element is missing then the value MUST be understood to be "no". The inclusion of the app:draft element represents a request by the client to control the visibility of a Member Resource and the app:draft element MAY be ignored by the server.

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endDraft

void endDraft()
              throws org.xml.sax.SAXException

Indicates the end of an app:draft entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startEdited

void startEdited(org.xml.sax.Attributes attrs)
                 throws org.xml.sax.SAXException

Indicates the start of an app:edited entry.

The "app:edited" element is a Date construct as defined by [RFC4287] whose value indicates the most recent instant in time when an entry was edited, including when created. Atom entry elements in Collection documents SHOULD contain one "app:edited" element, and MUST NOT contain more than one.

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endEdited

void endEdited()
               throws org.xml.sax.SAXException

Indicates the end of an app:edited entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created