src.modules
Class ZLocateModule

java.lang.Object
  src.server.ModuleClass
      src.modules.ZLocateModule

All Implemented Interfaces:

Module

public class ZLocateModule

extends ModuleClass

Provides an interface for running zlocate commands on nada's machines to find out where a user is if the user is logged in. A few commandexamples:

• Var är abcdefg?
• zlocate abcdefg
• Jag vill veta var abcdefg är!

Version:

2005-maj-08

Constructor Summary

ZLocateModule()
Constructor for ZLocate.

Method Summary

java.lang.String	doZLocate(java.lang.String param) Performs a zlocate command with the specified parameters and return the result.
boolean	isValidCache(ModuleQuery query, java.lang.String cachedUserId, long cacheAge) Checks if a cached result is valid or not based on how long ago the result was cached.
Package	processQuery(ModuleQuery query) Process a user sent query.

Methods inherited from class src.server.ModuleClass

getModuleMeta, processSettingRequest, processSettingRequest, setModuleMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

ZLocateModule

public ZLocateModule()

Constructor for ZLocate.

Method Detail

isValidCache

public boolean isValidCache(ModuleQuery query,
                            java.lang.String cachedUserId,
                            long cacheAge)

Description copied from interface: Module

Checks if a cached result is valid or not based on how long ago the result was cached. Some services might work fine with returning very old cached results, for instance the result of a map service wont change (often at least) and most cache ages would then be valid. Other things like news services on the other hand should not allow a long cache age.

Parameters:

query - The user query that resulted in the cached result. The user's query parameters are identical to the cached query parameters.

cachedUserId - The userId of the query that is cached.

cacheAge - The number of seconds that has elapsed since the cached version was cached.

Returns:

True if the cache should be concidered to still be valid. False otherwise.

processQuery

public Package processQuery(ModuleQuery query)

Description copied from interface: Module

Process a user sent query. This is very individual depending on the service provided by the module.

Parameters:

query - The user sent query.

Returns:

An ErrorPackage if an error occured while processing the query, an OutputPackage with the result otherwise.

doZLocate

public java.lang.String doZLocate(java.lang.String param)

Performs a zlocate command with the specified parameters and return the result.

Parameters:

param - The parameter to send to the command.

Returns:

The result of the command (including error messages from failures).