Presence.java

  1. /**
  2.  *
  3.  * Copyright 2003-2007 Jive Software, 2020-2024 Florian Schmaus.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.jivesoftware.smack.packet;

  20. import java.util.List;
  21. import java.util.Locale;

  23. import org.jivesoftware.smack.XMPPConnection;
  24. import org.jivesoftware.smack.util.StringUtils;
  25. import org.jivesoftware.smack.util.XmlStringBuilder;

  27. /**
  28.  * Represents XMPP presence stanzas. Every presence stanza has a type, which is one of
  29.  * the following values:
  30.  * <ul>
  31.  *      <li>{@link Presence.Type#available available} -- (Default) indicates the user is available to
  32.  *          receive messages.
  33.  *      <li>{@link Presence.Type#unavailable unavailable} -- the user is unavailable to receive messages.
  34.  *      <li>{@link Presence.Type#subscribe subscribe} -- request subscription to recipient's presence.
  35.  *      <li>{@link Presence.Type#subscribed subscribed} -- grant subscription to sender's presence.
  36.  *      <li>{@link Presence.Type#unsubscribe unsubscribe} -- request removal of subscription to
  37.  *          sender's presence.
  38.  *      <li>{@link Presence.Type#unsubscribed unsubscribed} -- grant removal of subscription to
  39.  *          sender's presence.
  40.  *      <li>{@link Presence.Type#error error} -- the presence stanza contains an error message.
  41.  * </ul><p>
  42.  *
  43.  * A number of attributes are optional:
  44.  * <ul>
  45.  *      <li>Status -- free-form text describing a user's presence (i.e., gone to lunch).
  46.  *      <li>Priority -- non-negative numerical priority of a sender's resource. The
  47.  *          highest resource priority is the default recipient of packets not addressed
  48.  *          to a particular resource.
  49.  *      <li>Mode -- one of five presence modes: {@link Mode#available available} (the default),
  50.  *          {@link Mode#chat chat}, {@link Mode#away away}, {@link Mode#xa xa} (extended away), and
  51.  *          {@link Mode#dnd dnd} (do not disturb).
  52.  * </ul><p>
  53.  *
  54.  * Presence stanzas are used for two purposes. First, to notify the server of
  55.  * the user's current presence status. Second, they are used to subscribe and
  56.  * unsubscribe users from the roster.
  57.  *
  58.  * @author Matt Tucker
  59.  */
  60. public final class Presence extends MessageOrPresence<PresenceBuilder>
  61.                 implements PresenceView {

  63.     public static final String ELEMENT = "presence";

  65.     private Type type = Type.available;
  66.     private String status = null;

  68.     /**
  69.      * The priority of the presence. It is <code>null</code> to indicate that the original
  70.      * presence stanza did not had an explicit priority set. In which case the priority defaults to 0.
  71.      *
  72.      * @see <a href="https://tools.ietf.org/html/rfc6121#section-4.7.2.3">RFC 6121 § 4.7.2.3.</a>
  73.      */
  74.     private Byte priority;

  76.     private Mode mode = null;

  78.     Presence(PresenceBuilder presenceBuilder) {
  79.         super(presenceBuilder);
  80.         type = presenceBuilder.type;
  81.         status = presenceBuilder.status;
  82.         priority = presenceBuilder.priority;
  83.         mode = presenceBuilder.mode;
  84.     }

  86.     /**
  87.      * Copy constructor.
  88.      * <p>
  89.      * This does not perform a deep clone, as extension elements are shared between the new and old
  90.      * instance.
  91.      * </p>
  92.      *
  93.      * @param other TODO javadoc me please
  94.      */
  95.     public Presence(Presence other) {
  96.         super(other);
  97.         this.type = other.type;
  98.         this.status = other.status;
  99.         this.priority = other.priority;
  100.         this.mode = other.mode;
  101.     }

  103.     /**
  104.      * Returns true if the {@link Type presence type} is available (online) and
  105.      * false if the user is unavailable (offline), or if this is a presence packet
  106.      * involved in a subscription operation. This is a convenience method
  107.      * equivalent to <code>getType() == Presence.Type.available</code>. Note that even
  108.      * when the user is available, their presence mode may be {@link Mode#away away},
  109.      * {@link Mode#xa extended away} or {@link Mode#dnd do not disturb}. Use
  110.      * {@link #isAway()} to determine if the user is away.
  111.      *
  112.      * @return true if the presence type is available.
  113.      */
  114.     public boolean isAvailable() {
  115.         return type == Type.available;
  116.     }

  118.     /**
  119.      * Returns true if the presence type is {@link Type#available available} and the presence
  120.      * mode is {@link Mode#away away}, {@link Mode#xa extended away}, or
  121.      * {@link Mode#dnd do not disturb}. False will be returned when the type or mode
  122.      * is any other value, including when the presence type is unavailable (offline).
  123.      * This is a convenience method equivalent to
  124.      * <code>type == Type.available &amp;&amp; (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd)</code>.
  125.      *
  126.      * @return true if the presence type is available and the presence mode is away, xa, or dnd.
  127.      */
  128.     public boolean isAway() {
  129.         return type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd);
  130.     }

  132.     @Override
  133.     public Type getType() {
  134.         return type;
  135.     }

  137.     @Override
  138.     public String getStatus() {
  139.         return status;
  140.     }

  142.     @Override
  143.     public int getPriority() {
  144.         return getPriorityByte();
  145.     }

  147.     @Override
  148.     public byte getPriorityByte() {
  149.         if (priority == null) {
  150.             return 0;
  151.         }
  152.         return priority;
  153.     }

  155.     /**
  156.      * Sets the priority of the presence. The valid range is -128 through 127.
  157.      *
  158.      * @param priority the priority of the presence.
  159.      * @see <a href="https://tools.ietf.org/html/rfc6121#section-4.7.2.3">RFC 6121 § 4.7.2.3. Priority Element</a>
  160.      * @deprecated use {@link PresenceBuilder} or {@link org.jivesoftware.smack.XMPPConnection#getStanzaFactory} instead.
  161.      */
  162.     @Deprecated
  163.     // TODO: Remove in Smack 4.6.
  164.     public void setPriority(byte priority) {
  165.         this.priority = priority;
  166.     }

  168.     @Override
  169.     public Mode getMode() {
  170.         if (mode == null) {
  171.             return Mode.available;
  172.         }
  173.         return mode;
  174.     }

  176.     @Override
  177.     public String getElementName() {
  178.         return ELEMENT;
  179.     }

  181.     @Override
  182.     public PresenceBuilder asBuilder() {
  183.         return StanzaBuilder.buildPresenceFrom(this, getStanzaId());
  184.     }

  186.     @Override
  187.     public PresenceBuilder asBuilder(String id) {
  188.         return StanzaBuilder.buildPresenceFrom(this, id);
  189.     }

  191.     @Override
  192.     public PresenceBuilder asBuilder(XMPPConnection connection) {
  193.         return connection.getStanzaFactory().buildPresenceStanzaFrom(this);
  194.     }

  196.     @Override
  197.     public String toString() {
  198.         StringBuilder sb = new StringBuilder();
  199.         sb.append("Presence Stanza [");
  200.         logCommonAttributes(sb);
  201.         sb.append("type=").append(type).append(',');
  202.         if (mode != null) {
  203.             sb.append("mode=").append(mode).append(',');
  204.         }
  205.         if (!StringUtils.isNullOrEmpty(status)) {
  206.             sb.append("status=").append(status).append(',');
  207.         }
  208.         if (priority != null) {
  209.             sb.append("prio=").append(priority).append(',');
  210.         }
  211.         sb.append(']');
  212.         return sb.toString();
  213.     }

  215.     @Override
  216.     public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  217.         XmlStringBuilder buf = new XmlStringBuilder(this, enclosingNamespace);
  218.         addCommonAttributes(buf);
  219.         if (type != Type.available) {
  220.             buf.attribute("type", type);
  221.         }

  223.         List<XmlElement> extensions = getExtensions();
  224.         if (status == null
  225.                         && priority == null
  226.                         && (mode == null || mode == Mode.available)
  227.                         && extensions.isEmpty()
  228.                         && getError() == null) {
  229.             return buf.closeEmptyElement();
  230.         }

  232.         buf.rightAngleBracket();

  234.         buf.optElement("status", status);
  235.         buf.optElement("priority", priority);
  236.         if (mode != null && mode != Mode.available) {
  237.             buf.element("show", mode);
  238.         }

  240.         buf.append(extensions);

  242.         // Add the error sub-packet, if there is one.
  243.         appendErrorIfExists(buf);

  245.         buf.closeElement(ELEMENT);

  247.         return buf;
  248.     }

  250.     /**
  251.      * An enum to represent the presence type. Note that presence type is often confused
  252.      * with presence mode. Generally, if a user is signed in to a server, they have a presence
  253.      * type of {@link #available available}, even if the mode is {@link Mode#away away},
  254.      * {@link Mode#dnd dnd}, etc. The presence type is only {@link #unavailable unavailable} when
  255.      * the user is signing out of the server.
  256.      */
  257.     public enum Type {

  259.        /**
  260.         * The user is available to receive messages (default).
  261.         */
  262.         available,

  264.         /**
  265.          * The user is unavailable to receive messages.
  266.          */
  267.         unavailable,

  269.         /**
  270.          * Request subscription to recipient's presence.
  271.          */
  272.         subscribe,

  274.         /**
  275.          * Grant subscription to sender's presence.
  276.          */
  277.         subscribed,

  279.         /**
  280.          * Request removal of subscription to sender's presence.
  281.          */
  282.         unsubscribe,

  284.         /**
  285.          * Grant removal of subscription to sender's presence.
  286.          */
  287.         unsubscribed,

  289.         /**
  290.          * The presence stanza contains an error message.
  291.          */
  292.         error,

  294.         /**
  295.          * A presence probe as defined in section 4.3 of RFC 6121.
  296.          */
  297.         probe,
  298.         ;

  300.         /**
  301.          * Converts a String into the corresponding types. Valid String values that can be converted
  302.          * to types are: "available", "unavailable", "subscribe", "subscribed", "unsubscribe",
  303.          * "unsubscribed" and "error".
  304.          *
  305.          * @param string the String value to covert.
  306.          * @return the corresponding Type.
  307.          * @throws IllegalArgumentException when not able to parse the string parameter
  308.          * @throws NullPointerException if the string is null
  309.          */
  310.         public static Type fromString(String string) {
  311.             return Type.valueOf(string.toLowerCase(Locale.US));
  312.         }
  313.     }

  315.     /**
  316.      * An enum to represent the presence mode.
  317.      */
  318.     public enum Mode {

  320.         /**
  321.          * Free to chat.
  322.          */
  323.         chat,

  325.         /**
  326.          * Available (the default).
  327.          */
  328.         available,

  330.         /**
  331.          * Away.
  332.          */
  333.         away,

  335.         /**
  336.          * Away for an extended period of time.
  337.          */
  338.         xa,

  340.         /**
  341.          * Do not disturb.
  342.          */
  343.         dnd;

  345.         /**
  346.          * Converts a String into the corresponding types. Valid String values that can be converted
  347.          * to types are: "chat", "available", "away", "xa", and "dnd".
  348.          *
  349.          * @param string the String value to covert.
  350.          * @return the corresponding Type.
  351.          * @throws IllegalArgumentException when not able to parse the string parameter
  352.          * @throws NullPointerException if the string is null
  353.          */
  354.         public static Mode fromString(String string) {
  355.             return Mode.valueOf(string.toLowerCase(Locale.US));
  356.         }
  357.     }
  358. }
Created with JaCoCo 0.8.6.202009150832