emulib.emustudio

Class API

java.lang.Object

emulib.emustudio.API

@ThreadSafe
public class API
extends Object

This class represents public API of emuStudio offered to plug-ins. Through this class, plug-ins are enabled to call emuStudio directly. It is a singleton class.

Method Summary

Modifier and Type	Method and Description
static boolean	assignPassword(String password) Assigns a password for most crucial emuLib operations.
void	clearAll(String password)
DebugTable	getDebugTable() Gets debug table from emuStudio.
static API	getInstance() Get singleton instance of this API object.
void	setDebugTable(DebugTable debugTable, String password) Set debug table.
static boolean	testPassword(Long hashCode)
static void	testPassword(String password) Determines if given password matches with password already set-up by emuStudio.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static API getInstance()

Get singleton instance of this API object.

Returns:

instance of this class

clearAll

public void clearAll(String password)
              throws InvalidPasswordException

Throws:

InvalidPasswordException

assignPassword

public static boolean assignPassword(String password)

Assigns a password for most crucial emuLib operations. This password should be a hash string by which the emuStudio is allowed to perform crucial operations in the emuLib, such as plug-in loading, or providing information about plug-in connections. These operations must be strictly protected from plug-ins. This method is called only once, and by the emuStudio. After each next call, it does nothing and returns false.

Parameters:

password - emuStudio hash string, the "password".

Returns:

true if the assignment was successful (first call), false otherwise.

testPassword

public static void testPassword(String password)
                         throws InvalidPasswordException

Determines if given password matches with password already set-up by emuStudio. If the password is correct, it does nothing. Otherwise it throws an exception. WARNING: Everyone can call this method.

Parameters:

password - The password

Throws:

InvalidPasswordException - thrown if password is wrong or trustedInstance is not trusted

testPassword

public static boolean testPassword(Long hashCode)

setDebugTable

public void setDebugTable(DebugTable debugTable,
                          String password)
                   throws InvalidPasswordException

Set debug table. It should be called by emuStudio only.

Parameters:

debugTable - The debug table

password - password that was assigned to the emuLib. It prevents from misuse of this method by other plug-ins.

Throws:

InvalidPasswordException - if the password do not match with the password set by emuStudio

getDebugTable

public DebugTable getDebugTable()

Gets debug table from emuStudio.

Returns:

debug table in emuStudio. If debug table was not set by emuStudio earlier, returns null.