de.fhg.igd.atlas.core
Interface LSProxyService

All Known Implementing Classes:

LSProxyServiceImpl

public interface LSProxyService

Defines the interface to a LSProxyService implementation. The LSProxyService provides the functionality of the Location Server Proxy (LSProxy) which can be seen as gateway between Location Service Client (LSClient) and Location Service Server (LSServer).

Version:

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

Author:

Jan Peters

See Also:

LSProxy

Method Summary

LSPReply	lookup(LSPLookup request) Handles the given lookup request (see LSPLookup).
LSPReply	proxyInvalidate(LSPProxyInvalidate request) Handles the given proxy invalidate request (see LSPProxyInvalidate).
LSPReply	refresh(LSPRefresh request) Handles the given refresh request (see LSPRefresh).
LSPReply	registerPlain(LSPRegisterPlain request) Handles the given register plain request (see LSPRegister).

Method Detail

lookup

public LSPReply lookup(LSPLookup request)

Handles the given lookup request (see LSPLookup).

 
  lookup in local database
  |  
  +--globalLookup
 

The lookup request is processed in the local database. If the entry has not been not found the request is forwarded to the corresponding LSServer and this result is returned.

Following reply states and bodies are possible (see LSPReply):

• ACKNOWLEDGE (LSPLookupResult body)
• IMPLICIT_NAME_NOT_FOUND (no body)

• WRONG_VERSION (no body)
• REQUEST_TYPE_INVALID (no body)
• REQUEST_BODY_INVALID (no body)

• INTERNAL_CLIENT_ERROR (no body)
• IO_ERROR (no body)

The SERVER_ERROR_FLAG of the reply is set, if the reply state of the LSServer has been an IO_ERROR.

Parameters:

request - The register lookup.

Returns:

The reply to the given request.

registerPlain

public LSPReply registerPlain(LSPRegisterPlain request)

Handles the given register plain request (see LSPRegister).

 
  +--registerPlain in local database
  |
  +--globalRegisterEncrypted/Encoded
     |
     +--globalRegisterPlain
 

The request is processed in the local database first. If the reply state is not ACKNOWLEDGE, registration is aborted and the reply returned directly.

If the reply was succesful the request is forwarded to the corresponding LSServer by using encryption respectively encoding of the request message if security options are available, using plain messages otherwise.

Nevertheless the result of the request processed on the local database will be returned (the proxy's state is more important than the serer's one)

Following reply states are possible (see LSPReply):

• ACKNOWLEDGE

• REQUEST_BODY_INVALID
• CONTACT_ADDRESS_NOT_EXISTENT
• COOKIE_INVALID
• IMPLICIT_NAME_NOT_PRESENT

The SERVER_ERROR_FLAG of the reply is set, if the reply state of the LSServer has been an IO_ERROR.

In the case that an update request could not be processed succesfully on proxy respectively server side, because the corresponding entry has not been found, it's tried to reinitialize the entry with an init request.

Parameters:

request - The register plain request.

Returns:

The reply to the given request.

refresh

public LSPReply refresh(LSPRefresh request)

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

• ACKNOWLEDGE (no body)
• SOME_IMPLICIT_NAMES_NOT_PRESENT (LSPRefreshResult body)

Parameters:

request - The refresh request.

Returns:

The reply to the given request.

proxyInvalidate

public LSPReply proxyInvalidate(LSPProxyInvalidate request)

Handles the given proxy invalidate request (see LSPProxyInvalidate). Following reply states are possible (see LSPReply):

• ACKNOWLEDGE
• IMPLICIT_NAME_NOT_PRESENT

Parameters:

request - The proxy invalidate request.

Returns:

The reply to the given request.