org.yamcs.api

Class EventProducerFactory

java.lang.Object

org.yamcs.api.EventProducerFactory

public class EventProducerFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
EventProducerFactory()

Method Summary

Modifier and Type	Method and Description
static EventProducer	getEventProducer() Creates an event producer based on the event-producer.yaml properties loaded from the classpath.
static EventProducer	getEventProducer(String instance) The instance passed as parameter will overwrite the instance in the config file if any.
static Queue<Yamcs.Event>	getMockupQueue()
static void	setMockup(boolean queue) Configure the factory to produce mockup objects, optionally queuing the events in a queue

Methods inherited from class java.lang.Object

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

Constructor Detail

EventProducerFactory

public EventProducerFactory()

Method Detail

setMockup

public static void setMockup(boolean queue)

Configure the factory to produce mockup objects, optionally queuing the events in a queue

Parameters:

queue - - if true then queue all messages in the mockupQueue queue.

getMockupQueue

public static Queue<Yamcs.Event> getMockupQueue()

getEventProducer

public static EventProducer getEventProducer()
                                      throws RuntimeException

Creates an event producer based on the event-producer.yaml properties loaded from the classpath. The yamcsURL in the file has to contain the yamcs instance. If the event-producer.yaml is not found, then a console event producer is created that just prints the messages on console.

Returns:

the created event producer

Throws:

RuntimeException - in case the config files is found but contains errors

getEventProducer

public static EventProducer getEventProducer(String instance)
                                      throws RuntimeException

The instance passed as parameter will overwrite the instance in the config file if any. If the event-producer.yml config file is not found on the classpath, returns a ConsoleEventProducer when called outside yamcs or an StreamEventProducer when called inside.

Parameters:

instance - - instance for which the producer is to be returned

Returns:

an EventProducer

Throws:

RuntimeException