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

Class WsRestReceiveMessageRequest

java.lang.Object

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

All Implemented Interfaces:

WsRequestBean

public class WsRestReceiveMessageRequest
extends java.lang.Object
implements WsRequestBean

request bean in body of rest request

Constructor Summary

Constructors

Constructor and Description
WsRestReceiveMessageRequest()

Method Summary

Modifier and Type	Method and Description
WsSubjectLookup	getActAsSubjectLookup() if acting as someone else
java.lang.String	getBlockMillis()
java.lang.String	getClientVersion() is the version of the client.
java.lang.String	getMaxMessagesToReceiveAtOnce()
java.lang.String	getMessageSystemName()
WsParam[]	getParams() optional: reserved for future use
java.lang.String	getQueueOrTopicName()
java.lang.String	getRoutingKey()
java.lang.String	isAutocreateObjects() create queue/topic if doesn't exist already.
GrouperRestHttpMethod	retrieveRestHttpMethod() see which http method this is supposed to be associated with, and override whatever was passed in
void	setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1) if acting as someone else
void	setAutocreateObjects(java.lang.String autocreateObjects1) create queue/topic if doesn't exist already.
void	setBlockMillis(java.lang.String blockMillis1)
void	setClientVersion(java.lang.String clientVersion1) is the version of the client.
void	setMaxMessagesToReceiveAtOnce(java.lang.String maxMessagesToReceiveAtOnce1)
void	setMessageSystemName(java.lang.String messageSystemName1)
void	setParams(WsParam[] params1) optional: reserved for future use
void	setQueueOrTopicName(java.lang.String queueOrTopicName1)
void	setRoutingKey(java.lang.String routingKey1)

Methods inherited from class java.lang.Object

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

Constructor Detail

WsRestReceiveMessageRequest

public WsRestReceiveMessageRequest()

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()

getQueueOrTopicName

public java.lang.String getQueueOrTopicName()

Returns:

queueOrTopicName

setQueueOrTopicName

public void setQueueOrTopicName(java.lang.String queueOrTopicName1)

Parameters:

queueOrTopicName1 -

getRoutingKey

public java.lang.String getRoutingKey()

Returns:

routingKey

setRoutingKey

public void setRoutingKey(java.lang.String routingKey1)

Parameters:

routingKey1 -

getMessageSystemName

public java.lang.String getMessageSystemName()

Returns:

messageSystemName

setMessageSystemName

public void setMessageSystemName(java.lang.String messageSystemName1)

Parameters:

messageSystemName1 -

getBlockMillis

public java.lang.String getBlockMillis()

Returns:

the millis to block waiting for messages, max of 20000 (optional)

setBlockMillis

public void setBlockMillis(java.lang.String blockMillis1)

Parameters:

blockMillis1 - - the millis to block waiting for messages, max of 20000 (optional)

getMaxMessagesToReceiveAtOnce

public java.lang.String getMaxMessagesToReceiveAtOnce()

Returns:

max number of messages to receive at once, though can't be more than the server maximum (optional)

setMaxMessagesToReceiveAtOnce

public void setMaxMessagesToReceiveAtOnce(java.lang.String maxMessagesToReceiveAtOnce1)

Parameters:

maxMessagesToReceiveAtOnce1 - - max number of messages to receive at once, though can't be more than the server maximum (optional)

isAutocreateObjects

public java.lang.String isAutocreateObjects()

create queue/topic if doesn't exist already.

Returns:

autocreateObjects

setAutocreateObjects

public void setAutocreateObjects(java.lang.String autocreateObjects1)

create queue/topic if doesn't exist already.

Parameters:

autocreateObjects1 -

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 -