WSAddressingParser.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.picketlink.identity.federation.core.parsers.wsa;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

import org.picketlink.identity.federation.core.exceptions.ParsingException;
import org.picketlink.identity.federation.core.parsers.AbstractParser;
import org.picketlink.identity.federation.core.parsers.ParserNamespaceSupport;
import org.picketlink.identity.federation.core.parsers.util.StaxParserUtil;
import org.picketlink.identity.federation.core.wstrust.WSTrustConstants;
import org.picketlink.identity.federation.ws.addressing.AttributedURIType;
import org.picketlink.identity.federation.ws.addressing.EndpointReferenceType;

/**
 * <p>
 * Able to parse the WS-Addressing pieces in WS-T RST.
 * <p>
 *
 * @author Anil.Saldhana@redhat.com
 * @since Oct 14, 2010
 */
public class WSAddressingParser extends AbstractParser {
    public static final String ENDPOINT_REFERENCE = "EndpointReference";

    public static final String ADDRESS = "Address";

    /**
     * @see {@link ParserNamespaceSupport#parse(XMLEventReader)}
     */
    public Object parse(XMLEventReader xmlEventReader) throws ParsingException {
        while (xmlEventReader.hasNext()) {
            XMLEvent xmlEvent = StaxParserUtil.peek(xmlEventReader);

            if (xmlEvent instanceof StartElement) {
                StartElement startElement = (StartElement) xmlEvent;

                String elementName = StaxParserUtil.getStartElementName(startElement);
                if (elementName.equalsIgnoreCase(ENDPOINT_REFERENCE)) {
                    startElement = StaxParserUtil.getNextStartElement(xmlEventReader);
                    StaxParserUtil.validate(startElement, ENDPOINT_REFERENCE);

                    // Lets get the wsa:Address
                    startElement = StaxParserUtil.getNextStartElement(xmlEventReader);
                    StaxParserUtil.validate(startElement, ADDRESS);

                    if (!StaxParserUtil.hasTextAhead(xmlEventReader))
                        throw logger.parserExpectedTextValue("endpointURI");

                    String endpointURI = StaxParserUtil.getElementText(xmlEventReader);

                    AttributedURIType attributedURI = new AttributedURIType();
                    attributedURI.setValue(endpointURI);
                    EndpointReferenceType reference = new EndpointReferenceType();
                    reference.setAddress(attributedURI);

                    // Lets get the end element
                    xmlEvent = StaxParserUtil.getNextEvent(xmlEventReader);
                    EndElement endElement = (EndElement) xmlEvent;
                    StaxParserUtil.validate(endElement, ENDPOINT_REFERENCE);

                    return reference;
                }
            } else {
                StaxParserUtil.getNextEvent(xmlEventReader);
            }
        }
        throw logger.parserFailed(WSTrustConstants.WSA_NS);
    }

    /**
     * @see {@link ParserNamespaceSupport#supports(QName)}
     */
    public boolean supports(QName qname) {
        return WSTrustConstants.WSA_NS.equals(qname.getNamespaceURI());
    }
}