Package org.gcube.portal.social.networking.ws.methods.v2

Class Messages

java.lang.Object

org.gcube.portal.social.networking.ws.methods.v2.Messages

@Path("2/messages")
public class Messages
extends Object

Messages services REST interface

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Constructor Summary

Constructors

Constructor	Description
Messages()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getReceivedMessages()
javax.ws.rs.core.Response	getSentMessages()
javax.ws.rs.core.Response	setMessageRead(String messageId, Boolean read)	Set message read or unread
javax.ws.rs.core.Response	writeMessage(org.gcube.social_networking.socialnetworking.model.beans.MessageInputBean input, javax.servlet.http.HttpServletRequest httpServletRequest)	Write a message to another user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Messages

public Messages()

Method Detail

writeMessage

@POST
@Path("write-message/")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response writeMessage(@NotNull(message="Message to send is missing")
                                              org.gcube.social_networking.socialnetworking.model.beans.MessageInputBean input,
                                              @Context
                                              javax.servlet.http.HttpServletRequest httpServletRequest)
                                       throws javax.validation.ValidationException,
                                              org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException,
                                              org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault

Write a message to another user. The sender is the token's owner by default

Parameters:

input - The message to write"

httpServletRequest -

Returns:

see response example

Throws:

javax.validation.ValidationException

org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException

org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault

getSentMessages

@GET
@Path("get-sent-messages")
@Produces("application/json")
public javax.ws.rs.core.Response getSentMessages()

getReceivedMessages

@GET
@Path("get-received-messages")
@Produces("application/json")
public javax.ws.rs.core.Response getReceivedMessages()

setMessageRead

@POST
@Path("set-message-read/")
@Produces("application/json")
public javax.ws.rs.core.Response setMessageRead(@NotNull(message="input is missing") @FormParam("messageId")
                                                String messageId,
                                                @FormParam("read")
                                                Boolean read)
                                         throws javax.validation.ValidationException

Set message read or unread

Parameters:

messageId - the message identifier

read - true to set read, false to set unread

Returns:

the result of the operation

Throws:

javax.validation.ValidationException