edu.internet2.middleware.grouper.ws.rest.messaging

Class WsRestAcknowledgeMessageRequest

java.lang.Object

edu.internet2.middleware.grouper.ws.rest.messaging.WsRestAcknowledgeMessageRequest

All Implemented Interfaces:

WsRequestBean

public class WsRestAcknowledgeMessageRequest
extends java.lang.Object
implements WsRequestBean

request bean in body of rest request

Constructor Summary

Constructors

Constructor and Description
WsRestAcknowledgeMessageRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAcknowledgeType() what to do with the message.
WsSubjectLookup	getActAsSubjectLookup() if acting as someone else
java.lang.String	getAnotherQueueOrTopicName() destination of the message if acknowledgeType is send_to_another_queue
java.lang.String	getAnotherQueueType() destination type if acknowledge type is send_to_another_queue.
java.lang.String	getClientVersion() is the version of the client.
java.lang.String[]	getMessageIds()
java.lang.String	getMessageSystemName()
WsParam[]	getParams() optional: reserved for future use
java.lang.String	getQueueOrTopicName()
GrouperRestHttpMethod	retrieveRestHttpMethod() see which http method this is supposed to be associated with, and override whatever was passed in
void	setAcknowledgeType(java.lang.String acknowledgeType1) what to do with the message.
void	setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1) if acting as someone else
void	setAnotherQueueOrTopicName(java.lang.String anotherQueueOrTopicName1) destination of the message if acknowledgeType is send_to_another_queue
void	setAnotherQueueType(java.lang.String anotherQueueOrTopic1) destination type if acknowledge type is send_to_another_queue.
void	setClientVersion(java.lang.String clientVersion1) is the version of the client.
void	setMessageIds(java.lang.String[] messageIds1)
void	setMessageSystemName(java.lang.String messageSystemName1)
void	setParams(WsParam[] params1) optional: reserved for future use
void	setQueueOrTopicName(java.lang.String queueOrTopicName1)

Methods inherited from class java.lang.Object

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

Constructor Detail

WsRestAcknowledgeMessageRequest

public WsRestAcknowledgeMessageRequest()

Method Detail

retrieveRestHttpMethod

public GrouperRestHttpMethod retrieveRestHttpMethod()

Description copied from interface: WsRequestBean

see which http method this is supposed to be associated with, and override whatever was passed in

Specified by:

retrieveRestHttpMethod in interface WsRequestBean

Returns:

the method

See Also:

WsRequestBean.retrieveRestHttpMethod()

getMessageIds

public java.lang.String[] getMessageIds()

Returns:

the messages to be marked as processed

setMessageIds

public void setMessageIds(java.lang.String[] messageIds1)

Parameters:

messageIds1 - to be marked as processed

getQueueOrTopicName

public java.lang.String getQueueOrTopicName()

Returns:

queueOrTopicName

setQueueOrTopicName

public void setQueueOrTopicName(java.lang.String queueOrTopicName1)

Parameters:

queueOrTopicName1 -

getMessageSystemName

public java.lang.String getMessageSystemName()

Returns:

messageSystemName

setMessageSystemName

public void setMessageSystemName(java.lang.String messageSystemName1)

Parameters:

messageSystemName1 -

getAcknowledgeType

public java.lang.String getAcknowledgeType()

what to do with the message. valid options are: mark_as_processed, return_to_queue, return_to_end_of_queue, send_to_another_queue

Returns:

acknowledgeType

setAcknowledgeType

public void setAcknowledgeType(java.lang.String acknowledgeType1)

what to do with the message. valid options are: mark_as_processed, return_to_queue, return_to_end_of_queue, send_to_another_queue

Parameters:

acknowledgeType1 -

getAnotherQueueOrTopicName

public java.lang.String getAnotherQueueOrTopicName()

destination of the message if acknowledgeType is send_to_another_queue

Returns:

anotherQueueOrTopicName

setAnotherQueueOrTopicName

public void setAnotherQueueOrTopicName(java.lang.String anotherQueueOrTopicName1)

destination of the message if acknowledgeType is send_to_another_queue

Parameters:

anotherQueueOrTopicName1 -

getAnotherQueueType

public java.lang.String getAnotherQueueType()

destination type if acknowledge type is send_to_another_queue. Valid values are queue and topic

Returns:

anotherQueueOrTopic

setAnotherQueueType

public void setAnotherQueueType(java.lang.String anotherQueueOrTopic1)

destination type if acknowledge type is send_to_another_queue. Valid values are queue and topic

Parameters:

anotherQueueOrTopic1 -

getClientVersion

public java.lang.String getClientVersion()

is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Returns:

version

setClientVersion

public void setClientVersion(java.lang.String clientVersion1)

is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Parameters:

clientVersion1 -

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()

if acting as someone else

Returns:

act as subject

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)

if acting as someone else

Parameters:

actAsSubjectLookup1 -

getParams

public WsParam[] getParams()

optional: reserved for future use

Returns:

params

setParams

public void setParams(WsParam[] params1)

optional: reserved for future use

Parameters:

params1 -