|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.usf.MessageService.MessageServiceClient
@Slf4j class MessageServiceClient
Groovy Client for MessageService
Constructor Summary | |
MessageServiceClient(java.lang.String messageHost)
@param messageHost URL of the MessageService Host (Example: https://server.example.edu) |
Method Summary | |
---|---|
JSONObject
|
changeMessageStatus(java.lang.String name, java.lang.String id, java.lang.String status)
Change the status on a message in a queue |
JSONObject
|
createQueue(java.lang.String name, java.util.List canRead = [], java.util.List canWrite = [], java.util.List canAdmin = [])
Create a new queue |
JSONObject
|
createQueueMessage(java.lang.String program, java.lang.String name, java.util.Map data)
Create a new message in a queue |
JSONObject
|
createTopic(java.lang.String name, java.util.List canRead = [], java.util.List canWrite = [], java.util.List canAdmin = [])
Create a new topic |
JSONObject
|
createTopicMessage(java.lang.String program, java.lang.String name, java.util.Map data)
Create a new message in a topic |
java.lang.String
|
deleteQueue(java.lang.String name)
Delete Queue |
java.lang.String
|
deleteQueueMessage(java.lang.String name, java.lang.String id)
Delete a message from a queue |
java.lang.String
|
deleteTopic(java.lang.String name)
Delete Topic |
JSONArray
|
getInProgressMessages(java.lang.String queue)
Get a list of all messages in a queue with the status 'in-progress' |
JSONObject
|
getQueueList()
Get a list of all message queues |
JSONObject
|
getQueueMessage(java.lang.String queue)
Get oldest "pending" message in a queue |
JSONObject
|
getTopicList()
Get a list of all message topics |
JSONArray
|
getTopicMessages(java.lang.String topic, java.lang.Object startTime = null , java.lang.Object endTime = null)
Get a list of all messages in a topic |
JSONArray
|
peek(java.lang.String queue, java.lang.Integer num = 10)
Get a list of messages in a queue without changing their status |
void
|
setCredentials(java.lang.String username, java.lang.String password)
Set the username and password for MessageService access |
void
|
setKeyStoreLocation(java.lang.String keyStorePath, java.lang.String keyStorePass)
Set the location and password of the Java Trust Store to use for this connection. |
void
|
setMessageBasePath(java.lang.String path)
Set the base location of the MessageService deployment. |
void
|
setQueueFileLocation(java.lang.String queueDirectory)
Set the directory to write local queue files to in case of a MessageService outage or error |
void
|
trustAllCerts()
Disable certificate validation and trust the certificate of any server we connect to. |
Methods inherited from class java.lang.Object | |
---|---|
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Constructor Detail |
---|
MessageServiceClient(java.lang.String messageHost)
messageHost
- URL of the MessageService Host (Example: https://server.example.edu)
Method Detail |
---|
JSONObject changeMessageStatus(java.lang.String name, java.lang.String id, java.lang.String status)
name
- Queue containing the messageid
- Message IDstatus
- Status to change the message to. (allowed: in-progress, pending, completed, error)
JSONObject createQueue(java.lang.String name, java.util.List canRead = [], java.util.List canWrite = [], java.util.List canAdmin = [])
canRead
- List of the user who can read messages from this queuecanWrite
- List of the user who can write messages to this queuecanAdmin
- List of the user who can modify this queue
JSONObject createQueueMessage(java.lang.String program, java.lang.String name, java.util.Map data)
program
- Name of the program creating this messagename
- Queue to write the message todata
- Data to write to the message
JSONObject createTopic(java.lang.String name, java.util.List canRead = [], java.util.List canWrite = [], java.util.List canAdmin = [])
canRead
- List of the user who can read messages from this topiccanWrite
- List of the user who can write messages to this topiccanAdmin
- List of the user who can modify this topic
JSONObject createTopicMessage(java.lang.String program, java.lang.String name, java.util.Map data)
program
- Name of the program creating this messagename
- Topic to write the message todata
- Data to write to the message
java.lang.String deleteQueue(java.lang.String name)
java.lang.String deleteQueueMessage(java.lang.String name, java.lang.String id)
name
- Queue containing the messageid
- Message ID
java.lang.String deleteTopic(java.lang.String name)
JSONArray getInProgressMessages(java.lang.String queue)
queue
- Queue to retrive messages from
JSONObject getQueueList()
JSONObject getQueueMessage(java.lang.String queue)
queue
- Queue to retrive messages from
JSONObject getTopicList()
JSONArray getTopicMessages(java.lang.String topic, java.lang.Object startTime = null , java.lang.Object endTime = null)
topic
- Topic to retrive messages fromstartTime
- Time to start message list at. Format yyyy-MM-dd'T'HH:mm:ss (optional)endTime
- Time to end message list at. Format yyyy-MM-dd'T'HH:mm:ss (optional)
JSONArray peek(java.lang.String queue, java.lang.Integer num = 10)
queue
- queue to retrive messages fromnum
- Number of messages to retrieve (Default: 10)
void setCredentials(java.lang.String username, java.lang.String password)
void setKeyStoreLocation(java.lang.String keyStorePath, java.lang.String keyStorePass)
keyStorePath
- Java key/trust storekeyStorePass
- keystore Password
void setMessageBasePath(java.lang.String path)
path
- MessageService path (Default: /MessageService/basic)
void setQueueFileLocation(java.lang.String queueDirectory)
queueDirectory
- Directory to save files in
void trustAllCerts()
Groovy Documentation