org.transitime.db.webstructs

Class WebAgency

java.lang.Object

org.transitime.db.webstructs.WebAgency

@Entity
public class WebAgency
extends java.lang.Object

For keeping track of agency data for a website. Contains info such as the host of the agency so that can use RMI to connect to it.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
WebAgency(java.lang.String agencyId, java.lang.String hostName, boolean active, java.lang.String dbName, java.lang.String dbType, java.lang.String dbHost, java.lang.String dbUserName, java.lang.String dbPassword) Simple constructor.

Method Summary

Modifier and Type	Method and Description
Agency	getAgency() Returns the first (there can be multiple) GTFS agency object for the specified agencyId.
java.lang.String	getAgencyId()
java.lang.String	getAgencyName() Returns the GTFS agency name.
static java.util.List<WebAgency>	getCachedOrderedListOfWebAgencies() Gets list of web agencies, ordered by their agency names.
static WebAgency	getCachedWebAgency(java.lang.String agencyId) Gets specified WebAgency from the cache.
static WebAgency	getCachedWebAgency(java.lang.String agencyId, long rereadIfOlderThanMsecs) Gets specified WebAgency from the cache.
java.lang.String	getDbEncryptedPassword()
java.lang.String	getDbHost()
java.lang.String	getDbName() Returns name of the db for the agency
java.lang.String	getDbPassword()
java.lang.String	getDbType()
java.lang.String	getDbUserName()
java.lang.String	getHostName()
boolean	isActive()
static void	main(java.lang.String[] args) For storing a web agency in the web database
void	store(java.lang.String dbName) Stores this WebAgency object in the specified db.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAgency

public WebAgency(java.lang.String agencyId,
                 java.lang.String hostName,
                 boolean active,
                 java.lang.String dbName,
                 java.lang.String dbType,
                 java.lang.String dbHost,
                 java.lang.String dbUserName,
                 java.lang.String dbPassword)

Simple constructor.

Parameters:

agencyId -

hostName -

active -

dbName -

dbType -

dbHost -

dbUserName -

dbPassword - The non-encrypted password

Method Detail

store

public void store(java.lang.String dbName)

Stores this WebAgency object in the specified db.

Parameters:

dbName - Name of the db that the WebAgency object is stored in

getAgency

public Agency getAgency()

Returns the first (there can be multiple) GTFS agency object for the specified agencyId. The GTFS agency object is cached. First time it is accessed it is read from server via RMI. If can't connect via RMI then will timeout after a few seconds. This means that any call to this method can take several seconds if there is a problem.

Returns:

The Agency object, or null if can't access the agency via RMI

getAgencyName

public java.lang.String getAgencyName()

Returns the GTFS agency name. It is obtained via RMI the first time this method is access for an agency. Subsequent times a cached value is returned. If cannot connect to RMI then the agencyId is returned.

Returns:

The GTFS agency name

getCachedOrderedListOfWebAgencies

public static java.util.List<WebAgency> getCachedOrderedListOfWebAgencies()

Gets list of web agencies, ordered by their agency names. Uses cached version if possible. But if data not read from db since more than 5 minutes ago then will reread database. This way when this method is used to indicate which agencies are available the list will automatically show additions or deletions.

Not synchronized since webAgencyOrderedList is set in a single operation and it is OK if read twice on rare occurrence.

Returns:

List of WebAgency objects ordered by their agency names.

getCachedWebAgency

public static WebAgency getCachedWebAgency(java.lang.String agencyId,
                                           long rereadIfOlderThanMsecs)

Gets specified WebAgency from the cache. Rereads WebAgencies from db if cache is older than rereadIfOlderThanMsecs.

Parameters:

agencyId -

rereadIfOlderThanMsecs - If web agencies read from db more than this time ago then they are read in again.

Returns:

The specified WebAgency, or null if it doesn't exist.

getCachedWebAgency

public static WebAgency getCachedWebAgency(java.lang.String agencyId)

Gets specified WebAgency from the cache. Doesn't cause the cache of WebAgencies to be reloaded from the db.

Parameters:

agencyId -

Returns:

The specified WebAgency, or null if it doesn't exist.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAgencyId

public java.lang.String getAgencyId()

getHostName

public java.lang.String getHostName()

isActive

public boolean isActive()

getDbName

public java.lang.String getDbName()

Returns name of the db for the agency

Returns:

getDbType

public java.lang.String getDbType()

getDbHost

public java.lang.String getDbHost()

getDbUserName

public java.lang.String getDbUserName()

getDbEncryptedPassword

public java.lang.String getDbEncryptedPassword()

getDbPassword

public java.lang.String getDbPassword()

main

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

For storing a web agency in the web database

Parameters:

args - agencyId = args[0]; hostName = args[1]; dbName = args[2]; dbType = args[3]; dbHost = args[4]; dbUserName = args[5]; dbPassword = args[6];