org.transitime.db.webstructs

Class ApiKey

java.lang.Object

org.transitime.db.webstructs.ApiKey

All Implemented Interfaces:

java.io.Serializable

@Entity
public class ApiKey
extends java.lang.Object
implements java.io.Serializable

Database class for storing keys and related info for the API.

Author:

SkiBu Smith

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ApiKey(java.lang.String applicationName, java.lang.String key, java.lang.String applicationUrl, java.lang.String email, java.lang.String phone, java.lang.String description) For creating object to be written to db.

Method Summary

Modifier and Type	Method and Description
void	deleteApiKey(java.lang.String dbName) Deletes this ApiKey from specified database
static java.util.List<ApiKey>	getApiKeys(org.hibernate.Session session) Reads in all keys from database.
java.lang.String	getApplicationName()
java.lang.String	getApplicationUrl()
java.lang.String	getDescription()
java.lang.String	getEmail()
java.lang.String	getKey()
java.lang.String	getPhone()
void	storeApiKey(java.lang.String dbName) Stores the ApiKey in the database
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

ApiKey

public ApiKey(java.lang.String applicationName,
              java.lang.String key,
              java.lang.String applicationUrl,
              java.lang.String email,
              java.lang.String phone,
              java.lang.String description)

For creating object to be written to db.

Parameters:

key -

Method Detail

getApiKeys

public static java.util.List<ApiKey> getApiKeys(org.hibernate.Session session)
                                         throws org.hibernate.HibernateException

Reads in all keys from database.

Parameters:

session -

Returns:

Throws:

org.hibernate.HibernateException

storeApiKey

public void storeApiKey(java.lang.String dbName)

Stores the ApiKey in the database

Parameters:

dbName - name of database

deleteApiKey

public void deleteApiKey(java.lang.String dbName)

Deletes this ApiKey from specified database

Parameters:

dbName - name of database

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getApplicationName

public java.lang.String getApplicationName()

getKey

public java.lang.String getKey()

getApplicationUrl

public java.lang.String getApplicationUrl()

getEmail

public java.lang.String getEmail()

getPhone

public java.lang.String getPhone()

getDescription

public java.lang.String getDescription()