org.moock.unity.core
Class RoomProperties

java.lang.Object
  |
  +--org.moock.unity.core.RoomModel
        |
        +--org.moock.unity.core.RoomProperties

public class RoomProperties
extends org.moock.unity.core.RoomModel

Holds the properties for a deployed Room.

Author:
Derek Clayton

Field Summary
static int AUTHENTICATION
           
static int NO_AUTHENTICATION
           
 
Constructor Summary
RoomProperties()
           
RoomProperties(java.lang.String roomType)
           
RoomProperties(java.lang.String roomType, java.lang.String namespace)
           
 
Method Summary
 int getAuthentication()
          Get the authentication for the room.
 boolean getDieOnEmpty()
          Returns true if the Room should die when the last Client leaves, false otherwise.
 java.util.ArrayList getIPAuthorizedList()
          Deprecated. no longer used by the server developers using this should maintain the list in an Attribute
 java.lang.String getNamespace()
          Gets the namespace this room is associated with.
 java.lang.String getRoomType()
          Gets the type of Room as defined in RoomTypes.xml.
 boolean isAutojoin()
          Returns true if clients are set to join the Room when they connect to the server.
 void setAutojoin(boolean setter)
          Set to true if the clients are set to join the Room when they connect to the server.
 
Methods inherited from class org.moock.unity.core.RoomModel
getMaxClients, getTimeout, isAcceptOutsideMessages, setAcceptOutsideMessages, setMaxClients
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_AUTHENTICATION

public static final int NO_AUTHENTICATION

AUTHENTICATION

public static final int AUTHENTICATION
Constructor Detail

RoomProperties

public RoomProperties()

RoomProperties

public RoomProperties(java.lang.String roomType)

RoomProperties

public RoomProperties(java.lang.String roomType,
                      java.lang.String namespace)
Method Detail

getIPAuthorizedList

public java.util.ArrayList getIPAuthorizedList()
Deprecated. no longer used by the server developers using this should maintain the list in an Attribute

Get the authorized list of IP's.

isAutojoin

public boolean isAutojoin()
Returns true if clients are set to join the Room when they connect to the server.

setAutojoin

public void setAutojoin(boolean setter)
Set to true if the clients are set to join the Room when they connect to the server.

getNamespace

public java.lang.String getNamespace()
Gets the namespace this room is associated with.

getRoomType

public java.lang.String getRoomType()
Gets the type of Room as defined in RoomTypes.xml.

getAuthentication

public int getAuthentication()
Get the authentication for the room.

getDieOnEmpty

public boolean getDieOnEmpty()
Returns true if the Room should die when the last Client leaves, false otherwise.