1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-26 22:12:05 +01:00

First round of refactoring.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2371 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2004-08-17 07:44:36 +00:00 committed by mtucker
parent cf47ba95af
commit 280c4b5a76
23 changed files with 2102 additions and 371 deletions

View file

@ -1,9 +1,63 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
import org.jivesoftware.smack.packet.Presence; import org.jivesoftware.smack.packet.Presence;
/** /**
* An Agent represents the agent role in a Workgroup Queue. * An agent represents the agent role in a workgroup queue.
*
* @author Matt Tucker
*/ */
public class Agent { public class Agent {
@ -13,11 +67,12 @@ public class Agent {
private Presence presence = null; private Presence presence = null;
/** /**
* Creates an Agent * Creates an Agent.
* @param user - the current agents JID *
* @param currentChats - the number of chats the agent is in. * @param user the agent's JID.
* @param maxChats - the maximum number of chats the agent is allowed. * @param currentChats the number of chats the agent is currently in.
* @param presence - the agents presence * @param maxChats the maximum number of chats the agent is allowed in.
* @param presence the agent's presence.
*/ */
public Agent(String user, int currentChats, int maxChats, Presence presence) { public Agent(String user, int currentChats, int maxChats, Presence presence) {
this.user = user; this.user = user;
@ -27,32 +82,36 @@ public class Agent {
} }
/** /**
* Return the agents JID * Return this agent's JID.
* @return - the agents JID. *
* @return this agent's JID.
*/ */
public String getUser() { public String getUser() {
return user; return user;
} }
/** /**
* Return the maximum number of chats for this agent. * Return the maximum number of chats this agent can participate in.
* @return - maximum number of chats allowed. *
* @return the maximum number of chats this agent can participate in.
*/ */
public int getMaxChats() { public int getMaxChats() {
return maxChats; return maxChats;
} }
/** /**
* Return the current chat count. * Return the number of chats this agent is currently in.
* @return - the current chat count. *
* @return the number of chats this agent is currently in.
*/ */
public int getCurrentChats() { public int getCurrentChats() {
return currentChats; return currentChats;
} }
/** /**
* Return the agents <code>Presence</code> * Return this agent's presence.
* @return - the agents presence. *
* @return this agent's presence.
*/ */
public Presence getPresence() { public Presence getPresence() {
return presence; return presence;

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
@ -19,16 +60,16 @@ import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Packet; import org.jivesoftware.smack.packet.Packet;
/** /**
* A class embodying the semantic agent chat offer; specific instances allow the acceptance or * A class embodying the semantic agent chat offer; specific instances allow
* rejecting of the offer.<br> * the acceptance or rejecting of the offer.<br>
* *
* @author Matt Tucker * @author Matt Tucker
* @author loki der quaeler
* @author Derek DeMoro * @author Derek DeMoro
*/ */
public class Offer { public class Offer {
private XMPPConnection connection; private XMPPConnection connection;
private AgentSession session; private WorkgroupSession session;
private String sessionID; private String sessionID;
private String userID; private String userID;
@ -40,18 +81,19 @@ public class Offer {
* Creates a new offer. * Creates a new offer.
* *
* @param conn the XMPP connection with which the issuing session was created. * @param conn the XMPP connection with which the issuing session was created.
* @param agentSession the agent session instance through which this offer was issued. * @param workgroupSession the agent session instance through which this offer was issued.
* @param userID the XMPP address of the user from which the offer originates. * @param userID the XMPP address of the user from which the offer originates.
* @param workgroupName the fully qualified name of the workgroup. * @param workgroupName the fully qualified name of the workgroup.
* @param expiresDate the date at which this offer expires. * @param expiresDate the date at which this offer expires.
* @param sessionID the session id associated with the offer. * @param sessionID the session id associated with the offer.
* @param metaData the metadata associated with the offer. * @param metaData the metadata associated with the offer.
*/ */
public Offer( XMPPConnection conn, AgentSession agentSession, String userID, public Offer(XMPPConnection conn, WorkgroupSession workgroupSession, String userID,
String workgroupName, Date expiresDate, String workgroupName, Date expiresDate,
String sessionID, Map metaData ) { String sessionID, Map metaData)
{
this.connection = conn; this.connection = conn;
this.session = agentSession; this.session = workgroupSession;
this.userID = userID; this.userID = userID;
this.workgroupName = workgroupName; this.workgroupName = workgroupName;
this.expiresDate = expiresDate; this.expiresDate = expiresDate;
@ -90,16 +132,17 @@ public class Offer {
} }
/** /**
* The fully qualified name of the workgroup (eg support@example.com). * The fully qualified name of the workgroup (eg support@example.com)
* that this offer is from.
* *
* @return the name of the workgroup. * @return the name of the workgroup this offer is from.
*/ */
public String getWorkgroupName() { public String getWorkgroupName() {
return this.workgroupName; return this.workgroupName;
} }
/** /**
* The date when the offer will expire. The agent must {@link #accept()} * The date when this offer will expire. The agent must {@link #accept()}
* the offer before the expiration date or the offer will lapse and be * the offer before the expiration date or the offer will lapse and be
* routed to another agent. Alternatively, the agent can {@link #reject()} * routed to another agent. Alternatively, the agent can {@link #reject()}
* the offer at any time if they don't wish to accept it.. * the offer at any time if they don't wish to accept it..
@ -111,16 +154,16 @@ public class Offer {
} }
/** /**
* The session ID associated with the offer. * The session ID associated with this offer.
* *
* @return the session id associated with the offer. * @return the session ID associated with this offer.
*/ */
public String getSessionID() { public String getSessionID() {
return this.sessionID; return this.sessionID;
} }
/** /**
* The meta-data associated with the offer. * Returns the meta-data associated with this offer.
* *
* @return the offer meta-data. * @return the offer meta-data.
*/ */
@ -159,5 +202,4 @@ public class Offer {
"\" xmlns=\"xmpp:workgroup" + "\"/>"; "\" xmlns=\"xmpp:workgroup" + "\"/>";
} }
} }
} }

View file

@ -3,26 +3,67 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
/** /**
* An interface which all classes interested in hearing about chat offers associated to a particular * An interface which all classes interested in hearing about chat offers associated to a particular
* AgentSession instance should implement.<br> * WorkgroupSession instance should implement.<br>
* *
* @author Matt Tucker * @author Matt Tucker
* @author loki der quaeler * @author loki der quaeler
* @see org.jivesoftware.smackx.workgroup.agent.AgentSession * @see org.jivesoftware.smackx.workgroup.agent.WorkgroupSession
*/ */
public interface OfferListener { public interface OfferListener {
/** /**
* The implementing class instance will be notified via this when the AgentSession has received * The implementing class instance will be notified via this when the WorkgroupSession has received
* an offer for a chat. The instance will then have the ability to accept, reject, or ignore * an offer for a chat. The instance will then have the ability to accept, reject, or ignore
* the request (resulting in a revocation-by-timeout). * the request (resulting in a revocation-by-timeout).
* *

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
import java.util.Set; import java.util.Set;

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
import java.util.Date; import java.util.Date;

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.agent; package org.jivesoftware.smackx.workgroup.agent;
@ -174,11 +215,12 @@ public class WorkgroupQueue {
* A class to represent the status of the workgroup. The possible values are: * A class to represent the status of the workgroup. The possible values are:
* *
* <ul> * <ul>
* <li>WorkgroupQueue.Status.OPEN -- the queue is active and accepting new chat requests. * <li>WorkgroupQueue.Status.OPEN -- the queue is active and accepting
* <li>WorkgroupQueue.Status.ACTIVE -- the queue is active but NOT accepting new chat * new chat requests.
* requests. * <li>WorkgroupQueue.Status.ACTIVE -- the queue is active but NOT accepting
* <li>WorkgroupQueue.Status.CLOSED -- the queue is NOT active and NOT accepting new * new chat requests.
* chat requests. * <li>WorkgroupQueue.Status.CLOSED -- the queue is NOT active and NOT
* accepting new chat requests.
* </ul> * </ul>
*/ */
public static class Status { public static class Status {

View file

@ -0,0 +1,683 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.agent;
import java.util.*;
import org.jivesoftware.smack.*;
import org.jivesoftware.smack.filter.*;
import org.jivesoftware.smack.packet.*;
import org.jivesoftware.smack.util.StringUtils;
import org.jivesoftware.smackx.GroupChatInvitation;
import org.jivesoftware.smackx.workgroup.*;
import org.jivesoftware.smackx.workgroup.packet.*;
/**
* This class embodies the agent's active presence within a given workgroup.
* The application should have N instances of this class, where N is the
* number of workgroups to which the owning agent of the application belongs.
* This class provides all functionality that a session within a given workgroup
* is expected to have from an agent's perspective -- setting the status, tracking
* the status of queues to which the agent belongs within the workgroup, and
* dequeuing customers.
*
* @author Matt Tucker
*/
public class WorkgroupSession {
private XMPPConnection connection;
private String workgroupName;
private boolean online = false;
private Presence.Mode presenceMode;
private int currentChats;
private int maxChats;
private Map metaData;
private Map queues;
private List offerListeners;
private List queueUsersListeners;
private List queueAgentsListeners;
/**
* Creates a new agent session instance.
*
* @param connection a connection instance which must have already gone through authentication.
* @param workgroupName the fully qualified name of the workgroup.
*/
public WorkgroupSession(String workgroupName, XMPPConnection connection) {
// Login must have been done before passing in connection.
if (!connection.isAuthenticated()) {
throw new IllegalStateException("Must login to server before creating workgroup.");
}
this.workgroupName = workgroupName;
this.connection = connection;
this.maxChats = -1;
this.metaData = new HashMap();
this.queues = new HashMap();
offerListeners = new ArrayList();
queueUsersListeners = new ArrayList();
queueAgentsListeners = new ArrayList();
// Create a filter to listen for packets we're interested in.
OrFilter filter = new OrFilter();
filter.addFilter(new PacketTypeFilter(OfferRequestProvider.OfferRequestPacket.class));
filter.addFilter(new PacketTypeFilter(OfferRevokeProvider.OfferRevokePacket.class));
filter.addFilter(new PacketTypeFilter(Presence.class));
filter.addFilter(new PacketTypeFilter(Message.class));
// only interested in packets from the workgroup or from operators also running the
// operator client -- for example peer-to-peer invites wouldn't come from
// the workgroup, but would come from the operator client
//OrFilter froms = new OrFilter(new FromContainsFilter(this.workgroupName),
// new FromContainsFilter(clientResource));
connection.addPacketListener(new PacketListener() {
public void processPacket(Packet packet) {
handlePacket(packet);
}
}, filter);
}
/**
* Returns the agent's current presence mode.
*
* @return the agent's current presence mode.
*/
public Presence.Mode getPresenceMode() {
return presenceMode;
}
/**
* Returns the current number of chats the agent is in.
*
* @return the current number of chats the agent is in.
*/
public int getCurrentChats() {
return currentChats;
}
/**
* Returns the maximum number of chats the agent can participate in.
*
* @return the maximum number of chats the agent can participate in.
*/
public int getMaxChats() {
return maxChats;
}
/**
* Returns true if the agent is online with the workgroup.
*
* @return true if the agent is online with the workgroup.
*/
public boolean isOnline() {
return online;
}
/**
* Allows the addition of a new key-value pair to the agent's meta data, if the value is
* new data, the revised meta data will be rebroadcast in an agent's presence broadcast.
*
* @param key the meta data key
* @param val the non-null meta data value
*/
public void setMetaData(String key, String val) throws XMPPException {
synchronized (this.metaData) {
String oldVal = (String)this.metaData.get(key);
if ((oldVal == null) || (! oldVal.equals(val))) {
metaData.put(key, val);
setStatus(presenceMode, currentChats, maxChats);
}
}
}
/**
* Allows the removal of data from the agent's meta data, if the key represents existing data,
* the revised meta data will be rebroadcast in an agent's presence broadcast.
*
* @param key the meta data key
*/
public void removeMetaData(String key)
throws XMPPException {
synchronized (this.metaData) {
String oldVal = (String)metaData.remove(key);
if (oldVal != null) {
setStatus(presenceMode, currentChats, maxChats);
}
}
}
/**
* Allows the retrieval of meta data for a specified key.
*
* @param key the meta data key
* @return the meta data value associated with the key or <tt>null</tt> if the meta-data
* doesn't exist..
*/
public String getMetaData(String key) {
return (String)metaData.get(key);
}
/**
* Sets whether the agent is online with the workgroup. If the user tries to go online with
* the workgroup but is not allowed to be an agent, an XMPPError with error code 401 will
* be thrown.
*
* @param online true to set the agent as online with the workgroup.
* @throws XMPPException if an error occurs setting the online status.
*/
public void setOnline( boolean online ) throws XMPPException {
// If the online status hasn't changed, do nothing.
if (this.online == online) {
return;
}
this.online = online;
Presence presence = null;
// If the user is going online...
if (online) {
presence = new Presence(Presence.Type.AVAILABLE);
presence.setTo(workgroupName);
PacketCollector collector = this.connection.createPacketCollector(new AndFilter(
new PacketTypeFilter(Presence.class), new FromContainsFilter(workgroupName)));
connection.sendPacket(presence);
presence = (Presence)collector.nextResult(5000);
collector.cancel();
if (presence == null) {
throw new XMPPException("No response from server on status set.");
}
if (presence.getError() != null) {
throw new XMPPException(presence.getError());
}
}
// Otherwise the user is going offline...
else {
presence = new Presence(Presence.Type.UNAVAILABLE);
presence.setTo(workgroupName);
connection.sendPacket(presence);
}
}
/**
* Sets the agent's current status with the workgroup. The presence mode affects how offers
* are routed to the agent. The possible presence modes with their meanings are as follows:<ul>
*
* <li>Presence.Mode.AVAILABLE -- (Default) the agent is available for more chats
* (equivalent to Presence.Mode.CHAT).
* <li>Presence.Mode.DO_NOT_DISTURB - the agent is busy and should not be disturbed.
* However, special case, or extreme urgency chats may still be offered to the agent.
* <li>Presence.Mode.AWAY -- the agent is not available and should not
* have a chat routed to them (equivalent to Presence.Mode.EXTENDED_AWAY).</ul>
*
* The current chats value indicates how many chats the agent is currently in. Because the agent
* is responsible for reporting the current chats value to the server, this value <b>must</b>
* be set every time it changes.<p>
*
* The max chats value is the maximum number of chats the agent is willing to have routed to
* them at once. Some servers may be configured to only accept max chat values in a certain
* range; for example, between two and five. In that case, the maxChats value the agent sends
* may be adjusted by the server to a value within that range.
*
* @param presenceMode the presence mode of the agent.
* @param currentChats the current number of chats the agent is in.
* @param maxChats the maximum number of chats the agent is willing to accept.
* @throws XMPPException if an error occurs setting the agent status.
* @throws IllegalStateException if the agent is not online with the workgroup.
*/
public void setStatus(Presence.Mode presenceMode, int currentChats, int maxChats )
throws XMPPException
{
setStatus( presenceMode, currentChats, maxChats, null );
}
/**
* Sets the agent's current status with the workgroup. The presence mode affects how offers
* are routed to the agent. The possible presence modes with their meanings are as follows:<ul>
*
* <li>Presence.Mode.AVAILABLE -- (Default) the agent is available for more chats
* (equivalent to Presence.Mode.CHAT).
* <li>Presence.Mode.DO_NOT_DISTURB - the agent is busy and should not be disturbed.
* However, special case, or extreme urgency chats may still be offered to the agent.
* <li>Presence.Mode.AWAY -- the agent is not available and should not
* have a chat routed to them (equivalent to Presence.Mode.EXTENDED_AWAY).</ul>
*
* The current chats value indicates how many chats the agent is currently in. Because the agent
* is responsible for reporting the current chats value to the server, this value <b>must</b>
* be set every time it changes.<p>
*
* The max chats value is the maximum number of chats the agent is willing to have routed to
* them at once. Some servers may be configured to only accept max chat values in a certain
* range; for example, between two and five. In that case, the maxChats value the agent sends
* may be adjusted by the server to a value within that range.
*
* @param presenceMode the presence mode of the agent.
* @param currentChats the current number of chats the agent is in.
* @param maxChats the maximum number of chats the agent is willing to accept.
* @param status sets the status message of the presence update.
* @throws XMPPException if an error occurs setting the agent status.
* @throws IllegalStateException if the agent is not online with the workgroup.
*/
public void setStatus(Presence.Mode presenceMode, int currentChats, int maxChats, String status )
throws XMPPException
{
if (!online) {
throw new IllegalStateException("Cannot set status when the agent is not online.");
}
if (presenceMode == null) {
presenceMode = Presence.Mode.AVAILABLE;
}
this.presenceMode = presenceMode;
this.currentChats = currentChats;
this.maxChats = maxChats;
Presence presence = new Presence(Presence.Type.AVAILABLE);
presence.setMode(presenceMode);
presence.setTo(this.getWorkgroupName());
if( status != null ) {
presence.setStatus( status );
}
// Send information about max chats and current chats as a packet extension.
DefaultPacketExtension agentStatus = new DefaultPacketExtension(AgentStatus.ELEMENT_NAME,
AgentStatus.NAMESPACE);
agentStatus.setValue("current-chats", ""+currentChats);
agentStatus.setValue("max-chats", ""+maxChats);
presence.addExtension(agentStatus);
presence.addExtension(new MetaData(this.metaData));
PacketCollector collector = this.connection.createPacketCollector(new AndFilter(
new PacketTypeFilter(Presence.class), new FromContainsFilter(workgroupName)));
this.connection.sendPacket(presence);
presence = (Presence)collector.nextResult(5000);
collector.cancel();
if (presence == null) {
throw new XMPPException("No response from server on status set.");
}
if (presence.getError() != null) {
throw new XMPPException(presence.getError());
}
}
/**
* Removes a user from the workgroup queue. This is an administrative action that the
*
* The agent is not guaranteed of having privileges to perform this action; an exception
* denying the request may be thrown.
*/
public void dequeueUser(String userID) throws XMPPException {
// todo: this method simply won't work right now.
DepartQueuePacket departPacket = new DepartQueuePacket(this.workgroupName);
// PENDING
this.connection.sendPacket(departPacket);
}
/**
* @return the fully-qualified name of the workgroup for which this session exists
*/
public String getWorkgroupName() {
return workgroupName;
}
/**
* @param queueName the name of the queue
* @return an instance of WorkgroupQueue for the argument queue name, or null if none exists
*/
public WorkgroupQueue getQueue(String queueName) {
return (WorkgroupQueue)queues.get(queueName);
}
public Iterator getQueues() {
return Collections.unmodifiableMap((new HashMap(queues))).values().iterator();
}
public void addQueueUsersListener(QueueUsersListener listener) {
synchronized(queueUsersListeners) {
if (!queueUsersListeners.contains(listener)) {
queueUsersListeners.add(listener);
}
}
}
public void removeQueueUsersListener(QueueUsersListener listener) {
synchronized(queueUsersListeners) {
queueUsersListeners.remove(listener);
}
}
public void addQueueAgentsListener(QueueAgentsListener listener) {
synchronized(queueAgentsListeners) {
if (!queueAgentsListeners.contains(listener)) {
queueAgentsListeners.add(listener);
}
}
}
public void removeQueueAgentsListener(QueueAgentsListener listener) {
synchronized(queueAgentsListeners) {
queueAgentsListeners.remove(listener);
}
}
/**
* Adds an offer listener.
*
* @param offerListener the offer listener.
*/
public void addOfferListener(OfferListener offerListener) {
synchronized(offerListeners) {
if (!offerListeners.contains(offerListener)) {
offerListeners.add(offerListener);
}
}
}
/**
* Removes an offer listener.
*
* @param offerListener the offer listener.
*/
public void removeOfferListener(OfferListener offerListener) {
synchronized(offerListeners) {
offerListeners.remove(offerListener);
}
}
/**
* Adds an invitation listener.
*
* @param invitationListener the invitation listener.
*/
public void addInvitationListener(InvitationListener invitationListener) {
synchronized(invitationListeners) {
if (!invitationListeners.contains(invitationListener)) {
invitationListeners.add(invitationListener);
}
}
}
/**
* Removes an invitation listener.
*
* @param invitationListener the invitation listener.
*/
public void removeInvitationListener(InvitationListener invitationListener) {
synchronized(invitationListeners) {
offerListeners.remove(invitationListener);
}
}
private void fireOfferRequestEvent(OfferRequestProvider.OfferRequestPacket requestPacket) {
Offer offer = new Offer(this.connection, this, requestPacket.getUserID(),
this.getWorkgroupName(),
new Date((new Date()).getTime()
+ (requestPacket.getTimeout() * 1000)),
requestPacket.getSessionID(), requestPacket.getMetaData());
synchronized (offerListeners) {
for (Iterator i=offerListeners.iterator(); i.hasNext(); ) {
OfferListener listener = (OfferListener)i.next();
listener.offerReceived(offer);
}
}
}
private void fireOfferRevokeEvent(OfferRevokeProvider.OfferRevokePacket orp) {
RevokedOffer revokedOffer = new RevokedOffer(orp.getUserID(), this.getWorkgroupName(),
orp.getSessionID(), orp.getReason(),
new Date());
synchronized (offerListeners) {
for (Iterator i=offerListeners.iterator(); i.hasNext(); ) {
OfferListener listener = (OfferListener)i.next();
listener.offerRevoked(revokedOffer);
}
}
}
private void fireInvitationEvent(String groupChatJID, String sessionID, String body,
String from, Map metaData)
{
Invitation invitation = new Invitation(connection.getUser(), groupChatJID,
workgroupName, sessionID, body, from, metaData);
synchronized(invitationListeners) {
for (Iterator i=invitationListeners.iterator(); i.hasNext(); ) {
InvitationListener listener = (InvitationListener)i.next();
listener.invitationReceived(invitation);
}
}
}
private void fireQueueUsersEvent(WorkgroupQueue queue, WorkgroupQueue.Status status,
int averageWaitTime, Date oldestEntry, Set users)
{
synchronized(queueUsersListeners) {
for (Iterator i=queueUsersListeners.iterator(); i.hasNext(); ) {
QueueUsersListener listener = (QueueUsersListener)i.next();
if (status != null) {
listener.statusUpdated(queue, status);
}
if (averageWaitTime != -1) {
listener.averageWaitTimeUpdated(queue, averageWaitTime);
}
if (oldestEntry != null) {
listener.oldestEntryUpdated(queue, oldestEntry);
}
if (users != null) {
listener.usersUpdated(queue, users);
}
}
}
}
private void fireQueueAgentsEvent(WorkgroupQueue queue, int currentChats,
int maxChats, Set agents)
{
synchronized(queueAgentsListeners) {
for (Iterator i=queueAgentsListeners.iterator(); i.hasNext(); ) {
QueueAgentsListener listener = (QueueAgentsListener)i.next();
if (currentChats != -1) {
listener.currentChatsUpdated(queue, currentChats);
}
if (maxChats != -1) {
listener.maxChatsUpdated(queue, maxChats);
}
if (agents != null) {
listener.agentsUpdated(queue, agents);
}
}
}
}
// PacketListener Implementation.
private void handlePacket(Packet packet) {
if (packet instanceof OfferRequestProvider.OfferRequestPacket) {
fireOfferRequestEvent((OfferRequestProvider.OfferRequestPacket)packet);
}
else if (packet instanceof Presence) {
Presence presence = (Presence)packet;
// The workgroup can send us a number of different presence packets. We
// check for different packet extensions to see what type of presence
// packet it is.
String queueName = StringUtils.parseResource(presence.getFrom());
WorkgroupQueue queue = (WorkgroupQueue)queues.get(queueName);
// If there isn't already an entry for the queue, create a new one.
if (queue == null) {
queue = new WorkgroupQueue(queueName);
queues.put(queueName, queue);
}
// QueueOverview packet extensions contain basic information about a queue.
QueueOverview queueOverview = (QueueOverview)presence.getExtension(
QueueOverview.ELEMENT_NAME, QueueOverview.NAMESPACE);
if (queueOverview != null) {
if (queueOverview.getStatus() == null) {
queue.setStatus(WorkgroupQueue.Status.CLOSED);
}
else {
queue.setStatus(queueOverview.getStatus());
}
queue.setAverageWaitTime(queueOverview.getAverageWaitTime());
queue.setOldestEntry(queueOverview.getOldestEntry());
// Fire event.
fireQueueUsersEvent(queue, queueOverview.getStatus(),
queueOverview.getAverageWaitTime(), queueOverview.getOldestEntry(),
null);
return;
}
// QueueDetails packet extensions contain information about the users in
// a queue.
QueueDetails queueDetails = (QueueDetails)packet.getExtension(
QueueDetails.ELEMENT_NAME, QueueDetails.NAMESPACE);
if (queueDetails != null) {
queue.setUsers(queueDetails.getUsers());
// Fire event.
fireQueueUsersEvent(queue, null, -1, null, queueDetails.getUsers());
return;
}
// Notify agent packets gives an overview of agent activity in a queue.
DefaultPacketExtension notifyAgents = (DefaultPacketExtension)presence.getExtension(
"notify-agents", "xmpp:workgroup");
if (notifyAgents != null) {
int currentChats = Integer.parseInt(notifyAgents.getValue("current-chats"));
int maxChats = Integer.parseInt(notifyAgents.getValue("max-chats"));
queue.setCurrentChats(currentChats);
queue.setMaxChats(maxChats);
// Fire event.
fireQueueAgentsEvent(queue, currentChats, maxChats, null);
return;
}
// Agent status
AgentStatus agentStatus = (AgentStatus)presence.getExtension(AgentStatus.ELEMENT_NAME,
AgentStatus.NAMESPACE);
if (agentStatus != null) {
Set agents = agentStatus.getAgents();
// Look for information about the agent that created this session and
// update local status fields accordingly.
for (Iterator i=agents.iterator(); i.hasNext(); ) {
Agent agent = (Agent)i.next();
if (agent.getUser().equals(StringUtils.parseBareAddress(
connection.getUser())))
{
maxChats = agent.getMaxChats();
currentChats = agent.getCurrentChats();
}
}
// Set the list of agents for the queue.
queue.setAgents(agents);
// Fire event.
fireQueueAgentsEvent(queue, -1, -1, agentStatus.getAgents());
return;
}
}
else if (packet instanceof Message) {
Message message = (Message)packet;
GroupChatInvitation invitation = (GroupChatInvitation)message.getExtension(
GroupChatInvitation.ELEMENT_NAME, GroupChatInvitation.NAMESPACE);
if (invitation != null) {
String roomAddress = invitation.getRoomAddress();
String sessionID = null;
Map metaData = null;
SessionID sessionIDExt = (SessionID)message.getExtension(SessionID.ELEMENT_NAME,
SessionID.NAMESPACE);
if (sessionIDExt != null) {
sessionID = sessionIDExt.getSessionID();
}
MetaData metaDataExt = (MetaData)message.getExtension(MetaData.ELEMENT_NAME,
MetaData.NAMESPACE);
if (metaDataExt != null) {
metaData = metaDataExt.getMetaData();
}
this.fireInvitationEvent(roomAddress, sessionID, message.getBody(),
message.getFrom(), metaData);
}
}
else if (packet instanceof OfferRevokeProvider.OfferRevokePacket) {
fireOfferRevokeEvent((OfferRevokeProvider.OfferRevokePacket)packet);
}
}
}

View file

@ -3,11 +3,53 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import java.util.*; import java.util.*;
@ -19,7 +61,6 @@ import org.jivesoftware.smack.provider.ProviderManager;
import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParser;
import org.jivesoftware.smackx.workgroup.agent.Agent; import org.jivesoftware.smackx.workgroup.agent.Agent;
/** /**
* An immutable container around the basic data known about a given agent, as well as a * An immutable container around the basic data known about a given agent, as well as a
* PacketExtension implementor which knows how to write the agent-status packet extension. * PacketExtension implementor which knows how to write the agent-status packet extension.

View file

@ -3,12 +3,52 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.*; import org.jivesoftware.smack.packet.*;

View file

@ -0,0 +1,59 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 1999-2003 Jive Software. All rights reserved.
*
* This software is the proprietary information of Jive Software.
* Use is subject to license terms.
*/
package org.jivesoftware.smackx.workgroup.packet;
import java.util.Map;
import org.jivesoftware.smackx.workgroup.util.MetaDataUtils;
import org.jivesoftware.smack.packet.PacketExtension;
/**
* MetaData packet extension.
*/
public class MetaData implements PacketExtension {
/**
* Element name of the packet extension.
*/
public static final String ELEMENT_NAME = "metadata";
/**
* Namespace of the packet extension.
*/
public static final String NAMESPACE = "http://www.jivesoftware.com/workgroup/metadata";
private Map metaData;
public MetaData(Map metaData) {
this.metaData = metaData;
}
/**
* @return the Map of metadata contained by this instance
*/
public Map getMetaData() {
return metaData;
}
public String getElementName() {
return ELEMENT_NAME;
}
public String getNamespace() {
return NAMESPACE;
}
public String toXML() {
return MetaDataUtils.encodeMetaData(this.getMetaData());
}
}

View file

@ -3,17 +3,57 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import java.util.Map; import java.util.Map;
import org.jivesoftware.smackx.workgroup.MetaData;
import org.jivesoftware.smackx.workgroup.util.MetaDataUtils; import org.jivesoftware.smackx.workgroup.util.MetaDataUtils;
import org.jivesoftware.smack.packet.PacketExtension; import org.jivesoftware.smack.packet.PacketExtension;
@ -21,7 +61,6 @@ import org.jivesoftware.smack.provider.PacketExtensionProvider;
import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParser;
/** /**
* This provider parses meta data if it's not contained already in a larger extension provider. * This provider parses meta data if it's not contained already in a larger extension provider.
* *

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
@ -143,7 +184,7 @@ public class OfferRequestProvider implements IQProvider {
} }
if (metaData != null) { if (metaData != null) {
buf.append(MetaDataUtils.serializeMetaData(metaData)); buf.append(MetaDataUtils.encodeMetaData(metaData));
} }
buf.append("</offer>"); buf.append("</offer>");

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.PacketExtension; import org.jivesoftware.smack.packet.PacketExtension;
@ -7,8 +59,6 @@ import org.xmlpull.v1.XmlPullParser;
import java.util.*; import java.util.*;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import org.jivesoftware.smackx.workgroup.QueueUser;
/** /**
* Queue details packet extension, which contains details about the users * Queue details packet extension, which contains details about the users
* currently in a queue. * currently in a queue.

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.PacketExtension; import org.jivesoftware.smack.packet.PacketExtension;

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.IQ; import org.jivesoftware.smack.packet.IQ;

View file

@ -0,0 +1,118 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet;
import java.util.Date;
/**
* An immutable class which wraps up customer-in-queue data return from the server; depending on
* the type of information dispatched from the server, not all information will be available in
* any given instance.
*
* @author loki der quaeler
*/
public class QueueUser {
private String userID;
private int queuePosition;
private int estimatedTime;
private Date joinDate;
/**
* @param uid the user jid of the customer in the queue
* @param position the position customer sits in the queue
* @param time the estimate of how much longer the customer will be in the queue in seconds
* @param joinedAt the timestamp of when the customer entered the queue
*/
public QueueUser (String uid, int position, int time, Date joinedAt) {
super();
this.userID = uid;
this.queuePosition = position;
this.estimatedTime = time;
this.joinDate = joinedAt;
}
/**
* @return the user jid of the customer in the queue
*/
public String getUserID () {
return this.userID;
}
/**
* @return the position in the queue at which the customer sits, or -1 if the update which
* this instance embodies is only a time update instead
*/
public int getQueuePosition () {
return this.queuePosition;
}
/**
* @return the estimated time remaining of the customer in the queue in seconds, or -1 if
* if the update which this instance embodies is only a position update instead
*/
public int getEstimatedRemainingTime () {
return this.estimatedTime;
}
/**
* @return the timestamp of when this customer entered the queue, or null if the server did not
* provide this information
*/
public Date getQueueJoinTimestamp () {
return this.joinDate;
}
}

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.PacketExtension; import org.jivesoftware.smack.packet.PacketExtension;

View file

@ -1,3 +1,55 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/
package org.jivesoftware.smackx.workgroup.packet; package org.jivesoftware.smackx.workgroup.packet;
import org.jivesoftware.smack.packet.PacketExtension; import org.jivesoftware.smack.packet.PacketExtension;

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.user; package org.jivesoftware.smackx.workgroup.user;

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.user; package org.jivesoftware.smackx.workgroup.user;
@ -18,12 +59,11 @@ import org.jivesoftware.smack.filter.*;
import org.jivesoftware.smack.packet.*; import org.jivesoftware.smack.packet.*;
import org.jivesoftware.smackx.GroupChatInvitation; import org.jivesoftware.smackx.GroupChatInvitation;
import org.jivesoftware.smackx.workgroup.*;
import org.jivesoftware.smackx.workgroup.packet.*; import org.jivesoftware.smackx.workgroup.packet.*;
import org.jivesoftware.smackx.workgroup.util.MetaDataUtils; import org.jivesoftware.smackx.workgroup.util.MetaDataUtils;
/** /**
* Provides workgroup services for users. Users can join the workgropu queue, depart the * Provides workgroup services for users. Users can join the workgroup queue, depart the
* queue, find status information about their placement in the queue, and register to * queue, find status information about their placement in the queue, and register to
* be notified when they are routed to an agent.<p> * be notified when they are routed to an agent.<p>
* *
@ -31,19 +71,19 @@ import org.jivesoftware.smackx.workgroup.util.MetaDataUtils;
* for use by agents. * for use by agents.
* *
* @author Matt Tucker * @author Matt Tucker
* @author loki der quaeler
*/ */
public class Workgroup { public class Workgroup {
private String workgroupName; private String workgroupName;
private XMPPConnection connection; private XMPPConnection connection;
private boolean inQueue; private boolean inQueue;
private List invitationListeners;
private List queueListeners; private List queueListeners;
private int queuePosition = -1; private int queuePosition = -1;
private int queueRemainingTime = -1; private int queueRemainingTime = -1;
private PacketListener packetListener;
/** /**
* Creates a new workgroup instance using the specified workgroup name * Creates a new workgroup instance using the specified workgroup name
* (eg support@example.com) and XMPP connection. The connection must have * (eg support@example.com) and XMPP connection. The connection must have
@ -63,7 +103,6 @@ public class Workgroup {
this.workgroupName = workgroupName; this.workgroupName = workgroupName;
this.connection = connection; this.connection = connection;
inQueue = false; inQueue = false;
invitationListeners = new ArrayList();
queueListeners = new ArrayList(); queueListeners = new ArrayList();
// Register as a queue listener for internal usage by this instance. // Register as a queue listener for internal usage by this instance.
@ -88,12 +127,17 @@ public class Workgroup {
}); });
// Register an invitation listener for internal usage by this instance. // Register an invitation listener for internal usage by this instance.
addInvitationListener(new InvitationListener() { addInvitationListener(new PacketListener() {
public void invitationReceived(Invitation invitation) {
public void processPacket(Packet packet) {
GroupChatInvitation invitation = (GroupChatInvitation)packet.getExtension(
GroupChatInvitation.ELEMENT_NAME, GroupChatInvitation.NAMESPACE);
if (invitation != null) {
inQueue = false; inQueue = false;
queuePosition = -1; queuePosition = -1;
queueRemainingTime = -1; queueRemainingTime = -1;
} }
}
}); });
// Register a packet listener for all queue events. // Register a packet listener for all queue events.
@ -102,11 +146,13 @@ public class Workgroup {
PacketFilter filter = new AndFilter(new FromContainsFilter(this.workgroupName), orFilter); PacketFilter filter = new AndFilter(new FromContainsFilter(this.workgroupName), orFilter);
connection.addPacketListener(new PacketListener() { packetListener = new PacketListener() {
public void processPacket(Packet packet) { public void processPacket(Packet packet) {
handlePacket(packet); handlePacket(packet);
} }
}, filter); };
connection.addPacketListener(packetListener, filter);
} }
/** /**
@ -306,34 +352,14 @@ public class Workgroup {
* Adds an invitation listener that will be notified of groupchat invitations * Adds an invitation listener that will be notified of groupchat invitations
* from the workgroup for the the user that created this Workgroup instance. * from the workgroup for the the user that created this Workgroup instance.
* *
* @param invitationListener the invitation listener. * @param packetListener the invitation listener.
*/ */
public void addInvitationListener(InvitationListener invitationListener) { public void addInvitationListener(PacketListener packetListener) {
synchronized(invitationListeners) { connection.addPacketListener(packetListener, null);
if (!invitationListeners.contains(invitationListener)) {
invitationListeners.add(invitationListener);
}
}
} }
/** protected void finalize() throws Throwable {
* Removes an invitation listener. connection.removePacketListener(packetListener);
*
* @param invitationListener the invitation listener.
*/
public void removeQueueListener(InvitationListener invitationListener) {
synchronized(invitationListeners) {
invitationListeners.remove(invitationListener);
}
}
private void fireInvitationEvent(Invitation invitation) {
synchronized (invitationListeners) {
for (Iterator i=invitationListeners.iterator(); i.hasNext(); ) {
InvitationListener listener = (InvitationListener)i.next();
listener.invitationReceived(invitation);
}
}
} }
private void fireQueueJoinedEvent() { private void fireQueueJoinedEvent() {
@ -383,35 +409,6 @@ public class Workgroup {
if (pe != null) { if (pe != null) {
fireQueueDepartedEvent(); fireQueueDepartedEvent();
} }
else {
// Check to see if the user has been invited to a chat.
GroupChatInvitation invitation = (GroupChatInvitation)msg.getExtension(
"x", "jabber:x:conference");
if (invitation != null) {
String roomAddress = invitation.getRoomAddress();
String sessionID = null;
Map metaData = null;
pe = msg.getExtension(SessionID.ELEMENT_NAME,
SessionID.NAMESPACE);
if (pe != null) {
sessionID = ((SessionID)pe).getSessionID();
}
pe = msg.getExtension(MetaData.ELEMENT_NAME,
MetaData.NAMESPACE);
if (pe != null) {
metaData = ((MetaData)pe).getMetaData();
}
Invitation inv = new Invitation(connection.getUser(), roomAddress,
workgroupName, sessionID, msg.getBody(),
msg.getFrom(), metaData);
fireInvitationEvent(inv);
}
}
} }
// Check to see if it's a queue update notification. // Check to see if it's a queue update notification.
else if (packet instanceof QueueUpdate) { else if (packet instanceof QueueUpdate) {
@ -446,7 +443,7 @@ public class Workgroup {
buf.append("<queue-notifications/>"); buf.append("<queue-notifications/>");
// Add any meta-data. // Add any meta-data.
buf.append(MetaDataUtils.serializeMetaData(metaData)); buf.append(MetaDataUtils.encodeMetaData(metaData));
buf.append("</join-queue>"); buf.append("</join-queue>");

View file

@ -3,10 +3,51 @@
* $Revision$ * $Revision$
* $Date$ * $Date$
* *
* Copyright (C) 1999-2003 Jive Software. All rights reserved. * Copyright (C) 2002-2004 Jive Software. All rights reserved.
* ====================================================================
* The Jive Software License (based on Apache Software License, Version 1.1)
* *
* This software is the proprietary information of Jive Software. * Redistribution and use in source and binary forms, with or without
* Use is subject to license terms. * modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by
* Jive Software (http://www.jivesoftware.com)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Smack" and "Jive Software" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact webmaster@jivesoftware.com.
*
* 5. Products derived from this software may not be called "Smack",
* nor may "Smack" appear in their name, without prior written
* permission of Jive Software.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/ */
package org.jivesoftware.smackx.workgroup.util; package org.jivesoftware.smackx.workgroup.util;
@ -20,7 +61,7 @@ import java.util.Hashtable;
import java.util.Collections; import java.util.Collections;
import java.io.IOException; import java.io.IOException;
import org.jivesoftware.smackx.workgroup.MetaData; import org.jivesoftware.smackx.workgroup.packet.MetaData;
/** /**
* Utility class for meta-data parsing and writing. * Utility class for meta-data parsing and writing.
@ -30,15 +71,18 @@ import org.jivesoftware.smackx.workgroup.MetaData;
public class MetaDataUtils { public class MetaDataUtils {
/** /**
* Parses any available meta-data and returns it as a Map of String name/value pairs. The * Parses any available meta-data and returns it as a Map of String name/value
* parser must be positioned at an opening meta-data tag, or the an empty map will be returned. * pairs. The parser must be positioned at an opening meta-data tag, or an
* empty map will be returned.
* *
* @param parser the XML parser positioned at an opening meta-data tag. * @param parser the XML parser positioned at an opening meta-data tag.
* @return the meta-data. * @return the meta-data.
* @throws XmlPullParserException if an error occurs while parsing the XML. * @throws XmlPullParserException if an error occurs while parsing the XML.
* @throws IOException if an error occurs while parsing the XML. * @throws IOException if an error occurs while parsing the XML.
*/ */
public static Map parseMetaData(XmlPullParser parser) throws XmlPullParserException, IOException { public static Map parseMetaData(XmlPullParser parser) throws XmlPullParserException,
IOException
{
int eventType = parser.getEventType(); int eventType = parser.getEventType();
// If correctly positioned on an opening meta-data tag, parse meta-data. // If correctly positioned on an opening meta-data tag, parse meta-data.
@ -67,12 +111,12 @@ public class MetaDataUtils {
} }
/** /**
* Serializes a Map of String name/value pairs into the meta-data XML format. * Encodes a Map of String name/value pairs into the meta-data XML format.
* *
* @param metaData the Map of meta-data. * @param metaData the Map of meta-data.
* @return the meta-data values in XML form. * @return the meta-data values in XML form.
*/ */
public static String serializeMetaData(Map metaData) { public static String encodeMetaData(Map metaData) {
StringBuffer buf = new StringBuffer(); StringBuffer buf = new StringBuffer();
if (metaData != null && metaData.size() > 0) { if (metaData != null && metaData.size() > 0) {
buf.append("<metadata xmlns=\"http://www.jivesoftware.com/workgroup/metadata\">"); buf.append("<metadata xmlns=\"http://www.jivesoftware.com/workgroup/metadata\">");