org.openhubframework.openhub.admin.web.message.rest

Class MessageController

java.lang.Object

org.openhubframework.openhub.admin.web.common.AbstractOhfController

org.openhubframework.openhub.admin.web.message.rest.MessageController

@RestController
 @RequestMapping(value="/api/messages")
public class MessageController
extends AbstractOhfController

Controller for managing operations with messages.

Since:

2.0

Author:

Karel Kovarik

Field Summary

Fields

Modifier and Type	Field and Description
static String	REST_URI

Fields inherited from class org.openhubframework.openhub.admin.web.common.AbstractOhfController

BASE_PATH

Constructor Summary

Constructors

Constructor and Description
MessageController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ActionResultRpc>	action(Long id, ActionRequestRpc actionRequestRpc) Perform action on message identified by its id.
org.springframework.http.ResponseEntity<MessageRpc>	detail(Long id) Get detail of message identified by its id.
MessageCollectionWrapper	list(MessageFilterRpc messageFilter) List messages, by given filter.

Methods inherited from class org.openhubframework.openhub.admin.web.common.AbstractOhfController

getMessage, getMessageEN, getMessageSource, pageContentList

Methods inherited from class java.lang.Object

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

Field Detail

REST_URI

public static final String REST_URI

See Also:

Constant Field Values

Constructor Detail

MessageController

public MessageController()

Method Detail

list

@GetMapping(produces={"application/xml","application/json"})
 @ResponseStatus(value=OK)
 @ResponseBody
public MessageCollectionWrapper list(MessageFilterRpc messageFilter)

List messages, by given filter.

Parameters:

messageFilter - the filter to filter messages.

Returns:

custom collection wrapper with message list elements.

detail

@GetMapping(path="/{id}",
            produces={"application/xml","application/json"})
public org.springframework.http.ResponseEntity<MessageRpc> detail(@PathVariable
                                                                                                                                                         Long id)

Get detail of message identified by its id.

Parameters:

id - the id of message.

Returns:

message detail.

action

@PostMapping(path="/{id}/action",
             produces={"application/xml","application/json"})
public org.springframework.http.ResponseEntity<ActionResultRpc> action(@PathVariable
                                                                                                                                                                       Long id,
                                                                                                                                                                       @RequestBody
                                                                                                                                                                       ActionRequestRpc actionRequestRpc)

Perform action on message identified by its id.

Parameters:

id - the id of message to perform action on.

actionRequestRpc - the action type.

Returns:

ActionResultRpc entity.