Package org.opentcs.access.rmi.services

Klasse RemoteKernelServicePortalProxy

java.lang.Object

org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy

Alle implementierten Schnittstellen:

KernelServicePortal, ServiceListener

public class RemoteKernelServicePortalProxy
extends Object
implements KernelServicePortal, ServiceListener

The default implementation for the KernelServicePortal.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
RemoteKernelServicePortalProxy(String userName, String password, SocketFactoryProvider socketFactoryProvider, Predicate<Object> eventFilter)	Creates a new instance.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<Object>	fetchEvents(long timeout)	Fetches events buffered for the client.
DispatcherService	getDispatcherService()	Returns the service a client can use to access methods regarding the dispatcher.
NotificationService	getNotificationService()	Returns the service a client can use to access methods regarding user notifications.
PeripheralDispatcherService	getPeripheralDispatcherService()	Returns the service a client can use to access methods regarding the peripheral dispatcher.
PeripheralJobService	getPeripheralJobService()	Returns the service a client can use to access methods regarding peripheral jobs.
PeripheralService	getPeripheralService()	Returns the service a client can use to access methods regarding peripherals.
PlantModelService	getPlantModelService()	Returns the service a client can use to access methods regarding the plant model.
QueryService	getQueryService()	Returns the service a client can use to access methods for generic queries.
RouterService	getRouterService()	Returns the service a client can use to access methods regarding the router.
ServiceListener	getServiceListener()
Kernel.State	getState()	Returns the current state of the kernel.
TransportOrderService	getTransportOrderService()	Returns the service a client can use to access methods regarding transport orders and order sequences.
VehicleService	getVehicleService()	Returns the service a client can use to access methods regarding vehicles.
void	login(String hostName, int port)	Logs in with/establishes a connection to the remote kernel service portal.
void	logout()	Logs out from/clears the connection to the remote kernel service portal.
void	onServiceUnavailable()	Notifies a listener that the service is unavailable, i.e. is not in a usable state.
void	publishEvent(Object event)	Publishes an event.
org.opentcs.access.rmi.services.AbstractRemoteServiceProxy<RemoteKernelServicePortal>	setServiceListener(ServiceListener serviceListener)	Sets the listener that is interested in updates of this service.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

RemoteKernelServicePortalProxy

public RemoteKernelServicePortalProxy(@Nonnull
 String userName,
 @Nonnull
 String password,
 @Nonnull
 SocketFactoryProvider socketFactoryProvider,
 @Nonnull
 Predicate<Object> eventFilter)

Creates a new instance.

Parameter:

userName - The user name used with the remote portal.

password - The password used with the remote portal.

socketFactoryProvider - Provides socket factories used for RMI.

eventFilter - The event filter to be applied to events on the server side.

Methodendetails

getServiceListener

public ServiceListener getServiceListener()

onServiceUnavailable

public void onServiceUnavailable()

Beschreibung aus Schnittstelle kopiert: ServiceListener

Notifies a listener that the service is unavailable, i.e. is not in a usable state.

Angegeben von:

onServiceUnavailable in Schnittstelle ServiceListener

login

public void login(@Nonnull
 String hostName,
 int port)
           throws CredentialsException,
ServiceUnavailableException

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Logs in with/establishes a connection to the remote kernel service portal.

Angegeben von:

login in Schnittstelle KernelServicePortal

Parameter:

hostName - The host on which the remote portal is running.

port - The port at which we can reach the remote RMI registry.

Löst aus:

CredentialsException

ServiceUnavailableException

logout

public void logout()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Logs out from/clears the connection to the remote kernel service portal.

Angegeben von:

logout in Schnittstelle KernelServicePortal

getState

public Kernel.State getState()
                      throws KernelRuntimeException

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the current state of the kernel.

Angegeben von:

getState in Schnittstelle KernelServicePortal

Gibt zurück:

The current state of the kernel.

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

fetchEvents

public List<Object> fetchEvents(long timeout)
                         throws KernelRuntimeException

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Fetches events buffered for the client.

Angegeben von:

fetchEvents in Schnittstelle KernelServicePortal

Parameter:

timeout - A timeout (in ms) for which to wait for events to arrive.

Gibt zurück:

A list of events (in the order they arrived).

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

publishEvent

public void publishEvent(Object event)
                  throws KernelRuntimeException

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Publishes an event.

Angegeben von:

publishEvent in Schnittstelle KernelServicePortal

Parameter:

event - The event to be published.

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

getPlantModelService

@Nonnull
public PlantModelService getPlantModelService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding the plant model.

Angegeben von:

getPlantModelService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding the plant model.

getTransportOrderService

@Nonnull
public TransportOrderService getTransportOrderService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding transport orders and order sequences.

Angegeben von:

getTransportOrderService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding transport orders and order sequences.

getVehicleService

@Nonnull
public VehicleService getVehicleService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding vehicles.

Angegeben von:

getVehicleService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding vehicles.

getNotificationService

@Nonnull
public NotificationService getNotificationService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding user notifications.

Angegeben von:

getNotificationService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding user notifications.

getDispatcherService

@Nonnull
public DispatcherService getDispatcherService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding the dispatcher.

Angegeben von:

getDispatcherService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding the dispatcher.

getRouterService

@Nonnull
public RouterService getRouterService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding the router.

Angegeben von:

getRouterService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding the router.

getQueryService

@Nonnull
public QueryService getQueryService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods for generic queries.

Angegeben von:

getQueryService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods for generic queries.

getPeripheralService

@Nonnull
public PeripheralService getPeripheralService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding peripherals.

Angegeben von:

getPeripheralService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding peripherals.

getPeripheralJobService

@Nonnull
public PeripheralJobService getPeripheralJobService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding peripheral jobs.

Angegeben von:

getPeripheralJobService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding peripheral jobs.

getPeripheralDispatcherService

@Nonnull
public PeripheralDispatcherService getPeripheralDispatcherService()

Beschreibung aus Schnittstelle kopiert: KernelServicePortal

Returns the service a client can use to access methods regarding the peripheral dispatcher.

Angegeben von:

getPeripheralDispatcherService in Schnittstelle KernelServicePortal

Gibt zurück:

The service a client can use to access methods regarding the peripheral dispatcher.

setServiceListener

public org.opentcs.access.rmi.services.AbstractRemoteServiceProxy<RemoteKernelServicePortal> setServiceListener(ServiceListener serviceListener)

Sets the listener that is interested in updates of this service.

Parameter:

serviceListener - The service listener.

Gibt zurück:

This remote service proxy.