Attributes Accessor convenience methods for accessing attributes. More...

Public Member Functions
	ConnectorAttributesAccessor (ICollection< ConnectorAttribute > attrs)

ConnectorAttribute	Find (String name)
	Find the named attribute More...

Name	GetName ()
	Get the Name attribute from the set of attributes. More...

bool	GetEnabled (bool dflt)
	Return the enabled status of the account. More...

GuardedString	GetPassword ()
	Get the password as a GuardeString More...

IList< Object >	FindList (String name)
	Return a list of attributes More...

IList< String >	FindStringList (String name)
	Return the multivalued attribute as a list of strings. More...

bool	HasAttribute (String name)
	Determines if the set as the attribute specified. More...

String	FindString (String name)
	Get the string value from the specified (single-valued) attribute. More...

int	FindInteger (String name)
	Get the integer value from the specified (single-valued) attribute. More...

long	FindLong (String name)
	Get the long value from the specified (single-valued) attribute. More...

DateTime	FindDateTime (String name)
	Get the date value from the specified (single-valued) attribute that contains a long. More...

double	FindDouble (String name)
	Get the integer value from the specified (single-valued) attribute. More...

bool	FindBoolean (String name)
	Get the boolean value from the specified (single-valued) attribute. More...

Detailed Description

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.

<author>Warren Strange</author>

Member Function Documentation

ConnectorAttribute Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.Find ( String name )

Find the named attribute

Parameters

name	- the attribute name to search for

Returns: the Attribute, or null if not found.

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindBoolean ( String name )

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

Parameters

name	Attribute from which to retrieve the boolean value.

Returns: null if the value is null otherwise the boolean value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an Boolean.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued).

DateTime Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindDateTime ( String name )

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

Parameters

name	Attribute from which to retrieve the date value.

Returns: null if the value is null otherwise the date value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an long.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued).

double Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindDouble ( String name )

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

Parameters

name	Attribute from which to retrieve the integer value.

Returns: null if the value is null otherwise the integer value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an integer.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued)..

int Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindInteger ( String name )

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

Parameters

name	Attribute from which to retrieve the long value.

Returns: null if the value is null otherwise the long value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an long.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued).

IList<Object> Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindList ( String name )

Return a list of attributes

Parameters

name	- name of attribute to search for.

Returns: The List (generic object) iff it exists otherwise null.

long Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindLong ( String name )

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

Parameters

name	Attribute from which to retrieve the long value.

Returns: null if the value is null otherwise the long value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an long.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued).

String Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindString ( String name )

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

Parameters

name	Attribute from which to retrieve the long value.

Returns: null if the value is null otherwise the long value for the attribute.

Exceptions

InvalidCastException	iff the object in the attribute is not an long.
ArgumentException	iff the attribute is a multi-valued (rather than single-valued).

IList<String> Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.FindStringList ( String name )

Return the multivalued attribute as a list of strings.

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

Parameters

name	the name of the attribute to search for

Returns: a List of String values for the attribute

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.GetEnabled ( bool dflt )

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.

Parameters

dflt	the default state if enable is not found.

Returns: true if the account is enabled, false otherwise

Name Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.GetName ( )

Get the Name attribute from the set of attributes.

Returns: the Name attribute in the set.

GuardedString Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.GetPassword ( )

Get the password as a GuardeString

Returns: the password as a guarded String

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributesAccessor.HasAttribute ( String name )

Determines if the set as the attribute specified.

Parameters

name	attribute name

Returns: true if the named attribute exists, false otherwise

The documentation for this class was generated from the following file:

C:/ADE/icfbuild_docgen/icf/framework/.ade_path/dotnet/Framework/CommonObjects.cs

Public Member Functions

Detailed Description

Member Function Documentation