001/**
002 *
003 * Copyright 2019-2021 Florian Schmaus
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.smack.provider;
018
019import java.io.IOException;
020import java.text.ParseException;
021
022import org.jivesoftware.smack.packet.IQ;
023import org.jivesoftware.smack.packet.IqData;
024import org.jivesoftware.smack.packet.XmlEnvironment;
025import org.jivesoftware.smack.parsing.SmackParsingException;
026import org.jivesoftware.smack.util.ParserUtils;
027import org.jivesoftware.smack.xml.XmlPullParser;
028import org.jivesoftware.smack.xml.XmlPullParserException;
029
030/**
031 * An abstract class for parsing custom {@link IQ} packets. Each IqProvider must be registered with the {@link
032 * ProviderManager} for it to be used. Every implementation of this abstract class <b>must</b> have a public,
033 * no-argument constructor.
034 *
035 * @param <I> the {@link IQ} that is parsed by implementations.
036 */
037public abstract class IqProvider<I extends IQ> extends AbstractProvider<I> {
038
039    public final I parse(XmlPullParser parser, IqData iqCommon)
040                    throws XmlPullParserException, IOException, SmackParsingException {
041        return parse(parser, iqCommon, null);
042    }
043
044    public final I parse(XmlPullParser parser, IqData iqData, XmlEnvironment outerXmlEnvironment)
045                    throws XmlPullParserException, IOException, SmackParsingException {
046        final int initialDepth = parser.getDepth();
047        final XmlEnvironment xmlEnvironment = XmlEnvironment.from(parser, outerXmlEnvironment);
048
049        I i = wrapExceptions(() -> parse(parser, initialDepth, iqData, xmlEnvironment));
050
051        // Parser should be at end tag of the consumed/parsed element
052        ParserUtils.forwardToEndTagOfDepth(parser, initialDepth);
053        return i;
054    }
055
056    public abstract I parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment)
057                    throws XmlPullParserException, IOException, SmackParsingException, ParseException;
058
059}