org.youscope.serverinterfaces

Interface YouScopeServerProperties

All Superinterfaces:

java.rmi.Remote

public interface YouScopeServerProperties
extends java.rmi.Remote

Interface providing information of the configuration and installed addons of the YouScope server.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
ServerAddon[]	getGeneralAddons() Returns an array of all general purpose addons known by the server.
byte[]	getIP() Returns the IP address of the server.
<T extends ServerAddon> T	getServerAddon(java.lang.Class<T> addonInterface) Returns a remote addon provider implementing the given interface.
<T extends ServerAddon> T[]	getServerAddons(java.lang.Class<T> addonInterface) Returns all remote addon providers implementing the given interface.
java.lang.String[]	getSupportedImageFormats() Returns a list of supported image formats.
java.lang.String[]	getSupportedScriptEngines() Returns a list of all supported script engines of the server.

Method Detail

getSupportedImageFormats

java.lang.String[] getSupportedImageFormats()
                                     throws java.rmi.RemoteException

Returns a list of supported image formats.

Returns:

List of image formats.

Throws:

java.rmi.RemoteException

getIP

byte[] getIP()
      throws java.net.UnknownHostException,
             java.rmi.RemoteException

Returns the IP address of the server.

Returns:

IP address of server.

Throws:

java.net.UnknownHostException

java.rmi.RemoteException

getSupportedScriptEngines

java.lang.String[] getSupportedScriptEngines()
                                      throws java.rmi.RemoteException

Returns a list of all supported script engines of the server.

Returns:

List of script engines.

Throws:

java.rmi.RemoteException

getServerAddon

<T extends ServerAddon> T getServerAddon(java.lang.Class<T> addonInterface)
                                  throws java.rmi.RemoteException

Returns a remote addon provider implementing the given interface. This is a general purpose function designed to allow for specialized addon types. The interface of the addon has to be known by the client. If more than one addon implements the given interface, the first one found is returned. If no addon implements the interface, null is returned. See the description of the interface GeneralPurposeAddon for more details.

Type Parameters:

T - The interface of the addon.

Parameters:

addonInterface - The interface of the addon.

Returns:

An addon implementing the given interface, or null, if no addon could be found.

Throws:

java.rmi.RemoteException

getServerAddons

<T extends ServerAddon> T[] getServerAddons(java.lang.Class<T> addonInterface)
                                     throws java.rmi.RemoteException

Returns all remote addon providers implementing the given interface. This is a general purpose function designed to allow for specialized addon types. The interface of the addon has to be known by the client. If no addon implements the interface, an empty array is returned. See the description of the interface GeneralPurposeAddon for more details.

Type Parameters:

T - The interface of the addons.

Parameters:

addonInterface - The interface of the addons.

Returns:

An array of addons implementing the given interface, or an empty array, if no addon could be found.

Throws:

java.rmi.RemoteException

getGeneralAddons

ServerAddon[] getGeneralAddons()
                        throws java.rmi.RemoteException

Returns an array of all general purpose addons known by the server.

Returns:

Array of general purpose addons, or an empty list, if no addon is known.

Throws:

java.rmi.RemoteException