All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface net.tabuleiro.nebulae.ServerObject

public abstract interface ServerObject

Interface representing the Nebulae server instance.
ServerSideScript classes can use the serverObject() method to retrieve a pointer to a ServerObject.

createServerMovie(String): Creates a new movie on the server and returns a pointer to it.
deleteServerMovie(String): Deletes a movie from the server.
getServerMovie(int): Retrieves a pointer to a ServerMovie object active on the server.
getServerMovie(String): Retrieves a pointer to a ServerMovie object active on the server.
getServerUserDatabase(): Returns a ponter to the ServerUserDatabase interface representing the default user authentication table.
getSQLGateway(): Returns a ponter to the SQLGateway interface representing the default SQL connection.
language(): This method is reserved.
path(): Gets the path of the server executable in the system
put(String): Displays a message to the server active output (log file or terminal window)
serverMovieCount(): Gets the number of active movies in the server.
setuserLevel(int): Sets the default user levels for users that connect to the server and do not have an user account in the DB.
timeStamp(): Gets the current server time as an int
timeString(): Gets the current server time formatted as a String
userLevel(): Gets the default user levels for users that connect to the server and do not have an user account in the DB.

put

 public abstract void put(java.lang.String msg)

Displays a message to the server active output (log file or terminal window)

getServerMovie

 public abstract net.tabuleiro.nebulae.ServerMovie getServerMovie(java.lang.String moviename) throws net.tabuleiro.nebulae.MovieNotFoundException

Retrieves a pointer to a ServerMovie object active on the server.

Parameters:: moviename - String with the name of the movie to be returned
Returns:: ServerMovie pointer, or throws a MovieNotFoundException

getServerMovie

 public abstract net.tabuleiro.nebulae.ServerMovie getServerMovie(int movieidx) throws net.tabuleiro.nebulae.MovieNotFoundException

Retrieves a pointer to a ServerMovie object active on the server.

Parameters:: movieidx - index of the movie to be returned
Returns:: ServerMovie pointer, or throws a MovieNotFoundException

createServerMovie

 public abstract net.tabuleiro.nebulae.ServerMovie createServerMovie(java.lang.String moviename) throws net.tabuleiro.nebulae.MUSErrorCode

Creates a new movie on the server and returns a pointer to it.

Parameters:: moviename - String with the name of the movie to be created
Returns:: ServerMovie pointer, or throws a MUSErrorCode if the creation fails

deleteServerMovie

 public abstract void deleteServerMovie(java.lang.String moviename)

Deletes a movie from the server.

Parameters:: moviename - String with the name of the movie to be deleted

serverMovieCount

 public abstract int serverMovieCount()

Gets the number of active movies in the server.

Returns:: the number of movies

path

 public abstract java.lang.String path()

Gets the path of the server executable in the system

timeString

 public abstract java.lang.String timeString()

Gets the current server time formatted as a String

timeStamp

 public abstract int timeStamp()

Gets the current server time as an int

language

 public abstract int language()

This method is reserved. Current implementation returns 0 for the English version of Nebulae.

userLevel

 public abstract int userLevel()

Gets the default user levels for users that connect to the server and do not have an user account in the DB.
This value can be configured by the DefaultUserLevel directive in Nebulae.cfg.

setuserLevel

 public abstract void setuserLevel(int level)

Sets the default user levels for users that connect to the server and do not have an user account in the DB.
When this method is used it overrides the value configured by the DefaultUserLevel directive in Nebulae.cfg.

getSQLGateway

 public abstract net.tabuleiro.nebulae.SQLGateway getSQLGateway()

Returns a ponter to the SQLGateway interface representing the default SQL connection.
Please consult the documentation of SQLGateway for more information.

getServerUserDatabase

 public abstract net.tabuleiro.nebulae.ServerUserDatabase getServerUserDatabase()

Returns a ponter to the ServerUserDatabase interface representing the default user authentication table.
Please consult the documentation of ServerUserDatabase for more information.

All Packages  Class Hierarchy  This Package  Previous  Next  Index