C# Class Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor

Attributes Accessor convenience methods for accessing attributes.

This class wraps a set of attributes to make lookup faster than the ConnectorAttributeUtil.Find(String, ICollection{ConnectorAttribute}) method, since that method must re-create the map each time.

Mostrar archivo Open project: Tirasa/ConnId

Public Methods

Method	Description
ConnectorAttributesAccessor ( ICollection attrs ) : System
Find ( String name ) : ConnectorAttribute	Find the named attribute
FindBigDecimal ( String name ) : BigDecimal	Get the big decimal value from the specified (single-valued) attribute. Since 1.4
FindBigInteger ( String name ) : BigInteger	Get the big integer value from the specified (single-valued) attribute. Since 1.4
FindBoolean ( String name ) : bool?	Get the boolean value from the specified (single-valued) attribute.
FindByte ( String name ) : byte?	Get the byte value from the specified (single-valued) attribute. Since 1.4
FindByteArray ( String name ) : byte[]	Get the byte array value from the specified (single-valued) attribute. Since 1.4
FindCharacter ( String name ) : char?	Get the char value from the specified (single-valued) attribute. Since 1.4
FindDateTime ( String name ) : DateTime?	Get the date value from the specified (single-valued) attribute that contains a long.
FindDictionary ( String name ) : object>.IDictionary	Get the dictionary value from the specified (single-valued) attribute. Since 1.4
FindDouble ( String name ) : double?	Get the integer value from the specified (single-valued) attribute.
FindFloat ( String name ) : float?	Get the float value from the specified (single-valued) attribute. Since 1.4
FindGuardedByteArray ( String name ) : GuardedByteArray	Get the guarded byte array value from the specified (single-valued) attribute. Since 1.4
FindGuardedString ( String name ) : GuardedString	Get the guarded string value from the specified (single-valued) attribute. Since 1.4
FindInteger ( String name ) : int?	Get the integer value from the specified (single-valued) attribute.
FindList ( String name ) : IList	Return a list of attributes
FindLong ( String name ) : long?	Get the long value from the specified (single-valued) attribute.
FindString ( String name ) : String	Get the string value from the specified (single-valued) attribute.
FindStringList ( String name ) : IList	Return the multivalued attribute as a list of strings. This will throw a ClassCastException if the underlying attribute list is not of type String.
GetEnabled ( bool dflt ) : bool	Return the enabled status of the account. If the ENABLE operational attribute is present, it's value takes precedence over the current value. If it is missing, the currentlyEnabled status is returned instead.
GetName ( ) : Name	Get the Name attribute from the set of attributes.
GetPassword ( ) : GuardedString	Get the password as a GuardeString
GetUid ( ) : Uid	Get the Uid attribute from the set of attributes.
HasAttribute ( String name ) : bool	Determines if the set as the attribute specified.
ListAttributeNames ( ) : ICollection	Get the name of attributes this Accessor was created with. Since 1.4

Method Details

ConnectorAttributesAccessor() public method

public ConnectorAttributesAccessor ( ICollection attrs ) : System
attrs	ICollection
return	System

Find() public method

Find the named attribute

public Find ( String name ) : ConnectorAttribute
name	String	- /// the attribute name to search for
return	ConnectorAttribute

FindBigDecimal() public method

Get the big decimal value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a big decimal. if the attribute is a multi-valued (rather than /// single-valued)..

public FindBigDecimal ( String name ) : BigDecimal
name	String	Attribute from which to retrieve the big decimal value.
return	BigDecimal

FindBigInteger() public method

Get the big integer value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a big integer. if the attribute is a multi-valued (rather than /// single-valued)..

public FindBigInteger ( String name ) : BigInteger
name	String	Attribute from which to retrieve the big integer value.
return	BigInteger

FindBoolean() public method

Get the boolean value from the specified (single-valued) attribute.

if the object in the attribute is not an . if the attribute is a multi-valued (rather than /// single-valued).

public FindBoolean ( String name ) : bool?
name	String	Attribute from which to retrieve the boolean value.
return	bool?

FindByte() public method

Get the byte value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a byte. if the attribute is a multi-valued (rather than /// single-valued)..

public FindByte ( String name ) : byte?
name	String	Attribute from which to retrieve the byte value.
return	byte?

FindByteArray() public method

Get the byte array value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a byte array. if the attribute is a multi-valued (rather than /// single-valued)..

public FindByteArray ( String name ) : byte[]
name	String	Attribute from which to retrieve the byte array value.
return	byte[]

FindCharacter() public method

Get the char value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a char. if the attribute is a multi-valued (rather than /// single-valued).

public FindCharacter ( String name ) : char?
name	String	Attribute from which to retrieve the char value.
return	char?

FindDateTime() public method

Get the date value from the specified (single-valued) attribute that contains a long.

if the object in the attribute is not an long. if the attribute is a multi-valued (rather than /// single-valued).

public FindDateTime ( String name ) : DateTime?
name	String	Attribute from which to retrieve the date value.
return	DateTime?

FindDictionary() public method

Get the dictionary value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a dictionary. if the attribute is a multi-valued (rather than /// single-valued)..

public FindDictionary ( String name ) : object>.IDictionary
name	String	Attribute from which to retrieve the dictionary value.
return	object>.IDictionary

FindDouble() public method

Get the integer value from the specified (single-valued) attribute.

if the object in the attribute is not an integer. if the attribute is a multi-valued (rather than /// single-valued)..

public FindDouble ( String name ) : double?
name	String	Attribute from which to retrieve the integer value.
return	double?

FindFloat() public method

Get the float value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a float. if the attribute is a multi-valued (rather than /// single-valued)..

public FindFloat ( String name ) : float?
name	String	Attribute from which to retrieve the float value.
return	float?

FindGuardedByteArray() public method

Get the guarded byte array value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a guarded byte array. if the attribute is a multi-valued (rather than /// single-valued)..

public FindGuardedByteArray ( String name ) : GuardedByteArray
name	String	Attribute from which to retrieve the guarded byte array value.
return	GuardedByteArray

FindGuardedString() public method

Get the guarded string value from the specified (single-valued) attribute.

Since 1.4

if the object in the attribute is not a guarded string. if the attribute is a multi-valued (rather than /// single-valued)..

public FindGuardedString ( String name ) : GuardedString
name	String	Attribute from which to retrieve the guarded string value.
return	GuardedString

FindInteger() public method

Get the integer value from the specified (single-valued) attribute.

if the object in the attribute is not an long. if the attribute is a multi-valued (rather than /// single-valued).

public FindInteger ( String name ) : int?
name	String	Attribute from which to retrieve the long value.
return	int?

FindList() public method

Return a list of attributes

public FindList ( String name ) : IList
name	String	- /// name of attribute to search for.
return	IList

FindLong() public method

Get the long value from the specified (single-valued) attribute.

if the object in the attribute is not an long. if the attribute is a multi-valued (rather than /// single-valued).

public FindLong ( String name ) : long?
name	String	Attribute from which to retrieve the long value.
return	long?

FindString() public method

Get the string value from the specified (single-valued) attribute.

if the object in the attribute is not a string. if the attribute is a multi-valued (rather than /// single-valued).

public FindString ( String name ) : String
name	String	Attribute from which to retrieve the string value.
return	String

FindStringList() public method

Return the multivalued attribute as a list of strings.

This will throw a ClassCastException if the underlying attribute list is not of type String.

public FindStringList ( String name ) : IList
name	String	the name of the attribute to search for
return	IList

GetEnabled() public method

Return the enabled status of the account.

If the ENABLE operational attribute is present, it's value takes precedence over the current value. If it is missing, the currentlyEnabled status is returned instead.

public GetEnabled ( bool dflt ) : bool
dflt	bool	the default state if enable is not found.
return	bool

GetName() public method

Get the Name attribute from the set of attributes.

public GetName ( ) : Name
return	Name

GetPassword() public method

Get the password as a GuardeString

public GetPassword ( ) : GuardedString
return	GuardedString

GetUid() public method

Get the Uid attribute from the set of attributes.

public GetUid ( ) : Uid
return	Uid

HasAttribute() public method

Determines if the set as the attribute specified.

public HasAttribute ( String name ) : bool
name	String	attribute name
return	bool

ListAttributeNames() public method

Get the name of attributes this Accessor was created with.

Since 1.4

public ListAttributeNames ( ) : ICollection
return	ICollection