org.forgerock.openam.scripting.rest.batch.helpers

Class ScriptResponse

java.lang.Object

org.forgerock.openam.scripting.rest.batch.helpers.ScriptResponse

public class ScriptResponse
extends Object

Simple device to allow easy generation of appropriate return format for SDK scripts.

Constructor Summary

Constructors

Constructor and Description
ScriptResponse()

Method Summary

Modifier and Type	Method and Description
org.forgerock.json.JsonValue	build() Builds this ScriptResponse into a JsonValue for transport to the SDK.
String	getResponse(String responseId) Retrieve a specific response from the ScriptResponse.
Map<String,String>	getResponses() Returns an unmodifiable map of the responses this ScriptResponse holds.
void	put(String responseName, org.forgerock.json.JsonValue response)
void	putResponse(String responseId, org.forgerock.json.JsonValue json) Store a response in the ScriptResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptResponse

public ScriptResponse()

Method Detail

put

public void put(String responseName,
                org.forgerock.json.JsonValue response)

putResponse

public void putResponse(String responseId,
                        org.forgerock.json.JsonValue json)

Store a response in the ScriptResponse.

Parameters:

responseId - Non null responseID.

json - Non null JsonValue representing the JSON returned.

getResponse

public String getResponse(String responseId)

Retrieve a specific response from the ScriptResponse.

Parameters:

responseId - Non null responseID.

Returns:

Possibly null JsonValue corresponding to the responseID.

getResponses

public Map<String,String> getResponses()

Returns an unmodifiable map of the responses this ScriptResponse holds.

Returns:

a map of the current responses.

build

public org.forgerock.json.JsonValue build()
                                   throws IOException

Builds this ScriptResponse into a JsonValue for transport to the SDK.

Returns:

a JsonValue representation of this class.

Throws:

IOException - if there were issues converting to Json.