RemoteArena (ARENA 0.9 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.globalse.arena.remote
Interface RemoteArena

All Superinterfaces:: java.rmi.Remote

All Known Implementing Classes:: Arena

public interface RemoteArena
extends java.rmi.Remote
extends java.rmi.Remote

This interface is a facade for accessing the top-level objects of an arena, including the leagues, tournament styles, games, and users. A RemoteArena is typically the only remote object that is bound in the registry. Clients get remote references to other objects by first accessing a RemoteArena. A client usually accesses a RemoteArena following these steps:

Get a remote reference to the remote arena using Naming.lookup(java.lang.String)
Authenticate with the remote arena using login(java.lang.String, java.lang.String); the login method will return a ticket
Register an RemoteArenaListener to receive event notifications about changes for a specific game.
Get the remote objects of interest, for example, with getMatchById(java.lang.String, java.lang.String) or getLeagueInfosByGame(java.lang.String, java.lang.String)
Invoke the appropriate remote method on the resulting object

For examples of how to access a RemoteArena, see MatchFrontEnd.

Author:: Michael Nagel, Allen Dutoit
See Also:: RemoteArenaListener

Method Summary
`void`	`addListener(java.lang.String ticket, java.lang.String gameName, RemoteArenaListener listener)`
`LeagueInfo`	`createLeague(java.lang.String ticket, User owner, java.lang.String name, java.lang.String description, java.lang.String gameName, java.lang.String styleName)`
`GameDescriptor[]`	`getGameInfos(java.lang.String ticket)`
`java.lang.String`	`getGuestTicket()`
`LeagueInfo[]`	`getLeagueInfos(java.lang.String ticket)`
`LeagueInfo[]`	`getLeagueInfosByGame(java.lang.String ticket, java.lang.String gameName)`
`MatchInfo`	`getMatchById(java.lang.String ticket, java.lang.String matchId)`
`MatchPanelFactory`	`getMatchPanelFactory(java.lang.String ticket, java.lang.String gameName)`
`User`	`getOperator()`
`java.lang.String[]`	`getTournamentStyleNames(java.lang.String ticket)`
`User`	`getUser(java.lang.String ticket)`
`boolean`	`hasAccess(java.lang.String ticket, java.lang.String access)`
`void`	`log(java.util.logging.Level level, java.lang.String className, java.lang.String message)`
`java.lang.String`	`login(java.lang.String username, java.lang.String password)`
`void`	`registerGamePeer(java.lang.String arenaTicket, RemoteGamePeer gamePeer, java.lang.String peerTicket)`
`void`	`removeListener(java.lang.String gameName, RemoteArenaListener listener)`

Method Detail

getOperator

User getOperator()
                 throws java.rmi.RemoteException

Throws:: java.rmi.RemoteException

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws java.rmi.RemoteException,
                              InvalidLoginException

Throws:: java.rmi.RemoteException; InvalidLoginException

getGuestTicket

java.lang.String getGuestTicket()
                                throws java.rmi.RemoteException

Throws:: java.rmi.RemoteException

getUser

User getUser(java.lang.String ticket)
             throws java.rmi.RemoteException,
                    InvalidTicketException

Throws:: java.rmi.RemoteException; InvalidTicketException

hasAccess

boolean hasAccess(java.lang.String ticket,
                  java.lang.String access)
                  throws java.rmi.RemoteException,
                         InvalidTicketException

Throws:: java.rmi.RemoteException; InvalidTicketException

getGameInfos

GameDescriptor[] getGameInfos(java.lang.String ticket)
                              throws java.rmi.RemoteException,
                                     InvalidTicketException

Throws:: java.rmi.RemoteException; InvalidTicketException

getTournamentStyleNames

java.lang.String[] getTournamentStyleNames(java.lang.String ticket)
                                           throws java.rmi.RemoteException,
                                                  InvalidTicketException

Throws:: java.rmi.RemoteException; InvalidTicketException

getLeagueInfos

LeagueInfo[] getLeagueInfos(java.lang.String ticket)
                            throws java.rmi.RemoteException,
                                   InvalidTicketException,
                                   AccessDeniedException

Throws:: java.rmi.RemoteException; InvalidTicketException; AccessDeniedException

getLeagueInfosByGame

LeagueInfo[] getLeagueInfosByGame(java.lang.String ticket,
                                  java.lang.String gameName)
                                  throws java.rmi.RemoteException,
                                         InvalidTicketException,
                                         GameNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; GameNotFoundException

createLeague

LeagueInfo createLeague(java.lang.String ticket,
                        User owner,
                        java.lang.String name,
                        java.lang.String description,
                        java.lang.String gameName,
                        java.lang.String styleName)
                        throws java.rmi.RemoteException,
                               InvalidTicketException,
                               AccessDeniedException,
                               GameNotFoundException,
                               TournamentStyleNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; AccessDeniedException; GameNotFoundException; TournamentStyleNotFoundException

addListener

void addListener(java.lang.String ticket,
                 java.lang.String gameName,
                 RemoteArenaListener listener)
                 throws java.rmi.RemoteException,
                        InvalidTicketException,
                        GameNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; GameNotFoundException

removeListener

void removeListener(java.lang.String gameName,
                    RemoteArenaListener listener)
                    throws java.rmi.RemoteException,
                           InvalidTicketException,
                           GameNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; GameNotFoundException

registerGamePeer

void registerGamePeer(java.lang.String arenaTicket,
                      RemoteGamePeer gamePeer,
                      java.lang.String peerTicket)
                      throws java.rmi.RemoteException,
                             InvalidTicketException,
                             AccessDeniedException,
                             GamePeerAlreadyRegisteredException

Throws:: java.rmi.RemoteException; InvalidTicketException; AccessDeniedException; GamePeerAlreadyRegisteredException

getMatchById

MatchInfo getMatchById(java.lang.String ticket,
                       java.lang.String matchId)
                       throws java.rmi.RemoteException,
                              InvalidTicketException,
                              AccessDeniedException,
                              MatchNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; AccessDeniedException; MatchNotFoundException

getMatchPanelFactory

MatchPanelFactory getMatchPanelFactory(java.lang.String ticket,
                                       java.lang.String gameName)
                                       throws java.rmi.RemoteException,
                                              InvalidTicketException,
                                              AccessDeniedException,
                                              GameNotFoundException

Throws:: java.rmi.RemoteException; InvalidTicketException; AccessDeniedException; GameNotFoundException

log

void log(java.util.logging.Level level,
         java.lang.String className,
         java.lang.String message)
         throws java.rmi.RemoteException

Throws:: java.rmi.RemoteException