openconnector

Class Plan

java.lang.Object

openconnector.Plan

public class Plan
extends java.lang.Object

A model to represent a set of provisioning requests for a connector. The connector can treat the entire plan as one "transaction" or it can break up the plan into several independent transactions. The plan is expected to be annotated with Result objects to convey what was done.

Structurally, a plan consists of a set of Requests and a Request consists of a set of Items. A request usually defines an operation to be performed on a particular user account and an item usually corresponds to an attribute or permission on that account.

Constructor Summary

Constructors

Constructor and Description
Plan()

Method Summary

Modifier and Type	Method and Description
void	add(Request request) Add a request to the plan.
java.lang.Object	getArgument(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
java.util.List<Request>	getRequests()
Result	getResult()
java.lang.String	getString(java.lang.String name)
void	setArguments(java.util.Map<java.lang.String,java.lang.Object> args) Set the extended plan arguments for the connector.
void	setRequests(java.util.List<Request> requests) Set the list of requests in the plan.
void	setResult(Result result) Set the overall result of the plan evaluation.
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

Plan

public Plan()

Method Detail

setRequests

public void setRequests(java.util.List<Request> requests)

Set the list of requests in the plan.

getRequests

public java.util.List<Request> getRequests()

Returns:

the list of requests in the plan.

setArguments

public void setArguments(java.util.Map<java.lang.String,java.lang.Object> args)

Set the extended plan arguments for the connector.

getArguments

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

Returns:

the extended plan arguments for the connector.

setResult

public void setResult(Result result)

Set the overall result of the plan evaluation. This can be overridden by Result objects stored within each child Request.

getResult

public Result getResult()

Returns:

the overall result of the plan evaluation. This can be overridden by Result objects stored within each child Request.

add

public void add(Request request)

Add a request to the plan.

toJson

public void toJson(JsonBuilder jb)

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

toJson

public java.lang.String toJson()

getArgument

public java.lang.Object getArgument(java.lang.String name)

getString

public java.lang.String getString(java.lang.String name)