aboutsummaryrefslogtreecommitdiff
path: root/src/org/jivesoftware/smackx/muc/RoomInfo.java
diff options
context:
space:
mode:
authorShuyi Chen <shuyichen@google.com>2013-05-22 14:51:55 -0700
committerShuyi Chen <shuyichen@google.com>2013-05-22 17:19:30 -0700
commitd7955ce24d294fb2014c59d11fca184471056f44 (patch)
treee260500b0b7639127038495d46a0ad6dcbb6d96c /src/org/jivesoftware/smackx/muc/RoomInfo.java
parent8f4ce9ea0de51fee918bffe19c434612d6bbb2d7 (diff)
downloadsmack-d7955ce24d294fb2014c59d11fca184471056f44.tar.gz
Add android smack source.HEADandroid-wear-5.0.0_r1android-sdk-4.4.2_r1.0.1android-sdk-4.4.2_r1android-l-preview_r2android-cts-5.1_r9android-cts-5.1_r8android-cts-5.1_r7android-cts-5.1_r6android-cts-5.1_r5android-cts-5.1_r4android-cts-5.1_r3android-cts-5.1_r28android-cts-5.1_r27android-cts-5.1_r26android-cts-5.1_r25android-cts-5.1_r24android-cts-5.1_r23android-cts-5.1_r22android-cts-5.1_r21android-cts-5.1_r20android-cts-5.1_r2android-cts-5.1_r19android-cts-5.1_r18android-cts-5.1_r17android-cts-5.1_r16android-cts-5.1_r15android-cts-5.1_r14android-cts-5.1_r13android-cts-5.1_r10android-cts-5.1_r1android-cts-5.0_r9android-cts-5.0_r8android-cts-5.0_r7android-cts-5.0_r6android-cts-5.0_r5android-cts-5.0_r4android-cts-5.0_r3android-cts-4.4_r4android-cts-4.4_r1android-5.1.1_r9android-5.1.1_r8android-5.1.1_r7android-5.1.1_r6android-5.1.1_r5android-5.1.1_r4android-5.1.1_r38android-5.1.1_r37android-5.1.1_r36android-5.1.1_r35android-5.1.1_r34android-5.1.1_r33android-5.1.1_r30android-5.1.1_r3android-5.1.1_r29android-5.1.1_r28android-5.1.1_r26android-5.1.1_r25android-5.1.1_r24android-5.1.1_r23android-5.1.1_r22android-5.1.1_r20android-5.1.1_r2android-5.1.1_r19android-5.1.1_r18android-5.1.1_r17android-5.1.1_r16android-5.1.1_r15android-5.1.1_r14android-5.1.1_r13android-5.1.1_r12android-5.1.1_r10android-5.1.1_r1android-5.1.0_r5android-5.1.0_r4android-5.1.0_r3android-5.1.0_r1android-5.0.2_r3android-5.0.2_r1android-5.0.1_r1android-5.0.0_r7android-5.0.0_r6android-5.0.0_r5.1android-5.0.0_r5android-5.0.0_r4android-5.0.0_r3android-5.0.0_r2android-5.0.0_r1android-4.4w_r1android-4.4_r1.2.0.1android-4.4_r1.2android-4.4_r1.1.0.1android-4.4_r1.1android-4.4_r1.0.1android-4.4_r1android-4.4_r0.9android-4.4_r0.8android-4.4_r0.7android-4.4.4_r2.0.1android-4.4.4_r2android-4.4.4_r1.0.1android-4.4.4_r1android-4.4.3_r1.1.0.1android-4.4.3_r1.1android-4.4.3_r1.0.1android-4.4.3_r1android-4.4.2_r2.0.1android-4.4.2_r2android-4.4.2_r1.0.1android-4.4.2_r1android-4.4.1_r1.0.1android-4.4.1_r1android-4.3_r3.1android-4.3_r3android-4.3_r2.3android-4.3_r2.2android-4.3_r2.1android-4.3_r2android-4.3_r1.1android-4.3_r1android-4.3_r0.9.1android-4.3_r0.9android-4.3.1_r1tools_r22.2mastermainlollipop-wear-releaselollipop-releaselollipop-mr1-wfc-releaselollipop-mr1-releaselollipop-mr1-fi-releaselollipop-mr1-devlollipop-mr1-cts-releaselollipop-devlollipop-cts-releasel-previewkitkat-wearkitkat-releasekitkat-mr2.2-releasekitkat-mr2.1-releasekitkat-mr2-releasekitkat-mr1.1-releasekitkat-mr1-releasekitkat-devkitkat-cts-releasekitkat-cts-devjb-mr2.0.0-releasejb-mr2.0-releasejb-mr2-releasejb-mr2-devidea133-weekly-releaseidea133
Change-Id: I49ce97136c17173c4ae3965c694af6e7bc49897d
Diffstat (limited to 'src/org/jivesoftware/smackx/muc/RoomInfo.java')
-rw-r--r--src/org/jivesoftware/smackx/muc/RoomInfo.java190
1 files changed, 190 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/muc/RoomInfo.java b/src/org/jivesoftware/smackx/muc/RoomInfo.java
new file mode 100644
index 0000000..f97f544
--- /dev/null
+++ b/src/org/jivesoftware/smackx/muc/RoomInfo.java
@@ -0,0 +1,190 @@
+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright 2003-2007 Jive Software.
+ *
+ * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jivesoftware.smackx.muc;
+
+import org.jivesoftware.smackx.Form;
+import org.jivesoftware.smackx.FormField;
+import org.jivesoftware.smackx.packet.DiscoverInfo;
+
+import java.util.Iterator;
+
+/**
+ * Represents the room information that was discovered using Service Discovery. It's possible to
+ * obtain information about a room before joining the room but only for rooms that are public (i.e.
+ * rooms that may be discovered).
+ *
+ * @author Gaston Dombiak
+ */
+public class RoomInfo {
+
+ /**
+ * JID of the room. The node of the JID is commonly used as the ID of the room or name.
+ */
+ private String room;
+ /**
+ * Description of the room.
+ */
+ private String description = "";
+ /**
+ * Last known subject of the room.
+ */
+ private String subject = "";
+ /**
+ * Current number of occupants in the room.
+ */
+ private int occupantsCount = -1;
+ /**
+ * A room is considered members-only if an invitation is required in order to enter the room.
+ * Any user that is not a member of the room won't be able to join the room unless the user
+ * decides to register with the room (thus becoming a member).
+ */
+ private boolean membersOnly;
+ /**
+ * Moderated rooms enable only participants to speak. Users that join the room and aren't
+ * participants can't speak (they are just visitors).
+ */
+ private boolean moderated;
+ /**
+ * Every presence packet can include the JID of every occupant unless the owner deactives this
+ * configuration.
+ */
+ private boolean nonanonymous;
+ /**
+ * Indicates if users must supply a password to join the room.
+ */
+ private boolean passwordProtected;
+ /**
+ * Persistent rooms are saved to the database to make sure that rooms configurations can be
+ * restored in case the server goes down.
+ */
+ private boolean persistent;
+
+ RoomInfo(DiscoverInfo info) {
+ super();
+ this.room = info.getFrom();
+ // Get the information based on the discovered features
+ this.membersOnly = info.containsFeature("muc_membersonly");
+ this.moderated = info.containsFeature("muc_moderated");
+ this.nonanonymous = info.containsFeature("muc_nonanonymous");
+ this.passwordProtected = info.containsFeature("muc_passwordprotected");
+ this.persistent = info.containsFeature("muc_persistent");
+ // Get the information based on the discovered extended information
+ Form form = Form.getFormFrom(info);
+ if (form != null) {
+ FormField descField = form.getField("muc#roominfo_description");
+ this.description = ( descField == null || !(descField.getValues().hasNext()) )? "" : descField.getValues().next();
+
+ FormField subjField = form.getField("muc#roominfo_subject");
+ this.subject = ( subjField == null || !(subjField.getValues().hasNext()) ) ? "" : subjField.getValues().next();
+
+ FormField occCountField = form.getField("muc#roominfo_occupants");
+ this.occupantsCount = occCountField == null ? -1 : Integer.parseInt(occCountField.getValues()
+ .next());
+ }
+ }
+
+ /**
+ * Returns the JID of the room whose information was discovered.
+ *
+ * @return the JID of the room whose information was discovered.
+ */
+ public String getRoom() {
+ return room;
+ }
+
+ /**
+ * Returns the discovered description of the room.
+ *
+ * @return the discovered description of the room.
+ */
+ public String getDescription() {
+ return description;
+ }
+
+ /**
+ * Returns the discovered subject of the room. The subject may be empty if the room does not
+ * have a subject.
+ *
+ * @return the discovered subject of the room.
+ */
+ public String getSubject() {
+ return subject;
+ }
+
+ /**
+ * Returns the discovered number of occupants that are currently in the room. If this
+ * information was not discovered (i.e. the server didn't send it) then a value of -1 will be
+ * returned.
+ *
+ * @return the number of occupants that are currently in the room or -1 if that information was
+ * not provided by the server.
+ */
+ public int getOccupantsCount() {
+ return occupantsCount;
+ }
+
+ /**
+ * Returns true if the room has restricted the access so that only members may enter the room.
+ *
+ * @return true if the room has restricted the access so that only members may enter the room.
+ */
+ public boolean isMembersOnly() {
+ return membersOnly;
+ }
+
+ /**
+ * Returns true if the room enabled only participants to speak. Occupants with a role of
+ * visitor won't be able to speak in the room.
+ *
+ * @return true if the room enabled only participants to speak.
+ */
+ public boolean isModerated() {
+ return moderated;
+ }
+
+ /**
+ * Returns true if presence packets will include the JID of every occupant.
+ *
+ * @return true if presence packets will include the JID of every occupant.
+ */
+ public boolean isNonanonymous() {
+ return nonanonymous;
+ }
+
+ /**
+ * Returns true if users musy provide a valid password in order to join the room.
+ *
+ * @return true if users musy provide a valid password in order to join the room.
+ */
+ public boolean isPasswordProtected() {
+ return passwordProtected;
+ }
+
+ /**
+ * Returns true if the room will persist after the last occupant have left the room.
+ *
+ * @return true if the room will persist after the last occupant have left the room.
+ */
+ public boolean isPersistent() {
+ return persistent;
+ }
+
+}