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

A

addExtraFeature(String) - Method in interface org.frogx.service.api.MUGService
Add additional service discovery features for this service.
addExtraIdentity(String, String, String) - Method in interface org.frogx.service.api.MUGService
Add an additional service discovery identity to the service.
addMember(JID, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
An occupant wants to add a new member.
addSpectator(MUGOccupant) - Method in interface org.frogx.service.api.MUGMatch
If a user joins the room as a spectator or a player releases the game role this function is called.

B

broadcastPresence(MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
Broadcast the presence of an occupant to all other occupants (expecting him).
broadcastRoomPresence() - Method in interface org.frogx.service.api.MUGRoom
Broadcast the room and match information to all occupants.
broadcastTurn(Collection<Element>, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
A MUGMatch may want to broadcast a game moves.

C

canDiscoverOccupants() - Method in interface org.frogx.service.api.MUGRoom
Return true if it's allowed that the list of occupants is publicly available.
CannotBeInvitedException - Exception in org.frogx.service.api.exception
 
CannotBeInvitedException() - Constructor for exception org.frogx.service.api.exception.CannotBeInvitedException
 
CannotBeInvitedException(String) - Constructor for exception org.frogx.service.api.exception.CannotBeInvitedException
 
CannotBeInvitedException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.CannotBeInvitedException
 
CannotBeInvitedException(Throwable) - Constructor for exception org.frogx.service.api.exception.CannotBeInvitedException
 
canOccupantsInvite() - Method in interface org.frogx.service.api.MUGRoom
Returns true if it's allowed that the occupants can invite other users.
changeNickname(String) - Method in interface org.frogx.service.api.MUGOccupant
Set a new nickname for the occupants attributes.
changeNickname(String, String, Presence) - Method in interface org.frogx.service.api.MUGRoom
An MUGOccupant want to change his nickname.
ConflictException - Exception in org.frogx.service.api.exception
 
ConflictException() - Constructor for exception org.frogx.service.api.exception.ConflictException
 
ConflictException(String) - Constructor for exception org.frogx.service.api.exception.ConflictException
 
ConflictException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.ConflictException
 
ConflictException(Throwable) - Constructor for exception org.frogx.service.api.exception.ConflictException
 
createMatch(MUGRoom) - Method in interface org.frogx.service.api.MultiUserGame
Create a match which implements the game logic within a game room.

D

debug(String) - Method in interface org.frogx.service.api.util.LogUtil
 
debug(Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
debug(String, Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
destroy() - Method in interface org.frogx.service.api.MUGMatch
This method is called when the match will be destroyed.
destroy() - Method in interface org.frogx.service.api.MUGOccupant
Called when the occupant is leaving the game room, to clean things up.
destroy() - Method in interface org.frogx.service.api.MUGRoom
Destroy the room.
destroyMatch(MUGRoom) - Method in interface org.frogx.service.api.MultiUserGame
Destroy the match in the specified game room.

E

error(String) - Method in interface org.frogx.service.api.util.LogUtil
 
error(Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
error(String, Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 

F

ForbiddenException - Exception in org.frogx.service.api.exception
 
ForbiddenException() - Constructor for exception org.frogx.service.api.exception.ForbiddenException
 
ForbiddenException(String) - Constructor for exception org.frogx.service.api.exception.ForbiddenException
 
ForbiddenException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.ForbiddenException
 
ForbiddenException(Throwable) - Constructor for exception org.frogx.service.api.exception.ForbiddenException
 

G

GameConfigurationException - Exception in org.frogx.service.api.exception
 
GameConfigurationException() - Constructor for exception org.frogx.service.api.exception.GameConfigurationException
 
GameConfigurationException(String) - Constructor for exception org.frogx.service.api.exception.GameConfigurationException
 
GameConfigurationException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.GameConfigurationException
 
GameConfigurationException(Throwable) - Constructor for exception org.frogx.service.api.exception.GameConfigurationException
 
getAddress() - Method in interface org.frogx.service.api.MUGService
Get the JID of the multi-user game service with the full service domain.
getAdmins() - Method in interface org.frogx.service.api.MUGService
Get a collection of the administrators JIDs.
getAffiliation() - Method in interface org.frogx.service.api.MUGOccupant
Get the MUGOccupant.Affiliation of this occupant.
getCategory() - Method in interface org.frogx.service.api.MultiUserGame
Get the category of the game e.g. board, cards, etc.
getConfigurationForm() - Method in interface org.frogx.service.api.MUGMatch
Get a collection of xml elements which were delivered to the owner if he wants to configure the match
getDescription() - Method in interface org.frogx.service.api.MUGRoom
Get a description of the game room.
getDescription() - Method in interface org.frogx.service.api.MUGService
Get a human readable description of the multi-user game service.
getDescription() - Method in interface org.frogx.service.api.MultiUserGame
Get the human readable description of the game.
getDomain() - Method in interface org.frogx.service.api.MUGService
Get the domain of the service e.g. gaming.example.com.
getExtraExtendedDiscoFields() - Method in interface org.frogx.service.api.MUGRoom
Get additional extended service discovery fields for more informations about this room.
getExtraFeatures() - Method in interface org.frogx.service.api.MUGRoom
Obtains a collection of additional service discovery features.
getExtraFeatures() - Method in interface org.frogx.service.api.MUGService
Obtains a collection of additional service discovery features.
getExtraIdentities() - Method in interface org.frogx.service.api.MUGService
Obtains a collection of additional service discovery identities.
getFreeRoles() - Method in interface org.frogx.service.api.MUGMatch
Get a collection of the available free roles in the match.
getGame() - Method in interface org.frogx.service.api.MUGRoom
Returns the MultiUserGame which can be played within the room.
getGameRoom() - Method in interface org.frogx.service.api.MUGOccupant
Get the MUGRoom associated with this occupant.
getGameRoom(String, String, JID) - Method in interface org.frogx.service.api.MUGService
Obtains a game room.
getGameRooms() - Method in interface org.frogx.service.api.MUGService
Get a collection of all game rooms hosted by the service.
getJID() - Method in interface org.frogx.service.api.MUGRoom
Get the JID of this room e.g. chess@games.example.com.
getLocaleUtil() - Method in interface org.frogx.service.api.MUGManager
 
getLocalizedString(String) - Method in interface org.frogx.service.api.util.LocaleUtil
 
getLogUtil() - Method in interface org.frogx.service.api.MUGManager
 
getMatch() - Method in interface org.frogx.service.api.MUGRoom
Get the current MUGMatch which handels the game state and logic.
getMaxOccupants() - Method in interface org.frogx.service.api.MUGRoom
Get the number of occupants which are able to join the MUGRoom.
getMUGService() - Method in interface org.frogx.service.api.MUGRoom
Get the MUGService which is hosting the room.
getName() - Method in interface org.frogx.service.api.MUGRoom
Get the name of this room.
getName() - Method in interface org.frogx.service.api.MUGService
Get the name of the service e.g. gaming for the domain gaming.example.com.
getNamespace() - Method in interface org.frogx.service.api.MultiUserGame
Gets the xml namespace of the implemented game which can be discovered.
getNaturalLanguageName() - Method in interface org.frogx.service.api.MUGRoom
Get a human readable name of this room which was configured by the owner.
getNickname() - Method in interface org.frogx.service.api.MUGOccupant
Get the nickname of this occupant.
getNumberActiveRooms() - Method in interface org.frogx.service.api.MUGService
Get the number of active multi-user rooms.
getNumberRooms() - Method in interface org.frogx.service.api.MUGService
Retuns the number of existing Rooms on the server (i.e. active or not, in memory or not).
getNumberSavedRooms() - Method in interface org.frogx.service.api.MUGService
Get the number of saved multi-user rooms.
getNumberUserSessions() - Method in interface org.frogx.service.api.MUGService
Retuns the total number of user sessions on this service.
getOccupants() - Method in interface org.frogx.service.api.MUGRoom
Obtain a collection of all MUGOccupants in the game room.
getOccupantsCount() - Method in interface org.frogx.service.api.MUGRoom
Returns the current number of occupants in the MUGRoom.
getOwner() - Method in interface org.frogx.service.api.MUGRoom
Get the JID of the room owner.
getPassword() - Method in interface org.frogx.service.api.MUGRoom
Returns the password that the user must provide to enter the room.
getPlayers() - Method in interface org.frogx.service.api.MUGMatch
Get a collection of the players in the match.
getPlayersCount() - Method in interface org.frogx.service.api.MUGRoom
Returns the current number of occupants reserved a game role and playing a match.
getPresence() - Method in interface org.frogx.service.api.MUGOccupant
Obtain the actual presence information for this occupant including information about his affiliation and game role.
getRole(MUGOccupant) - Method in interface org.frogx.service.api.MUGMatch
Get the role of an MUGOccupant.
getRoleName() - Method in interface org.frogx.service.api.MUGOccupant
Get the name of the role which this occupant is reserved.
getRoomAddress() - Method in interface org.frogx.service.api.MUGOccupant
Obtain the JID representing this occupant in a room.
getServerName() - Method in interface org.frogx.service.api.MUGManager
 
getServiceAdmins(String) - Method in interface org.frogx.service.api.MUGPersistenceProvider
Get a collection of the bare JIDs of administrators of a XMPP component.
getServiceProperty(String, String) - Method in interface org.frogx.service.api.MUGPersistenceProvider
Get a property value for a specific Multi-User Gaming component or null if none is present.
getState() - Method in interface org.frogx.service.api.MUGMatch
Get xml element which represents the actual match state.
getStatus() - Method in interface org.frogx.service.api.MUGMatch
Get the current status of the match.
getSupportedGames() - Method in interface org.frogx.service.api.MUGService
Get the games supported by the service.
getUserAddress() - Method in interface org.frogx.service.api.MUGOccupant
Get the real JID of this occupant.
getValue() - Method in enum org.frogx.service.api.MUGOccupant.Affiliation
Returns the value for the affiliation.

H

handleOwnerIQ(IQ, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
Handle game room requests within the Owner namespace.
hasRole() - Method in interface org.frogx.service.api.MUGOccupant
Return true if the occupant has a game role and therefore is a player in the match.
hasRoom(String) - Method in interface org.frogx.service.api.MUGService
If a game room with the specified name exists this method returns true.

I

info(String) - Method in interface org.frogx.service.api.util.LogUtil
 
info(Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
info(String, Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
InvalidTurnException - Exception in org.frogx.service.api.exception
 
InvalidTurnException() - Constructor for exception org.frogx.service.api.exception.InvalidTurnException
 
InvalidTurnException(String) - Constructor for exception org.frogx.service.api.exception.InvalidTurnException
 
InvalidTurnException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.InvalidTurnException
 
InvalidTurnException(Throwable) - Constructor for exception org.frogx.service.api.exception.InvalidTurnException
 
invite(JID, String, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
An occupant want to invite another user to join the game room.
isFullyAnonymous() - Method in interface org.frogx.service.api.MUGRoom
Returns true if it's a room in which an occupant's full JID can't be discovered by anyone.
isGameRegistered(String) - Method in interface org.frogx.service.api.MUGManager
Returns true if a MultiUserGame is configured for this server.
isLocked() - Method in interface org.frogx.service.api.MUGRoom
Returns true if the room is locked.
isMembersOnly() - Method in interface org.frogx.service.api.MUGRoom
Returns true if a user cannot join the room without being on the member list.
isModerated() - Method in interface org.frogx.service.api.MUGRoom
Returns true if the room owner is allowed to kick users, revoke roles amd save the match.
isNonAnonymous() - Method in interface org.frogx.service.api.MUGRoom
Returns true if it's a room in which an occupant's full JID is exposed to all other occupants.
isPasswordProtected() - Method in interface org.frogx.service.api.MUGRoom
Returns true if a user cannot enter without first providing the correct password.
isPublicRoom() - Method in interface org.frogx.service.api.MUGRoom
Returns true if the room is visible through service discovery or jabber search.
isSemiAnonymous() - Method in interface org.frogx.service.api.MUGRoom
Returns true if it's a room in which an occupant's full JID can be discovered only by the room owner.
isServiceEnabled() - Method in interface org.frogx.service.api.MUGService
Get true if the the multi-user game service is started and running.

J

join(String, String, JID, Presence) - Method in interface org.frogx.service.api.MUGRoom
A user want to join the game room.

L

leave(MUGOccupant) - Method in interface org.frogx.service.api.MUGMatch
An MUGOccupant leaves the match.
leave(MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
An occupant is quitting the participation of this room.
LocaleUtil - Interface in org.frogx.service.api.util
 
LogUtil - Interface in org.frogx.service.api.util
 

M

MUGManager - Interface in org.frogx.service.api
The MUGManager is the interface for MultiUserGame plugins to register and unregister their support within MUGService components.
MUGMatch - Interface in org.frogx.service.api
A MUGMatch provides the game logic, handles the state of the game and provides roles which can be assigned by an MUGOccupant to become a player.
MUGMatch.Status - Enum in org.frogx.service.api
The Status of a MUGMatch is part of the game state within a MUGRoom and describes if the game is running, paused or can be configured.
mugNS - Static variable in interface org.frogx.service.api.MUGService
The xml namespace of the multi-user game service.
MUGOccupant - Interface in org.frogx.service.api
A Multi-User Gaming occupant represents an user who is associated with a game room.
MUGOccupant.Affiliation - Enum in org.frogx.service.api
The Affiliation represents the authorization of an MUGOccupant.
mugOwnerNS - Static variable in interface org.frogx.service.api.MUGService
The Suffix of the owner xml namespace.
MUGPersistenceProvider - Interface in org.frogx.service.api
The MUGPersistenceProvider defines the data which must be provided by a storage for Multi-User Gaming services.
MUGRoom - Interface in org.frogx.service.api
A game room on the Multi-User Gaming server manages its occupants, sends game moves, invitations, presence information,...
MUGService - Interface in org.frogx.service.api
A Multi-User Gaming service is a XMPP component which manages game rooms and users.
mugUserNS - Static variable in interface org.frogx.service.api.MUGService
The Suffix of the user xml namespace.
MultiUserGame - Interface in org.frogx.service.api
A MultiUserGame provides information about the implemented game and handles MUGMatch instances.

N

NotAcceptableException - Exception in org.frogx.service.api.exception
 
NotAcceptableException() - Constructor for exception org.frogx.service.api.exception.NotAcceptableException
 
NotAcceptableException(String) - Constructor for exception org.frogx.service.api.exception.NotAcceptableException
 
NotAcceptableException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.NotAcceptableException
 
NotAcceptableException(Throwable) - Constructor for exception org.frogx.service.api.exception.NotAcceptableException
 
NotAllowedException - Exception in org.frogx.service.api.exception
 
NotAllowedException() - Constructor for exception org.frogx.service.api.exception.NotAllowedException
 
NotAllowedException(String) - Constructor for exception org.frogx.service.api.exception.NotAllowedException
 
NotAllowedException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.NotAllowedException
 
NotAllowedException(Throwable) - Constructor for exception org.frogx.service.api.exception.NotAllowedException
 
NotFoundException - Exception in org.frogx.service.api.exception
 
NotFoundException() - Constructor for exception org.frogx.service.api.exception.NotFoundException
 
NotFoundException(String) - Constructor for exception org.frogx.service.api.exception.NotFoundException
 
NotFoundException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.NotFoundException
 
NotFoundException(Throwable) - Constructor for exception org.frogx.service.api.exception.NotFoundException
 

O

org.frogx.service.api - package org.frogx.service.api
The interface between Multi-User Gaming Services and game plugins.
org.frogx.service.api.exception - package org.frogx.service.api.exception
Game specific exceptions.
org.frogx.service.api.util - package org.frogx.service.api.util
Utility classes e.g. for internationalization.

P

processTurn(MUGOccupant, Collection<Element>) - Method in interface org.frogx.service.api.MUGMatch
A player (an occupant reserved a game role) want to make a turn.

R

registerMultiUserGame(String, MultiUserGame) - Method in interface org.frogx.service.api.MUGManager
Registers a MultiUserGame at the multi-user game plugin which handles the MUGService.
registerMultiUserGame(String, MultiUserGame) - Method in interface org.frogx.service.api.MUGService
Registers a new MultiUserGame implementation to the service.
releaseRole(MUGOccupant) - Method in interface org.frogx.service.api.MUGMatch
A MUGOccupant want to release his role.
removeExtraFeature(String) - Method in interface org.frogx.service.api.MUGService
Remove an additional service discovery feature from the service.
removeExtraIdentity(String) - Method in interface org.frogx.service.api.MUGService
Remove an additional service discovery identity from the service (if exists).
removeGameRoom(String) - Method in interface org.frogx.service.api.MUGService
Remove a game room from this service.
RequiredPlayerException - Exception in org.frogx.service.api.exception
 
RequiredPlayerException() - Constructor for exception org.frogx.service.api.exception.RequiredPlayerException
 
RequiredPlayerException(String) - Constructor for exception org.frogx.service.api.exception.RequiredPlayerException
 
RequiredPlayerException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.RequiredPlayerException
 
RequiredPlayerException(Throwable) - Constructor for exception org.frogx.service.api.exception.RequiredPlayerException
 
reserveFreeRole(MUGOccupant) - Method in interface org.frogx.service.api.MUGMatch
An occupant which have no role yet can reserve any free game role.
reserveRole(MUGOccupant, String) - Method in interface org.frogx.service.api.MUGMatch
An occupant which have no role yet can try to reserve a game role.
RoomLockedException - Exception in org.frogx.service.api.exception
 
RoomLockedException() - Constructor for exception org.frogx.service.api.exception.RoomLockedException
 
RoomLockedException(String) - Constructor for exception org.frogx.service.api.exception.RoomLockedException
 
RoomLockedException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.RoomLockedException
 
RoomLockedException(Throwable) - Constructor for exception org.frogx.service.api.exception.RoomLockedException
 

S

send(Packet) - Method in interface org.frogx.service.api.MUGOccupant
Sends a packet to the occupant.
sendInvitationRejection(JID, String, JID) - Method in interface org.frogx.service.api.MUGRoom
A user declines an invitation.
sendPacket(MUGService, Packet) - Method in interface org.frogx.service.api.MUGManager
 
sendPrivatePacket(Packet, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
A occupant can send another occupant a private message.
sendTurn(Collection<Element>, MUGOccupant, MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
A MUGMatch may want to send game moves.
ServiceUnavailableException - Exception in org.frogx.service.api.exception
 
ServiceUnavailableException() - Constructor for exception org.frogx.service.api.exception.ServiceUnavailableException
 
ServiceUnavailableException(String) - Constructor for exception org.frogx.service.api.exception.ServiceUnavailableException
 
ServiceUnavailableException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.ServiceUnavailableException
 
ServiceUnavailableException(Throwable) - Constructor for exception org.frogx.service.api.exception.ServiceUnavailableException
 
setConfiguration(Collection<Element>) - Method in interface org.frogx.service.api.MUGMatch
Configure the match with help of the ConfigurationFrom get by getConfigurationForm().
setConstructedState(Element) - Method in interface org.frogx.service.api.MUGMatch
In some games the owner can request a constructed match by sending an starting match state.
setDescription(String) - Method in interface org.frogx.service.api.MUGService
Assign the human readable description of multi-user game service.
setPresence(Presence) - Method in interface org.frogx.service.api.MUGOccupant
Sets a new presence information for the occupant.
setServiceProperty(String, String, String) - Method in interface org.frogx.service.api.MUGPersistenceProvider
Get a property value for a specific Multi-User Gaming component or null if none is present.
start() - Method in interface org.frogx.service.api.MUGMatch
The room occupants want to start the game.
startMatch(MUGOccupant) - Method in interface org.frogx.service.api.MUGRoom
An MUGOccupant signals that he is ready to start the match.

U

UnauthorizedException - Exception in org.frogx.service.api.exception
 
UnauthorizedException() - Constructor for exception org.frogx.service.api.exception.UnauthorizedException
 
UnauthorizedException(String) - Constructor for exception org.frogx.service.api.exception.UnauthorizedException
 
UnauthorizedException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.UnauthorizedException
 
UnauthorizedException(Throwable) - Constructor for exception org.frogx.service.api.exception.UnauthorizedException
 
unregisterMultiUserGame(String) - Method in interface org.frogx.service.api.MUGManager
Unregisters a MultiUserGame at the multi-user game plugin which handles the MUGService.
unregisterMultiUserGame(String) - Method in interface org.frogx.service.api.MUGService
Unregisters a MultiUserGame implementation.
UnsupportedGameException - Exception in org.frogx.service.api.exception
 
UnsupportedGameException() - Constructor for exception org.frogx.service.api.exception.UnsupportedGameException
 
UnsupportedGameException(String) - Constructor for exception org.frogx.service.api.exception.UnsupportedGameException
 
UnsupportedGameException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.UnsupportedGameException
 
UnsupportedGameException(Throwable) - Constructor for exception org.frogx.service.api.exception.UnsupportedGameException
 
UserAlreadyExistsException - Exception in org.frogx.service.api.exception
 
UserAlreadyExistsException() - Constructor for exception org.frogx.service.api.exception.UserAlreadyExistsException
 
UserAlreadyExistsException(String) - Constructor for exception org.frogx.service.api.exception.UserAlreadyExistsException
 
UserAlreadyExistsException(String, Throwable) - Constructor for exception org.frogx.service.api.exception.UserAlreadyExistsException
 
UserAlreadyExistsException(Throwable) - Constructor for exception org.frogx.service.api.exception.UserAlreadyExistsException
 

V

valueOf(String) - Static method in enum org.frogx.service.api.MUGMatch.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.frogx.service.api.MUGOccupant.Affiliation
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum org.frogx.service.api.MUGOccupant.Affiliation
Returns the affiliation associated with the specified value.
values() - Static method in enum org.frogx.service.api.MUGMatch.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.frogx.service.api.MUGOccupant.Affiliation
Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String) - Method in interface org.frogx.service.api.util.LogUtil
 
warn(Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 
warn(String, Throwable) - Method in interface org.frogx.service.api.util.LogUtil
 

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

Copyright © 2009. All Rights Reserved.