SFSZone

java.lang.Object
- com.smartfoxserver.v2.entities.SFSZone

All Implemented Interfaces:

Zone
```
public final class SFSZone
extends java.lang.Object
implements Zone
```
Overview
The Zone represent an application running in the Server, from a simple chat application to a large scale MMO with dozens of games. Each Zone can contain any number of Rooms organized in Room Groups.
Also each Zone provides a number of essential services:
- Room and User management
- Persistent BuddyList system
- Words filtering
- Flood filtering
- Database connection management and pooling
- Event dispatching
- Room persistence
Finally each Zone is fully extensible via the use of a server side Extension which allow to process client requests, server events and more. The Extension is attached to the Zone itself and initialized as soon as the Zone is ready. The Extension can take control of the Zone and interact with the server via the server side API.
See Also:

Room, SFSApi, BaseSFSExtension, SFSExtension

Constructor Summary

Constructors
Constructor and Description

SFSZone(java.lang.String name)

Constructors
Constructor and Description
`SFSZone(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDisabledSystemEvent(java.lang.String eventID)` INTERNAL
`void`	`addRoom(Room room)` INTERNAL Instead use `SFSApi.createRoom(Zone, CreateRoomSettings, User)`
`void`	`changeRoomCapacity(Room room, int newMaxUsers, int newMaxSpect)` Use the `SFSApi.changeRoomCapacity(User, Room, int, int)`
`void`	`changeRoomName(Room room, java.lang.String newName)` Use the `SFSApi.changeRoomName(User, Room, String)`
`void`	`changeRoomPasswordState(Room room, java.lang.String password)` Use the `SFSApi.changeRoomPassword(User, Room, String)`
`void`	`checkAndRemove(Room room)`
`boolean`	`containsGroup(java.lang.String groupId)` Check if the Zone contains the specified Group
`boolean`	`containsProperty(java.lang.Object key)` Checks the existance of a Zone property
`boolean`	`containsPublicGroup(java.lang.String groupId)` Check if the Zone contains the specified public Group
`Room`	`createRoom(CreateRoomSettings params)` Use the `SFSApi.createRoom(Zone, CreateRoomSettings, User)` method instead
`Room`	`createRoom(CreateRoomSettings params, User user)` Use the `SFSApi.createRoom(Zone, CreateRoomSettings, User)` method instead
`com.smartfoxserver.v2.util.IAdminHelper`	`getAdminHelper()`
`BuddyListManager`	`getBuddyListManager()` INTERNAL Instead use `SFSBuddyApi`
`IDBManager`	`getDBManager()` Obtain a reference to the Zone's Database Manager.
`java.util.List<java.lang.String>`	`getDefaultGroups()` Get the list of Groups that each User will be automatically subscribed to when joining the Zone.
`java.lang.String`	`getDefaultPlayerIdGeneratorClassName()`
`java.lang.String`	`getDump()`
`ISFSExtension`	`getExtension()` INTERNAL
`ISystemFilterChain`	`getFilterChain(SystemRequest requestId)` Obtain a reference to the Zone's SystemFilterChain.
`IFloodFilter`	`getFloodFilter()` INTERNAL
`int`	`getGameRoomCount()`
`java.util.Set<SFSRoomEvents>`	`getGroupEvents(java.lang.String groupId)`
`java.util.List<java.lang.String>`	`getGroups()` Get the full list of Room Groups available in the Zone.
`java.lang.String`	`getGuestUserNamePrefix()` Get the prefix used by the system to auto-generate guest user names.
`int`	`getId()` A numeric ID used by the AdminTool.
`int`	`getMaxAllowedRooms()` The maximum number of Rooms that can be created in the Room.
`int`	`getMaxAllowedUsers()` The maximum number of users allowed to join the Zone.
`int`	`getMaxFailedLogins()` The max number of login attempts (in the same session) a user can fail before being disconnected.
`int`	`getMaxFindRoomResults()` Get the max number of "FindRoom" results for a client request.
`int`	`getMaxFindUserResults()` Get the max number of "Find User" results for a client request.
`int`	`getMaxInvitationsPerRequest()` Get the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
`int`	`getMaxRoomNameChars()` The maximum number of characters allowed for a Room name
`int`	`getMaxRoomsCreatedPerUserLimit()` The maximum number of Rooms that a User can create at once.
`int`	`getMaxRoomVariablesAllowed()` The maximum number of Room Variables allowed for each Room.
`int`	`getMaxUserIdleTime()` Get the max allowed idle time for a User.
`int`	`getMaxUserVariablesAllowed()` The maximum number of User Variables allowed for each User.
`int`	`getMinRoomNameChars()` The minimum number of characters allowed for Room name
`java.lang.String`	`getName()` The name of the Zone.
`PrivilegeManager`	`getPrivilegeManager()`
`java.lang.Object`	`getProperty(java.lang.Object key)` Properties are custom values that can be added or removed from the Zone at run-time.
`java.util.List<java.lang.String>`	`getPublicGroups()` Get a list of names of the "Public" Room Groups available in the Zone.
`Room`	`getRoomById(int id)` Get a Room from its unique ID
`Room`	`getRoomByName(java.lang.String name)` Get a Room from its name
`java.util.List<Room>`	`getRoomList()` Get the list of Rooms in the Zone
`ISFSArray`	`getRoomListData()` INTERNAL
`ISFSArray`	`getRoomListData(java.util.List<java.lang.String> groupIds)` INTERNAL
`java.util.List<Room>`	`getRoomListFromGroup(java.lang.String groupId)` Get the list of Rooms from a specific Group
`com.smartfoxserver.v2.entities.managers.IRoomManager`	`getRoomManager()` Obtain a reference to the internal Room Manager
`IRoomStorage`	`getRoomPersistenceApi()` Obtain the Room Persistence API object.
`java.util.Collection<ISession>`	`getSessionList()` Get the list of Sessions logged in the Zone
`java.util.Collection<ISession>`	`getSessionsInGroup(java.lang.String groupId)` Get a list of Sessions from all Rooms in the provided Room Group
`java.util.Collection<ISession>`	`getSessionsListeningToGroup(java.lang.String groupId)` Get a list of Sessions listening for events in a specific Group
`int`	`getTotalRoomCount()`
`com.smartfoxserver.v2.util.IResponseThrottler`	`getUCountThrottler()` INTERNAL
`User`	`getUserById(int id)` Get a User from its unique ID
`User`	`getUserByName(java.lang.String name)` Get a User from its name
`User`	`getUserBySession(ISession session)` Get a User from its Session object
`int`	`getUserCount()` Get the current amount of Users connected to the Zone
`int`	`getUserCountChangeUpdateInterval()` Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
`java.util.Collection<User>`	`getUserList()` Get the list of Users logged in the Zone
`com.smartfoxserver.v2.entities.managers.IUserManager`	`getUserManager()`
`int`	`getUserReconnectionSeconds()` Return the amount of seconds available for a User to reconnect to the system in case their socket connection goes down.
`java.util.Collection<User>`	`getUsersInGroup(java.lang.String groupId)` Get a list of Users from all Rooms in the provided Room Group
`IWordFilter`	`getWordFilter()` INTERNAL
`com.smartfoxserver.v2.entities.managers.IZoneManager`	`getZoneManager()`
`void`	`initRoomPersistence(RoomStorageMode mode, BaseStorageConfig config)` Initializes the Room Persistence functionality.
`boolean`	`isActive()` Checks if the Zone is currently enabled in the system or not.
`boolean`	`isAllowInvitationsOnlyForBuddies()` True if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
`boolean`	`isClientAllowedToOverridRoomEvents()` Deprecated.
`boolean`	`isCustomLogin()` Check if the Zone fires LOGIN events to the Zone extension at login time.
`boolean`	`isEncrypted()` True if protocol cryptography is turned on in this Zone.
`boolean`	`isFilterBuddyMessages()` Toggle the filtering of Buddy messages via the Words Filter.
`boolean`	`isFilterChainInited()` Returns true if the FilterChain was initialized
`boolean`	`isFilterPrivateMessages()` If turned on the Zone will apply the Words Filter to private messages
`boolean`	`isFilterRoomNames()` If turned on the Zone will apply the Words Filter to Room names
`boolean`	`isFilterUserNames()` If turned on the Zone will apply the Words Filter to User names provided at login time
`boolean`	`isForceLogout()` If turned on it allows a User to connect from another location while another connection is already active.
`boolean`	`isGeoLocationEnabled()` Toggles geolocation for clients.
`boolean`	`isGroupEventSet(java.lang.String groupId, SFSRoomEvents eventToCheck)` Checks whether a specific Room Event for the specified Group is active
`boolean`	`isGuestUserAllowed()` Check if the Zone allows guest users (those sending no name and no password).
`boolean`	`isHidden()` INTERNAL
`boolean`	`isSystemEventAllowed(java.lang.String eventID)` INTERNAL
`boolean`	`isUploadEnabled()` True if the Zone supports HTTP uploads.
`User`	`login(LoginData loginData)` INTERNAL Instead use `SFSApi.login(ISession, String, String, String, com.smartfoxserver.v2.entities.data.ISFSObject)`
`void`	`registerEventsForRoomGroup(java.lang.String groupId, java.util.Set<SFSRoomEvents> flags)` Use `SFSApi.subscribeRoomGroup(User, String)`
`void`	`removeAllUsers()`
`void`	`removeDisabledSystemEvent(java.lang.String eventID)` INTERNAL
`void`	`removeProperty(java.lang.Object key)` Remove a property.
`void`	`removeRoom(int roomId)` Use `SFSApi.removeRoom(Room)`
`void`	`removeRoom(Room room)` Use `SFSApi.removeRoom(Room)`
`void`	`removeRoom(java.lang.String name)` Use `SFSApi.removeRoom(Room)`
`void`	`removeUser(int userId)` INTERNAL Instead use `SFSApi.disconnectUser(User)`
`void`	`removeUser(ISession session)` INTERNAL Instead use `SFSApi.disconnect(ISession)`
`void`	`removeUser(java.lang.String userName)` INTERNAL Instead use `SFSApi.disconnectUser(User)`
`void`	`removeUser(User user)` INTERNAL Instead use `SFSApi.disconnectUser(User)`
`void`	`removeUserFromRoom(User user, Room room)` Use `SFSApi.leaveRoom(User, Room)`
`void`	`resetSystemFilterChain()` Resets the whole SystemController Filter chain.
`void`	`setActive(boolean flag)` Changes the state of the Zone.
`void`	`setAdminHelper(com.smartfoxserver.v2.util.IAdminHelper adminHelper)`
`void`	`setAllowInvitationsOnlyForBuddies(boolean allowInvitationsOnlyForBuddies)` Set to true if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
`void`	`setBuddyListManager(BuddyListManager buddyListManager)` INTERNAL
`void`	`setClientAllowedToOverridRoomEvents(boolean flag)` Deprecated.
`void`	`setCustomLogin(boolean flag)` Set the Zone as Custom login.
`void`	`setDBManager(IDBManager manager)` INTERNAL
`void`	`setDefaultGroups(java.util.List<java.lang.String> groupIDs)`
`void`	`setDefaultPlayerIdGeneratorClassName(java.lang.String className)`
`void`	`setEncrypted(boolean value)` Toggles the protocol cryptography.
`void`	`setExtension(ISFSExtension extension)` INTERNAL
`void`	`setFilterBuddyMessages(boolean flag)` If turned on the Zone will apply the Words Filter to Buddy messages
`void`	`setFilterChain(SystemRequest requestId, ISystemFilterChain chain)` Set a SystemFilterChain for a specific SystemController's Request.
`void`	`setFilterPrivateMessages(boolean flag)` Toggle the filtering of private messages via the Words Filter.
`void`	`setFilterRoomNames(boolean flag)` Toggle the filtering of Room names via the Words Filter.
`void`	`setFilterUserNames(boolean flag)` Toggle the filtering of User names via the Words Filter at login time.
`void`	`setForceLogout(boolean flag)` If turned on it allows a User to connect from another location while another connection is already active.
`void`	`setGeoLocationEnabled(boolean value)` Toggles geolocation for clients.
`void`	`setGuestUserAllowed(boolean flag)` Toggles the Zone guest users (login with no name and no password).
`void`	`setGuestUserNamePrefix(java.lang.String prefix)` Set the prefix used by the system to auto-generate guest user names.
`void`	`setHidden(boolean flag)` INTERNAL
`void`	`setId(int id)` A numeric ID used by the AdminTool.
`void`	`setMaxAllowedRooms(int max)` Set the maximum number of Rooms that can be created in the Room.
`void`	`setMaxAllowedUsers(int max)` Set the maximum number of users allowed to join the Zone.
`void`	`setMaxFailedLogins(int value)` Set the max number of login attempts (in the same session) a user can fail before being disconnected.
`void`	`setMaxFindRoomResults(int value)` Set the max number of "FindRoom" results for a client request.
`void`	`setMaxFindUserResults(int value)` Set the max number of "FindUser" results for a client request.
`void`	`setMaxInvitationsPerRequest(int maxInvitationsPerRequest)` Set the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
`void`	`setMaxRoomNameChars(int maxRoomNameChars)` Set the maximum number of characters allowed for a Room name
`void`	`setMaxRoomsCreatedPerUserLimit(int max)` Set the maximum number of Rooms that a User can create at once.
`void`	`setMaxRoomVariablesAllowed(int max)` Set the maximum number of Room variables allowed in the Room
`void`	`setMaxUserIdleTime(int seconds)` Set the max allowed idle time for a User.
`void`	`setMaxUserVariablesAllowed(int max)` Set the maximum number of User Variables allowed for each User.
`void`	`setMinRoomNameChars(int minRoomNameChars)` Set the minimum number of characters allowed for a Room name
`void`	`setPrivilegeManager(PrivilegeManager privilegeManager)`
`void`	`setProperty(java.lang.Object key, java.lang.Object value)` Properties are custom values that can be added or removed from the Zone at run-time.
`void`	`setPublicGroups(java.util.List<java.lang.String> groupIDs)`
`void`	`setUploadEnabled(boolean val)` Switches on/off the ability to upload data via HTTP.
`void`	`setUserCountChangeUpdateInterval(int interval)` Set the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
`void`	`setUserReconnectionSeconds(int seconds)` Set the amount of seconds available for a User to reconnect to the system in case their socket connection goes down.
`void`	`setZoneManager(com.smartfoxserver.v2.entities.managers.IZoneManager manager)`
`java.lang.String`	`toString()`
`void`	`validateUserName(java.lang.String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SFSZone
```
public SFSZone(java.lang.String name)
```
- Method Detail
  - getRoomManager
```
public com.smartfoxserver.v2.entities.managers.IRoomManager getRoomManager()
```
    Obtain a reference to the internal Room Manager
    
    Specified by:
    
    getRoomManager in interface Zone
    
    Returns:
    
    the Room Manager
  - getUserManager
```
public com.smartfoxserver.v2.entities.managers.IUserManager getUserManager()
```
    Specified by:
    
    getUserManager in interface Zone
  - containsGroup
```
public boolean containsGroup(java.lang.String groupId)
```
    Check if the Zone contains the specified Group
    
    Specified by:
    
    containsGroup in interface Zone
    
    Returns:
    
    true if the Zone contains the specified Group
  - containsPublicGroup
```
public boolean containsPublicGroup(java.lang.String groupId)
```
    Check if the Zone contains the specified public Group
    
    Specified by:
    
    containsPublicGroup in interface Zone
    
    Returns:
    
    true if the Zone contains the specified public Group
  - createRoom
```
public Room createRoom(CreateRoomSettings params,
                       User user)
                throws SFSCreateRoomException
```
    Use the SFSApi.createRoom(Zone, CreateRoomSettings, User) method instead
    
    Specified by:
    
    createRoom in interface Zone
    
    Throws:
    
    SFSCreateRoomException
  - createRoom
```
public Room createRoom(CreateRoomSettings params)
                throws SFSCreateRoomException
```
    Use the SFSApi.createRoom(Zone, CreateRoomSettings, User) method instead
    
    Specified by:
    
    createRoom in interface Zone
    
    Throws:
    
    SFSCreateRoomException
  - changeRoomName
```
public void changeRoomName(Room room,
                           java.lang.String newName)
                    throws SFSRoomException
```
    Use the SFSApi.changeRoomName(User, Room, String)
    
    Specified by:
    
    changeRoomName in interface Zone
    
    Throws:
    
    SFSRoomException
  - changeRoomPasswordState
```
public void changeRoomPasswordState(Room room,
                                    java.lang.String password)
```
    Use the SFSApi.changeRoomPassword(User, Room, String)
    
    Specified by:
    
    changeRoomPasswordState in interface Zone
  - changeRoomCapacity
```
public void changeRoomCapacity(Room room,
                               int newMaxUsers,
                               int newMaxSpect)
```
    Use the SFSApi.changeRoomCapacity(User, Room, int, int)
    
    Specified by:
    
    changeRoomCapacity in interface Zone
  - addDisabledSystemEvent
```
public void addDisabledSystemEvent(java.lang.String eventID)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    addDisabledSystemEvent in interface Zone
  - addRoom
```
public void addRoom(Room room)
             throws SFSTooManyRoomsException
```
    Description copied from interface: Zone
    
    INTERNAL
    Instead use SFSApi.createRoom(Zone, CreateRoomSettings, User)
    
    Specified by:
    
    addRoom in interface Zone
    
    Throws:
    
    SFSTooManyRoomsException
  - getGuestUserNamePrefix
```
public java.lang.String getGuestUserNamePrefix()
```
    Get the prefix used by the system to auto-generate guest user names.
    Example: by default the prefix is "Guest#"
    At the end of the prefix it will be added the unique user id.
    
    Specified by:
    
    getGuestUserNamePrefix in interface Zone
    
    Returns:
    
    the user name prefix
  - getUserCount
```
public int getUserCount()
```
    Get the current amount of Users connected to the Zone
    
    Specified by:
    
    getUserCount in interface Zone
    
    Returns:
    
    the amount of Users connected to the Zone
  - getTotalRoomCount
```
public int getTotalRoomCount()
```
    Specified by:
    
    getTotalRoomCount in interface Zone
  - getGameRoomCount
```
public int getGameRoomCount()
```
    Specified by:
    
    getGameRoomCount in interface Zone
  - getMaxAllowedRooms
```
public int getMaxAllowedRooms()
```
    The maximum number of Rooms that can be created in the Room.
    
    Specified by:
    
    getMaxAllowedRooms in interface Zone
    
    Returns:
    
    the maximum number of Rooms that can be created in the Room.
  - getMaxUserVariablesAllowed
```
public int getMaxUserVariablesAllowed()
```
    The maximum number of User Variables allowed for each User.
    
    Specified by:
    
    getMaxUserVariablesAllowed in interface Zone
    
    Returns:
    
    the maximum number of User Variables allowed for each User.
  - getMaxAllowedUsers
```
public int getMaxAllowedUsers()
```
    The maximum number of users allowed to join the Zone.
    
    Specified by:
    
    getMaxAllowedUsers in interface Zone
    
    Returns:
    
    the maximum number of users allowed to join the Zone.
  - getMaxRoomsCreatedPerUserLimit
```
public int getMaxRoomsCreatedPerUserLimit()
```
    The maximum number of Rooms that a User can create at once.
    Example: if the limit is == 3 and the User has created Rooms A, B and C he won't be able to create any more Room at least until any of these Rooms is destroyed.
    
    Specified by:
    
    getMaxRoomsCreatedPerUserLimit in interface Zone
    
    Returns:
    
    the maximum number of Rooms that a User can create at once.
  - getName
```
public java.lang.String getName()
```
    The name of the Zone. Each Zone must have a unique name.
    
    Specified by:
    
    getName in interface Zone
    
    Returns:
    
    the name of the Zone.
  - getId
```
public int getId()
```
    A numeric ID used by the AdminTool. The true identifier of a Zone is its name
    
    Specified by:
    
    getId in interface Zone
    
    Returns:
    
    the id
  - getProperty
```
public java.lang.Object getProperty(java.lang.Object key)
```
    Properties are custom values that can be added or removed from the Zone at run-time. They can be used for many purposes, in particular to keep global references that can be shared across multiple objects in the extension code, Rooms etc...
    
    Specified by:
    
    getProperty in interface Zone
    
    Parameters:
    
    key - the name of the property
    
    Returns:
    
    the value of the property, null if the property doesn't exist
  - removeProperty
```
public void removeProperty(java.lang.Object key)
```
    Remove a property.
    
    Specified by:
    
    removeProperty in interface Zone
    
    Parameters:
    
    key - the name of the property.
    
    See Also:
    
    Zone.setProperty(Object, Object)
  - getPublicGroups
```
public java.util.List<java.lang.String> getPublicGroups()
```
    Get a list of names of the "Public" Room Groups available in the Zone. Public Groups are those in which the client is allowed to create Rooms dynamically. The other Groups can be manipulated only via server side code.
    
    Specified by:
    
    getPublicGroups in interface Zone
    
    Returns:
    
    the list of group ids
  - getGroups
```
public java.util.List<java.lang.String> getGroups()
```
    Get the full list of Room Groups available in the Zone. More groups can be added from server side by simply assigning a non-existent Group Id to a newly created Room. As soon as the new Group is detected, it will be added to the Group List
    
    Specified by:
    
    getGroups in interface Zone
    
    Returns:
    
    the list of Room Groups
  - getDefaultGroups
```
public java.util.List<java.lang.String> getDefaultGroups()
```
    Get the list of Groups that each User will be automatically subscribed to when joining the Zone.
    
    Specified by:
    
    getDefaultGroups in interface Zone
    
    Returns:
    
    the list of default groups
    
    See Also:
    
    SFSApi.subscribeRoomGroup(User, String)
  - getRoomById
```
public Room getRoomById(int id)
```
    Get a Room from its unique ID
    
    Specified by:
    
    getRoomById in interface Zone
    
    Parameters:
    
    id - the Room id
    
    Returns:
    
    the Room or null if no Room exists with the specified ID
  - getRoomByName
```
public Room getRoomByName(java.lang.String name)
```
    Get a Room from its name
    
    Specified by:
    
    getRoomByName in interface Zone
    
    Parameters:
    
    name - the Room name
    
    Returns:
    
    the Room or null if no Room exists with the specified name
  - getRoomList
```
public java.util.List<Room> getRoomList()
```
    Get the list of Rooms in the Zone
    
    Specified by:
    
    getRoomList in interface Zone
    
    Returns:
    
    the room list
  - getRoomListFromGroup
```
public java.util.List<Room> getRoomListFromGroup(java.lang.String groupId)
```
    Get the list of Rooms from a specific Group
    
    Specified by:
    
    getRoomListFromGroup in interface Zone
    
    Parameters:
    
    groupId - the id of the group
    
    Returns:
    
    the list of Rooms in the specified Group
  - getUserById
```
public User getUserById(int id)
```
    Get a User from its unique ID
    
    Specified by:
    
    getUserById in interface Zone
    
    Parameters:
    
    id - the User ID
    
    Returns:
    
    the User, or null if no User exists with the provided ID
  - getUserByName
```
public User getUserByName(java.lang.String name)
```
    Get a User from its name
    
    Specified by:
    
    getUserByName in interface Zone
    
    Parameters:
    
    name - the User name
    
    Returns:
    
    the User, or null if no User exists with the provided name
  - getUserBySession
```
public User getUserBySession(ISession session)
```
    Get a User from its Session object
    
    Specified by:
    
    getUserBySession in interface Zone
    
    Parameters:
    
    session - the Session
    
    Returns:
    
    the User, or null if no User exists for the provided Session. In this case it would mean that the client is connected but not logged id.
  - getUserCountChangeUpdateInterval
```
public int getUserCountChangeUpdateInterval()
```
    Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
    A value of zero will use the default, real-time updating that was also present in SmartFoxServer 1.x In high traffic servers these updates could be thousands per second, so we highly recommend to use a slower update rate in order to optimize the network usage. Reasonable values can be in the range of 500ms - 2000ms
    
    Specified by:
    
    getUserCountChangeUpdateInterval in interface Zone
    
    Returns:
    
    the interval in milliseconds between each UserCountUpdate
  - getUCountThrottler
```
public com.smartfoxserver.v2.util.IResponseThrottler getUCountThrottler()
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    getUCountThrottler in interface Zone
  - getDefaultPlayerIdGeneratorClassName
```
public java.lang.String getDefaultPlayerIdGeneratorClassName()
```
    Specified by:
    
    getDefaultPlayerIdGeneratorClassName in interface Zone
  - setDefaultPlayerIdGeneratorClassName
```
public void setDefaultPlayerIdGeneratorClassName(java.lang.String className)
```
    Specified by:
    
    setDefaultPlayerIdGeneratorClassName in interface Zone
  - isUploadEnabled
```
public boolean isUploadEnabled()
```
    True if the Zone supports HTTP uploads.
    
    Specified by:
    
    isUploadEnabled in interface Zone
    
    Returns:
    
    true if the Zone supports HTTP uploads.
  - setUploadEnabled
```
public void setUploadEnabled(boolean val)
```
    Switches on/off the ability to upload data via HTTP. This in turn causes the SFSEventType.FILE_UPLOAD event to be fired at Zone Level.
    
    Specified by:
    
    setUploadEnabled in interface Zone
  - isFilterChainInited
```
public boolean isFilterChainInited()
```
    Returns true if the FilterChain was initialized
    
    Specified by:
    
    isFilterChainInited in interface Zone
    
    Returns:
    
    true if at least one Filter was added to the FilterChain
  - resetSystemFilterChain
```
public void resetSystemFilterChain()
```
    Resets the whole SystemController Filter chain. All filters for any SystemRequest is removed.
    
    Specified by:
    
    resetSystemFilterChain in interface Zone
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    isHidden in interface Zone
  - setHidden
```
public void setHidden(boolean flag)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    setHidden in interface Zone
  - getFilterChain
```
public ISystemFilterChain getFilterChain(SystemRequest requestId)
```
    Obtain a reference to the Zone's SystemFilterChain. Here you can add custom filters that will execute before any System Request is handled by the system itself.
    
    Specified by:
    
    getFilterChain in interface Zone
    
    Parameters:
    
    requestId - the request id associated with the filter chain
    
    Returns:
    
    the SystemFilterChain
    
    See Also:
    
    ISystemFilterChain, ISystemFilter
  - setFilterChain
```
public void setFilterChain(SystemRequest requestId,
                           ISystemFilterChain chain)
```
    Set a SystemFilterChain for a specific SystemController's Request. For example you can set one ore more filters for the CreateRoom request or the PublicMessage etc... The filter chain will be executed before the request is passed to the SystemController.
    
    Specified by:
    
    setFilterChain in interface Zone
    
    Parameters:
    
    requestId - the SystemController request Id
    
    chain - the filter chain
    
    See Also:
    
    SysControllerFilterChain, SysControllerFilter
  - getExtension
```
public ISFSExtension getExtension()
```
    INTERNAL
    
    Specified by:
    
    getExtension in interface Zone
  - setExtension
```
public void setExtension(ISFSExtension extension)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    setExtension in interface Zone
  - getUserReconnectionSeconds
```
public int getUserReconnectionSeconds()
```
    Return the amount of seconds available for a User to reconnect to the system in case their socket connection goes down. A value of zero will turn the reconnection feature off.
    
    Specified by:
    
    getUserReconnectionSeconds in interface Zone
    
    Returns:
    
    the amount of seconds to reconnect.
  - setUserReconnectionSeconds
```
public void setUserReconnectionSeconds(int seconds)
```
    Set the amount of seconds available for a User to reconnect to the system in case their socket connection goes down. A value of zero will turn the reconnection feature off.
    
    Specified by:
    
    setUserReconnectionSeconds in interface Zone
    
    Parameters:
    
    seconds - the amount of seconds to reconnect
  - getMaxUserIdleTime
```
public int getMaxUserIdleTime()
```
    Get the max allowed idle time for a User. When this interval expires the server will disconnect the "idle" User. Any request sent from the client will reset the Idle timer.
    
    Specified by:
    
    getMaxUserIdleTime in interface Zone
    
    Returns:
    
    the time in seconds
  - setMaxUserIdleTime
```
public void setMaxUserIdleTime(int seconds)
```
    Set the max allowed idle time for a User. When this interval expires the server will disconnect the "idle" User. Any request sent from the client will reset the Idle timer.
    
    Specified by:
    
    setMaxUserIdleTime in interface Zone
    
    Parameters:
    
    seconds - the interval
  - getUsersInGroup
```
public java.util.Collection<User> getUsersInGroup(java.lang.String groupId)
```
    Get a list of Users from all Rooms in the provided Room Group
    
    Specified by:
    
    getUsersInGroup in interface Zone
    
    Parameters:
    
    groupId - a group Id
    
    Returns:
    
    the list of Users from all Rooms in the provided Room Group
  - getSessionsInGroup
```
public java.util.Collection<ISession> getSessionsInGroup(java.lang.String groupId)
```
    Get a list of Sessions from all Rooms in the provided Room Group
    
    Specified by:
    
    getSessionsInGroup in interface Zone
    
    Parameters:
    
    groupId - a group Id
    
    Returns:
    
    the list of Sessions from all Rooms in the provided Room Group
  - getSessionsListeningToGroup
```
public java.util.Collection<ISession> getSessionsListeningToGroup(java.lang.String groupId)
```
    Description copied from interface: Zone
    
    Get a list of Sessions listening for events in a specific Group
    
    Specified by:
    
    getSessionsListeningToGroup in interface Zone
    
    Parameters:
    
    groupId - a group Id
    
    Returns:
    
    the list of Sessions listening for events in a specific Group
  - getSessionList
```
public java.util.Collection<ISession> getSessionList()
```
    Get the list of Sessions logged in the Zone
    
    Specified by:
    
    getSessionList in interface Zone
    
    Returns:
    
    the list of Sessions logged in the Zone
  - getUserList
```
public java.util.Collection<User> getUserList()
```
    Get the list of Users logged in the Zone
    
    Specified by:
    
    getUserList in interface Zone
    
    Returns:
    
    the list of Users logged in the Zone
  - getZoneManager
```
public com.smartfoxserver.v2.entities.managers.IZoneManager getZoneManager()
```
    Specified by:
    
    getZoneManager in interface Zone
  - isActive
```
public boolean isActive()
```
    Checks if the Zone is currently enabled in the system or not. Inactive Zones won't allow anyone to login. You can deactivate a Zone at runtime (from the AdminTool) if you are planning to remove it. All Users will be disconnected.
    
    Specified by:
    
    isActive in interface Zone
    
    Returns:
    
    true, if the Zone is active
  - isClientAllowedToOverridRoomEvents
```
public boolean isClientAllowedToOverridRoomEvents()
```
    Deprecated.
    
    Specified by:
    
    isClientAllowedToOverridRoomEvents in interface Zone
  - isCustomLogin
```
public boolean isCustomLogin()
```
    Check if the Zone fires LOGIN events to the Zone extension at login time. This allows the developer to take full control over the login process in their extension code, like checking the credentials etc...
    
    Specified by:
    
    isCustomLogin in interface Zone
    
    Returns:
    
    true if the Zone uses a custom login process
    
    See Also:
    
    SFSEvent, SFSEventType
  - isForceLogout
```
public boolean isForceLogout()
```
    If turned on it allows a User to connect from another location while another connection is already active. This will result in the first session to be disconnected and the new one to be started.
    
    Specified by:
    
    isForceLogout in interface Zone
    
    Returns:
    
    true if the feature is turned on
  - isGuestUserAllowed
```
public boolean isGuestUserAllowed()
```
    Check if the Zone allows guest users (those sending no name and no password). If so the server will automatically set up a "guest name" for the User.
    
    Specified by:
    
    isGuestUserAllowed in interface Zone
    
    Returns:
    
    true if the Zone allows guests
    
    See Also:
    
    Zone.getGuestUserNamePrefix()
  - isSystemEventAllowed
```
public boolean isSystemEventAllowed(java.lang.String eventID)
```
    INTERNAL
    
    Specified by:
    
    isSystemEventAllowed in interface Zone
  - isFilterUserNames
```
public boolean isFilterUserNames()
```
    If turned on the Zone will apply the Words Filter to User names provided at login time
    
    Specified by:
    
    isFilterUserNames in interface Zone
    
    Returns:
    
    true if filtering is turned on
  - isFilterRoomNames
```
public boolean isFilterRoomNames()
```
    If turned on the Zone will apply the Words Filter to Room names
    
    Specified by:
    
    isFilterRoomNames in interface Zone
    
    Returns:
    
    true if filtering is turned on
  - setFilterRoomNames
```
public void setFilterRoomNames(boolean flag)
```
    Toggle the filtering of Room names via the Words Filter.
    
    Specified by:
    
    setFilterRoomNames in interface Zone
    
    Parameters:
    
    flag - a boolean
  - isFilterBuddyMessages
```
public boolean isFilterBuddyMessages()
```
    Toggle the filtering of Buddy messages via the Words Filter.
    
    Specified by:
    
    isFilterBuddyMessages in interface Zone
    
    Returns:
    
    true if buddy messages filtering is turned on
  - setFilterBuddyMessages
```
public void setFilterBuddyMessages(boolean flag)
```
    If turned on the Zone will apply the Words Filter to Buddy messages
    
    Specified by:
    
    setFilterBuddyMessages in interface Zone
  - containsProperty
```
public boolean containsProperty(java.lang.Object key)
```
    Checks the existance of a Zone property
    
    Specified by:
    
    containsProperty in interface Zone
    
    Parameters:
    
    key - the name of the property
    
    Returns:
    
    true if the property exists
  - registerEventsForRoomGroup
```
public void registerEventsForRoomGroup(java.lang.String groupId,
                                       java.util.Set<SFSRoomEvents> flags)
```
    Use SFSApi.subscribeRoomGroup(User, String)
    
    Specified by:
    
    registerEventsForRoomGroup in interface Zone
  - isGroupEventSet
```
public boolean isGroupEventSet(java.lang.String groupId,
                               SFSRoomEvents eventToCheck)
```
    Checks whether a specific Room Event for the specified Group is active
    
    Specified by:
    
    isGroupEventSet in interface Zone
    
    Parameters:
    
    groupId - the group name
    
    eventToCheck - the type of event to check
    
    Returns:
    
    true if the event is active
  - getGroupEvents
```
public java.util.Set<SFSRoomEvents> getGroupEvents(java.lang.String groupId)
```
    Specified by:
    
    getGroupEvents in interface Zone
  - removeDisabledSystemEvent
```
public void removeDisabledSystemEvent(java.lang.String eventID)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    removeDisabledSystemEvent in interface Zone
  - removeRoom
```
public void removeRoom(int roomId)
```
    Use SFSApi.removeRoom(Room)
    
    Specified by:
    
    removeRoom in interface Zone
  - removeRoom
```
public void removeRoom(java.lang.String name)
```
    Use SFSApi.removeRoom(Room)
    
    Specified by:
    
    removeRoom in interface Zone
  - removeRoom
```
public void removeRoom(Room room)
```
    Use SFSApi.removeRoom(Room)
    
    Specified by:
    
    removeRoom in interface Zone
  - checkAndRemove
```
public void checkAndRemove(Room room)
```
    Specified by:
    
    checkAndRemove in interface Zone
  - removeUserFromRoom
```
public void removeUserFromRoom(User user,
                               Room room)
```
    Use SFSApi.leaveRoom(User, Room)
    
    Specified by:
    
    removeUserFromRoom in interface Zone
  - getMinRoomNameChars
```
public int getMinRoomNameChars()
```
    The minimum number of characters allowed for Room name
    
    Specified by:
    
    getMinRoomNameChars in interface Zone
    
    Returns:
    
    the minimum number of characters allowed for Room name
  - setMinRoomNameChars
```
public void setMinRoomNameChars(int minRoomNameChars)
```
    Set the minimum number of characters allowed for a Room name
    
    Specified by:
    
    setMinRoomNameChars in interface Zone
    
    Parameters:
    
    minRoomNameChars - the minimum number of characters allowed for Room name
  - getMaxRoomNameChars
```
public int getMaxRoomNameChars()
```
    The maximum number of characters allowed for a Room name
    
    Specified by:
    
    getMaxRoomNameChars in interface Zone
    
    Returns:
    
    the maximum number of characters allowed for a Room name
  - setMaxRoomNameChars
```
public void setMaxRoomNameChars(int maxRoomNameChars)
```
    Set the maximum number of characters allowed for a Room name
    
    Specified by:
    
    setMaxRoomNameChars in interface Zone
    
    Parameters:
    
    maxRoomNameChars - the maximum number of characters allowed for a Room name
  - setActive
```
public void setActive(boolean flag)
```
    Changes the state of the Zone. De-activating a Zone at runtime will result in an abrupt disconnection of all Users. Use only when strictly necessary.
    
    Specified by:
    
    setActive in interface Zone
    
    Parameters:
    
    flag - the state of the Zone
  - setId
```
public void setId(int id)
```
    Description copied from interface: Zone
    
    A numeric ID used by the AdminTool. The true identifier of a Zone is its name
    
    Specified by:
    
    setId in interface Zone
    
    Parameters:
    
    id - the id
  - setClientAllowedToOverridRoomEvents
```
public void setClientAllowedToOverridRoomEvents(boolean flag)
```
    Deprecated.
    
    Specified by:
    
    setClientAllowedToOverridRoomEvents in interface Zone
  - setCustomLogin
```
public void setCustomLogin(boolean flag)
```
    Description copied from interface: Zone
    
    Set the Zone as Custom login. If turned on the developer's Extension will be able to take control over the login process.
    
    Specified by:
    
    setCustomLogin in interface Zone
    
    See Also:
    
    SFSEvent, SFSEventType
  - setForceLogout
```
public void setForceLogout(boolean flag)
```
    Description copied from interface: Zone
    
    If turned on it allows a User to connect from another location while another connection is already active. This will result in the first session to be disconnected and the new one to be started.
    
    Specified by:
    
    setForceLogout in interface Zone
  - setGuestUserAllowed
```
public void setGuestUserAllowed(boolean flag)
```
    Toggles the Zone guest users (login with no name and no password). If active the server will automatically set up a "guest name" for the User.
    
    Specified by:
    
    setGuestUserAllowed in interface Zone
    
    See Also:
    
    Zone.getGuestUserNamePrefix()
  - setFilterUserNames
```
public void setFilterUserNames(boolean flag)
```
    Toggle the filtering of User names via the Words Filter at login time.
    
    Specified by:
    
    setFilterUserNames in interface Zone
  - setGuestUserNamePrefix
```
public void setGuestUserNamePrefix(java.lang.String prefix)
```
    Set the prefix used by the system to auto-generate guest user names.
    Example: by default the prefix is "Guest#"
    At the end of the prefix it will be added the unique user id.
    
    Specified by:
    
    setGuestUserNamePrefix in interface Zone
  - setMaxAllowedRooms
```
public void setMaxAllowedRooms(int max)
```
    Set the maximum number of Rooms that can be created in the Room.
    
    Specified by:
    
    setMaxAllowedRooms in interface Zone
    
    Parameters:
    
    max - the maximum number of Rooms that can be created in the Room.
  - setMaxAllowedUsers
```
public void setMaxAllowedUsers(int max)
```
    Set the maximum number of users allowed to join the Zone.
    
    Specified by:
    
    setMaxAllowedUsers in interface Zone
    
    Parameters:
    
    max - the max allowed Users
  - setMaxUserVariablesAllowed
```
public void setMaxUserVariablesAllowed(int max)
```
    Set the maximum number of User Variables allowed for each User.
    
    Specified by:
    
    setMaxUserVariablesAllowed in interface Zone
    
    Parameters:
    
    max - the maximum number of User Variables allowed for each User.
  - setMaxRoomsCreatedPerUserLimit
```
public void setMaxRoomsCreatedPerUserLimit(int max)
```
    Set the maximum number of Rooms that a User can create at once.
    
    Specified by:
    
    setMaxRoomsCreatedPerUserLimit in interface Zone
    
    Parameters:
    
    max - the maximum number of Rooms that a User can create at once.
  - setProperty
```
public void setProperty(java.lang.Object key,
                        java.lang.Object value)
```
    Properties are custom values that can be added or removed from the Zone at run-time. They can be used for many purposes, in particular to keep global references that can be shared across multiple objects in the extension code, Rooms etc...
    
    Specified by:
    
    setProperty in interface Zone
    
    Parameters:
    
    key - the name of the property
    
    value - the value of the property
  - setPublicGroups
```
public void setPublicGroups(java.util.List<java.lang.String> groupIDs)
```
    Specified by:
    
    setPublicGroups in interface Zone
  - setDefaultGroups
```
public void setDefaultGroups(java.util.List<java.lang.String> groupIDs)
```
    Specified by:
    
    setDefaultGroups in interface Zone
  - setUserCountChangeUpdateInterval
```
public void setUserCountChangeUpdateInterval(int interval)
```
    Set the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
    
    Specified by:
    
    setUserCountChangeUpdateInterval in interface Zone
    
    Parameters:
    
    interval - the interval in ms between each UserCountUpdate. Recommended range: 500-2000ms.
  - setZoneManager
```
public void setZoneManager(com.smartfoxserver.v2.entities.managers.IZoneManager manager)
```
    Specified by:
    
    setZoneManager in interface Zone
  - validateUserName
```
public void validateUserName(java.lang.String name)
                      throws SFSException
```
    Specified by:
    
    validateUserName in interface Zone
    
    Throws:
    
    SFSException
  - getFloodFilter
```
public IFloodFilter getFloodFilter()
```
    INTERNAL
    
    Specified by:
    
    getFloodFilter in interface Zone
  - getWordFilter
```
public IWordFilter getWordFilter()
```
    INTERNAL
    
    Specified by:
    
    getWordFilter in interface Zone
  - removeAllUsers
```
public void removeAllUsers()
```
    Specified by:
    
    removeAllUsers in interface Zone
  - removeUser
```
public void removeUser(int userId)
```
    INTERNAL
    Instead use SFSApi.disconnectUser(User)
    
    Specified by:
    
    removeUser in interface Zone
  - removeUser
```
public void removeUser(ISession session)
```
    INTERNAL
    Instead use SFSApi.disconnect(ISession)
    
    Specified by:
    
    removeUser in interface Zone
  - removeUser
```
public void removeUser(java.lang.String userName)
```
    INTERNAL
    Instead use SFSApi.disconnectUser(User)
    
    Specified by:
    
    removeUser in interface Zone
  - removeUser
```
public void removeUser(User user)
```
    INTERNAL
    Instead use SFSApi.disconnectUser(User)
    
    Specified by:
    
    removeUser in interface Zone
  - getMaxRoomVariablesAllowed
```
public int getMaxRoomVariablesAllowed()
```
    The maximum number of Room Variables allowed for each Room.
    NOTE: each Room can set its own limit of Room Variables. However when a Room is created from a client request this Zone limit is applied.
    
    Specified by:
    
    getMaxRoomVariablesAllowed in interface Zone
    
    Returns:
    
    the maximum number of Room Variables allowed for each Room.
  - setMaxRoomVariablesAllowed
```
public void setMaxRoomVariablesAllowed(int max)
```
    Set the maximum number of Room variables allowed in the Room
    
    Specified by:
    
    setMaxRoomVariablesAllowed in interface Zone
    
    Parameters:
    
    max - the maximum number of Room variables allowed in the Room
    NOTE: each Room can set its own limit of Room Variables. However when a Room is created from a client request this Zone limit is applied.
  - getPrivilegeManager
```
public PrivilegeManager getPrivilegeManager()
```
    Specified by:
    
    getPrivilegeManager in interface Zone
  - setPrivilegeManager
```
public void setPrivilegeManager(PrivilegeManager privilegeManager)
```
    Specified by:
    
    setPrivilegeManager in interface Zone
  - getBuddyListManager
```
public BuddyListManager getBuddyListManager()
```
    INTERNAL
    Instead use SFSBuddyApi
    
    Specified by:
    
    getBuddyListManager in interface Zone
  - setBuddyListManager
```
public void setBuddyListManager(BuddyListManager buddyListManager)
```
    INTERNAL
    
    Specified by:
    
    setBuddyListManager in interface Zone
  - getDBManager
```
public IDBManager getDBManager()
```
    Obtain a reference to the Zone's Database Manager.
    
    Specified by:
    
    getDBManager in interface Zone
    
    See Also:
    
    SFSDBManager
  - setDBManager
```
public void setDBManager(IDBManager manager)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    setDBManager in interface Zone
  - isFilterPrivateMessages
```
public boolean isFilterPrivateMessages()
```
    If turned on the Zone will apply the Words Filter to private messages
    
    Specified by:
    
    isFilterPrivateMessages in interface Zone
    
    Returns:
    
    true if the Words Filter is applied to private messages
  - setFilterPrivateMessages
```
public void setFilterPrivateMessages(boolean flag)
```
    Toggle the filtering of private messages via the Words Filter.
    
    Specified by:
    
    setFilterPrivateMessages in interface Zone
  - login
```
public User login(LoginData loginData)
           throws SFSLoginException
```
    INTERNAL
    Instead use SFSApi.login(ISession, String, String, String, com.smartfoxserver.v2.entities.data.ISFSObject)
    
    Specified by:
    
    login in interface Zone
    
    Throws:
    
    SFSLoginException
  - getRoomListData
```
public ISFSArray getRoomListData()
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    getRoomListData in interface Zone
  - getRoomListData
```
public ISFSArray getRoomListData(java.util.List<java.lang.String> groupIds)
```
    Description copied from interface: Zone
    
    INTERNAL
    
    Specified by:
    
    getRoomListData in interface Zone
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getDump
```
public java.lang.String getDump()
```
    Specified by:
    
    getDump in interface Zone
  - getAdminHelper
```
public com.smartfoxserver.v2.util.IAdminHelper getAdminHelper()
```
  - setAdminHelper
```
public void setAdminHelper(com.smartfoxserver.v2.util.IAdminHelper adminHelper)
```
  - initRoomPersistence
```
public void initRoomPersistence(RoomStorageMode mode,
                                BaseStorageConfig config)
```
    Initializes the Room Persistence functionality. Typically you will invoke this method in the init() method of your Extension.
    The Room Persistence API provides two different storage systems for Rooms:
    - FILE_STORAGE:
    - DB_STORAGE
    Specified by:
    
    initRoomPersistence in interface Zone
    
    config - an optional config object. At the moment it is required only for DB_STORAGE mode only.
    
    See Also:
    
    RoomStorageMode, SFSDBManager, IRoomStorage
  - getRoomPersistenceApi
```
public IRoomStorage getRoomPersistenceApi()
```
    Obtain the Room Persistence API object.
    IMPORTANT: it is necessary to first initialize the Persistence system before accessing it. Failing this will return a null object.
    
    Specified by:
    
    getRoomPersistenceApi in interface Zone
    
    Returns:
    
    the Room Persistence API object or null if the API was not initialized.
    
    See Also:
    
    Zone.initRoomPersistence(RoomStorageMode, BaseStorageConfig), IRoomStorage
  - isEncrypted
```
public boolean isEncrypted()
```
    True if protocol cryptography is turned on in this Zone. Requests sent unencrypted when the flag is turned ON will result in a sudden client disconnection.
    
    Specified by:
    
    isEncrypted in interface Zone
    
    Returns:
    
    returns true if protocol cryptography is turned on in this Zone
  - setEncrypted
```
public void setEncrypted(boolean value)
```
    Toggles the protocol cryptography.
    
    Specified by:
    
    setEncrypted in interface Zone
    
    Parameters:
    
    value - toggles protocol cryptography.
  - getMaxInvitationsPerRequest
```
public int getMaxInvitationsPerRequest()
```
    Get the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
    
    Specified by:
    
    getMaxInvitationsPerRequest in interface Zone
    
    Returns:
    
    the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
  - setMaxInvitationsPerRequest
```
public void setMaxInvitationsPerRequest(int maxInvitationsPerRequest)
```
    Set the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
    
    Specified by:
    
    setMaxInvitationsPerRequest in interface Zone
    
    Parameters:
    
    maxInvitationsPerRequest - the max number of people that can be invited in each request
  - isAllowInvitationsOnlyForBuddies
```
public boolean isAllowInvitationsOnlyForBuddies()
```
    True if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
    
    Specified by:
    
    isAllowInvitationsOnlyForBuddies in interface Zone
    
    Returns:
    
    True if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
  - setAllowInvitationsOnlyForBuddies
```
public void setAllowInvitationsOnlyForBuddies(boolean allowInvitationsOnlyForBuddies)
```
    Set to true if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
    
    Specified by:
    
    setAllowInvitationsOnlyForBuddies in interface Zone
  - getMaxFailedLogins
```
public int getMaxFailedLogins()
```
    Description copied from interface: Zone
    
    The max number of login attempts (in the same session) a user can fail before being disconnected.
    
    Specified by:
    
    getMaxFailedLogins in interface Zone
    
    Returns:
    
    the max number of login attempts (in the same session) a user can fail before being disconnected.
  - setMaxFailedLogins
```
public void setMaxFailedLogins(int value)
```
    Description copied from interface: Zone
    
    Set the max number of login attempts (in the same session) a user can fail before being disconnected.
    
    Specified by:
    
    setMaxFailedLogins in interface Zone
    
    Parameters:
    
    value - the max number of login attempts (in the same session) a user can fail before being disconnected.
  - isGeoLocationEnabled
```
public boolean isGeoLocationEnabled()
```
    Description copied from interface: Zone
    
    Toggles geolocation for clients.
    
    Specified by:
    
    isGeoLocationEnabled in interface Zone
    
    Returns:
    
    true if geolocation is enabled in this Zone
  - setGeoLocationEnabled
```
public void setGeoLocationEnabled(boolean value)
```
    Description copied from interface: Zone
    
    Toggles geolocation for clients.
    NOTE:IP address geolocation is done via a local database so the added performance cost is negligible.
    
    Specified by:
    
    setGeoLocationEnabled in interface Zone
    
    Parameters:
    
    value - true to enable the geolocation service, false to turn it off. Default = false
  - getMaxFindUserResults
```
public int getMaxFindUserResults()
```
    Description copied from interface: Zone
    
    Get the max number of "Find User" results for a client request. Default is 50.
    
    Specified by:
    
    getMaxFindUserResults in interface Zone
  - setMaxFindUserResults
```
public void setMaxFindUserResults(int value)
```
    Description copied from interface: Zone
    
    Set the max number of "FindUser" results for a client request. Default is 50.
    
    Specified by:
    
    setMaxFindUserResults in interface Zone
  - getMaxFindRoomResults
```
public int getMaxFindRoomResults()
```
    Description copied from interface: Zone
    
    Get the max number of "FindRoom" results for a client request. Default is 50.
    
    Specified by:
    
    getMaxFindRoomResults in interface Zone
  - setMaxFindRoomResults
```
public void setMaxFindRoomResults(int value)
```
    Description copied from interface: Zone
    
    Set the max number of "FindRoom" results for a client request. Default is 50.
    
    Specified by:
    
    setMaxFindRoomResults in interface Zone

Class SFSZone

Overview

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SFSZone

Method Detail

getRoomManager

getUserManager

containsGroup

containsPublicGroup

createRoom

createRoom

changeRoomName

changeRoomPasswordState

changeRoomCapacity

addDisabledSystemEvent

addRoom

getGuestUserNamePrefix

getUserCount

getTotalRoomCount

getGameRoomCount

getMaxAllowedRooms

getMaxUserVariablesAllowed

getMaxAllowedUsers

getMaxRoomsCreatedPerUserLimit

getName

getId

getProperty

removeProperty

getPublicGroups

getGroups

getDefaultGroups

getRoomById

getRoomByName

getRoomList

getRoomListFromGroup

getUserById

getUserByName

getUserBySession

getUserCountChangeUpdateInterval

getUCountThrottler

getDefaultPlayerIdGeneratorClassName

setDefaultPlayerIdGeneratorClassName

isUploadEnabled

setUploadEnabled

isFilterChainInited

resetSystemFilterChain

isHidden

setHidden

getFilterChain

setFilterChain

getExtension

setExtension

getUserReconnectionSeconds

setUserReconnectionSeconds

getMaxUserIdleTime

setMaxUserIdleTime

getUsersInGroup

getSessionsInGroup

getSessionsListeningToGroup

getSessionList

getUserList

getZoneManager

isActive

isClientAllowedToOverridRoomEvents

isCustomLogin

isForceLogout

isGuestUserAllowed

isSystemEventAllowed

isFilterUserNames

isFilterRoomNames

setFilterRoomNames

isFilterBuddyMessages

setFilterBuddyMessages

containsProperty

registerEventsForRoomGroup

isGroupEventSet

getGroupEvents