openconnector

Class Item

java.lang.Object

openconnector.Item

public class Item
extends java.lang.Object

A model for a single change request for an object. A list of these is found within a Request object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.Operation Operations describe how values should be applied when updating.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	SecretAttributes Item or argument names that can contain passwords that need to be hidden.

Constructor Summary

Constructors

Constructor and Description
Item()
Item(java.lang.String name, Item.Operation op, java.lang.Object value)
Item(java.lang.String name, java.lang.Object value)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getArgument(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
boolean	getBoolean()
java.lang.String	getCurrent() Pseudo property accessor to return the optional current password argument.
java.util.Date	getExpiration() Pseudo property accessor to return the optional password expiration argument.
java.lang.String	getName()
Item.Operation	getOperation()
Result	getResult()
java.lang.String	getScope()
java.lang.String	getString()
java.lang.Object	getValue()
static Item	remove(java.util.List<Item> items, java.lang.String name) Remove an item with the given name from a list if it exists.
void	setArgument(java.lang.String name, java.lang.Object value) Set an extended connector argument.
void	setArguments(java.util.Map<java.lang.String,java.lang.Object> args) Set optional extended arguments for the connector.
void	setName(java.lang.String s) Set the name of the object attribute.
void	setOperation(Item.Operation op) Set the operation to apply to the attribute.
void	setResult(Result result) Set the result of this request.
void	setScope(java.lang.String s) Set the scope of the attribute request.
void	setValue(java.lang.Object o) Set the value to apply to the attribute.
boolean	toBoolean(java.lang.Object o) Coerce the object into a boolean value.
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

Field Detail

SecretAttributes

public static java.lang.String[] SecretAttributes

Item or argument names that can contain passwords that need to be hidden. The passwords are obvious, "current" is used to convey the current password in some password change requests. That's a little more ambiguous, a schema could in theory use "current" for something else, but we are only using this right now for plan debugging it does not matter.

Constructor Detail

Item

public Item()

Item

public Item(java.lang.String name,
            java.lang.Object value)

Item

public Item(java.lang.String name,
            Item.Operation op,
            java.lang.Object value)

Method Detail

setScope

public void setScope(java.lang.String s)

Set the scope of the attribute request. This is the name of an attribute whose values are complex types. Currently it is only used for attributes of type Permission. The request then becomes an add/remove/set operation on permission rights.

getScope

public java.lang.String getScope()

Returns:

the scope of the request.

setName

public void setName(java.lang.String s)

Set the name of the object attribute.

getName

public java.lang.String getName()

Returns:

the name of the object attribute.

setOperation

public void setOperation(Item.Operation op)

Set the operation to apply to the attribute.

getOperation

public Item.Operation getOperation()

Returns:

the operation to apply to the attribute. If not set the default can be assumed to be Add.

setValue

public void setValue(java.lang.Object o)

Set the value to apply to the attribute.

getValue

public java.lang.Object getValue()

Returns:

the value to apply to the attribute.

setArguments

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

Set optional extended arguments for the connector.

getArguments

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

Returns:

optional extended 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.

remove

public static Item remove(java.util.List<Item> items,
                          java.lang.String name)

Remove an item with the given name from a list if it exists.

Returns:

the removed item

toBoolean

public boolean toBoolean(java.lang.Object o)

Coerce the object into a boolean value.

Parameters:

o - object to coerce to boolean value

Returns:

the boolean value of the object

getBoolean

public boolean getBoolean()

Returns:

true if the value of this item is logically true.

getString

public java.lang.String getString()

Returns:

the string representation of the value in this item.

setArgument

public void setArgument(java.lang.String name,
                        java.lang.Object value)

Set an extended connector argument.

getArgument

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

Parameters:

name - name of the argument to return

Returns:

an extended connector argument.

getCurrent

public java.lang.String getCurrent()

Pseudo property accessor to return the optional current password argument.

Returns:

the optional current password argument

getExpiration

public java.util.Date getExpiration()

Pseudo property accessor to return the optional password expiration argument.

Returns:

the optional password expiration argument

toJson

public void toJson(JsonBuilder jb)

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

toJson

public java.lang.String toJson()