org.transitime.ipc.servers

Class VehiclesServer

java.lang.Object

org.transitime.ipc.rmi.AbstractServer

org.transitime.ipc.servers.VehiclesServer

All Implemented Interfaces:

java.rmi.Remote, VehiclesInterface

public class VehiclesServer
extends AbstractServer
implements VehiclesInterface

Implements the VehiclesInterface interface on the server side such that a VehiclessClient can make RMI calls in order to obtain vehicle information. The vehicle information is provided using org.transitime.ipc.data.Vehicle objects.

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IpcVehicle>	get() Gets from server IpcVehicle info for all vehicles.
java.util.Collection<IpcVehicle>	get(java.util.Collection<java.lang.String> vehicleIds) Gets from server IpcVehicle info for vehicles specified by vehicles parameter.
IpcVehicle	get(java.lang.String vehicleId) Gets from server IpcVehicle info for specified vehicle.
java.util.Collection<IpcActiveBlock>	getActiveBlocks(java.util.Collection<java.lang.String> routeIds, int allowableBeforeTimeSecs) Gets from the server IpcActiveBlocks for blocks that are currently active.
java.util.Collection<IpcVehicleComplete>	getComplete() Gets from server IpcCompleteVehicle info for all vehicles.
java.util.Collection<IpcVehicleComplete>	getComplete(java.util.Collection<java.lang.String> vehicleIds) Gets from server IpcCompleteVehicle info for vehicles specified by vehicles parameter.
IpcVehicleComplete	getComplete(java.lang.String vehicleId) Gets from server IpcCompleteVehicle info for specified vehicle.
java.util.Collection<IpcVehicleComplete>	getCompleteForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames) Gets from server IpcCompleteVehicle info for all vehicles currently.
java.util.Collection<IpcVehicleComplete>	getCompleteForRoute(java.lang.String routeIdOrShortName) Gets from server IpcCompleteVehicle info for all vehicles currently.
java.util.Collection<IpcVehicle>	getForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames) Gets from server IpcVehicle info for all vehicles currently.
java.util.Collection<IpcVehicle>	getForRoute(java.lang.String routeIdOrShortName) Gets from server IpcVehicle info for all vehicles currently.
java.util.Collection<IpcVehicleGtfsRealtime>	getGtfsRealtime() Gets from server IpcCompleteVehicle info for all vehicles.
java.util.Collection<IpcVehicleConfig>	getVehicleConfigs() For getting configuration information for all vehicles.
static VehiclesServer	start(java.lang.String agencyId, VehicleDataCache vehicleManager) Starts up the VehiclesServer so that RMI calls can query for predictions.

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 VehiclesServer start(java.lang.String agencyId,
                                   VehicleDataCache vehicleManager)

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

Parameters:

agencyId -

predictionManager -

Returns:

the singleton PredictionsServer object

get

public java.util.Collection<IpcVehicle> get()
                                     throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcVehicle info for all vehicles.

Specified by:

get in interface VehiclesInterface

Returns:

Collection of IpcVehicle objects

Throws:

java.rmi.RemoteException

getComplete

public java.util.Collection<IpcVehicleComplete> getComplete()
                                                     throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for all vehicles.

Specified by:

getComplete in interface VehiclesInterface

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getGtfsRealtime

public java.util.Collection<IpcVehicleGtfsRealtime> getGtfsRealtime()
                                                             throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for all vehicles.

Specified by:

getGtfsRealtime in interface VehiclesInterface

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

get

public IpcVehicle get(java.lang.String vehicleId)
               throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcVehicle info for specified vehicle.

Specified by:

get in interface VehiclesInterface

Parameters:

vehicleId - ID of vehicle to get data for

Returns:

info for specified vehicle

Throws:

java.rmi.RemoteException

getComplete

public IpcVehicleComplete getComplete(java.lang.String vehicleId)
                               throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for specified vehicle.

Specified by:

getComplete in interface VehiclesInterface

Parameters:

vehicleId - ID of vehicle to get data for

Returns:

info for specified vehicle

Throws:

java.rmi.RemoteException

get

public java.util.Collection<IpcVehicle> get(java.util.Collection<java.lang.String> vehicleIds)
                                     throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcVehicle info for vehicles specified by vehicles parameter.

Specified by:

get in interface VehiclesInterface

Parameters:

vehicleIds - Collection of vehicle IDs to get Vehicle data for.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getComplete

public java.util.Collection<IpcVehicleComplete> getComplete(java.util.Collection<java.lang.String> vehicleIds)
                                                     throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for vehicles specified by vehicles parameter.

Specified by:

getComplete in interface VehiclesInterface

Parameters:

vehicleIds - Collection of vehicle IDs to get Vehicle data for.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getForRoute

public java.util.Collection<IpcVehicle> getForRoute(java.lang.String routeIdOrShortName)
                                             throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcVehicle info for all vehicles currently. associated with route.

Specified by:

getForRoute in interface VehiclesInterface

Parameters:

routeIdOrShortName - Specifies which route to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getCompleteForRoute

public java.util.Collection<IpcVehicleComplete> getCompleteForRoute(java.lang.String routeIdOrShortName)
                                                             throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for all vehicles currently. associated with route.

Specified by:

getCompleteForRoute in interface VehiclesInterface

Parameters:

routeIdOrShortName - Specifies which route to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getForRoute

public java.util.Collection<IpcVehicle> getForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames)
                                             throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcVehicle info for all vehicles currently. associated with route.

Specified by:

getForRoute in interface VehiclesInterface

Parameters:

routeIdsOrShortNames - Specifies which routes to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getCompleteForRoute

public java.util.Collection<IpcVehicleComplete> getCompleteForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames)
                                                             throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from server IpcCompleteVehicle info for all vehicles currently. associated with route.

Specified by:

getCompleteForRoute in interface VehiclesInterface

Parameters:

routeIdsOrShortNames - Specifies which routes to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getActiveBlocks

public java.util.Collection<IpcActiveBlock> getActiveBlocks(java.util.Collection<java.lang.String> routeIds,
                                                            int allowableBeforeTimeSecs)
                                                     throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

Gets from the server IpcActiveBlocks for blocks that are currently active.

Specified by:

getActiveBlocks in interface VehiclesInterface

Parameters:

routeIds - List of routes that want data for. Can also be null or empty.

allowableBeforeTimeSecs - How much before the block time the block is considered to be active

Returns:

Collection of blocks that are active

Throws:

java.rmi.RemoteException

getVehicleConfigs

public java.util.Collection<IpcVehicleConfig> getVehicleConfigs()
                                                         throws java.rmi.RemoteException

Description copied from interface: VehiclesInterface

For getting configuration information for all vehicles. Useful for determining IDs of all vehicles in system

Specified by:

getVehicleConfigs in interface VehiclesInterface

Returns:

Collection of IpcVehicleConfig objects

Throws:

java.rmi.RemoteException