org.jivesoftware.smackx.workgroup.packet.QueueDetails Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smack-legacy Show documentation
Show all versions of smack-legacy Show documentation
Smack legacy extensions.
Usually XEPs in the state 'retracted', 'rejected', 'deprecated',
'obsolete' or in a long standing 'deferred' state.
/**
*
* 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 java.io.IOException;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import java.util.logging.Logger;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.workgroup.QueueUser;
/**
* Queue details stanza extension, which contains details about the users
* currently in a queue.
*/
public final class QueueDetails implements ExtensionElement {
private static final Logger LOGGER = Logger.getLogger(QueueDetails.class.getName());
/**
* Element name of the stanza extension.
*/
public static final String ELEMENT_NAME = "notify-queue-details";
/**
* Namespace of the stanza extension.
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private static final String DATE_FORMAT = "yyyyMMdd'T'HH:mm:ss";
private final SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT);
/**
* The list of users in the queue.
*/
private final Set users = new HashSet<>();
/**
* Returns the number of users currently in the queue that are waiting to
* be routed to an agent.
*
* @return the number of users in the queue.
*/
public int getUserCount() {
return users.size();
}
/**
* Returns the set of users in the queue that are waiting to
* be routed to an agent (as QueueUser objects).
*
* @return a Set for the users waiting in a queue.
*/
public Set getUsers() {
synchronized (users) {
return users;
}
}
/**
* Adds a user to the packet.
*
* @param user the user.
*/
private void addUser(QueueUser user) {
synchronized (users) {
users.add(user);
}
}
@Override
public String getElementName() {
return ELEMENT_NAME;
}
@Override
public String getNamespace() {
return NAMESPACE;
}
@Override
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
StringBuilder buf = new StringBuilder();
buf.append('<').append(ELEMENT_NAME).append(" xmlns=\"").append(NAMESPACE).append("\">");
synchronized (users) {
for (Iterator i = users.iterator(); i.hasNext(); ) {
QueueUser user = i.next();
int position = user.getQueuePosition();
int timeRemaining = user.getEstimatedRemainingTime();
Date timestamp = user.getQueueJoinTimestamp();
buf.append("");
if (position != -1) {
buf.append("").append(position).append(" ");
}
if (timeRemaining != -1) {
buf.append("");
}
if (timestamp != null) {
buf.append("");
buf.append(dateFormat.format(timestamp));
buf.append(" ");
}
buf.append(" ");
}
}
buf.append("');
return buf.toString();
}
/**
* Provider class for QueueDetails stanza extensions.
*/
public static class Provider extends ExtensionElementProvider {
@SuppressWarnings("JavaUtilDate")
@Override
public QueueDetails parse(XmlPullParser parser,
int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException,
IOException, TextParseException, ParseException {
SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT);
QueueDetails queueDetails = new QueueDetails();
XmlPullParser.Event eventType = parser.getEventType();
while (eventType != XmlPullParser.Event.END_ELEMENT &&
"notify-queue-details".equals(parser.getName())) {
eventType = parser.next();
while ((eventType == XmlPullParser.Event.START_ELEMENT) && "user".equals(parser.getName())) {
String uid;
int position = -1;
int time = -1;
Date joinTime = null;
uid = parser.getAttributeValue("", "jid");
if (uid == null) {
// throw exception
}
eventType = parser.next();
while (eventType != XmlPullParser.Event.END_ELEMENT
|| !"user".equals(parser.getName())) {
if ("position".equals(parser.getName())) {
position = Integer.parseInt(parser.nextText());
}
else if ("time".equals(parser.getName())) {
time = Integer.parseInt(parser.nextText());
}
else if ("join-time".equals(parser.getName())) {
joinTime = dateFormat.parse(parser.nextText());
}
else if (parser.getName().equals("waitTime")) {
Date wait = dateFormat.parse(parser.nextText());
LOGGER.fine(wait.toString());
}
eventType = parser.next();
if (eventType != XmlPullParser.Event.END_ELEMENT) {
// throw exception
}
}
queueDetails.addUser(new QueueUser(uid, position, time, joinTime));
eventType = parser.next();
}
}
return queueDetails;
}
}
}