org.transitime.ipc.servers

Class ConfigServer

java.lang.Object

org.transitime.ipc.rmi.AbstractServer

org.transitime.ipc.servers.ConfigServer

All Implemented Interfaces:

java.rmi.Remote, ConfigInterface

public class ConfigServer
extends AbstractServer
implements ConfigInterface

Implements ConfigInterface to serve up configuration information to RMI clients.

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
java.util.List<Agency>	getAgencies() Returns list of Agency objects containing data from GTFS agency.txt file
java.util.List<IpcCalendar>	getAllCalendars() Returns list of all Calendar objects.
IpcBlock	getBlock(java.lang.String blockId, java.lang.String serviceId) Returns block info for specified blockId and serviceId.
java.util.List<java.lang.String>	getBlockIds() Returns list of block IDs, unsorted, duplicates removed
java.util.List<java.lang.String>	getBlockIds(java.lang.String serviceId) Returns list of block IDs for specified serviceId, unsorted
java.util.Collection<IpcBlock>	getBlocks(java.lang.String blockId) Returns blocks for each service class for the blockId specified.
java.util.List<IpcCalendar>	getCurrentCalendars() Returns list of Calendar objects that are currently active.
java.util.List<java.lang.String>	getCurrentServiceIds() Returns list of service IDs, unsorted
IpcRoute	getRoute(java.lang.String routeIdOrShortName, java.lang.String directionId, java.lang.String stopId, java.lang.String tripPatternId) Obtains data for single route.
java.util.Collection<IpcRouteSummary>	getRoutes() Obtains ordered list of routes configured.
java.util.List<IpcSchedule>	getSchedules(java.lang.String routeIdOrShortName) Returns list of IpcSchedule objects for the specified routeIdOrShortName
java.util.List<java.lang.String>	getServiceIds() Returns list of service IDs, unsorted
IpcDirectionsForRoute	getStops(java.lang.String routeIdOrShortName) Returns stops for each direction for a route.
IpcTrip	getTrip(java.lang.String tripId) Returns trip info for specified tripId.
java.util.List<java.lang.String>	getTripIds() Returns list of trip IDs, unsorted
java.util.List<IpcTripPattern>	getTripPatterns(java.lang.String routeIdOrShortName) Returns trip patterns for specified routeIdOrShortName.
java.util.List<java.lang.String>	getVehicleIds() Returns list of vehicle IDs, unsorted
static ConfigServer	start(java.lang.String agencyId) Starts up the ConfigServer so that RMI calls can query for configuration data.

Methods inherited from class org.transitime.ipc.rmi.AbstractServer

getAgencyId, getBindName, isConstructed

Methods inherited from class java.lang.Object

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

Method Detail

start

public static ConfigServer start(java.lang.String agencyId)

Starts up the ConfigServer so that RMI calls can query for configuration data. This will automatically cause the object to continue to run and serve requests.

Parameters:

agencyId -

Returns:

the singleton ConfigServer object. Usually does not need to used since the server will be fully running.

getRoutes

public java.util.Collection<IpcRouteSummary> getRoutes()
                                                throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Obtains ordered list of routes configured.

Specified by:

getRoutes in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getRoute

public IpcRoute getRoute(java.lang.String routeIdOrShortName,
                         java.lang.String directionId,
                         java.lang.String stopId,
                         java.lang.String tripPatternId)
                  throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Obtains data for single route.

Specified by:

getRoute in interface ConfigInterface

Parameters:

routeIdOrShortName - Specifies which route to provide data for. routeShortName is often used instead of routeId since routeIds unfortunately often change when there is a schedule change.

directionId - optional. If want UI to highlight the remaining stops and paths left in the trip then can specify directionId along with the stopId. The directionId can be needed for agencies where only a single stop is used for both directions for a route.

stopId - optional. If want UI to highlight the remaining stops and paths left in trip then stopId is used to return which stops remain in trip. If this additional info not needed for UI then null can be specified.

tripPatternId - optional. If want UI to highlight the remaining stops and paths left in trip then stopId is used to determine which trip pattern to highlight. If this additional info not needed for UI then null can be specified.

Returns:

Throws:

java.rmi.RemoteException

getStops

public IpcDirectionsForRoute getStops(java.lang.String routeIdOrShortName)
                               throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns stops for each direction for a route.

Specified by:

getStops in interface ConfigInterface

Parameters:

routeIdOrShortName - Specifies which route to provide data for. routeShortName is often used instead of routeId since routeIds unfortunately often change when there is a schedule change.

Returns:

Throws:

java.rmi.RemoteException

getBlock

public IpcBlock getBlock(java.lang.String blockId,
                         java.lang.String serviceId)
                  throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns block info for specified blockId and serviceId. Includes all trip and trip pattern info associated with the block.

Specified by:

getBlock in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getBlocks

public java.util.Collection<IpcBlock> getBlocks(java.lang.String blockId)
                                         throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns blocks for each service class for the blockId specified.

Specified by:

getBlocks in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getTrip

public IpcTrip getTrip(java.lang.String tripId)
                throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns trip info for specified tripId. Includes all trip pattern info associated with the trip.

Specified by:

getTrip in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getTripPatterns

public java.util.List<IpcTripPattern> getTripPatterns(java.lang.String routeIdOrShortName)
                                               throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns trip patterns for specified routeIdOrShortName.

Specified by:

getTripPatterns in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getAgencies

public java.util.List<Agency> getAgencies()
                                   throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of Agency objects containing data from GTFS agency.txt file

Specified by:

getAgencies in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getSchedules

public java.util.List<IpcSchedule> getSchedules(java.lang.String routeIdOrShortName)
                                         throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of IpcSchedule objects for the specified routeIdOrShortName

Specified by:

getSchedules in interface ConfigInterface

Returns:

Throws:

java.rmi.RemoteException

getCurrentCalendars

public java.util.List<IpcCalendar> getCurrentCalendars()

Description copied from interface: ConfigInterface

Returns list of Calendar objects that are currently active.

Specified by:

getCurrentCalendars in interface ConfigInterface

Returns:

getAllCalendars

public java.util.List<IpcCalendar> getAllCalendars()

Description copied from interface: ConfigInterface

Returns list of all Calendar objects.

Specified by:

getAllCalendars in interface ConfigInterface

Returns:

getVehicleIds

public java.util.List<java.lang.String> getVehicleIds()
                                               throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of vehicle IDs, unsorted

Specified by:

getVehicleIds in interface ConfigInterface

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getServiceIds

public java.util.List<java.lang.String> getServiceIds()
                                               throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of service IDs, unsorted

Specified by:

getServiceIds in interface ConfigInterface

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getCurrentServiceIds

public java.util.List<java.lang.String> getCurrentServiceIds()
                                                      throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of service IDs, unsorted

Specified by:

getCurrentServiceIds in interface ConfigInterface

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getTripIds

public java.util.List<java.lang.String> getTripIds()
                                            throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of trip IDs, unsorted

Specified by:

getTripIds in interface ConfigInterface

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getBlockIds

public java.util.List<java.lang.String> getBlockIds()
                                             throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of block IDs, unsorted, duplicates removed

Specified by:

getBlockIds in interface ConfigInterface

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getBlockIds

public java.util.List<java.lang.String> getBlockIds(java.lang.String serviceId)
                                             throws java.rmi.RemoteException

Description copied from interface: ConfigInterface

Returns list of block IDs for specified serviceId, unsorted

Specified by:

getBlockIds in interface ConfigInterface

Parameters:

serviceId - If null then all block IDs are returned

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException