XEP-0296: Best Practices for Resource Locking

WARNING: This document has been automatically Deferred after 12 months of inactivity in its previous Experimental state. Implementation of the protocol described herein is not recommended for production systems. However, exploratory implementations are encouraged to resume the standards process.

1. Introduction
2. General Rules
    2.1. Initial Conversation State
    2.2. Locking a Conversation
    2.3. Unlocking a Conversation
    2.4. Interactions with Chat States
3. User Agent Implementation Notes
    3.1. User Experience Considerations
    3.2. Idle Conversations
    3.3. Overall Inactivity
4. Security Considerations
5. IANA Considerations
6. XMPP Registrar Considerations

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

The goal of this specification is to provide implementation guidance for XMPP clients to improve the user experience when maintaining a chat conversation between the user and a conversee. Section 5.1 of XMPP IM [1] defines the concept of a "one-to-one chat session" and recommends that clients support the behavior described there, including:

However, following only these guidelines can still lead to "disjointed" chat conversations in clients, epsecially if multiple resources are in play.

This specification reinforces the recommendations from XMPP-IM and provides additional implementation guidance to developers of XMPP clients.

2. General Rules

2.1 Initial Conversation State

A client MUST start conversations in the unlocked state. In this state, a client MUST send <message/>s to a conversee's bare JID.

2.2 Locking a Conversation

Once a client receives a chat <message/> from the conversee, whether or not this client initiated the conversation, it MUST lock the conversation. The client MUST remember the conversee's full JID and send further correspondence to this full JID until one of the unlocking conditions are met.

2.3 Unlocking a Conversation

A client MUST unlock a chat session from a resource when one of the following conditions is met:

A <message/> from the same bare JID, but a different resource, is received. In this case, the client SHOULD lock to the new resource; or the client MAY revert to the initial state, sending any following correspondence to the conversee's bare JID.
any <presence/> update from any resource for the conversee's bare JID, including <presence type='unavailable'/>. The client SHOULD revert to the initial state, sending any following correspondence to the conversee's bare JID.

2.4 Interactions with Chat States

If a client supports Chat State Notifications (XEP-0085) [2], then the following additional considerations apply:

If a client receives a <message/> with a <gone xmlns='http://jabber.org/protocol/chatstates'/> chat state, it SHOULD unlock the coversation.

3. User Agent Implementation Notes

This section is non-normative, but provides additional guidelines for clients that interact directly with users.

3.1 User Experience Considerations

To further improve the user experience, clients are strongly encouraged to implement Chat State Notifications and adhere to the recommendations from Best Practices for Message Threads (XEP-0201) [3].

3.2 Idle Conversations

A client MAY take into account the lack of activity of a conversation. Exactly how much inactivity constitutes an idle conversation is left to implementations to determine.

3.3 Overall Inactivity

A client MAY take into account the overall lack of activity of a user, in which case it is RECOMMENDED the client send a <presence/> update to trigger any conversations to unlock. The exact conditions and <presence/> information conveyed is left to implementations to determine.

4. Security Considerations

5. IANA Considerations

6. XMPP Registrar Considerations

Appendices

Appendix A: Document Information

Series: XEP
Number: 0296
Publisher: XMPP Standards Foundation
Status: Deferred
Type: Informational
Version: 0.2
Last Updated: 2011-08-18
Approving Body: XMPP Council
Dependencies: XMPP Core, XMPP IM, XEP-0085, XEP-0201
Supersedes: None
Superseded By: None
Short Name: NOT_YET_ASSIGNED
Source Control: HTML
This document in other formats: XML PDF

Appendix B: Author Information

Matthew Miller

Email: linuxwolf@outer-planes.net
JabberID: linuxwolf@outer-planes.net

Appendix C: Legal Notices

Copyright

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://tools.ietf.org/html/rfc6121>.

2. XEP-0085: Chat State Notifications <https://xmpp.org/extensions/xep-0085.html>.

3. XEP-0201: Best Practices for Message Threads <https://xmpp.org/extensions/xep-0201.html>.

4. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

5. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.

Appendix H: Revision History

Version 0.2 (2011-08-18)

Expanded intro with a short problem description; moved chat states considerations to their own section; tightened requirement regarding a message from different resource from MAY to SHOULD; loosened requirement regarding a message with 'gone' from MUST to SHOULD; added missing but required sections

(mam)

Version 0.1 (2011-04-11)

Initial published version.

(psa)

Version 0.0.1 (2011-03-14)

Initial draft

(mm)

Abstract:	This document specifies best practices to be followed by Jabber/XMPP clients about when to lock into, and unlock away from, resources.
Author:	Matthew Miller
Copyright:	© 1999 – 2017 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:	Deferred
Type:	Informational
Version:	0.2
Last Updated:	2011-08-18