001/*
002 *
003 * Copyright 2003-2007 Jive Software.
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 */
017
018package org.jivesoftware.smackx.workgroup.packet;
019
020import java.io.IOException;
021
022import org.jivesoftware.smack.packet.IqData;
023import org.jivesoftware.smack.packet.SimpleIQ;
024import org.jivesoftware.smack.packet.XmlEnvironment;
025import org.jivesoftware.smack.parsing.SmackParsingException;
026import org.jivesoftware.smack.provider.IqProvider;
027import org.jivesoftware.smack.util.PacketParserUtils;
028import org.jivesoftware.smack.xml.XmlPullParser;
029import org.jivesoftware.smack.xml.XmlPullParserException;
030
031import org.jxmpp.JxmppContext;
032
033/**
034 * IQ stanza for retrieving the transcript search form, submitting the completed search form
035 * or retrieving the answer of a transcript search.
036 *
037 * @author Gaston Dombiak
038 */
039public class TranscriptSearch extends SimpleIQ {
040
041    /**
042    * Element name of the stanza extension.
043    */
044   public static final String ELEMENT_NAME = "transcript-search";
045
046   /**
047    * Namespace of the stanza extension.
048    */
049   public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
050
051   public TranscriptSearch() {
052       super(ELEMENT_NAME, NAMESPACE);
053   }
054
055    /**
056     * An IQProvider for TranscriptSearch packets.
057     *
058     * @author Gaston Dombiak
059     */
060    public static class Provider extends IqProvider<TranscriptSearch> {
061
062        @Override
063        public TranscriptSearch parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment, JxmppContext jxmppContext) throws XmlPullParserException, IOException, SmackParsingException {
064            TranscriptSearch answer = new TranscriptSearch();
065
066            boolean done = false;
067            while (!done) {
068                XmlPullParser.Event eventType = parser.next();
069                if (eventType == XmlPullParser.Event.START_ELEMENT) {
070                    // Parse the packet extension
071                    PacketParserUtils.addExtensionElement(answer, parser, xmlEnvironment, jxmppContext);
072                }
073                else if (eventType == XmlPullParser.Event.END_ELEMENT) {
074                    if (parser.getName().equals(ELEMENT_NAME)) {
075                        done = true;
076                    }
077                }
078            }
079
080            return answer;
081        }
082    }
083}