Packagecoldfusion.service.mxml
Classpublic class Ldap
InheritanceLdap Inheritance BasicService

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

The proxy class for ldap services exposed by ColdFusion.



Public Properties
 PropertyDefined By
  attributes : String
For queries: comma-delimited list of attributes to return.
Ldap
  delimiter : String
Separator between attribute name-value pairs.
Ldap
  dn : String
Distinguished name, for update action, for example, "cn=BobJensen,o=AceIndustry,c=US"
Ldap
  filter : String
Search criteria for action="query".
Ldap
  maxrows : String
Maximum number of entries for LDAP queries.
Ldap
  modifyType : String
How to process an attribute in a multivalue list: add: appends it to any attributes. delete: deletes it from the set of attributes. replace: replaces it with specified attributes.
Ldap
  password : String
Password that corresponds to user name.
Ldap
  port : String
Port.
Ldap
  rebind : String
yes: attempts to rebind referral callback and reissue query by referred address using original credentials. no: referred connections are anonymous.
Ldap
  referral : String
Integer.
Ldap
  scope : String
Scope of search, from entry specified in start attribute for action="Query" .
Ldap
  secure : Boolean
Specifies the security to employ, and the required information.
Ldap
  separator : String
Delimiter to separate attribute values of multi-value attributes.
Ldap
  server : String
Host name or IP address of LDAP server.
Ldap
  sort : String
Attribute(s) by which to sort query results.
Ldap
  sortControl : String
nocase: case-insensitive sort asc: ascending (a to z) case-sensitive sort. desc: descending (z to a) case-sensitive sort.
Ldap
  start : String
Distinguished name of entry to be used to start a search.
Ldap
  startRow : String
Used with action="query".
Ldap
  timeout : String
Maximum length of time, in milliseconds, to wait for LDAP processing.
Ldap
  userName : String
User ID.
Ldap
Public Methods
 MethodDefined By
  
Creates an instance of the Ldap class.
Ldap
  
Sends information to the ColdFusion service based on the action and the attributes that the user sets.
Ldap
Protected Methods
 MethodDefined By
  
[override] This is the overriden function of the default implementation is BasicService.
Ldap
Property Detail
attributesproperty
public var attributes:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

For queries: comma-delimited list of attributes to return. For queries, to get all attributes, specify ".

delimiterproperty 
public var delimiter:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Separator between attribute name-value pairs. Use this attribute if either of these situations exist:

The default value is ; (semicolon).

dnproperty 
public var dn:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Distinguished name, for update action, for example, "cn=BobJensen,o=AceIndustry,c=US"

filterproperty 
public var filter:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Search criteria for action="query".

The default value is "objectclass =.

maxrowsproperty 
public var maxrows:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Maximum number of entries for LDAP queries.

modifyTypeproperty 
public var modifyType:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

How to process an attribute in a multivalue list:

The default value is replace .

passwordproperty 
public var password:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Password that corresponds to user name. If secure ="CFSSL_BASIC", V2 encrypts the password before transmission.

portproperty 
public var port:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Port.

The default value is 389.

rebindproperty 
public var rebind:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

The default value is no.

referralproperty 
public var referral:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Integer. Number of hops allowed in a referral. A value of 0 disables referred addresses for LDAP; no data is returned.

scopeproperty 
public var scope:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Scope of search, from entry specified in start attribute for action="Query" .

The default value is oneLevel.

secureproperty 
public var secure:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Specifies the security to employ, and the required information. If you specify this attribute, its value must be CFSSL_BASIC, which provides V2 SSL encryption and server authentication.

separatorproperty 
public var separator:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Delimiter to separate attribute values of multi-value attributes. Used by query, add, and modify actions, and by cfldap to output multi-value attributes.

The default value is , (comma).

serverproperty 
public var server:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Host name or IP address of LDAP server.

sortproperty 
public var sort:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Attribute(s) by which to sort query results. Use a comma delimiter.

sortControlproperty 
public var sortControl:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

The default value is asc.

startproperty 
public var start:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Distinguished name of entry to be used to start a search.

startRowproperty 
public var startRow:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Used with action="query". First row of LDAP query to insert into a ColdFusion query.

The default value is 1.

timeoutproperty 
public var timeout:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Maximum length of time, in milliseconds, to wait for LDAP processing.

The default value is 60000.

userNameproperty 
public var userName:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

User ID.

The default value is (anonymous).

Constructor Detail
Ldap()Constructor
public function Ldap()

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates an instance of the Ldap class.

Method Detail
convertResultInEvent()method
override protected function convertResultInEvent(event:ResultEvent):ColdFusionServiceResultEvent

This is the overriden function of the default implementation is BasicService. This function checks if the result returned is 2d array of serviceelement If it is, it converts it into a 2d array of objects and creates an instance of ColdFusionResultEvent and returns the event.

Parameters

event:ResultEvent

Returns
ColdFusionServiceResultEvent
execute()method 
public function execute():void

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 10, AIR 1.5

Sends information to the ColdFusion service based on the action and the attributes that the user sets.