org.keycloak.saml.common.parsers

Class AbstractStaxParser<T,E>

java.lang.Object

org.keycloak.saml.common.parsers.AbstractStaxParser<T,E>

Type Parameters:

T - Java class that will be result of parsing this element

E - Type containing all tokens that can be found in subelements of the element parsed by this parser, usually an enum

All Implemented Interfaces:

StaxParser

Direct Known Subclasses:

AbstractStaxSamlAssertionParser, AbstractStaxSamlMetadataParser, AbstractStaxSamlProtocolParser, AbstractStaxXmlDSigParser, AnyDomParser

public abstract class AbstractStaxParser<T,E>
extends Object
implements StaxParser

Simple support for STaX type of parsing. Parses single element and allows processing its direct children.

Author:

hmlnarik

Field Summary

Fields

Modifier and Type	Field and Description
protected QName	expectedStartElement
protected static PicketLinkLogger	LOGGER

Constructor Summary

Constructors

Constructor and Description
AbstractStaxParser(QName expectedStartElement, E unknownElement)

Method Summary

Modifier and Type	Method and Description
protected abstract E	getElementFromName(QName name)
protected abstract T	instantiateElement(XMLEventReader xmlEventReader, StartElement element) Instantiates the target Java class representing the current element. Precondition: Current event is the StartElement Postcondition: Current event is the StartElement or the EndElement corresponding to the StartElement
protected boolean	isUnknownElement(E token)
T	parse(XMLEventReader xmlEventReader) Parse the event stream
protected abstract void	processSubElement(XMLEventReader xmlEventReader, T target, E element, StartElement elementDetail) Processes the subelement of the element processed in instantiateElement(javax.xml.stream.XMLEventReader, javax.xml.stream.events.StartElement) method. Precondition: Current event: Last before the StartElement corresponding to the processed subelement, i.e.
protected void	validateStartElement(StartElement startElement) Validates that the given startElement has the expected properties (namely QName matches the expected one).

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final PicketLinkLogger LOGGER

expectedStartElement

protected final QName expectedStartElement

Constructor Detail

AbstractStaxParser

public AbstractStaxParser(QName expectedStartElement,
                          E unknownElement)

Method Detail

parse

public T parse(XMLEventReader xmlEventReader)
        throws ParsingException

Description copied from interface: StaxParser

Parse the event stream

Specified by:

parse in interface StaxParser

Returns:

Throws:

ParsingException

validateStartElement

protected void validateStartElement(StartElement startElement)

Validates that the given startElement has the expected properties (namely QName matches the expected one).

Parameters:

startElement -

isUnknownElement

protected boolean isUnknownElement(E token)

getElementFromName

protected abstract E getElementFromName(QName name)

instantiateElement

protected abstract T instantiateElement(XMLEventReader xmlEventReader,
                                        StartElement element)
                                 throws ParsingException

Instantiates the target Java class representing the current element.
Precondition: Current event is the StartElement
Postcondition: Current event is the StartElement or the EndElement corresponding to the StartElement

Parameters:

xmlEventReader -

element - The XML event that was just read from the xmlEventReader

Returns:

Throws:

ParsingException

processSubElement

protected abstract void processSubElement(XMLEventReader xmlEventReader,
                                          T target,
                                          E element,
                                          StartElement elementDetail)
                                   throws ParsingException

Processes the subelement of the element processed in instantiateElement(javax.xml.stream.XMLEventReader, javax.xml.stream.events.StartElement) method.
Precondition: Current event: Last before the StartElement corresponding to the processed subelement, i.e. event obtained by Iterator.next() is the StartElement of the subelement being processed
Postcondition: Event obtained by Iterator.next() is either the same StartElement (i.e. no change in position which causes this subelement to be skipped), the corresponding EndElement, or the event after the corresponding EndElement.

Note that in case of recursive nesting the same element, the corresponding end element MUST be consumed in this method.

Parameters:

xmlEventReader -

target - Target object (the one created by the instantiateElement(javax.xml.stream.XMLEventReader, javax.xml.stream.events.StartElement) method.

element - The constant corresponding to the current start element.

elementDetail - The XML event that was just read from the xmlEventReader

Throws:

ParsingException