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

Afficher le fichier Open project: Tirasa/ConnId

Méthodes publiques

Méthode Description
AddUid ( ICollection attrs, Uid uid ) : ICollection

Returns a mutable copy of the original set with the uid attribute added.
CreateSpecialName ( string name ) : string

Creates the special naming for operational type attributes.
FilterUid ( ICollection attrs ) : ICollection

Returns a mutable copy of the original set with the uid attribute removed.
Find ( string name, ICollection attrs ) : ConnectorAttribute

Find the ConnectorAttribute of the given name in the Set.
GetAsStringValue ( ConnectorAttribute attr ) : string

Gets the string value from the single value attribute.
GetBasicAttributes ( ICollection attrs ) : ICollection

Filters out all special attributes from the set.

These special attributes include Password, Uid etc..

GetBigDecimalValue ( ConnectorAttribute attr ) : BigDecimal

Gets the big decimal value from the single value attribute.

Since 1.4

GetBigIntegerValue ( ConnectorAttribute attr ) : BigInteger

Gets the big integer value from the single value attribute.

Since 1.4

GetBooleanValue ( ConnectorAttribute attr ) : bool?

Gets the boolean value from the single value attribute.
GetByteArrayValue ( ConnectorAttribute attr ) : byte[]

Gets the byte value from the single value attribute.

Since 1.4

GetByteValue ( ConnectorAttribute attr ) : byte?

Gets the byte value from the single value attribute.

Since 1.4

GetCharacterValue ( ConnectorAttribute attr ) : char?

Gets the character value from the single value attribute.

Since 1.4

GetCurrentPasswordValue ( ICollection attrs ) : GuardedString

Get the current password value from the provided set of ConnectorAttributes.
GetDateTimeValue ( ConnectorAttribute attr ) : DateTime?

Gets the date value from the single value attribute.
GetDictionaryValue ( ConnectorAttribute attr ) : object>.IDictionary

Gets the dictionary value from the single value attribute.

Since 1.4

GetDoubleValue ( ConnectorAttribute attr ) : double?

Gets the double value from the single value attribute.
GetEnableDate ( ICollection attrs ) : DateTime?

Get the enable date from the set of attributes.
GetFloatValue ( ConnectorAttribute attr ) : float?

Gets the float value from the single value attribute.

Since 1.4

GetGuardedByteArrayValue ( ConnectorAttribute attr ) : GuardedByteArray

Gets the guarded byte array value from the single value attribute.

Since 1.4

GetGuardedStringValue ( ConnectorAttribute attr ) : GuardedString

Gets the guarded string value from the single value attribute.
GetIntegerValue ( ConnectorAttribute attr ) : int?

Gets the integer value from the single value attribute.
GetLongValue ( ConnectorAttribute attr ) : long?

Gets the long value from the single value attribute.
GetNameFromAttributes ( ICollection attrs ) : Name

Gets the 'Name' attribute from a set of ConnectorAttributes.
GetPasswordExpirationDate ( ConnectorObject obj ) : DateTime?

Retrieve the password expiration date from the ConnectorObject.
GetPasswordExpired ( ICollection attrs ) : bool?

Get the password expired attribute from a Collection of ConnectorAttributes.
GetPasswordValue ( ICollection attrs ) : GuardedString

Get the password value from the provided set of ConnectorAttributes.
GetSingleValue ( ConnectorAttribute attr ) : object

Get the single value from the ConnectorAttribute.

Return null if the attribute's list of values is null or empty.

GetSpecialAttributes ( ICollection attrs ) : ICollection

Filter out any basic attributes from the specified set, leaving only special attributes.

Special attributes include Name, Uid, and OperationalAttributes.

GetStringValue ( ConnectorAttribute attr ) : string

Gets the string value from the single value attribute.
GetUidAttribute ( ICollection attrs ) : Uid

Get the Uid from the attribute set.
IsEnabled ( ConnectorObject obj ) : bool?

Determine if the ConnectorObject is enable.

By getting the value of the OperationalAttributes.ENABLE_NAME.

IsLockedOut ( ConnectorObject obj ) : bool?

Determine if the ConnectorObject is locked out.

By getting the value of the OperationalAttributes.LOCK_OUT_NAME.

IsPasswordExpired ( ConnectorObject obj ) : bool?

Determine if the password is expired for this object.
IsSpecial ( ConnectorAttribute attr ) : bool

Determines if this attribute is a special attribute.
IsSpecial ( ConnectorAttributeInfo attr ) : bool

Determines if this attribute is a special attribute.
IsSpecialName ( String name ) : bool

Determines whether the specified attribute name is special in the sense of ConnectorAttributeUtil.CreateSpecialName.
NamesEqual ( string name1, string name2 ) : bool

Compares two attribute names for equality.
ToMap ( ICollection attributes ) : ConnectorAttribute>.IDictionary

Transform a Collection of ConnectorAttribute} instances into a {@link Map}. The key to each element in the map is the name of an ConnectorAttribute. The value of each element in the map is the ConnectorAttribute instance with that name.

Method Details

AddUid() public static méthode

Returns a mutable copy of the original set with the uid attribute added.
public static AddUid ( ICollection attrs, Uid uid ) : ICollection
attrs ICollection The original set. Must not be null.
uid Uid The uid. Must not be null.
Résultat ICollection

CreateSpecialName() public static méthode

Creates the special naming for operational type attributes.
public static CreateSpecialName ( string name ) : string
name string string to make special
Résultat string

FilterUid() public static méthode

Returns a mutable copy of the original set with the uid attribute removed.
public static FilterUid ( ICollection attrs ) : ICollection
attrs ICollection The original set. Must not be null.
Résultat ICollection

Find() public static méthode

Find the ConnectorAttribute of the given name in the Set.
public static Find ( string name, ICollection attrs ) : ConnectorAttribute
name string /// 's name to search for.
attrs ICollection /// of attribute to search.
Résultat ConnectorAttribute

GetAsStringValue() public static méthode

Gets the string value from the single value attribute.
if the attribute is a multi valued instead of single valued.
public static GetAsStringValue ( ConnectorAttribute attr ) : string
attr ConnectorAttribute ConnectorAttribute to retrieve the string value from.
Résultat string

GetBasicAttributes() public static méthode

Filters out all special attributes from the set.
These special attributes include Password, Uid etc..
public static GetBasicAttributes ( ICollection attrs ) : ICollection
attrs ICollection set of s to filter out the operational and /// default attributes.
Résultat ICollection

GetBigDecimalValue() public static méthode

Gets the big decimal value from the single value attribute.
Since 1.4
if the object in the attribute is not a big decimal. if the attribute is a multi valued instead of single valued.
public static GetBigDecimalValue ( ConnectorAttribute attr ) : BigDecimal
attr ConnectorAttribute ConnectorAttribute to retrieve the big decimal value from.
Résultat BigDecimal

GetBigIntegerValue() public static méthode

Gets the big integer value from the single value attribute.
Since 1.4
if the object in the attribute is not a big integer. if the attribute is a multi valued instead of single valued.
public static GetBigIntegerValue ( ConnectorAttribute attr ) : BigInteger
attr ConnectorAttribute ConnectorAttribute to retrieve the big integer value from.
Résultat BigInteger

GetBooleanValue() public static méthode

Gets the boolean value from the single value attribute.
if the object in the attribute is not a boolean. if the attribute is a multi valued instead of single valued.
public static GetBooleanValue ( ConnectorAttribute attr ) : bool?
attr ConnectorAttribute ConnectorAttribute to retrieve the boolean value from.
Résultat bool?

GetByteArrayValue() public static méthode

Gets the byte value from the single value attribute.
Since 1.4
if the object in the attribute is not a byte. if the attribute is a multi valued instead of single valued.
public static GetByteArrayValue ( ConnectorAttribute attr ) : byte[]
attr ConnectorAttribute ConnectorAttribute to retrieve the byte value from.
Résultat byte[]

GetByteValue() public static méthode

Gets the byte value from the single value attribute.
Since 1.4
if the object in the attribute is not a byte. if the attribute is a multi valued instead of single valued.
public static GetByteValue ( ConnectorAttribute attr ) : byte?
attr ConnectorAttribute ConnectorAttribute to retrieve the byte value from.
Résultat byte?

GetCharacterValue() public static méthode

Gets the character value from the single value attribute.
Since 1.4
if the object in the attribute is not an string. if the attribute is a multi valued instead of single valued.
public static GetCharacterValue ( ConnectorAttribute attr ) : char?
attr ConnectorAttribute ConnectorAttribute to retrieve the character value from.
Résultat char?

GetCurrentPasswordValue() public static méthode

Get the current password value from the provided set of ConnectorAttributes.
public static GetCurrentPasswordValue ( ICollection attrs ) : GuardedString
attrs ICollection Set of s that may contain the current password /// /// .
Résultat GuardedString

GetDateTimeValue() public static méthode

Gets the date value from the single value attribute.
if the object in the attribute is not an long. if the attribute is a multi valued instead of single valued.
public static GetDateTimeValue ( ConnectorAttribute attr ) : DateTime?
attr ConnectorAttribute ConnectorAttribute to retrieve the date value from.
Résultat DateTime?

GetDictionaryValue() public static méthode

Gets the dictionary value from the single value attribute.
Since 1.4
if the object in the attribute is not a dictionary. if the attribute is a multi valued instead of single valued.
public static GetDictionaryValue ( ConnectorAttribute attr ) : object>.IDictionary
attr ConnectorAttribute ConnectorAttribute to retrieve the dictionary value from.
Résultat object>.IDictionary

GetDoubleValue() public static méthode

Gets the double value from the single value attribute.
if the object in the attribute is not a double. if the attribute is a multi valued instead of single valued.
public static GetDoubleValue ( ConnectorAttribute attr ) : double?
attr ConnectorAttribute ConnectorAttribute to retrieve the double value from.
Résultat double?

GetEnableDate() public static méthode

Get the enable date from the set of attributes.
public static GetEnableDate ( ICollection attrs ) : DateTime?
attrs ICollection set of attribute to find the enable date /// .
Résultat DateTime?

GetFloatValue() public static méthode

Gets the float value from the single value attribute.
Since 1.4
if the object in the attribute is not a float. if the attribute is a multi valued instead of single valued.
public static GetFloatValue ( ConnectorAttribute attr ) : float?
attr ConnectorAttribute ConnectorAttribute to retrieve the float value from.
Résultat float?

GetGuardedByteArrayValue() public static méthode

Gets the guarded byte array value from the single value attribute.
Since 1.4
if the object in the attribute is not a guarded byte array. if the attribute is a multi valued instead of single valued.
public static GetGuardedByteArrayValue ( ConnectorAttribute attr ) : GuardedByteArray
attr ConnectorAttribute ConnectorAttribute to retrieve the guarded byte array value from.
Résultat GuardedByteArray

GetGuardedStringValue() public static méthode

Gets the guarded string value from the single value attribute.
if the object in the attribute is not a guarded string. if the attribute is a multi valued instead of single valued.
public static GetGuardedStringValue ( ConnectorAttribute attr ) : GuardedString
attr ConnectorAttribute ConnectorAttribute to retrieve the guarded string value from.
Résultat GuardedString

GetIntegerValue() public static méthode

Gets the integer value from the single value attribute.
if the object in the attribute is not an integer. if the attribute is a multi valued instead of single valued.
public static GetIntegerValue ( ConnectorAttribute attr ) : int?
attr ConnectorAttribute ConnectorAttribute to retrieve the integer value from.
Résultat int?

GetLongValue() public static méthode

Gets the long value from the single value attribute.
if the object in the attribute is not an long. if the attribute is a multi valued instead of single valued.
public static GetLongValue ( ConnectorAttribute attr ) : long?
attr ConnectorAttribute ConnectorAttribute to retrieve the long value from.
Résultat long?

GetNameFromAttributes() public static méthode

Gets the 'Name' attribute from a set of ConnectorAttributes.
public static GetNameFromAttributes ( ICollection attrs ) : Name
attrs ICollection set of attributes to search against.
Résultat Name

GetPasswordExpirationDate() public static méthode

Retrieve the password expiration date from the ConnectorObject.
if the object does not contain attribute in question. if the parameter 'obj' is null.
public static GetPasswordExpirationDate ( ConnectorObject obj ) : DateTime?
obj ConnectorObject /// object to inspect.
Résultat DateTime?

GetPasswordExpired() public static méthode

Get the password expired attribute from a Collection of ConnectorAttributes.
public static GetPasswordExpired ( ICollection attrs ) : bool?
attrs ICollection set of attribute to find the expired password /// .
Résultat bool?

GetPasswordValue() public static méthode

Get the password value from the provided set of ConnectorAttributes.
public static GetPasswordValue ( ICollection attrs ) : GuardedString
attrs ICollection
Résultat GuardedString

GetSingleValue() public static méthode

Get the single value from the ConnectorAttribute.
Return null if the attribute's list of values is null or empty.
public static GetSingleValue ( ConnectorAttribute attr ) : object
attr ConnectorAttribute
Résultat object

GetSpecialAttributes() public static méthode

Filter out any basic attributes from the specified set, leaving only special attributes.
Special attributes include Name, Uid, and OperationalAttributes.
public static GetSpecialAttributes ( ICollection attrs ) : ICollection
attrs ICollection set of s to filter out the basic attributes
Résultat ICollection

GetStringValue() public static méthode

Gets the string value from the single value attribute.
if the object in the attribute is not an string. if the attribute is a multi valued instead of single valued.
public static GetStringValue ( ConnectorAttribute attr ) : string
attr ConnectorAttribute ConnectorAttribute to retrieve the string value from.
Résultat string

GetUidAttribute() public static méthode

Get the Uid from the attribute set.
public static GetUidAttribute ( ICollection attrs ) : Uid
attrs ICollection set of s that may contain a .
Résultat Uid

IsEnabled() public static méthode

Determine if the ConnectorObject is enable.
By getting the value of the OperationalAttributes.ENABLE_NAME.
if the object does not contain attribute in question. if the parameter 'obj' is null.
public static IsEnabled ( ConnectorObject obj ) : bool?
obj ConnectorObject /// object to inspect.
Résultat bool?

IsLockedOut() public static méthode

Determine if the ConnectorObject is locked out.
By getting the value of the OperationalAttributes.LOCK_OUT_NAME.
if the parameter 'obj' is null.
public static IsLockedOut ( ConnectorObject obj ) : bool?
obj ConnectorObject /// object to inspect.
Résultat bool?

IsPasswordExpired() public static méthode

Determine if the password is expired for this object.
public static IsPasswordExpired ( ConnectorObject obj ) : bool?
obj ConnectorObject /// that should contain a password expired /// attribute.
Résultat bool?

IsSpecial() public static méthode

Determines if this attribute is a special attribute.
if the attribute parameter is null.
public static IsSpecial ( ConnectorAttribute attr ) : bool
attr ConnectorAttribute /// to test for against.
Résultat bool

IsSpecial() public static méthode

Determines if this attribute is a special attribute.
if the attribute parameter is null.
public static IsSpecial ( ConnectorAttributeInfo attr ) : bool
attr ConnectorAttributeInfo /// to test for against.
Résultat bool

IsSpecialName() public static méthode

Determines whether the specified attribute name is special in the sense of ConnectorAttributeUtil.CreateSpecialName.
public static IsSpecialName ( String name ) : bool
name String the name of the attribute to test
Résultat bool

NamesEqual() public static méthode

Compares two attribute names for equality.
public static NamesEqual ( string name1, string name2 ) : bool
name1 string the first attribute name
name2 string the second attribute name
Résultat bool

ToMap() public static méthode

Transform a Collection of ConnectorAttribute} instances into a {@link Map}. The key to each element in the map is the name of an ConnectorAttribute. The value of each element in the map is the ConnectorAttribute instance with that name.
public static ToMap ( ICollection attributes ) : ConnectorAttribute>.IDictionary
attributes ICollection
Résultat ConnectorAttribute>.IDictionary