openconnector

Class Request

java.lang.Object

openconnector.Request

public class Request
extends java.lang.Object

A model to represent a request for a single target object. A list of these is found within a Plan object.

Usually the target is a user account, but it could be a group or some other object managed by this connector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Operation Operations specify what is to be done to the object.

Constructor Summary

Constructors

Constructor and Description
Request()

Method Summary

Modifier and Type	Method and Description
void	add(Item item) Add an item to the request.
java.lang.Object	getArgument(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
Request.Operation	getEffectiveOperation()
java.lang.String	getId()
java.util.List<Item>	getItems()
Request.Operation	getOperation()
java.lang.String	getResource()
Result	getResult()
java.util.List<Item>	getSchemaItems()
java.lang.String	getString(java.lang.String name)
java.util.List<Item>	getSystemItems()
java.lang.String	getTrackingId()
java.lang.String	getType()
void	setArguments(java.util.Map<java.lang.String,java.lang.Object> args) Set extended request-specific arguments for the connector.
void	setId(java.lang.String id) Set the unique identifier of the target object.
void	setItems(java.util.List<Item> items) Set the list of items to apply to the object.
void	setOperation(Request.Operation op) Set the operation to apply to the object.
void	setResource(java.lang.String res) Set the name of the resource owning the object.
void	setResult(Result result) Set the result of this request.
void	setTrackingId(java.lang.String trackingId) Set the trackingId of this request.
void	setType(java.lang.String type) Set the object type.
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

Request

public Request()

Method Detail

setType

public void setType(java.lang.String type)

Set the object type. If not set it is assumed to be OBJECT_TYPE_ACCOUNT.

getType

public java.lang.String getType()

Returns:

the object type.

setOperation

public void setOperation(Request.Operation op)

Set the operation to apply to the object.

getOperation

public Request.Operation getOperation()

Returns:

the operation to apply to the object.

setResource

public void setResource(java.lang.String res)

Set the name of the resource owning the object. This is set only for proxy connectors that can handle requests for several resources. For simple connectors it will be null.

getResource

public java.lang.String getResource()

Returns:

the name of the resource owning the object. This is set only for proxy connectors that can handle requests for several resources. For simple connectors it will be null.

setId

public void setId(java.lang.String id)

Set the unique identifier of the target object.

getId

public java.lang.String getId()

Returns:

the unique identifier of the target object.

setItems

public void setItems(java.util.List<Item> items)

Set the list of items to apply to the object.

getItems

public java.util.List<Item> getItems()

Returns:

the list of items to apply to the object.

setArguments

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

Set extended request-specific arguments for the connector.

getArguments

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

Returns:

extended request-specific arguments for the connector.

setResult

public void setResult(Result result)

Set the result of this request. This can be null if there will be one shared Result for the entire Plan.

getResult

public Result getResult()

Returns:

the result of this request. This can be null if there will be one shared Result for the entire Plan.

getTrackingId

public java.lang.String getTrackingId()

Returns:

the trackingId of this request. This can be null if there will be one shared Result for the entire Plan.

setTrackingId

public void setTrackingId(java.lang.String trackingId)

Set the trackingId of this request. This can be null if there will be one shared Result for the entire Plan.

getArgument

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

getString

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

getEffectiveOperation

public Request.Operation getEffectiveOperation()

Returns:

the operation code or Operation.Update if one is not set.

add

public void add(Item item)

Add an item to the request.

getSchemaItems

public java.util.List<Item> getSchemaItems()

Returns:

a list containing only those Items that are for attributes defined in the object schema.

This is a convenience for connectors that do not process items one at a time and instead just like to convert them all to a Map and pass them along.

getSystemItems

public java.util.List<Item> getSystemItems()

Returns:

a list containing only those Items that are for system properties like Connector.ATT_DISABLED.

toJson

public void toJson(JsonBuilder jb)

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

toJson

public java.lang.String toJson()