1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Revision$ 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Date$ 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2007 Jive Software. 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smackx.workgroup.agent; 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smackx.workgroup.packet.TranscriptSearch; 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.PacketCollector; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.SmackConfiguration; 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.Connection; 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.XMPPException; 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.filter.PacketIDFilter; 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.packet.IQ; 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smackx.Form; 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smackx.ReportedData; 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * A TranscriptSearchManager helps to retrieve the form to use for searching transcripts 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * {@link #getSearchForm(String)} or to submit a search form and return the results of 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * the search {@link #submitSearch(String, Form)}. 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Gaston Dombiak 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class TranscriptSearchManager { 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private Connection connection; 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public TranscriptSearchManager(Connection connection) { 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.connection = connection; 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the Form to use for searching transcripts. It is unlikely that the server 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * will change the form (without a restart) so it is safe to keep the returned form 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * for future submissions. 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param serviceJID the address of the workgroup service. 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the Form to use for searching transcripts. 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @throws XMPPException if an error occurs while sending the request to the server. 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Form getSearchForm(String serviceJID) throws XMPPException { 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen TranscriptSearch search = new TranscriptSearch(); 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen search.setType(IQ.Type.GET); 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen search.setTo(serviceJID); 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen PacketCollector collector = connection.createPacketCollector( 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen new PacketIDFilter(search.getPacketID())); 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen connection.sendPacket(search); 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen TranscriptSearch response = (TranscriptSearch) collector.nextResult( 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen SmackConfiguration.getPacketReplyTimeout()); 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Cancel the collector. 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen collector.cancel(); 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (response == null) { 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen throw new XMPPException("No response from server on status set."); 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (response.getError() != null) { 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen throw new XMPPException(response.getError()); 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return Form.getFormFrom(response); 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Submits the completed form and returns the result of the transcript search. The result 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * will include all the data returned from the server so be careful with the amount of 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * data that the search may return. 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param serviceJID the address of the workgroup service. 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param completedForm the filled out search form. 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the result of the transcript search. 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @throws XMPPException if an error occurs while submiting the search to the server. 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public ReportedData submitSearch(String serviceJID, Form completedForm) throws XMPPException { 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen TranscriptSearch search = new TranscriptSearch(); 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen search.setType(IQ.Type.GET); 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen search.setTo(serviceJID); 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen search.addExtension(completedForm.getDataFormToSend()); 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen PacketCollector collector = connection.createPacketCollector(new PacketIDFilter(search.getPacketID())); 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen connection.sendPacket(search); 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen TranscriptSearch response = (TranscriptSearch) collector.nextResult(SmackConfiguration.getPacketReplyTimeout()); 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Cancel the collector. 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen collector.cancel(); 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (response == null) { 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen throw new XMPPException("No response from server on status set."); 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (response.getError() != null) { 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen throw new XMPPException(response.getError()); 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return ReportedData.getReportedDataFrom(response); 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 112