1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-06-14 23:54:49 +02:00
Smack/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/Transcript.java
Florian Schmaus 4698805a34 Rename 'Packet' class to 'Stanza'
Smack still uses the term 'Packet' in some places. This is just the
first step towards using correct XMPP terms in Smack.
2015-02-06 09:34:51 +01:00

94 lines
3 KiB
Java

/**
*
* Copyright 2003-2007 Jive Software.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Stanza;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
/**
* Represents the conversation transcript that occured in a group chat room between an Agent
* and a user that requested assistance. The transcript contains all the Messages that were sent
* to the room as well as the sent presences.
*
* @author Gaston Dombiak
*/
public class Transcript extends IQ {
private String sessionID;
private List<Stanza> packets;
/**
* Creates a transcript request for the given sessionID.
*
* @param sessionID the id of the session to get the conversation transcript.
*/
public Transcript(String sessionID) {
this(sessionID, new ArrayList<Stanza>());
}
/**
* Creates a new transcript for the given sessionID and list of packets. The list of packets
* may include Messages and/or Presences.
*
* @param sessionID the id of the session that generated this conversation transcript.
* @param packets the list of messages and presences send to the room.
*/
public Transcript(String sessionID, List<Stanza> packets) {
super("transcript", "http://jabber.org/protocol/workgroup");
this.sessionID = sessionID;
this.packets = packets;
}
/**
* Returns id of the session that generated this conversation transcript. The sessionID is a
* value generated by the server when a new request is received.
*
* @return id of the session that generated this conversation transcript.
*/
public String getSessionID() {
return sessionID;
}
/**
* Returns the list of Messages and Presences that were sent to the room.
*
* @return the list of Messages and Presences that were sent to the room.
*/
public List<Stanza> getPackets() {
return Collections.unmodifiableList(packets);
}
@Override
protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder buf) {
buf.append(" sessionID=\"")
.append(sessionID)
.append("\">");
for (Iterator<Stanza> it=packets.iterator(); it.hasNext();) {
Stanza packet = it.next();
buf.append(packet.toXML());
}
return buf;
}
}