openconnector

Class Result

java.lang.Object

openconnector.Result

public class Result
extends java.lang.Object

A model to represent a result from a provisioning request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Result.Status The set of possible result status codes.

Constructor Summary

Constructors

Constructor and Description
Result() Construct an empty result.
Result(Result.Status status) Construct a result with an initial status.

Method Summary

Modifier and Type	Method and Description
void	add(java.util.List<java.lang.String> msgs) Add a list of messages to the result.
void	add(java.lang.String msg) Add one message to the result.
void	add(java.lang.Throwable t) Add a messages for an exception to the result.
void	fail(java.lang.String msg) Add a messages to the result and also set the status to Failed.
void	fail(java.lang.Throwable t) Add a messages for an exception to the result and also set the status to Failed.
java.util.List<java.lang.String>	getMessages() Get the result message list.
java.util.Map<java.lang.String,java.lang.Object>	getObject() This can be optionally returned by the connector in the result stored within a Request.
int	getRetryInterval() This is the optional preferred amount of time to wait before the request is retried.
Result.Status	getStatus()
java.lang.String	getToken() The token is used to identify an internal system object that was created to process the request.
boolean	isFailed()
boolean	isRetry()
boolean	isSubmitted()
void	setMessages(java.util.List<java.lang.String> messages) Set the result message list.
void	setObject(java.util.Map<java.lang.String,java.lang.Object> obj) Set the result object.
void	setRetryableFailure(java.lang.Throwable t) Add a messages for an exception to the result and also set the status to Retry.
void	setRetryInterval(int seconds) Set the retry interval.
void	setStatus(Result.Status status) Set the result status code.
void	setToken(java.lang.String token) Set the result token.
java.lang.String	toJson()
void	toJson(JsonBuilder jb) Render the Item as a JSON string for logging and debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result()

Construct an empty result.

Result

public Result(Result.Status status)

Construct a result with an initial status.

Method Detail

setStatus

public void setStatus(Result.Status status)

Set the result status code.

getStatus

public Result.Status getStatus()

Returns:

the result status code.

setToken

public void setToken(java.lang.String token)

Set the result token. The token is used to identify an internal system object that was created to process the request. Examples are trouble ticket id, or the id of a workflow process. In some systems this can be used to poll for status.

getToken

public java.lang.String getToken()

The token is used to identify an internal system object that was created to process the request. Examples are trouble ticket id, or the id of a workflow process. In some systems this can be used to poll for status.

Returns:

the result token.

setMessages

public void setMessages(java.util.List<java.lang.String> messages)

Set the result message list. This can be optionally set by the connector if it needs to return additional information to be shown to the user about the processing of the request.

getMessages

public java.util.List<java.lang.String> getMessages()

Get the result message list.

setRetryInterval

public void setRetryInterval(int seconds)

Set the retry interval. This is the optional preferred amount of time to wait before the request is retried. The value is in seconds. This is ignored unless status is Retry.

getRetryInterval

public int getRetryInterval()

This is the optional preferred amount of time to wait before the request is retried. The value is in seconds. This is ignored unless status is Retry.

Returns:

the retry interval.

setObject

public void setObject(java.util.Map<java.lang.String,java.lang.Object> obj)

Set the result object. This may be optionally returned by the connector in the result stored within a Request. When this is returned it will contain all of the attributes of the updated object, which can include things that were not in the request. This can then be used by the caller to refresh an external model rather than waiting for the next aggregation.

getObject

public java.util.Map<java.lang.String,java.lang.Object> getObject()

This can be optionally returned by the connector in the result stored within a Request. When this is returned it will contain all of the attributes of the updated object, which can include things that were not in the request. This can then be used by the caller to refresh an external model rather than waiting for the next aggregation.

Returns:

the result object.

add

public void add(java.lang.String msg)

Add one message to the result.

add

public void add(java.util.List<java.lang.String> msgs)

Add a list of messages to the result.

add

public void add(java.lang.Throwable t)

Add a messages for an exception to the result.

fail

public void fail(java.lang.Throwable t)

Add a messages for an exception to the result and also set the status to Failed.

fail

public void fail(java.lang.String msg)

Add a messages to the result and also set the status to Failed.

setRetryableFailure

public void setRetryableFailure(java.lang.Throwable t)

Add a messages for an exception to the result and also set the status to Retry.

isFailed

public boolean isFailed()

Returns:

true if the status is Failed.

isRetry

public boolean isRetry()

Returns:

true if the status is Retry.

isSubmitted

public boolean isSubmitted()

Returns:

true if the status is Queued or Committed.

toJson

public void toJson(JsonBuilder jb)

Render the Item as a JSON string for logging and debugging.

toJson

public java.lang.String toJson()