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.packet.XmlEnvironment;
022import org.jivesoftware.smack.provider.ExtensionElementProvider;
023import org.jivesoftware.smack.util.ParserUtils;
024import org.jivesoftware.smack.xml.XmlPullParser;
025import org.jivesoftware.smack.xml.XmlPullParserException;
026
027import org.jivesoftware.smackx.pubsub.Subscription;
028
029import org.jxmpp.jid.Jid;
030
031/**
032 * Parses the <b>subscription</b> element out of the PubSub IQ message from
033 * the server as specified in the <a href="http://xmpp.org/extensions/xep-0060.html#schemas-pubsub">subscription schema</a>.
034 *
035 * @author Robin Collier
036 */
037public class SubscriptionProvider extends ExtensionElementProvider<Subscription> {
038    @Override
039    public Subscription parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)
040                    throws XmlPullParserException, IOException {
041        Jid jid = ParserUtils.getJidAttribute(parser);
042        String nodeId = parser.getAttributeValue(null, "node");
043        String subId = parser.getAttributeValue(null, "subid");
044        String state = parser.getAttributeValue(null, "subscription");
045        boolean isRequired = false;
046
047        XmlPullParser.Event tag = parser.next();
048
049        if ((tag == XmlPullParser.Event.START_ELEMENT) && parser.getName().equals("subscribe-options")) {
050            tag = parser.next();
051
052            if ((tag == XmlPullParser.Event.START_ELEMENT) && parser.getName().equals("required"))
053                isRequired = true;
054
055            while (tag != XmlPullParser.Event.END_ELEMENT && !parser.getName().equals("subscribe-options")) tag = parser.next();
056        }
057        while (parser.getEventType() != XmlPullParser.Event.END_ELEMENT) parser.next();
058        return new Subscription(jid, nodeId, subId, state == null ? null : Subscription.State.valueOf(state), isRequired);
059    }
060
061}