001/**
002 *
003 * Copyright the original author or authors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.pubsub.provider;
018
019import java.io.IOException;
020
021import org.jivesoftware.smack.provider.ExtensionElementProvider;
022import org.jivesoftware.smack.util.ParserUtils;
023
024import org.jivesoftware.smackx.pubsub.Subscription;
025
026import org.jxmpp.jid.Jid;
027import org.xmlpull.v1.XmlPullParser;
028import org.xmlpull.v1.XmlPullParserException;
029
030/**
031 * Parses the <b>subscription</b> element out of the PubSub IQ message from
032 * the server as specified in the <a href="http://xmpp.org/extensions/xep-0060.html#schemas-pubsub">subscription schema</a>.
033 *
034 * @author Robin Collier
035 */
036public class SubscriptionProvider extends ExtensionElementProvider<Subscription> {
037    @Override
038    public Subscription parse(XmlPullParser parser, int initialDepth)
039                    throws XmlPullParserException, IOException {
040        Jid jid = ParserUtils.getJidAttribute(parser);
041        String nodeId = parser.getAttributeValue(null, "node");
042        String subId = parser.getAttributeValue(null, "subid");
043        String state = parser.getAttributeValue(null, "subscription");
044        boolean isRequired = false;
045
046        int tag = parser.next();
047
048        if ((tag == XmlPullParser.START_TAG) && parser.getName().equals("subscribe-options")) {
049            tag = parser.next();
050
051            if ((tag == XmlPullParser.START_TAG) && parser.getName().equals("required"))
052                isRequired = true;
053
054            while (tag != XmlPullParser.END_TAG && !parser.getName().equals("subscribe-options")) tag = parser.next();
055        }
056        while (parser.getEventType() != XmlPullParser.END_TAG) parser.next();
057        return new Subscription(jid, nodeId, subId, (state == null ? null : Subscription.State.valueOf(state)), isRequired);
058    }
059
060}