| hierarchy: |
WEB-INF.cftags.component cso2ad.javaldap |
| path: | Where ever you put it. |
| properties: | |
| methods: | add, connection_end, connection_start*, init, resultsToQuery*, search, update |
| add |
|---|
public
void
add
(
required string
userdn,
required struct
userdetails
)
Performs an ldap add. Output: suppressed Parameters: userdn: string, required, userdn - The desired distinguished name of the ldap user to add. userdetails: struct, required, userdetails - A structure containing the new values for the object. |
| connection_end |
public
void
connection_end
(
)
Closes the ldap connection. Output: suppressed |
| connection_start* |
private
void
connection_start
(
)
Starts the ldap connection. Output: suppressed |
| init |
public
void
init
(
required string
server,
required string
dn,
required string
password,
string
port="389",
string
timeout="1000",
boolean
secure="FALSE"
)
Initalizes the Ldap object and opens a connection. Output: suppressed Parameters: server: string, required, server - The ldap server to contact. dn: string, required, dn - The distinguished name of the ldap user to connect with. password: string, required, password - The password name of the ldap user to connect with. port: string, optional, port - The port to communicate to the ldap server on. timeout: string, optional, timeout - The timeout for the ldap connection. secure: boolean, optional, secure - Whether or not to establish a secure connection. |
| resultsToQuery* |
private
query
resultsToQuery
(
required array
attributeArray,
required any
searchResults
)
Output: suppressed Parameters: attributeArray: array, required, attributeArray searchResults: any, required, searchResults |
| search |
public
query
search
(
required string
filter,
required string
attributes,
string
base="DC=wharton,DC=upenn,DC=edu",
string
attributesDelimiter=",",
string
scope="SUBTREE"
)
Performs an ldap search. Returns a raw array of results. Output: suppressed Parameters: filter: string, required, filter - The distinguished name of the ldap user to connect with. attributes: string, required, attributes - A delimited list of attributes to retreive. base: string, optional, base - The starting point for the ldap search. attributesDelimiter: string, optional, attributesDelimiter - The delimiter in the list of attributes. scope: string, optional, scope - The scope of the ldap search. |
| update |
public
void
update
(
required string
userdn,
required struct
userdetails,
string
modifytype="replace"
)
Performs an ldap update. Output: enabled Parameters: userdn: string, required, userdn - The distinguished name of the ldap user to update. userdetails: struct, required, userdetails - A structure containing the new values for the object. modifytype: string, optional, modifytype - How to handle multi-value attribute updates. |