A B C D E F G H I J L M N O P R S T U V W

A

Account - Interface in net.user1.union.api

An Account represents a persistent user in the Union Server.

ACCOUNT_CREATE_REQUESTED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when there is a request to create an account.

ACCOUNT_CREATED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a persistent client account has been created on the server.

ACCOUNT_EXISTS - Static variable in class net.user1.union.api.Status

ACCOUNT_NOT_FOUND - Static variable in class net.user1.union.api.Status

ACCOUNT_REMOVED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a persistent client account has been removed.

AccountEvent - Class in net.user1.union.core.event

AccountEvent is a simple data class used to pass information from an account to registered event-listeners when an event occurs.

AccountEvent(Account) - Constructor for class net.user1.union.core.event.AccountEvent

Constructor.

AccountNotFoundException - Exception in net.user1.union.core.exception

AccountNotFoundException() - Constructor for exception net.user1.union.core.exception.AccountNotFoundException

AccountNotFoundException(String) - Constructor for exception net.user1.union.core.exception.AccountNotFoundException

AccountNotFoundException(String, Throwable) - Constructor for exception net.user1.union.core.exception.AccountNotFoundException

ADD_CLIENT - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client has joined the room.

ADD_OBSERVER - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client observes the room.

ADD_SLAVE_ROOM - Static variable in class net.user1.union.core.event.RemoteRoomEvent

Dispatched by a room when a slave room has been created on another node.

addAttribute(String, String) - Method in class net.user1.union.core.def.ModuleDef

Add an attribute to the module.

addAttribute(AttributeDef) - Method in class net.user1.union.core.def.RoomDef

Add an attribute to the room.

addClientEventListener(Client, String, String) - Method in interface net.user1.union.api.ScriptWrapper

Add a client event listener to the given room.

addEventListener(String, Object, String) - Method in interface net.user1.union.core.event.EventProducer

Adds an event listener to this EventProducer.

addModule(ModuleDef) - Method in class net.user1.union.core.def.RoomDef

Add a room module to be deployed with the room.

addRemoteEventListener(String, Object, String) - Method in interface net.user1.union.core.event.RemoteEventProducer

Adds an event listener to this RemoteEventProducer.

addRoomEventListener(String, String) - Method in interface net.user1.union.api.ScriptWrapper

Add a room event listener to the room to which the room module script is attached.

addRoomEventListener(Room, String, String) - Method in interface net.user1.union.api.ScriptWrapper

Add a room event listener to the given room.

addServerEventListener(String, String) - Method in interface net.user1.union.api.ScriptWrapper

Add an event listener to the server.

ADMIN_MAX_UPDATE_LEVEL - Static variable in enum net.user1.union.core.UpdateLevel

The maximum update levels for an admin.

ALL_ATTRIBUTE_UPDATES - Static variable in enum net.user1.union.core.UpdateLevel

And (&) of all attribute update bits (client and room).

ALREADY_ASSIGNED - Static variable in class net.user1.union.api.Status

ALREADY_BANNED - Static variable in class net.user1.union.api.Status

ALREADY_IN_ROOM - Static variable in class net.user1.union.api.Status

ALREADY_LOGGED_IN - Static variable in class net.user1.union.api.Status

ALREADY_OBSERVING - Static variable in class net.user1.union.api.Status

ALREADY_WATCHING - Static variable in class net.user1.union.api.Status

ATTR_CLUSTER_TYPE - Static variable in interface net.user1.union.api.Room

ATTR_CONNECTIONTYPE - Static variable in interface net.user1.union.api.Client

ATTR_CONNECTTIME - Static variable in interface net.user1.union.api.Client

ATTR_DIE_ON_EMPTY - Static variable in interface net.user1.union.api.Room

ATTR_GATEWAYID - Static variable in interface net.user1.union.api.Client

ATTR_GATEWAYTYPE - Static variable in interface net.user1.union.api.Client

ATTR_IP - Static variable in interface net.user1.union.api.Client

ATTR_LASTACTIVE - Static variable in interface net.user1.union.api.Client

ATTR_MAX_CLIENTS - Static variable in interface net.user1.union.api.Room

ATTR_MAX_UPDATE_LEVEL - Static variable in interface net.user1.union.api.Room

ATTR_NOT_FOUND - Static variable in class net.user1.union.api.Status

ATTR_PASSWORD - Static variable in interface net.user1.union.api.Room

ATTR_ROLES - Static variable in interface net.user1.union.api.Client

ATTR_SCRIPT_FILE - Static variable in class net.user1.union.core.def.ModuleDef

If the module is written as a script this attribute is a path to the script file from UNION_HOME/modules.

ATTR_TYPE - Static variable in interface net.user1.union.api.Client

ATTR_UPC_VERSION - Static variable in interface net.user1.union.api.Client

ATTR_UPDATE_LEVEL - Static variable in interface net.user1.union.api.Client

ATTR_USERAGENT - Static variable in interface net.user1.union.api.Client

Attribute - Interface in net.user1.union.core.attribute

Attributes are values that can be set on AttributeHolders.

ATTRIBUTE_CHANGED - Static variable in class net.user1.union.core.event.ClientEvent

Dispatched when a client attribute changes.

ATTRIBUTE_CHANGED - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a room attribute changes.

ATTRIBUTE_REMOVED - Static variable in class net.user1.union.core.event.ClientEvent

Dispatched when a client attribute is removed.

ATTRIBUTE_REMOVED - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a room attribute is removed.

AttributeDef - Class in net.user1.union.core.def

AttributeDef() - Constructor for class net.user1.union.core.def.AttributeDef

AttributeDef(String, String) - Constructor for class net.user1.union.core.def.AttributeDef

AttributeDef(String, Object, int) - Constructor for class net.user1.union.core.def.AttributeDef

AttributeException - Exception in net.user1.union.core.exception

Thrown when an Exception occurs while using attributes.

AttributeException() - Constructor for exception net.user1.union.core.exception.AttributeException

AttributeException(String) - Constructor for exception net.user1.union.core.exception.AttributeException

AttributeException(String, Throwable) - Constructor for exception net.user1.union.core.exception.AttributeException

AttributeHolder - Interface in net.user1.union.core.attribute

An AttributeHolder can have attributes.

AUTHORIZATION_FAILED - Static variable in class net.user1.union.api.Status

AUTHORIZATION_REQUIRED - Static variable in class net.user1.union.api.Status

B

banClient(String, int, String) - Method in interface net.user1.union.api.Security

Ban a client from connecting to the server.

BanInterval - Class in net.user1.union.security

BanInterval() - Constructor for class net.user1.union.security.BanInterval

BannedDetails - Class in net.user1.union.security

Contains information about a client that was banned.

BannedDetails(String, long, int, String) - Constructor for class net.user1.union.security.BannedDetails

BaseEvent - Class in net.user1.union.core.event

This is the base class for all events dispatched in the server.

BaseEvent() - Constructor for class net.user1.union.core.event.BaseEvent

Constructor.

BaseEvent(Map<String, Object>) - Constructor for class net.user1.union.core.event.BaseEvent

Constructor.

bit - Variable in enum net.user1.union.core.UpdateLevel

The bit that indicates the UpdateLevel is set.

bit - Variable in enum net.user1.union.security.SecurityRole

C

changeAccountPassword(String, String, String) - Method in interface net.user1.union.api.Server

Change the password for an account

checkAccountInfoAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to account information.

checkAccountListAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the account list.

checkAddRole(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to add roles to clients.

checkBan(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to ban addresses.

checkBannedListAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the list of the banned addresses.

checkClientInfoAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to client information (eg.

checkClientListAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the client list.

checkCreateAccount(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to create accounts.

checkCreateRoom(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to create rooms.

checkJoinRoom(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to join the room.

checkKickClient(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to kick other clients.

checkLogin(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to login.

checkLogoff(Client, Account) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to logoff the account.

checkModifyAccountAttribute(Client, Account) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to modify the attributes of the account.

checkModifyClientAttribute(Client, Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the acting client is not allowed to modify the attributes of the target client.

checkModifyRoomAttribute(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to modify the attributes of the room.

checkModifyRoomSetting(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to modify the settings of the room.

checkModuleAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the module list and cannot clear the module cache.

checkNodeListAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the list of nodes connected to this server.

checkRemoveAccount(Client, Account) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to remove an account.

checkRemoveRole(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to add remove roles from clients.

checkRemoveRoom(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to remove the room.

checkRoomInfoAccess(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to room information.

checkRoomListAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the room list.

checkSendMessageToClient(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to send messages to clients.

checkSendMessageToRoom(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to send messages to rooms.

checkSendMessageToServer(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to send messages to the entire server.

checkSendRoomModuleMessage(Client, Room) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to send a room module message to the room.

checkSendServerModuleMessage(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to send server module messages.

checkServerStatisticsAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to the server statistics.

checkUnban(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed to unban addresses.

checkUPCAccess(Client) - Method in interface net.user1.union.api.Security

Throws a UnionSecurityException if the client is not allowed access to UPC stats or to listen to the UPCs being processed on the server.

CLASS - Static variable in class net.user1.union.core.def.ModuleDef

Denotes that the module is written as a Java class.

clearAccountCache() - Method in interface net.user1.union.api.Server

For efficiency Union uses a cache for recently used Accounts.

Client - Interface in net.user1.union.api

A client is a single user in the system who has connected to the server.

CLIENT_ADDED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a client has been added to the server.

CLIENT_LOGIN - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a client logs in to the server.

CLIENT_LOGOFF - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a client logs off from the server.

CLIENT_NOT_FOUND - Static variable in class net.user1.union.api.Status

CLIENT_READY - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a Reactor client has joined the server and is now ready to send and receive messages.

CLIENT_REMOVED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a client leaves the server.

CLIENT_SHUTDOWN - Static variable in class net.user1.union.api.Status

ClientEvent - Class in net.user1.union.core.event

ClientEvent is a simple data class used to pass information from a client to registered event-listeners when a client event occurs.

ClientEvent(Client) - Constructor for class net.user1.union.core.event.ClientEvent

Constructor.

ClientEvent(Client, Attribute) - Constructor for class net.user1.union.core.event.ClientEvent

ClientNotFoundException - Exception in net.user1.union.core.exception

Thrown when trying to obtain a reference to a client by using it's client ID but no such client exists.

ClientNotFoundException() - Constructor for exception net.user1.union.core.exception.ClientNotFoundException

ClientNotFoundException(String) - Constructor for exception net.user1.union.core.exception.ClientNotFoundException

ClientNotFoundException(String, Throwable) - Constructor for exception net.user1.union.core.exception.ClientNotFoundException

Cluster - Interface in net.user1.union.api

The cluster controls behaviour related to communication within the cluster.

Connection - Interface in net.user1.union.api

Represents a Connection to Union.

containsAccount(String) - Method in interface net.user1.union.api.Datasource

Asks the datasource if the account exists for the given userID.

containsAccount(String) - Method in interface net.user1.union.api.Server

Returns true if the server has an account (logged in or not) for the userID.

containsClient(Client) - Method in interface net.user1.union.api.Room

Returns true if the client is in the room, false otherwise.

containsClient(String) - Method in interface net.user1.union.api.Server

Returns true if a client with the given ID exists on the server.

containsObserver(Client) - Method in interface net.user1.union.api.Room

Returns true if the Client is an observer of the room, false otherwise.

containsRoom(String) - Method in interface net.user1.union.api.Server

Returns true if a room with the given ID exists on the server.

createAccount(String, String) - Method in interface net.user1.union.api.Datasource

Create an account on the server.

createAccount(String, String) - Method in interface net.user1.union.api.Server

Create an account on the server.

CreateGatewayException - Exception in net.user1.union.core.exception

Thrown when trying to create a module if the module cannot be created.

CreateGatewayException() - Constructor for exception net.user1.union.core.exception.CreateGatewayException

CreateGatewayException(String) - Constructor for exception net.user1.union.core.exception.CreateGatewayException

CreateGatewayException(String, Throwable) - Constructor for exception net.user1.union.core.exception.CreateGatewayException

createModule(ModuleDef) - Method in interface net.user1.union.api.Server

Creates the module based on the given ModuleDef.

CreateModuleException - Exception in net.user1.union.core.exception

Thrown when trying to create a module if the module cannot be created.

CreateModuleException() - Constructor for exception net.user1.union.core.exception.CreateModuleException

CreateModuleException(String) - Constructor for exception net.user1.union.core.exception.CreateModuleException

CreateModuleException(String, Throwable) - Constructor for exception net.user1.union.core.exception.CreateModuleException

createRoom(RoomDef) - Method in interface net.user1.union.api.Server

Creates a room based on the given RoomDef.

CreateRoomException - Exception in net.user1.union.core.exception

Thrown when trying to create a room if the room cannot be created.

CreateRoomException() - Constructor for exception net.user1.union.core.exception.CreateRoomException

CreateRoomException(String) - Constructor for exception net.user1.union.core.exception.CreateRoomException

CreateRoomException(String, Throwable) - Constructor for exception net.user1.union.core.exception.CreateRoomException

D

Datasource - Interface in net.user1.union.api

A Datasource saves/retrieves persistent information on the server.

DatasourceContext - Interface in net.user1.union.core.context

DatasourceContext contains contextual information about the environment in which a datasource is running.

DatasourceException - Exception in net.user1.union.core.exception

DatasourceException() - Constructor for exception net.user1.union.core.exception.DatasourceException

DatasourceException(String) - Constructor for exception net.user1.union.core.exception.DatasourceException

DatasourceException(String, Throwable) - Constructor for exception net.user1.union.core.exception.DatasourceException

DatasourceException(Throwable) - Constructor for exception net.user1.union.core.exception.DatasourceException

dispatchEvent(String, Event) - Method in interface net.user1.union.core.event.EventProducer

Has the event producer dispatch an event.

dispatchRemoteEvent(String, RemoteEvent) - Method in interface net.user1.union.core.event.RemoteEventProducer

Has the event producer dispatch a remote event.

dispatchRemoteEvent(String, RemoteEvent, String) - Method in interface net.user1.union.core.event.RemoteEventProducer

Has the event producer dispatch a remote event to the specified node only.

dispose() - Method in interface net.user1.union.api.Account

Disposes of a reference count for the Account in the cache.

doFilter(Client) - Method in interface net.user1.union.filter.Filter

Returns true if the client has passed the filter criteria.

E

equals(Object) - Method in class net.user1.union.core.def.AttributeDef

ERROR - Static variable in class net.user1.union.api.Status

EVALUATION_FAILED - Static variable in class net.user1.union.api.Status

EvaluationFailedAttributeException - Exception in net.user1.union.core.exception

Thrown when trying to set an attribute that should be evaluated.

EvaluationFailedAttributeException() - Constructor for exception net.user1.union.core.exception.EvaluationFailedAttributeException

EvaluationFailedAttributeException(String) - Constructor for exception net.user1.union.core.exception.EvaluationFailedAttributeException

EvaluationFailedAttributeException(String, Throwable) - Constructor for exception net.user1.union.core.exception.EvaluationFailedAttributeException

Event - Interface in net.user1.union.core.event

All events dispatched in the server implement the Event interface.

EventProducer - Interface in net.user1.union.core.event

An EventProducer is capable of dispatching events to listeners who have registered to receive those events.

F

FIFTEEN_MINUTES - Static variable in class net.user1.union.security.BanInterval

FIFTEEN_SECONDS - Static variable in class net.user1.union.security.BanInterval

Filter - Interface in net.user1.union.filter

Filters can be used when sending messages to determine if a client will receive the message or not.

FLAG_EVALUATE - Static variable in interface net.user1.union.core.attribute.Attribute

Indicates the value of the attribute should be evaluated as a mathematical expression before assignment.

FLAG_IGNORE - Static variable in interface net.user1.union.core.attribute.Attribute

FLAG_IMMUTABLE - Static variable in interface net.user1.union.core.attribute.Attribute

Indicates that once the attribute is set it can no longer be changed.

FLAG_NONE - Static variable in interface net.user1.union.core.attribute.Attribute

FLAG_PERSISTENT - Static variable in interface net.user1.union.core.attribute.Attribute

Flags that the attribute should be persisted by a datasource.

FLAG_SERVER_ONLY - Static variable in interface net.user1.union.core.attribute.Attribute

Indicates the attribute can be changed only by code on the server (i.e.

FLAG_SHARED - Static variable in interface net.user1.union.core.attribute.Attribute

Flags the attribute should be shared.

FLAG_SOFTLY_PERSISTENT - Static variable in interface net.user1.union.core.attribute.Attribute

Unsupported in Alpha

FOREVER - Static variable in class net.user1.union.security.BanInterval

G

GatewayAlreadyExistsException - Exception in net.user1.union.core.exception

GatewayAlreadyExistsException() - Constructor for exception net.user1.union.core.exception.GatewayAlreadyExistsException

GatewayAlreadyExistsException(String) - Constructor for exception net.user1.union.core.exception.GatewayAlreadyExistsException

GatewayAlreadyExistsException(String, Throwable) - Constructor for exception net.user1.union.core.exception.GatewayAlreadyExistsException

GatewayNotFoundException - Exception in net.user1.union.core.exception

Thrown when trying to obtain a reference to a module by using it's module ID but no such module exists.

GatewayNotFoundException() - Constructor for exception net.user1.union.core.exception.GatewayNotFoundException

GatewayNotFoundException(String) - Constructor for exception net.user1.union.core.exception.GatewayNotFoundException

GatewayNotFoundException(String, Throwable) - Constructor for exception net.user1.union.core.exception.GatewayNotFoundException

getAccount() - Method in interface net.user1.union.api.Client

Get the Account for the client.

getAccount(String) - Method in interface net.user1.union.api.Server

Returns the account for the given userID.

getAccount() - Method in class net.user1.union.core.event.AccountEvent

For all events this returns the account involved in the event.

getAccounts() - Method in interface net.user1.union.api.Datasource

Returns a list of the userIDs for all persistent accounts.

getAction(String) - Static method in enum net.user1.union.security.SecurityAction

getAddress() - Method in interface net.user1.union.api.Client

Returns the address (determined by the Connection type) for this client.

getAddress() - Method in interface net.user1.union.api.Connection

Return the address that will be used to identify this Connection (eg.

getAddress() - Method in class net.user1.union.security.BannedDetails

getAffinityAddress() - Method in interface net.user1.union.api.Cluster

Get the affinity address for the node if configured.

getAffinityDuration() - Method in interface net.user1.union.api.Cluster

Get the affinity duration for the node if configured.

getArg(String) - Method in interface net.user1.union.api.Message

Gets an argument in the message or null if no argument with the name given exists.

getArgs() - Method in interface net.user1.union.api.Message

Gets a map of all of the args in the message.

getAttribute(String, String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Gets an attribute or null if no such attribute exists.

getAttribute(String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Gets a global scope (Attribute.SCOPE_GLOBAL) attribute with the given name or null if no such attribute exists.

getAttribute() - Method in class net.user1.union.core.event.ClientEvent

In ATTRIBUTE_CHANGED, and ATTRIBUTE_REMOVED events this returns the attribute involved in the event.

getAttribute() - Method in class net.user1.union.core.event.RoomEvent

In ATTRIBUTE_CHANGED, and ATTRIBUTE_REMOVED events this returns the attribute involved in the event.

getAttributes(String, int) - Method in interface net.user1.union.core.attribute.AttributeHolder

Returns the list of attributes in the given scope that match the given flags.

getAttributes() - Method in interface net.user1.union.core.attribute.AttributeHolder

Returns all of the attributes for this AttributeHolder.

getAttributes() - Method in interface net.user1.union.core.context.DatasourceContext

Returns a name-value map of the attributes that have been set for this datasource.

getAttributes() - Method in interface net.user1.union.core.context.ModuleContext

Returns a name-value map of the attributes that have been set for this module.

getAttributes() - Method in class net.user1.union.core.def.ModuleDef

Get the attributes that have been set for the module.

getAttributes() - Method in class net.user1.union.core.def.RoomDef

Get the attributes set for this room.

getAttributesByScope() - Method in interface net.user1.union.core.attribute.AttributeHolder

Returns all of the attributes on the server.

getAttributeValue(String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Returns the value of the attribute with the given name from the global scope (Attribute.SCOPE_GLOBAL) or null if the attribute doesn't exist.

getAttributeValue(String, String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Returns the value of the attribute with the given name from the given scope or null if the attribute doesn't exist.

getBannedAt() - Method in class net.user1.union.security.BannedDetails

getBannedDetails(String) - Method in interface net.user1.union.api.Security

Returns the banned details for an address.

getBannedList() - Method in interface net.user1.union.api.Security

Return a list of Objects containing information about the banned addresses.

getClient() - Method in interface net.user1.union.api.Account

Returns the currently connected client for this account if the account is logged in.

getClient() - Method in interface net.user1.union.api.Request

Get the client who made the request.

getClient(String) - Method in interface net.user1.union.api.Server

Gets the client with the given ID.

getClient() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the client that sent the UPC.

getClient() - Method in class net.user1.union.core.event.ClientEvent

For all events this returns the client involved in the event.

getClient() - Method in class net.user1.union.core.event.RoomEvent

In MODULE_MESSAGE, ADD_CLIENT, REMOVE_CLIENT, ADD_OBSERVER, and REMOVE_OBSERVER, ROOM_MESSAGE events this returns the client involved in the event.

getClient() - Method in class net.user1.union.core.event.ServerEvent

In CLIENT_ADDED, CLIENT_READY, and CLIENT_REMOVED events this returns the client involved in the event.

getClientByUserID(String) - Method in interface net.user1.union.api.Server

Gets the client with the given userID if the client is currently logged in.

getClientID() - Method in interface net.user1.union.api.Client

Get the ID for the client.

getClients() - Method in interface net.user1.union.api.Room

Returns a reference to all of clients in the room.

getClients() - Method in interface net.user1.union.api.Server

Return a set of the clients currently on the server.

getCluster() - Method in interface net.user1.union.api.Server

Returns access to the Cluster API.

getClusterRole() - Method in interface net.user1.union.api.Room

Returns the role, if any, that the room has within the cluster (eg.

getConnectRefusalRecipients() - Method in interface net.user1.union.api.Security

Returns a Set of the recipients that should receive a CONNECTION_REFUSED (u164) if their connection was refused.

getConnectToServerTime() - Method in interface net.user1.union.api.Client

Deprecated. use getAttribute

getCreationTime() - Method in interface net.user1.union.api.Room

Retrieves the time the room was created.

getCurrentRequest() - Method in interface net.user1.union.api.Server

Get the current request being processed.

getDuration() - Method in class net.user1.union.security.BannedDetails

getEventClassMap() - Method in interface net.user1.union.core.event.EventProducer

Returns a Map of declared events dispatched by the EventProducer keyed by event name and mapped to the event class that is dispatched.

getFlags() - Method in interface net.user1.union.core.attribute.Attribute

Returns the flags set for the attribute.

getFlags() - Method in class net.user1.union.core.def.AttributeDef

getGateway() - Method in interface net.user1.union.api.Connection

Returns the Gateway to which this Connection connected.

getID() - Method in class net.user1.union.core.def.ModuleDef

Gets the ID of the module.

getLastHeartbeatActive() - Method in interface net.user1.union.api.Client

Returns the System time (System.timeCurrentMillis()) the client was last active (i.e.

getLifetimeNumClients() - Method in interface net.user1.union.api.Server

Returns the total number of lifetime connections to the server.

getLifetimeNumRooms() - Method in interface net.user1.union.api.Server

Returns the total number of lifetime rooms created on the server.

getMessage() - Method in class net.user1.union.core.event.RoomEvent

In MODULE_MESSAGE event this returns the message involved in the event.

getMessageName() - Method in interface net.user1.union.api.Message

Returns the name of the message.

getModule(String) - Method in interface net.user1.union.api.Server

Get the module with the given ID.

getName() - Method in interface net.user1.union.core.attribute.Attribute

Returns the name of the attribute

getName() - Method in class net.user1.union.core.def.AttributeDef

getNodeID() - Method in class net.user1.union.core.event.RemoteRoomEvent

Returns the ID of the node where the event originated.

getNodeID() - Method in class net.user1.union.core.event.RemoteServerEvent

Returns the ID of the node where the event originated.

getNodeIDs() - Method in interface net.user1.union.api.Cluster

Get a list of node IDs connected to the server.

getNumClients() - Method in interface net.user1.union.api.Room

Get the number of clients in the room.

getNumClients() - Method in interface net.user1.union.api.Server

Returns the total number of clients on the server.

getNumClientsTotal(String) - Method in interface net.user1.union.api.Server

Returns the total number of clients in the given qualifier.

getNumClientsUnique(String) - Method in interface net.user1.union.api.Server

Returns the total number of unique clients in the given qualifier.

getNumObservers() - Method in interface net.user1.union.api.Room

Get the number of observers spectating the room.

getNumRooms() - Method in interface net.user1.union.api.Server

Returns the total number of rooms on the server.

getOwnerID() - Method in interface net.user1.union.api.Room

Return the client ID of the owner of the room.

getOwnerID() - Method in class net.user1.union.core.def.RoomDef

Get the clientID of the owner of the room.

getPassword() - Method in interface net.user1.union.api.Account

Return the password for the account.

getPassword(String) - Method in interface net.user1.union.api.Datasource

Return the password for the given userID.

getProcessDuration() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the duration (in ms) the UPCMessage took to process.

getProcessFinishedAt() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the time the server finished processing the UPCMessage.

getProcessStartedAt() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the time the server started to process the UPCMessage.

getProperty(String) - Method in class net.user1.union.core.event.BaseEvent

Gets a named property for the event.

getProperty(String) - Method in interface net.user1.union.core.event.Event

Gets a named property for the event.

getQualiferFromFQName(String) - Static method in class net.user1.union.core.util.Util

Returns the qualifier from the given fully qualified name or the empty string if no qualifier exists.

getQualiferScopeFromFQName(String) - Static method in class net.user1.union.core.util.Util

Returns the qualifier scope (i.e.

getQualifiedID() - Method in interface net.user1.union.api.Room

Returns the ID including the qualifier for the room.

getQueuedAt() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the time the server queued the UPCMessage for processing.

getQueuedDuration() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the duration (in ms) the UPCMessage was queued.

getReason() - Method in class net.user1.union.security.BannedDetails

getRefusalDescription() - Method in interface net.user1.union.api.Connection

A string providing information about the condition that led to the refusal.

getRefusalReason() - Method in interface net.user1.union.api.Connection

A string representing the reason for the connection refusal.

getRemoteEventClassMap() - Method in interface net.user1.union.core.event.RemoteEventProducer

Returns a Map of declared remote events dispatched by the RemoteEventProducer keyed by event name and mapped to the remote event class that is dispatched.

getRole(String) - Static method in enum net.user1.union.security.SecurityRole

getRoom(String) - Method in interface net.user1.union.api.Server

Gets a room that is on the server.

getRoom() - Method in interface net.user1.union.core.context.ModuleContext

If this is a room module it returns the room associated with the module.

getRoom() - Method in class net.user1.union.core.event.RoomEvent

For all events this returns the room involved in the event.

getRoom() - Method in class net.user1.union.core.event.ServerEvent

In ROOM_CREATED events this returns the room involved in the event.

getRoomID() - Method in class net.user1.union.core.def.RoomDef

Get the ID of the room.

getRoomID() - Method in class net.user1.union.core.event.RemoteRoomEvent

Returns the ID of the room involved in the event.

getRoomID() - Method in class net.user1.union.core.event.RemoteServerEvent

Returns the ID of the room involved in the event.

getRoomList() - Method in interface net.user1.union.api.Client

Returns the room ID's of Rooms the Client is in.

getRoomModules() - Method in class net.user1.union.core.def.RoomDef

Returns a list of the modules to be deployed with the room.

getRooms() - Method in interface net.user1.union.api.Server

Get a list of all rooms on the server.

getRooms(String) - Method in interface net.user1.union.api.Server

Get a list of rooms on the server that are in the given qualifier.

getScope() - Method in interface net.user1.union.core.attribute.Attribute

Returns the scope of the attribute.

getSecurity() - Method in interface net.user1.union.api.Server

Returns access to the Security API.

getServer() - Method in interface net.user1.union.core.context.DatasourceContext

Gets a reference to the server.

getServer() - Method in interface net.user1.union.core.context.ModuleContext

Gets a reference to the server.

getSimpleID() - Method in interface net.user1.union.api.Room

Returns the Simple ID of the room.

getSimplifiedFromFQName(String) - Static method in class net.user1.union.core.util.Util

Returns the simplified name from a fully qualified name.

getSource() - Method in class net.user1.union.core.def.ModuleDef

Get the source (the Java class or script name) for the module.

getStartTime() - Method in interface net.user1.union.api.Server

Returns the System time (System.currenTimeMillis()) the server was started.

getTotalDuration() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the duration (in ms) from when the UPCMessage was retrieved to when it was finished processing.

getType() - Method in class net.user1.union.core.def.ModuleDef

Gets the module type (SCRIPT or CLASS)

getUPC() - Method in interface net.user1.union.api.UPCProcessingRecord

Returns the UPCMessage that was sent.

getUPCMessage() - Method in interface net.user1.union.api.Request

Get the UPCMessage that was made for the request

getUPCMessage() - Method in class net.user1.union.core.event.RoomEvent

In ROOM_MESSAGE events this returns UPCMessage (u1) that initiated the event.

getUPCMessageProcessor() - Method in interface net.user1.union.api.Server

Returns access to the UPCMessageProcessor API.

getUPCProcessingRecord() - Method in class net.user1.union.core.event.UPCEvent

Returns the UPCProcessingRecord for the UPC.

getUpdateLevels(String) - Method in interface net.user1.union.api.Client

Return the update levels for set for the given roomID.

getUserID() - Method in interface net.user1.union.api.Account

Return the userID for the account.

getUserID() - Method in interface net.user1.union.api.Client

This is a convenience method for retrieving the userID of the client without having to do null check on the client.

getUsers() - Method in interface net.user1.union.api.Server

Returns a list of userIDs for all accounts on the server.

getValue() - Method in interface net.user1.union.core.attribute.Attribute

Returns the value of the attribute.

getValue() - Method in class net.user1.union.core.def.AttributeDef

getVersion() - Method in interface net.user1.union.api.Server

Returns the version of Union.

H

hashCode() - Method in class net.user1.union.core.def.AttributeDef

I

id - Variable in enum net.user1.union.security.SecurityRole

IMMUTABLE - Static variable in class net.user1.union.api.Status

ImmutableAttributeException - Exception in net.user1.union.core.exception

Thrown when trying to set an attribute that has previously been set with the flag Attribute.FLAG_IMMUTABLE.

ImmutableAttributeException() - Constructor for exception net.user1.union.core.exception.ImmutableAttributeException

ImmutableAttributeException(String) - Constructor for exception net.user1.union.core.exception.ImmutableAttributeException

ImmutableAttributeException(String, Throwable) - Constructor for exception net.user1.union.core.exception.ImmutableAttributeException

init(DatasourceContext) - Method in interface net.user1.union.api.Datasource

Called when the datasource is initialized by the server.

init(ModuleContext) - Method in interface net.user1.union.api.Module

Called when the module is initialized.

INIT - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when the underlying room has been initialized.

init(ModuleContext) - Method in class net.user1.union.module.MaxClients

init(ModuleContext) - Method in class net.user1.union.module.MaxConcurrentConnection

init(ModuleContext) - Method in class net.user1.union.module.MaxRooms

initModerator(boolean) - Method in interface net.user1.union.api.Account

Initializes the Account as a moderator.

INVALID_QUALIFIER - Static variable in class net.user1.union.api.Status

isAccountOnline(String) - Method in interface net.user1.union.api.Server

Returns true if the account given by the userID is currently logged in.

isAdmin() - Method in interface net.user1.union.api.Client

Returns true if the client is an administrator.

isAnyAttributeUpdate(int) - Static method in enum net.user1.union.core.UpdateLevel

isBanned(String) - Method in interface net.user1.union.api.Security

Returns true if the given address is banned.

isCanceled() - Method in class net.user1.union.core.event.BaseEvent

Returns true if the default action is to be prevented.

isCanceled() - Method in interface net.user1.union.core.event.Event

Returns true if the default action is to be prevented.

isLoggedIn() - Method in interface net.user1.union.api.Client

Returns true if the client has logged in.

isModerator() - Method in interface net.user1.union.api.Account

Returns true if the account has moderator privileges.

isShutdown() - Method in interface net.user1.union.api.Client

Returns true if shutdown has been called on the client.

isShutdown() - Method in interface net.user1.union.api.Room

Indicates if this room has been shutdown.

isShutdown() - Method in interface net.user1.union.api.Server

Returns true if the server is shutdown.

isValidQualifier(String) - Static method in class net.user1.union.core.util.Util

Returns true if the given qualifier is syntactically valid.

isValidRoomID(String) - Static method in class net.user1.union.core.util.Util

Returns true if the room ID is valid.

J

JOIN_ROOM_REQUESTED - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client requests to join a room.

joinRoom(String, String) - Method in interface net.user1.union.api.Client

Attempts to have client join a room.

L

leaveRoom(String) - Method in interface net.user1.union.api.Client

Removes the client from a room.

loadAccount(Account) - Method in interface net.user1.union.api.Datasource

Load the account fields from the persistent storage.

loadAccountGlobalAttributes(Account) - Method in interface net.user1.union.api.Datasource

The datasource should load any global attributes it has for the account by setting them on the account.

loadAccountRoomAttributes(Account, String) - Method in interface net.user1.union.api.Datasource

Load the account attributes for the specified room.

loadAllAccountAttributes(Account) - Method in interface net.user1.union.api.Datasource

The datasource should load all account attributes it has for the account.

loadRoomAttributes(Room) - Method in interface net.user1.union.api.Datasource

Called when a room is created.

loadServerAttributes(Server) - Method in interface net.user1.union.api.Datasource

Called when the server starts.

login(String, String) - Method in interface net.user1.union.api.Client

Login the client to the server.

logoff(String) - Method in interface net.user1.union.api.Client

Logoff the client from the server.

M

m_eventProperties - Variable in class net.user1.union.core.event.BaseEvent

MaxClients - Class in net.user1.union.module

A module that only allows a configurable number of clients to be connected to the server at the same time.

MaxClients() - Constructor for class net.user1.union.module.MaxClients

MaxConcurrentConnection - Class in net.user1.union.module

A module that only allows a configurable number of clients with the same connection address to connect concurrently.

MaxConcurrentConnection() - Constructor for class net.user1.union.module.MaxConcurrentConnection

MaxRooms - Class in net.user1.union.module

This module enforces a max room limitation on the server.

MaxRooms() - Constructor for class net.user1.union.module.MaxRooms

Message - Interface in net.user1.union.api

A message is the unit of communication for clients, rooms and modules.

Module - Interface in net.user1.union.api

A module extends the functionality of the server or a specific room.

MODULE_MESSAGE - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a message has arrived for the modules attached to the room.

ModuleAlreadyExistsException - Exception in net.user1.union.core.exception

Thrown when trying to set create a module with an ID that already exists.

ModuleAlreadyExistsException() - Constructor for exception net.user1.union.core.exception.ModuleAlreadyExistsException

ModuleAlreadyExistsException(String) - Constructor for exception net.user1.union.core.exception.ModuleAlreadyExistsException

ModuleAlreadyExistsException(String, Throwable) - Constructor for exception net.user1.union.core.exception.ModuleAlreadyExistsException

ModuleContext - Interface in net.user1.union.core.context

ModuleContext contains contextual information about the environment in which a module is running.

ModuleDef - Class in net.user1.union.core.def

A ModuleDef defines how a module should be constructed.

ModuleDef() - Constructor for class net.user1.union.core.def.ModuleDef

ModuleEvent - Class in net.user1.union.core.event

ModuleEvent is a simple data class used to pass information from a module to registered event-listeners when a module event occurs.

ModuleEvent() - Constructor for class net.user1.union.core.event.ModuleEvent

ModuleNotFoundException - Exception in net.user1.union.core.exception

Thrown when trying to obtain a reference to a module by using it's module ID but no such module exists.

ModuleNotFoundException() - Constructor for exception net.user1.union.core.exception.ModuleNotFoundException

ModuleNotFoundException(String) - Constructor for exception net.user1.union.core.exception.ModuleNotFoundException

ModuleNotFoundException(String, Throwable) - Constructor for exception net.user1.union.core.exception.ModuleNotFoundException

N

net.user1.union.api - package net.user1.union.api

net.user1.union.core - package net.user1.union.core

net.user1.union.core.attribute - package net.user1.union.core.attribute

net.user1.union.core.context - package net.user1.union.core.context

net.user1.union.core.def - package net.user1.union.core.def

net.user1.union.core.event - package net.user1.union.core.event

net.user1.union.core.exception - package net.user1.union.core.exception

net.user1.union.core.util - package net.user1.union.core.util

net.user1.union.filter - package net.user1.union.filter

net.user1.union.module - package net.user1.union.module

net.user1.union.security - package net.user1.union.security

NON_ADMIN_MAX_UPDATE_LEVEL - Static variable in enum net.user1.union.core.UpdateLevel

The maximum update levels for a non-admin.

NOT_ASSIGNED - Static variable in class net.user1.union.api.Status

NOT_BANNED - Static variable in class net.user1.union.api.Status

NOT_IN_ROOM - Static variable in class net.user1.union.api.Status

NOT_LOGGED_IN - Static variable in class net.user1.union.api.Status

NOT_OBSERVING - Static variable in class net.user1.union.api.Status

NOT_WATCHING - Static variable in class net.user1.union.api.Status

nullSafeGetValue() - Method in interface net.user1.union.core.attribute.Attribute

Returns the value of the attribute as a String by calling the Object toString() method.

NUM_CLIENTS_CHANGED - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when the number of clients in the room changes.

O

OBSERVE_ROOM_REQUESTED - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client requests to observe room.

observeRoom(String, String) - Method in interface net.user1.union.api.Client

Attempts to have the client observe a room.

onChangeAttribute(Attribute) - Method in interface net.user1.union.core.attribute.AttributeHolder

Callback to attribute holders when an attribute changes.

onClientDisconnect(ServerEvent) - Method in class net.user1.union.module.MaxConcurrentConnection

onConnection(ConnectionEvent) - Method in class net.user1.union.module.MaxClients

onConnection(ConnectionEvent) - Method in class net.user1.union.module.MaxConcurrentConnection

ONE_DAY - Static variable in class net.user1.union.security.BanInterval

ONE_HOUR - Static variable in class net.user1.union.security.BanInterval

ONE_MINUTE - Static variable in class net.user1.union.security.BanInterval

ONE_WEEK - Static variable in class net.user1.union.security.BanInterval

onRemoveAttribute(Attribute) - Method in interface net.user1.union.core.attribute.AttributeHolder

Callback to attribute holders when an attribute is removed.

onRoomCreateRequest(ServerEvent) - Method in class net.user1.union.module.MaxRooms

P

PERMISSION_DENIED - Static variable in class net.user1.union.api.Status

preventDefault() - Method in class net.user1.union.core.event.BaseEvent

Invoking this method on an event will prevent it's default action, if any, from occuring.

preventDefault() - Method in interface net.user1.union.core.event.Event

Invoking this method on an event will prevent it's default action, if any, from occuring.

PROP_PASSWORD - Static variable in class net.user1.union.core.event.ServerEvent

This property contains the String password when ROOM_CREATE_REQUESTED and ACCOUNT_CREATE_REQUESTED are dispatched.

PROP_ROOMDEF - Static variable in class net.user1.union.core.event.RemoteServerEvent

This property contains the RoomDef when REMOTE_ROOM_CREATED is dispatched.

PROP_ROOMDEF - Static variable in class net.user1.union.core.event.ServerEvent

This property contains the RoomDef when ROOM_CREATE_REQUESTED is dispatched.

PROP_USERID - Static variable in class net.user1.union.core.event.ServerEvent

This property contains the String userID when account related events are dispatched.

R

readExternal(ObjectInput) - Method in class net.user1.union.core.def.AttributeDef

readExternal(ObjectInput) - Method in class net.user1.union.core.def.ModuleDef

readExternal(ObjectInput) - Method in class net.user1.union.core.def.RoomDef

readExternal(ObjectInput) - Method in class net.user1.union.core.event.RemoteRoomEvent

readExternal(ObjectInput) - Method in class net.user1.union.core.event.RemoteServerEvent

refuse(String, String) - Method in interface net.user1.union.api.Connection

Refuse the Connection.

REMOTE_ROOM_CREATED - Static variable in class net.user1.union.core.event.RemoteServerEvent

Dispatched when a clustered room has been created on a node.

REMOTE_ROOM_REMOVED - Static variable in class net.user1.union.core.event.RemoteServerEvent

Dispatched when a clustered master room has been removed from a node.

RemoteEvent - Interface in net.user1.union.core.event

A RemoteEvent is an event dispatched across a cluster.

RemoteEventProducer - Interface in net.user1.union.core.event

A RemoteEventProducer can dispatch events that are re-dispatched by the equivalent objects across the cluster.

RemoteRoomEvent - Class in net.user1.union.core.event

RemoteRoomEvent is a simple data class used to pass information from a room to registered event-listeners when a remote room event occurs.

RemoteRoomEvent() - Constructor for class net.user1.union.core.event.RemoteRoomEvent

RemoteRoomEvent(String, String) - Constructor for class net.user1.union.core.event.RemoteRoomEvent

Constructor.

RemoteRoomEvent(String, String, Map<String, Object>) - Constructor for class net.user1.union.core.event.RemoteRoomEvent

RemoteRoomEventListener - Annotation Type in net.user1.union.module

Modules can use this annotation to have methods automatically listen for remote room events.

RemoteServerEvent - Class in net.user1.union.core.event

RemoteServerEvent is a simple data class used to pass information from the server to registered event-listeners when a remote server event occurs.

RemoteServerEvent() - Constructor for class net.user1.union.core.event.RemoteServerEvent

Constructor.

RemoteServerEvent(String, String) - Constructor for class net.user1.union.core.event.RemoteServerEvent

Constructor.

RemoteServerEvent(String, String, Map<String, Object>) - Constructor for class net.user1.union.core.event.RemoteServerEvent

Constructor.

remove() - Method in interface net.user1.union.core.attribute.Attribute

Removes the attribute from its holder (Server, Client, or Room).

REMOVE_CLIENT - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client leaves the room.

REMOVE_OBSERVER - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client stops observing the room.

REMOVE_SLAVE_ROOM - Static variable in class net.user1.union.core.event.RemoteRoomEvent

Dispatched by a room when a slave room has been removed on another node.

removeAccount(String) - Method in interface net.user1.union.api.Datasource

Remove an account.

removeAccount(String, String) - Method in interface net.user1.union.api.Server

Remove an account from the server.

removeAccountAttribute(Account, Attribute) - Method in interface net.user1.union.api.Datasource

Remove an account attribute.

removeAttribute(String, String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Removes the attribute with the given name from the given scope.

removeAttribute(String) - Method in interface net.user1.union.core.attribute.AttributeHolder

Removes the global scoped attribute with the given name.

removeClientEventListener(Client, String, String) - Method in interface net.user1.union.api.ScriptWrapper

Remove an event listener from the given client.

removeEventListener(String, Object, String) - Method in interface net.user1.union.core.event.EventProducer

Deregisters an event listener for an event from this EventProducer.

removeRemoteEventListener(String, Object, String) - Method in interface net.user1.union.core.event.RemoteEventProducer

Deregisters an event listener for an event from this RemoteEventProducer.

removeRoomAttribute(Room, Attribute) - Method in interface net.user1.union.api.Datasource

Remove a room attribute.

removeRoomEventListener(String, String) - Method in interface net.user1.union.api.ScriptWrapper

Remove an event listener from the room to which the room module script is attached.

removeRoomEventListener(Room, String, String) - Method in interface net.user1.union.api.ScriptWrapper

Remove an event listener from the given room.

removeServerAttribute(Attribute) - Method in interface net.user1.union.api.Datasource

Remove a server attribute.

removeServerEventListener(String, String) - Method in interface net.user1.union.api.ScriptWrapper

Remove an event listener from the server.

Request - Interface in net.user1.union.api

Request represents a client request made to the server such as create room, send message or set attribute.

RequiredAttribute - Annotation Type in net.user1.union.module

Indicates that an attribute in a module is required and must be correctly set or the module will not be created.

resetNodeStreams() - Method in interface net.user1.union.api.Cluster

Reset the communication streams for all of the nodes connected within the cluster.

restart() - Method in interface net.user1.union.api.Room

Restarts the room with the original RoomDef.

ROLE_NOT_FOUND - Static variable in class net.user1.union.api.Status

Room - Interface in net.user1.union.api

A room is a place for clients to engage in group communication.

ROOM_CREATE_REQUESTED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when there is a request to create a room.

ROOM_CREATED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a room has been created on the server.

ROOM_EXISTS - Static variable in class net.user1.union.api.Status

ROOM_FULL - Static variable in class net.user1.union.api.Status

ROOM_MESSAGE - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when a client has sent a message to all other clients in the room.

ROOM_NOT_FOUND - Static variable in class net.user1.union.api.Status

ROOM_REMOVED - Static variable in class net.user1.union.core.event.ServerEvent

Dispatched when a room has been removed from the server.

RoomAlreadyExistsException - Exception in net.user1.union.core.exception

Thrown when trying to create room but a room with the ID already exists on the server.

RoomAlreadyExistsException() - Constructor for exception net.user1.union.core.exception.RoomAlreadyExistsException

RoomAlreadyExistsException(String) - Constructor for exception net.user1.union.core.exception.RoomAlreadyExistsException

RoomAlreadyExistsException(String, Throwable) - Constructor for exception net.user1.union.core.exception.RoomAlreadyExistsException

RoomDef - Class in net.user1.union.core.def

A RoomDef defines how a room should be constructed.

RoomDef() - Constructor for class net.user1.union.core.def.RoomDef

Constructor.

RoomDef(String) - Constructor for class net.user1.union.core.def.RoomDef

Constructor.

RoomEvent - Class in net.user1.union.core.event

RoomEvent is a simple data class used to pass information from a room to registered event-listeners when a room event occurs.

RoomEvent(Room, Client, Message) - Constructor for class net.user1.union.core.event.RoomEvent

Constructor.

RoomEvent(Room, Client, Message, Attribute) - Constructor for class net.user1.union.core.event.RoomEvent

Constructor.

RoomEvent(Room, Client, Message, Attribute, UPCMessage) - Constructor for class net.user1.union.core.event.RoomEvent

RoomEventListener - Annotation Type in net.user1.union.module

Modules can use this annotation to have methods automatically listen for room events.

RoomNotFoundException - Exception in net.user1.union.core.exception

Thrown when trying to obtain a reference to a room by using it's room ID but no such room exists.

RoomNotFoundException() - Constructor for exception net.user1.union.core.exception.RoomNotFoundException

RoomNotFoundException(String) - Constructor for exception net.user1.union.core.exception.RoomNotFoundException

RoomNotFoundException(String, Throwable) - Constructor for exception net.user1.union.core.exception.RoomNotFoundException

S

saveAccount(Account) - Method in interface net.user1.union.api.Datasource

Save an existing account to the server.

saveAccountAttribute(Account, Attribute) - Method in interface net.user1.union.api.Datasource

Save an account attribute.

saveRoomAttribute(Room, Attribute) - Method in interface net.user1.union.api.Datasource

Save a room attribute.

saveServerAttribute(Attribute) - Method in interface net.user1.union.api.Datasource

Save a server attribute.

SCOPE_GLOBAL - Static variable in interface net.user1.union.core.attribute.Attribute

Indicates the scope should be global.

SCRIPT - Static variable in class net.user1.union.core.def.ModuleDef

Denotes that the module is written using a scripting language.

ScriptWrapper - Interface in net.user1.union.api

A ScriptWrapper acts as a proxy for scripts for event handling.

Security - Interface in net.user1.union.api

Used by applications to perform various security functions such as: - determine if an action is permissible.

SecurityAction - Enum in net.user1.union.security

SecurityRole - Enum in net.user1.union.security

sendMessage(String, String...) - Method in interface net.user1.union.api.Client

This generates a u7 which is sent to the client.

sendMessage(String, String...) - Method in interface net.user1.union.api.Room

This generates a u7 which is sent to all clients in the room.

sendMessage(Filter, String, String...) - Method in interface net.user1.union.api.Room

This generates a u7 which is sent to all clients in the room.

sendMessage(Set<Client>, String, String...) - Method in interface net.user1.union.api.Room

This generates a u7 which is sent to the clients in the list clients.

sendMessage(String, String...) - Method in interface net.user1.union.api.Server

This generates a u7 which is sent to all clients on the server.

sendMessage(Filter, String, String...) - Method in interface net.user1.union.api.Server

This generates a u7 which is sent to all clients on the server.

Server - Interface in net.user1.union.api

The server is the container for all other objects in the server.

SERVER_ONLY - Static variable in class net.user1.union.api.Status

ServerEvent - Class in net.user1.union.core.event

ServerEvent is a simple data class used to pass information from the server to registered event-listeners when a server event occurs.

ServerEvent(Room, Client) - Constructor for class net.user1.union.core.event.ServerEvent

Constructor.

ServerEvent(Room, Client, Map<String, Object>) - Constructor for class net.user1.union.core.event.ServerEvent

Constructor.

ServerEventListener - Annotation Type in net.user1.union.module

Modules can use this annotation to have methods automatically listen for server events.

ServerOnlyAttributeException - Exception in net.user1.union.core.exception

Thrown when a client, through UPC, triest to set an attribute that has previously been set with the flag Attribute.FLAG_SERVER_ONLY.

ServerOnlyAttributeException() - Constructor for exception net.user1.union.core.exception.ServerOnlyAttributeException

ServerOnlyAttributeException(String) - Constructor for exception net.user1.union.core.exception.ServerOnlyAttributeException

ServerOnlyAttributeException(String, Throwable) - Constructor for exception net.user1.union.core.exception.ServerOnlyAttributeException

setAffinityAddress(String) - Method in interface net.user1.union.api.Cluster

Set the affinity address that will be sent in the u66 (SERVER_HELLO).

setAffinityDuration(int) - Method in interface net.user1.union.api.Cluster

Set the affinity duration that will be sent in the u66 (SERVER_HELL).

setAttribute(String, Object, String, int) - Method in interface net.user1.union.core.attribute.AttributeHolder

Sets or updates an attribute on the attribute holder.

setFlags(int) - Method in interface net.user1.union.core.attribute.Attribute

Sets the flags for the attribute.

setFlags(int) - Method in class net.user1.union.core.def.AttributeDef

setID(String) - Method in class net.user1.union.core.def.ModuleDef

Set the ID of the module.

setModerator(boolean) - Method in interface net.user1.union.api.Account

Sets the account moderator status.

setModules(List<ModuleDef>) - Method in class net.user1.union.core.def.RoomDef

Set a list of modules to be deployed with the room.

setName(String) - Method in class net.user1.union.core.def.AttributeDef

setOwnerID(String) - Method in class net.user1.union.core.def.RoomDef

Set the clientID of the owner of the room.

setPermission(SecurityAction, SecurityRole...) - Method in interface net.user1.union.api.Security

Gives permission for the given roles to execute the given action.

setRoomID(String) - Method in class net.user1.union.core.def.RoomDef

Set the ID of the room.

setSource(String) - Method in class net.user1.union.core.def.ModuleDef

Set the source (the Java class or script name) for the module.

setType(String) - Method in class net.user1.union.core.def.ModuleDef

Set the module type (SCRIPT or CLASS)

setUpdateLevels(String, int) - Method in interface net.user1.union.api.Client

Sets the update levels for the room.

setValue(Object) - Method in interface net.user1.union.core.attribute.Attribute

Sets the value of the attribute

setValue(Object) - Method in class net.user1.union.core.def.AttributeDef

shutdown() - Method in interface net.user1.union.api.Client

Removes the client from the server after sending any messages currently queued to be sent.

shutdown(boolean) - Method in interface net.user1.union.api.Client

Removes the client from the server.

shutdown() - Method in interface net.user1.union.api.Datasource

Called when the datasource is shutdown.

shutdown() - Method in interface net.user1.union.api.Module

Called when the module is shutdown.

SHUTDOWN - Static variable in class net.user1.union.core.event.ClientEvent

Dispatched when a client is shutdown.

SHUTDOWN - Static variable in class net.user1.union.core.event.RoomEvent

Dispatched when the room is shutdown.

shutdown() - Method in class net.user1.union.module.MaxClients

shutdown() - Method in class net.user1.union.module.MaxConcurrentConnection

shutdown() - Method in class net.user1.union.module.MaxRooms

shutdownModule(String) - Method in interface net.user1.union.api.Server

Shuts down the module with the given ID.

shutdownRoom() - Method in interface net.user1.union.api.Room

Shuts down this room and removes it from the server.

shutdownRoom(String, String) - Method in interface net.user1.union.api.Server

Shuts down the room and removes it from the Server.

shutdownServer() - Method in interface net.user1.union.api.Server

Stops the server.

Status - Class in net.user1.union.api

This class contains a list of all Status codes used in the UPC specification.

Status() - Constructor for class net.user1.union.api.Status

stopObservingRoom(String) - Method in interface net.user1.union.api.Client

Stop observing a room.

SUCCESS - Static variable in class net.user1.union.api.Status

T

THIRTY_MINUTES - Static variable in class net.user1.union.security.BanInterval

THIRTY_SECONDS - Static variable in class net.user1.union.security.BanInterval

U

unbanClient(String) - Method in interface net.user1.union.api.Security

UnionException - Exception in net.user1.union.core.exception

The superclass for all custom exceptions thrown by the server.

UnionException() - Constructor for exception net.user1.union.core.exception.UnionException

UnionException(String) - Constructor for exception net.user1.union.core.exception.UnionException

UnionException(String, Throwable) - Constructor for exception net.user1.union.core.exception.UnionException

UnionException(Throwable) - Constructor for exception net.user1.union.core.exception.UnionException

UnionSecurityException - Exception in net.user1.union.core.exception

UnionSecurityException() - Constructor for exception net.user1.union.core.exception.UnionSecurityException

UnionSecurityException(String) - Constructor for exception net.user1.union.core.exception.UnionSecurityException

UnionSecurityException(String, Throwable) - Constructor for exception net.user1.union.core.exception.UnionSecurityException

UPC_PROCESSED - Static variable in class net.user1.union.core.event.UPCEvent

Dispatched when a UPC has been processed by the server.

UPC_QUEUE_REQUESTED - Static variable in class net.user1.union.core.event.UPCEvent

Dispatched when a UPC is about to be queued for processing by the server.

UPCEvent - Class in net.user1.union.core.event

UPCEvent is a simple data class used to pass information about a UPCEvent to registered event-listeners.

UPCEvent(UPCProcessingRecord) - Constructor for class net.user1.union.core.event.UPCEvent

Constructor.

UPCEventListener - Annotation Type in net.user1.union.module

Modules can use this annotation to have methods automatically listen for server events.

UPCProcessingRecord - Interface in net.user1.union.api

Contains information about the processing of a UPCMessage (the low level message structure used by the server).

UPCProcessor - Interface in net.user1.union.api

Used to access the events and methods of the underlying UPCMessages being processed.

UpdateLevel - Enum in net.user1.union.core

UpdateLevel contains a breakdown of information that can be retrieved by the server.

Util - Class in net.user1.union.core.util

Some utilities for developers creating server side modules.

Util() - Constructor for class net.user1.union.core.util.Util

V

validate() - Method in class net.user1.union.core.def.AttributeDef

validate() - Method in class net.user1.union.core.def.ModuleDef

valueOf(String) - Static method in enum net.user1.union.core.UpdateLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.user1.union.security.SecurityAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.user1.union.security.SecurityRole

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.user1.union.core.UpdateLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.user1.union.security.SecurityAction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.user1.union.security.SecurityRole

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeExternal(ObjectOutput) - Method in class net.user1.union.core.def.AttributeDef

writeExternal(ObjectOutput) - Method in class net.user1.union.core.def.ModuleDef

writeExternal(ObjectOutput) - Method in class net.user1.union.core.def.RoomDef

writeExternal(ObjectOutput) - Method in class net.user1.union.core.event.RemoteRoomEvent

writeExternal(ObjectOutput) - Method in class net.user1.union.core.event.RemoteServerEvent

A B C D E F G H I J L M N O P R S T U V W