rocks.xmpp.extensions.muc.model

Class RoomConfiguration

java.lang.Object

rocks.xmpp.extensions.muc.model.RoomConfiguration

public final class RoomConfiguration
extends Object

Represents a standardized DataForm with form type http://jabber.org/protocol/muc#roomconfig, which can be used to configure a MUC room.

Usage

To wrap an existing DataForm to retrieve standard data from it, use:

 
 RoomConfiguration roomConfiguration = new RoomConfiguration(dataForm);
 
 

To build a form:

 
 RoomConfiguration roomConfiguration = RoomConfiguration.builder()
     .maxHistoryMessages(4)
     .rolesThatMaySendPrivateMessages(Arrays.asList(Role.MODERATOR, Role.PARTICIPANT))
     .invitesAllowed(true)
     .changeSubjectAllowed(true)
     .loggingEnabled(true)
     .rolesThatMayRetrieveMemberList(Collections.singleton(Role.PARTICIPANT))
     .language("en")
     .pubSubNode(URI.create("xmpp:pubsub.shakespeare.lit?;node=princely_musings"))
     .maxUsers(30)
     .membersOnly(true)
     .moderated(true)
     .passwordProtected(true)
     .persistent(true)
     .rolesForWhichPresenceIsBroadcast(Arrays.asList(Role.MODERATOR, Role.PARTICIPANT))
     .publicRoom(true)
     .administrators(Arrays.asList(Jid.of("admin1"), Jid.of("admin2")))
     .description("description")
     .name("name")
     .owners(Arrays.asList(Jid.of("owner1"), Jid.of("owner2")))
     .password("pass")
     .rolesThatMayDiscoverRealJids(EnumSet.of(Role.MODERATOR))
     .build();
 
 

See Also:

10.1.3 Creating a Reserved Room, 15.5.3 muc#roomconfig FORM_TYPE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoomConfiguration.Builder A builder to build a room configuration.

Constructor Summary

Constructors

Constructor and Description
RoomConfiguration(DataForm dataForm)

Method Summary

Modifier and Type	Method and Description
static RoomConfiguration.Builder	builder()
Collection<rocks.xmpp.addr.Jid>	getAdministrators() Gets the administrators.
DataForm	getDataForm() Gets the underlying form.
String	getDescription() Gets a short description.
Locale	getLanguage() Gets the natural language for room discussions.
Integer	getMaxHistoryMessages() Gets the maximum number of history messages returned by the room.
Integer	getMaxUsers() Gets the maximum number of room occupants.
String	getName() Gets the natural-language room name.
Collection<rocks.xmpp.addr.Jid>	getOwners() Gets the owners.
String	getPassword() Gets the room password.
URI	getPubSubNode() Gets the XMPP URI of associated publish-subscribe node.
Collection<Role>	getRolesForWhichPresenceIsBroadcast() Gets the roles for which presence is broadcast.
Collection<Role>	getRolesThatMayDiscoverRealJids() Get the roles, which may discover real JIDs.
Collection<Role>	getRolesThatMayRetrieveMemberList() Gets the roles which may retrieve member list.
Collection<Role>	getRolesThatMaySendPrivateMessages() Gets the roles that may send private messages.
boolean	isChangeSubjectAllowed() Indicates, whether to allow occupants to change subject.
boolean	isInvitesAllowed() Indicates, whether to allow occupants to invite others.
boolean	isLoggingEnabled() Indicates, whether to enable public logging of room conversations.
boolean	isMembersOnly() Indicates, whether the room is members-only.
boolean	isModerated() Indicates, whether the room is moderated.
boolean	isPasswordProtected() Indicates, whether the room is password protected.
boolean	isPersistent() Indicates, whether the room is persistent.
boolean	isPublicRoom() Indicates, whether the room is public.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomConfiguration

public RoomConfiguration(DataForm dataForm)

Method Detail

builder

public static RoomConfiguration.Builder builder()

getMaxHistoryMessages

public Integer getMaxHistoryMessages()

Gets the maximum number of history messages returned by the room.

Returns:

The maximum number of history messages returned by the room.

getRolesThatMaySendPrivateMessages

public Collection<Role> getRolesThatMaySendPrivateMessages()

Gets the roles that may send private messages.

Returns:

The roles.

isInvitesAllowed

public boolean isInvitesAllowed()

Indicates, whether to allow occupants to invite others.

Returns:

True, if occupants are allowed to invite others.

isChangeSubjectAllowed

public boolean isChangeSubjectAllowed()

Indicates, whether to allow occupants to change subject.

Returns:

True, if occupants are allowed to change subject.

isLoggingEnabled

public boolean isLoggingEnabled()

Indicates, whether to enable public logging of room conversations.

Returns:

True, if public logging of room conversations is enabled.

getRolesThatMayRetrieveMemberList

public Collection<Role> getRolesThatMayRetrieveMemberList()

Gets the roles which may retrieve member list.

Returns:

The roles which may retrieve member list.

getLanguage

public Locale getLanguage()

Gets the natural language for room discussions.

Returns:

The language.

getPubSubNode

public URI getPubSubNode()

Gets the XMPP URI of associated publish-subscribe node.

Returns:

The URI.

getMaxUsers

public Integer getMaxUsers()

Gets the maximum number of room occupants.

Returns:

The maximum number of room occupants.

isMembersOnly

public boolean isMembersOnly()

Indicates, whether the room is members-only.

Returns:

True, if the room is members-only.

isModerated

public boolean isModerated()

Indicates, whether the room is moderated.

Returns:

True, if the room is moderated.

isPasswordProtected

public boolean isPasswordProtected()

Indicates, whether the room is password protected.

Returns:

True, if the room is password protected.

isPersistent

public boolean isPersistent()

Indicates, whether the room is persistent.

Returns:

True, if the room is persistent.

getRolesForWhichPresenceIsBroadcast

public Collection<Role> getRolesForWhichPresenceIsBroadcast()

Gets the roles for which presence is broadcast.

Returns:

The roles for which presence is broadcast.

isPublicRoom

public boolean isPublicRoom()

Indicates, whether the room is public.

Returns:

True, if the room is public.

getAdministrators

public Collection<rocks.xmpp.addr.Jid> getAdministrators()

Gets the administrators.

Returns:

The administrators.

getDescription

public String getDescription()

Gets a short description.

Returns:

The description.

getName

public String getName()

Gets the natural-language room name.

Returns:

The room name.

getOwners

public Collection<rocks.xmpp.addr.Jid> getOwners()

Gets the owners.

Returns:

The owners.

getPassword

public String getPassword()

Gets the room password.

Returns:

The password.

getRolesThatMayDiscoverRealJids

public Collection<Role> getRolesThatMayDiscoverRealJids()

Get the roles, which may discover real JIDs.

Returns:

The roles, which may discover real JIDs.

getDataForm

public DataForm getDataForm()

Gets the underlying form.

Returns:

The underlying data form.