org.yamcs.api.artemis

Class YamcsClient

java.lang.Object

org.yamcs.api.artemis.YamcsClient

public class YamcsClient
extends Object

Collect here scenarios and corresponding methods for sending/receiving data: sendRequest via rpcProducer - "method" name as property and parameters as a ProtoBuf message - should automatically encode the replyTo address sendReply via rpcProducer - OK/NOK as property and return parameters as a ProtoBuf message - should somehow correlate with the request TODO executeRpc via rpcProducer/rpcConsumer -sendRequest and wait for replay a configurable timeout sendData via dataProducer - one chunk in a stream of data. - should manage end of stream conditions - should manage multiplexing different ProtoBuf message types sendEvent via dataProducer - event name as property and parameters as ProtoBuf message

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YamcsClient.ClientBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_ADDRESS_PREFIX
static String	DATA_QUEUE_PREFIX
org.apache.activemq.artemis.api.core.SimpleString	dataAddress
org.apache.activemq.artemis.api.core.client.ClientConsumer	dataConsumer
org.apache.activemq.artemis.api.core.SimpleString	dataQueue
static String	RPC_ADDRESS_PREFIX
static String	RPC_QUEUE_PREFIX
org.apache.activemq.artemis.api.core.SimpleString	rpcAddress
org.apache.activemq.artemis.api.core.client.ClientConsumer	rpcConsumer
org.apache.activemq.artemis.api.core.client.ClientProducer	rpcProducer
org.apache.activemq.artemis.api.core.SimpleString	rpcQueue
long	rpcTimeout

Method Summary

Modifier and Type	Method and Description
void	close()
com.google.protobuf.MessageLite	executeRpc(org.apache.activemq.artemis.api.core.SimpleString toAddress, String request, com.google.protobuf.MessageLite body, com.google.protobuf.MessageLite.Builder responseBuilder)
org.apache.activemq.artemis.api.core.client.ClientProducer	getDataProducer()
YamcsSession	getYamcsSession()
com.google.protobuf.MessageLite	receiveData(com.google.protobuf.MessageLite.Builder dataBuilder) Receives and decodes data Returns null if the FINISH message is received
com.google.protobuf.MessageLite	receiveImmediate(com.google.protobuf.MessageLite.Builder dataBuilder)
void	sendData(org.apache.activemq.artemis.api.core.SimpleString hornetAddress, org.apache.activemq.artemis.api.core.client.ClientMessage msg) Send message to the address using the data producer.
void	sendData(org.apache.activemq.artemis.api.core.SimpleString toAddress, org.yamcs.protobuf.Yamcs.ProtoDataType type, com.google.protobuf.MessageLite data)
void	sendDataEnd(org.apache.activemq.artemis.api.core.SimpleString toAddress)
void	sendDataError(org.apache.activemq.artemis.api.core.SimpleString toAddress, String message)
void	sendErrorReply(org.apache.activemq.artemis.api.core.SimpleString replyto, String message)
void	sendErrorReply(org.apache.activemq.artemis.api.core.SimpleString replyto, YamcsException e) Sends a ActiveMQ message containing an YamcsException.
void	sendEvent(org.apache.activemq.artemis.api.core.SimpleString toAddress, String eventName, com.google.protobuf.MessageLite data) sends an event via the dataProducer
void	sendReply(org.apache.activemq.artemis.api.core.SimpleString replyto, String response, com.google.protobuf.MessageLite body)
void	sendRequest(org.apache.activemq.artemis.api.core.SimpleString toAddress, String request, com.google.protobuf.MessageLite body)

Methods inherited from class java.lang.Object

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

Field Detail

DATA_ADDRESS_PREFIX

public static final String DATA_ADDRESS_PREFIX

See Also:

Constant Field Values

DATA_QUEUE_PREFIX

public static final String DATA_QUEUE_PREFIX

See Also:

Constant Field Values

RPC_ADDRESS_PREFIX

public static final String RPC_ADDRESS_PREFIX

See Also:

Constant Field Values

RPC_QUEUE_PREFIX

public static final String RPC_QUEUE_PREFIX

See Also:

Constant Field Values

dataConsumer

public org.apache.activemq.artemis.api.core.client.ClientConsumer dataConsumer

dataQueue

public org.apache.activemq.artemis.api.core.SimpleString dataQueue

dataAddress

public org.apache.activemq.artemis.api.core.SimpleString dataAddress

rpcAddress

public org.apache.activemq.artemis.api.core.SimpleString rpcAddress

rpcQueue

public org.apache.activemq.artemis.api.core.SimpleString rpcQueue

rpcConsumer

public org.apache.activemq.artemis.api.core.client.ClientConsumer rpcConsumer

rpcProducer

public org.apache.activemq.artemis.api.core.client.ClientProducer rpcProducer

rpcTimeout

public long rpcTimeout

Method Detail

sendErrorReply

public void sendErrorReply(org.apache.activemq.artemis.api.core.SimpleString replyto,
                           String message)
                    throws ArtemisApiException

Throws:

ArtemisApiException

sendErrorReply

public void sendErrorReply(org.apache.activemq.artemis.api.core.SimpleString replyto,
                           YamcsException e)
                    throws ArtemisApiException

Sends a ActiveMQ message containing an YamcsException. The exception type and string message are encoded in the headers while the extra payload (if any) is encoded in the body The exception extra arguments are encoded as

Parameters:

replyto -

e -

Throws:

ArtemisApiException

sendReply

public void sendReply(org.apache.activemq.artemis.api.core.SimpleString replyto,
                      String response,
                      com.google.protobuf.MessageLite body)
               throws ArtemisApiException

Throws:

ArtemisApiException

sendRequest

public void sendRequest(org.apache.activemq.artemis.api.core.SimpleString toAddress,
                        String request,
                        com.google.protobuf.MessageLite body)
                 throws ArtemisApiException

Throws:

ArtemisApiException

executeRpc

public com.google.protobuf.MessageLite executeRpc(org.apache.activemq.artemis.api.core.SimpleString toAddress,
                                                  String request,
                                                  com.google.protobuf.MessageLite body,
                                                  com.google.protobuf.MessageLite.Builder responseBuilder)
                                           throws ArtemisApiException,
                                                  YamcsException

Throws:

ArtemisApiException

YamcsException

close

public void close()
           throws org.apache.activemq.artemis.api.core.ActiveMQException

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

sendDataError

public void sendDataError(org.apache.activemq.artemis.api.core.SimpleString toAddress,
                          String message)
                   throws IOException,
                          ArtemisApiException

Throws:

IOException

ArtemisApiException

sendData

public void sendData(org.apache.activemq.artemis.api.core.SimpleString toAddress,
                     org.yamcs.protobuf.Yamcs.ProtoDataType type,
                     com.google.protobuf.MessageLite data)
              throws ArtemisApiException

Throws:

ArtemisApiException

sendDataEnd

public void sendDataEnd(org.apache.activemq.artemis.api.core.SimpleString toAddress)
                 throws ArtemisApiException

Throws:

ArtemisApiException

receiveData

public com.google.protobuf.MessageLite receiveData(com.google.protobuf.MessageLite.Builder dataBuilder)
                                            throws YamcsException,
                                                   ArtemisApiException,
                                                   org.apache.activemq.artemis.api.core.ActiveMQException

Receives and decodes data Returns null if the FINISH message is received

Throws:

YamcsException

ArtemisApiException

org.apache.activemq.artemis.api.core.ActiveMQException

receiveImmediate

public com.google.protobuf.MessageLite receiveImmediate(com.google.protobuf.MessageLite.Builder dataBuilder)
                                                 throws YamcsException,
                                                        ArtemisApiException

Throws:

YamcsException

ArtemisApiException

sendEvent

public void sendEvent(org.apache.activemq.artemis.api.core.SimpleString toAddress,
                      String eventName,
                      com.google.protobuf.MessageLite data)
               throws org.apache.activemq.artemis.api.core.ActiveMQException

sends an event via the dataProducer

Parameters:

toAddress -

eventName - name of the event to be encoded in the header

data -

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

getYamcsSession

public YamcsSession getYamcsSession()

sendData

public void sendData(org.apache.activemq.artemis.api.core.SimpleString hornetAddress,
                     org.apache.activemq.artemis.api.core.client.ClientMessage msg)
              throws ArtemisApiException

Send message to the address using the data producer.

Parameters:

hornetAddress -

msg -

Throws:

ArtemisApiException

getDataProducer

public org.apache.activemq.artemis.api.core.client.ClientProducer getDataProducer()