Package | coldfusion.service.mxml |
Class | public class Ldap |
Inheritance | Ldap BasicService InternalConfig Object |
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Property | Defined By | ||
---|---|---|---|
action : String
Action string for the service. | BasicService | ||
attributes : String
For queries: comma-delimited list of attributes to return. | Ldap | ||
cfContextRoot : String
Context root of the ColdFusion server. | InternalConfig | ||
cfPort : int
Port where the ColdFusion server is running. | InternalConfig | ||
cfServer : String
Name or IP address of the ColdFusion server. | InternalConfig | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
delimiter : String
Separator between attribute name-value pairs. | Ldap | ||
destination : String
Specifies the destination for the remoting call. | InternalConfig | ||
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 | ||
secureHttp : Boolean
Boolean value that specifies if secure HTTP is used:
yes: uses secure HTTP
no: does not use secure HTTP
| InternalConfig | ||
separator : String
Delimiter to separate attribute values of multi-value attributes. | Ldap | ||
server : String
Host name or IP address of LDAP server. | Ldap | ||
servicePassword : String
Password to access ColdFusion services. | InternalConfig | ||
serviceUserName : String
Username to access ColdFusion services. | InternalConfig | ||
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 |
Method | Defined By | ||
---|---|---|---|
Ldap()
Creates an instance of the Ldap class. | Ldap | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | BasicService | ||
Dispatches an event into the event flow. | BasicService | ||
Sends information to the ColdFusion service based on the action and the attributes that
the user sets. | Ldap | ||
Returns the RemoteObject instance used by the proxy classes to make the
remote object call. | BasicService | ||
Checks whether the EventDispatcher object has any listeners registered
for a specific type of event. | BasicService | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | BasicService | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its
ancestors for the specified event type. | BasicService |
Method | Defined By | ||
---|---|---|---|
[override]
This is the overriden function of the default implementation is BasicService. | Ldap |
attributes | property |
public var attributes:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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 ".
delimiter | property |
public var delimiter:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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
attributes
attribute specifies more than one item. - An attribute contains the default delimiter (semicolon),
for example:
mgrpmsgrejecttext;lang-en
The default value is ; (semicolon).
dn | property |
public var dn:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Distinguished name, for update action, for example, "cn=BobJensen,o=AceIndustry,c=US"
filter | property |
public var filter:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Search criteria for action="query".
The default value is "objectclass =.
maxrows | property |
public var maxrows:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Maximum number of entries for LDAP queries.
modifyType | property |
public var modifyType:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
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.
The default value is replace
.
password | property |
public var password:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
port | property |
public var port:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Port.
The default value is 389.
rebind | property |
public var rebind:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
yes
: attempts to rebind referral callback and reissue query by referred address using original credentials.no
: referred connections are anonymous.
The default value is no
.
referral | property |
public var referral:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
scope | property |
public var scope:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Scope of search, from entry specified in start attribute for action="Query"
.
oneLevel
: entries one level below entry.base
: only the entry.subtree
: entry and all levels below it.
The default value is oneLevel
.
secure | property |
public var secure:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
separator | property |
public var separator:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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).
server | property |
public var server:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Host name or IP address of LDAP server.
sort | property |
public var sort:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Attribute(s) by which to sort query results. Use a comma delimiter.
sortControl | property |
public var sortControl:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
nocase
: case-insensitive sortasc
: ascending (a to z) case-sensitive sort.desc
: descending (z to a) case-sensitive sort.
The default value is asc
.
start | property |
public var start:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Distinguished name of entry to be used to start a search.
startRow | property |
public var startRow:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
timeout | property |
public var timeout:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
userName | property |
public var userName:String
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
User ID.
The default value is (anonymous).
Ldap | () | Constructor |
public function Ldap()
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 9 |
Runtime Versions: | Flash Player 9, AIR 1.0 |
Creates an instance of the Ldap class.
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 |
ColdFusionServiceResultEvent |
execute | () | method |
public function execute():void
Language Version: | ActionScript 3.0 |
Product Version: | ColdFusion 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.
Wed Nov 21 2018, 06:34 AM -08:00