com.nitido.nim
Class EntityProvisionDescriptor

java.lang.Object
  com.nitido.nim.EntityProvisionDescriptor

All Implemented Interfaces:

java.io.Serializable

public class EntityProvisionDescriptor
extends java.lang.Object
implements java.io.Serializable

This class is a data object used by application developers to collect entity profile information. This profile information can then be passed to the provisionEntity() method on NiM to request the entity be provision with the profile information stored in this class. This object is NOT synchronized and thus, it is not thread safe.

See Also:

Serialized Form

Constructor Summary

EntityProvisionDescriptor(Credential credential)
This constructor is used to create a new instance of this class

Method Summary

void	addAttributeValue(java.lang.String key, java.io.Serializable value) This method adds the given profile attribute value under the given key.
void	addAttributeValues(java.lang.String key, java.util.Set values) This method adds the given profile attribute value under the given key.
java.util.Set	getAttributeKeys() This method returns an enumeration with all the profile attribute keys currently available in the EntityProvisionDescriptor.
java.io.Serializable	getAttributeValue(java.lang.String key) This method returns the profile attribute that corresponds to the given key.
java.util.Set	getAttributeValues(java.lang.String key) This method returns the profile attribute that corresponds to the given key.
Credential	getCredential() This method returns the indentifying credential of the entity being provisioned.
void	removeAttributeValue(java.lang.String key, java.io.Serializable value) This method remove the given profile attribute value under the given key.
void	removeAttributeValues(java.lang.String key, java.util.Set values) This method remove the given profile attribute values under the given key.
void	setAttributeValue(java.lang.String key, java.io.Serializable value) This method replaces the given profile attribute value under the given key.
void	setAttributeValues(java.lang.String key, java.util.Set values) This method replaces the given profile attribute values under the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityProvisionDescriptor

public EntityProvisionDescriptor(Credential credential)

This constructor is used to create a new instance of this class

Parameters:

credential - The identifying credential of the entity to be provisioned.

Method Detail

getCredential

public Credential getCredential()

This method returns the indentifying credential of the entity being provisioned.

Returns:

Reference to the identifying credential of the entity being provisioned.

getAttributeValue

public java.io.Serializable getAttributeValue(java.lang.String key)

This method returns the profile attribute that corresponds to the given key.

Parameters:

key - The key under which the requested profile attribute is stored.

Returns:

The first value of the profile attribute associated to the given key or null if no attribute exists with that key.

getAttributeValues

public java.util.Set getAttributeValues(java.lang.String key)

This method returns the profile attribute that corresponds to the given key.

Parameters:

key - The key under which the requested profile attribute is stored.

Returns:

The values of the profile attribute associated to the given key or null if no attribute exists with that key. This returned set is directly associated to the actual attributes stored in this container. Changing this return set will affect the attribute values stored in this object.

getAttributeKeys

public java.util.Set getAttributeKeys()

This method returns an enumeration with all the profile attribute keys currently available in the EntityProvisionDescriptor.

Returns:

A Set of strings with all the profile attribute keys currently stored in this class. This returned set is directly associated to the actual attributes stored in this container. Changing this return set will affect the attribute keys stored in this object.

setAttributeValue

public void setAttributeValue(java.lang.String key,
                              java.io.Serializable value)

This method replaces the given profile attribute value under the given key. (i.e. all existing values of the attribute key will be replaced by this new value.) If the value of the attribute is null, the key and all its values will be removed.

Parameters:

key - The key under which the attribute will be stored.

value - The value of the profile attribute

removeAttributeValue

public void removeAttributeValue(java.lang.String key,
                                 java.io.Serializable value)

This method remove the given profile attribute value under the given key. If the value of the attribute is null, the key and all its values will be removed.

Parameters:

key - The key under which the attribute will be removed.

value - The value of the profile attribute to be removed.

addAttributeValue

public void addAttributeValue(java.lang.String key,
                              java.io.Serializable value)

This method adds the given profile attribute value under the given key.

Parameters:

key - The key under which the attribute will be stored.

value - The value of the profile attribute This parameter cannot be null. If null is encountered, a java.lang.IllegalArgumentException will be thrown.

addAttributeValues

public void addAttributeValues(java.lang.String key,
                               java.util.Set values)

This method adds the given profile attribute value under the given key.

Parameters:

key - The key under which the attribute will be stored.

values - The values of the profile attribute This parameter cannot be null. If null is encountered, a java.lang.IllegalArgumentException will be thrown.

setAttributeValues

public void setAttributeValues(java.lang.String key,
                               java.util.Set values)

This method replaces the given profile attribute values under the given key. (i.e. all existing values of the attribute key will be replaced by this new values.)

If the values of the attribute is null, the key will be removed. In this case, the ProvisionService will use the default values for this attribute if the associated configuration exists.

If the values is an empty Set, the ProvisionService will not use the default values for this attribute. Instead, it will not store any attribute value for this attribute key to the backend.

NOTE: This is the only method that you can use to tell the ProvisionService to override the default values with NO value at all. Other set/add/remove attribute methods will only make the data so that the ProvisionService either uses the specified non-null values or uses the default values.

Parameters:

key - The key under which the attribute will be stored.

values - The values of the profile attribute.

removeAttributeValues

public void removeAttributeValues(java.lang.String key,
                                  java.util.Set values)

This method remove the given profile attribute values under the given key. If the values Set is null, the specified key and all its existing values will be removed.

Parameters:

key - The key under which the attribute will be removed.

values - The values of the profile attribute to be removed.