de.fhg.igd.atlas.core
Interface LSAdminService

All Known Implementing Classes:

LSProxyServiceImpl, LSServerServiceImpl

public interface LSAdminService

Defines the interface to parts of a LSProxyService respectively LSServerService implementation. The LSAdminService provides functionality of the Location Server Gui (LSGui) which can be used to watch and control the LSProxy and LSServer in an admistrative way.

Version:

"$Id: LSAdminService.java 1913 2007-08-08 02:41:53Z jpeters $"

Author:

Jan Peters

See Also:

LSProxyServiceImpl, LSServerServiceImpl

Method Summary

TrustedListener	addListener(Listener listener) Adds a Listener.
boolean	getEventFlag() Returns the current state of the event flag of the server's or proxy's internal database.
long	getTimeout() Returns the timeout of entries in the server database.
LSPReply	list(LSPList request) Handles the given list request (see LSPList).
boolean	securityAvailable() Returns the availability of encryption and encoding what needs special cryptographic algorithms.
void	setEventFlag(boolean flag) Sets the event flag to enable respectively disable the generation of events within the server's or proxy's internal database.
void	setTimeout(long timeout) Sets the timeout of entries in the server database.

Method Detail

list

public LSPReply list(LSPList request)

Handles the given list request (see LSPList). Following reply states and bodies are possible (see LSPReply):

• ACKNOWLEDGE (LSPListResult body)

Parameters:

request - The list request.

Returns:

The reply to the given request.

getTimeout

public long getTimeout()

Returns the timeout of entries in the server database.

Returns:

The timeout of entries in the server database. or 0 if the timeout mechanism is deactivated.

setTimeout

public void setTimeout(long timeout)

Sets the timeout of entries in the server database. A timeout of 0 deactivates the timeout mechanism.

Parameters:

timeout - The timeout in milli seconds.

securityAvailable

public boolean securityAvailable()

Returns the availability of encryption and encoding what needs special cryptographic algorithms.

Returns:

true if secure register requests can be handled; false otherwise.

addListener

public TrustedListener addListener(Listener listener)

Adds a Listener. The Listener will receive events of the type StorageDBEvent. Iff the event flag has been set, those events are triggered by the internal database of the server to incrementally describe its state. Listener instances passed to this method shall be wrapped in a TrustedListener which is then returned.

Parameters:

listener - The Listener to be registered.

Returns:

The TrustedListener that wraps around the given Listener.

Throws:

NullPointerException - if listener is null.

setEventFlag

public void setEventFlag(boolean flag)

Sets the event flag to enable respectively disable the generation of events within the server's or proxy's internal database.

Parameters:

flag - The event flag to be set.

getEventFlag

public boolean getEventFlag()

Returns the current state of the event flag of the server's or proxy's internal database.

Returns:

The event flag.