org.transitime.db.webstructs

Class ApiKeyManager

java.lang.Object

org.transitime.db.webstructs.ApiKeyManager

public class ApiKeyManager
extends java.lang.Object

Manages the ApiKeys. Caches them so API can quickly determine if key is valid.

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
void	deleteKey(java.lang.String key) Deletes the ApiKey from the database
ApiKey	generateApiKey(java.lang.String applicationName, java.lang.String applicationUrl, java.lang.String email, java.lang.String phone, java.lang.String description) Generates the new ApiKey and stores it in the db.
java.util.List<ApiKey>	getApiKeys() Gets the API keys from the database.
static ApiKeyManager	getInstance() Get singleton instance.
boolean	isKeyValid(java.lang.String key) Returns true if key is valid.
static void	main(java.lang.String[] args) For testing and debugging.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ApiKeyManager getInstance()

Get singleton instance.

Returns:

isKeyValid

public boolean isKeyValid(java.lang.String key)

Returns true if key is valid. Uses cache of keys so doesn't have to access database each time. If key not in cache then will reread keys from database in case it was just added. But won't do so more than every few seconds since more frequent access could allow an app with a bad key to cause the db to be queried to often putting an unneeded burden on the db.

Synchronized because can have simultaneous access and using a cache.

Parameters:

key - The key to investigate

Returns:

True if key is valid

getApiKeys

public java.util.List<ApiKey> getApiKeys()

Gets the API keys from the database. Gets the session for db access. The session is specified by parameters in CoreConfig including CoreConfig.getAgencyId() for the name of the database (such as "web") and CoreConfig.getDbHost(), CoreConfig.getDbUserName(), and CoreConfig.getDbPassword(). The db host, user name, and password can also be set in the hibernate.cfg.xml file if the parameter transitime.hibernate.configFile in the CoreConfig is set.

Returns:

generateApiKey

public ApiKey generateApiKey(java.lang.String applicationName,
                             java.lang.String applicationUrl,
                             java.lang.String email,
                             java.lang.String phone,
                             java.lang.String description)
                      throws java.lang.IllegalArgumentException,
                             org.hibernate.HibernateException

Generates the new ApiKey and stores it in the db.

Parameters:

applicationName -

applicationUrl -

email -

phone -

description -

Returns:

The new ApiKey or null if there was a problem such as the key

Throws:

java.lang.IllegalArgumentException

org.hibernate.HibernateException

deleteKey

public void deleteKey(java.lang.String key)

Deletes the ApiKey from the database

Parameters:

key -

main

public static void main(java.lang.String[] args)

For testing and debugging. Currently creates a new key for an application.

Parameters:

args -