org.yamcs.parameter

Class ParameterWithIdRequestHelper

java.lang.Object

org.yamcs.parameter.ParameterWithIdRequestHelper

All Implemented Interfaces:

ParameterConsumer

public class ParameterWithIdRequestHelper
extends Object
implements ParameterConsumer

This sits in front of the ParameterRequestManager and implements subscriptions based on NamedObjectId taking care to send to the consumers the parameters with the requested id. A client can request in fact the same parameter with two different names and they will get it twice each time. In addition it can also provide updates on parameter expirations. TODO: impose some subscription limits

Author:

nm

Constructor Summary

Constructors

Constructor and Description
ParameterWithIdRequestHelper(ParameterRequestManager prm, ParameterWithIdConsumer listener)

Method Summary

Modifier and Type	Method and Description
void	addItemsToRequest(int subscriptionId, List<Yamcs.NamedObjectId> idList, AuthenticationToken authToken)
int	addRequest(List<Yamcs.NamedObjectId> idList, AuthenticationToken authToken)
int	addRequest(List<Yamcs.NamedObjectId> idList, boolean checkExpiration, AuthenticationToken authToken)
ParameterRequestManager	getPrm()
List<ParameterValueWithId>	getValuesFromCache(List<Yamcs.NamedObjectId> idList, AuthenticationToken authToken)
boolean	hasParameterCache()
void	quit()
void	removeItemsFromRequest(int subscriptionId, List<Yamcs.NamedObjectId> parameterIds, AuthenticationToken authToken)
void	removeRequest(int subscriptionId)
int	subscribeAll(String namespace, AuthenticationToken authToken)
List<Yamcs.NamedObjectId>	switchPrm(ParameterRequestManager newPrm, AuthenticationToken authToken) Change processor and return the list of parameters that were valid in the old processor and are not anymore
void	updateItems(int subscriptionId, List<ParameterValue> items) Called from when new parameters are available to be sent to clients

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterWithIdRequestHelper

public ParameterWithIdRequestHelper(ParameterRequestManager prm,
                                    ParameterWithIdConsumer listener)

Method Detail

addRequest

public int addRequest(List<Yamcs.NamedObjectId> idList,
                      AuthenticationToken authToken)
               throws InvalidIdentification,
                      NoPermissionException

Throws:

InvalidIdentification

NoPermissionException

addRequest

public int addRequest(List<Yamcs.NamedObjectId> idList,
                      boolean checkExpiration,
                      AuthenticationToken authToken)
               throws InvalidIdentification,
                      NoPermissionException

Throws:

InvalidIdentification

NoPermissionException

addItemsToRequest

public void addItemsToRequest(int subscriptionId,
                              List<Yamcs.NamedObjectId> idList,
                              AuthenticationToken authToken)
                       throws InvalidIdentification,
                              NoPermissionException

Throws:

InvalidIdentification

NoPermissionException

removeRequest

public void removeRequest(int subscriptionId)

removeItemsFromRequest

public void removeItemsFromRequest(int subscriptionId,
                                   List<Yamcs.NamedObjectId> parameterIds,
                                   AuthenticationToken authToken)
                            throws NoPermissionException

Throws:

NoPermissionException

getPrm

public ParameterRequestManager getPrm()

subscribeAll

public int subscribeAll(String namespace,
                        AuthenticationToken authToken)
                 throws NoPermissionException

Throws:

NoPermissionException

getValuesFromCache

public List<ParameterValueWithId> getValuesFromCache(List<Yamcs.NamedObjectId> idList,
                                                     AuthenticationToken authToken)
                                              throws InvalidIdentification,
                                                     NoPermissionException

Throws:

InvalidIdentification

NoPermissionException

updateItems

public void updateItems(int subscriptionId,
                        List<ParameterValue> items)

Called from when new parameters are available to be sent to clients

Specified by:

updateItems in interface ParameterConsumer

switchPrm

public List<Yamcs.NamedObjectId> switchPrm(ParameterRequestManager newPrm,
                                           AuthenticationToken authToken)
                                    throws NoPermissionException

Change processor and return the list of parameters that were valid in the old processor and are not anymore

Throws:

NoPermissionException

hasParameterCache

public boolean hasParameterCache()

quit

public void quit()