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

Show file Open project: Tirasa/ConnId Class Usage Examples

Public Methods

Method	Description
AddValue ( ) : ConnectorAttributeBuilder
AddValue ( ICollection
Build ( ) : ConnectorAttribute
Build ( String name ) : ConnectorAttribute
Build ( String name, ICollection
BuildCurrentPassword ( GuardedString password ) : ConnectorAttribute	Builds the operational attribute current password. The current password indicates this a password change by the account owner and not an administrator. The use case is that an administrator password change may not keep history or validate against policy.
BuildCurrentPassword ( SecureString password ) : ConnectorAttribute
BuildDisableDate ( System.DateTime date ) : ConnectorAttribute	Builds out an operational ConnectorAttribute that determines the disable date for an object.
BuildDisableDate ( long date ) : ConnectorAttribute	Builds out an operational ConnectorAttribute that determines the disable date for an object. The time parameter is UTC in milliseconds.
BuildEnableDate ( System.DateTime date ) : ConnectorAttribute	Builds out an operational ConnectorAttribute that determines the enable date for an object.
BuildEnableDate ( long date ) : ConnectorAttribute	Builds out an operational ConnectorAttribute that determines the enable date for an object. The time parameter is UTC in milliseconds.
BuildEnabled ( bool val ) : ConnectorAttribute	Builds ant operational attribute that either represents the object is enabled or sets in disabled depending on where its used for instance on CreateApiOp it could be used to create a disabled account. In SearchApiOp it would show the object is enabled or disabled.
BuildLastLoginDate ( System.DateTime date ) : ConnectorAttribute	Builds out a pre-defined ConnectorAttribute that determines the last login date for an object.
BuildLastLoginDate ( long date ) : ConnectorAttribute	Builds out a pre-defined ConnectorAttribute that determines the last login date for an object. The time parameter is UTC in milliseconds.
BuildLastPasswordChangeDate ( System.DateTime date ) : ConnectorAttribute	Builds out a pre-defined ConnectorAttribute that determines the last password change date for an object.
BuildLastPasswordChangeDate ( long date ) : ConnectorAttribute	Builds out a pre-defined ConnectorAttribute that determines the last password change date for an object.
BuildLockOut ( bool lck ) : ConnectorAttribute	Builds the lock attribute that determines if an object is locked out.
BuildPassword ( GuardedString password ) : ConnectorAttribute	Builds the operational attribute password.
BuildPassword ( SecureString password ) : ConnectorAttribute
BuildPasswordChangeInterval ( long val ) : ConnectorAttribute	Common password policy attribute where the password must be changed every so often. The value for this attribute is milliseconds since its the lowest common denominator.
BuildPasswordExpirationDate ( System.DateTime dateTime ) : ConnectorAttribute	Builds an password expiration date ConnectorAttribute. This ConnectorAttribute represents the date/time a password will expire on a resource.
BuildPasswordExpirationDate ( long dateTime ) : ConnectorAttribute	Builds an password expiration date ConnectorAttribute. This ConnectorAttribute represents the date/time a password will expire on a resource.
BuildPasswordExpired ( bool expired ) : ConnectorAttribute	Builds out an operational ConnectorAttribute that determines if a password is expired or expires a password.
ConnectorAttributeBuilder ( ) : System

Private Methods

Method	Description
AddValuesInternal ( IEnumerable
CheckSingleValue ( ) : void
GetSingleStringValue ( ) : String

Method Details

AddValue() public method

public AddValue ( ) : ConnectorAttributeBuilder
return	ConnectorAttributeBuilder

AddValue() public method

public AddValue ( ICollection
values	ICollection
return	ConnectorAttributeBuilder

Build() public method

public Build ( ) : ConnectorAttribute
return	ConnectorAttribute

Build() public static method

public static Build ( String name ) : ConnectorAttribute
name	String
return	ConnectorAttribute

Build() public static method

public static Build ( String name, ICollection
name	String
val	ICollection
return	ConnectorAttribute

BuildCurrentPassword() public static method

Builds the operational attribute current password.

The current password indicates this a password change by the account owner and not an administrator. The use case is that an administrator password change may not keep history or validate against policy.

public static BuildCurrentPassword ( GuardedString password ) : ConnectorAttribute
password	GuardedString	the string that represents a password.
return	ConnectorAttribute

BuildCurrentPassword() public static method

public static BuildCurrentPassword ( SecureString password ) : ConnectorAttribute
password	System.Security.SecureString
return	ConnectorAttribute

BuildDisableDate() public static method

Builds out an operational ConnectorAttribute that determines the disable date for an object.

public static BuildDisableDate ( System.DateTime date ) : ConnectorAttribute
date	System.DateTime	The date and time to enable a particular object, or the date /// time an object will be enabled.
return	ConnectorAttribute

BuildDisableDate() public static method

Builds out an operational ConnectorAttribute that determines the disable date for an object.

The time parameter is UTC in milliseconds.

public static BuildDisableDate ( long date ) : ConnectorAttribute
date	long	The date and time to enable a particular object, or the date /// time an object will be enabled.
return	ConnectorAttribute

BuildEnableDate() public static method

Builds out an operational ConnectorAttribute that determines the enable date for an object.

public static BuildEnableDate ( System.DateTime date ) : ConnectorAttribute
date	System.DateTime	The date and time to enable a particular object, or the date /// time an object will be enabled.
return	ConnectorAttribute

BuildEnableDate() public static method

Builds out an operational ConnectorAttribute that determines the enable date for an object.

The time parameter is UTC in milliseconds.

public static BuildEnableDate ( long date ) : ConnectorAttribute
date	long	The date and time to enable a particular object, or the date /// time an object will be enabled.
return	ConnectorAttribute

BuildEnabled() public static method

Builds ant operational attribute that either represents the object is enabled or sets in disabled depending on where its used for instance on CreateApiOp it could be used to create a disabled account.

In SearchApiOp it would show the object is enabled or disabled.

public static BuildEnabled ( bool val ) : ConnectorAttribute
val	bool
return	ConnectorAttribute

BuildLastLoginDate() public static method

Builds out a pre-defined ConnectorAttribute that determines the last login date for an object.

public static BuildLastLoginDate ( System.DateTime date ) : ConnectorAttribute
date	System.DateTime	The date and time of the last login.
return	ConnectorAttribute

BuildLastLoginDate() public static method

Builds out a pre-defined ConnectorAttribute that determines the last login date for an object.

The time parameter is UTC in milliseconds.

public static BuildLastLoginDate ( long date ) : ConnectorAttribute
date	long	The date and time of the last login.
return	ConnectorAttribute

BuildLastPasswordChangeDate() public static method

Builds out a pre-defined ConnectorAttribute that determines the last password change date for an object.

public static BuildLastPasswordChangeDate ( System.DateTime date ) : ConnectorAttribute
date	System.DateTime	The date and time the password was changed.
return	ConnectorAttribute

BuildLastPasswordChangeDate() public static method

Builds out a pre-defined ConnectorAttribute that determines the last password change date for an object.

public static BuildLastPasswordChangeDate ( long date ) : ConnectorAttribute
date	long	The date and time the password was changed.
return	ConnectorAttribute

BuildLockOut() public static method

Builds the lock attribute that determines if an object is locked out.

public static BuildLockOut ( bool lck ) : ConnectorAttribute
lck	bool
return	ConnectorAttribute

BuildPassword() public static method

Builds the operational attribute password.

public static BuildPassword ( GuardedString password ) : ConnectorAttribute
password	GuardedString	the string that represents a password.
return	ConnectorAttribute

BuildPassword() public static method

public static BuildPassword ( SecureString password ) : ConnectorAttribute
password	System.Security.SecureString
return	ConnectorAttribute

BuildPasswordChangeInterval() public static method

Common password policy attribute where the password must be changed every so often.

The value for this attribute is milliseconds since its the lowest common denominator.

public static BuildPasswordChangeInterval ( long val ) : ConnectorAttribute
val	long
return	ConnectorAttribute

BuildPasswordExpirationDate() public static method

Builds an password expiration date ConnectorAttribute.

This ConnectorAttribute represents the date/time a password will expire on a resource.

public static BuildPasswordExpirationDate ( System.DateTime dateTime ) : ConnectorAttribute
dateTime	System.DateTime	UTC time in milliseconds.
return	ConnectorAttribute

BuildPasswordExpirationDate() public static method

Builds an password expiration date ConnectorAttribute.

This ConnectorAttribute represents the date/time a password will expire on a resource.

public static BuildPasswordExpirationDate ( long dateTime ) : ConnectorAttribute
dateTime	long	UTC time in milliseconds.
return	ConnectorAttribute

BuildPasswordExpired() public static method

Builds out an operational ConnectorAttribute that determines if a password is expired or expires a password.

public static BuildPasswordExpired ( bool expired ) : ConnectorAttribute
expired	bool
return	ConnectorAttribute

ConnectorAttributeBuilder() public method

public ConnectorAttributeBuilder ( ) : System
return	System