railo.runtime.tag
Class Ldap

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.tag.Ldap
All Implemented Interfaces:
javax.servlet.jsp.tagext.Tag

public final class Ldap
extends TagImpl

Provides an interface to LDAP Lightweight Directory Access Protocol directory servers like the Netscape Directory Server.


Field Summary
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Ldap()
           
 
Method Summary
 int doStartTag()
           
 void release()
           
 void setAction(String action)
          Specifies the LDAP action.
 void setAttributes(String strAttributes)
           
 void setDelimiter(String delimiter)
          Specifies the character that cfldap uses to separate multiple attribute name/value pairs when more than one attribute is specified in the attribute attribute or the attribute that you want to use has the default delimiter character, which is the semicolon (;), such as mgrpmsgrejecttext;lang-en.
 void setDn(String dn)
          Specifies the distinguished name for update actions.
 void setFilter(String filter)
           
 void setFilterfile(String filterfile)
           
 void setMaxrows(double maxrows)
          Specifies the maximum number of entries for LDAP queries.
 void setModifytype(String modifyType)
          Indicates whether to add, delete, or replace an attribute in a multi-value list of attributes.
 void setName(String name)
          The name you assign to the LDAP query.
 void setPassword(String password)
           
 void setPort(double port)
          Port defaults to the standard LDAP port, 389.
 void setRebind(boolean rebind)
          If you set rebind to Yes, cfldap attempts to rebind the referral callback and reissue the query by the referred address using the original credentials.
 void setReferral(double referral)
          Identifies the type of security to employ, CFSSL_BASIC or CFSSL_CLIENT_AUTH, and additional information that is required by the specified security type.
 void setReturnasbinary(String returnAsBinary)
           
 void setScope(String strScope)
          Specifies the scope of the search from the entry specified in the Start attribute for action = "Query".
 void setSecure(String secure)
           
 void setSeparator(String separator)
          Specifies the character that cfldap uses to separate attribute values in multi-value attributes.
 void setServer(String server)
          Host name "biff.upperlip.com" or IP address "192.1.2.225" of the LDAP server.
 void setSort(String sort)
          Indicates the attribute or attributes by which to sort query results.
 void setSortcontrol(String sortControl)
          Specifies how to sort query results.
 void setStart(String start)
          Specifies the distinguished name of the entry to be used to start the search.
 void setStartrow(double startrow)
          Used in conjunction with action = "Query".
 void setTimeout(double timeout)
          Specifies the maximum amount of time, in seconds, to wait for LDAP processing.
 void setUsername(String username)
          If no user name is specified, the LDAP connection is anonymous.
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
doEndTag, getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Ldap

public Ldap()
Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class TagImpl
See Also:
TagImpl.release()

setFilterfile

public void setFilterfile(String filterfile)
Parameters:
filterfile - The filterfile to set.
Throws:
ApplicationException

setDelimiter

public void setDelimiter(String delimiter)
Specifies the character that cfldap uses to separate multiple attribute name/value pairs when more than one attribute is specified in the attribute attribute or the attribute that you want to use has the default delimiter character, which is the semicolon (;), such as mgrpmsgrejecttext;lang-en. The delimiter character is used by the query, add, and modify action attributes, and is used by cfldap to output multi-value attributes

Parameters:
delimiter - delimeter to set

setStartrow

public void setStartrow(double startrow)
Used in conjunction with action = "Query". Specifies the first row of the LDAP query to insert into the query. The default is 1.

Parameters:
startrow - The startrow to set.

setMaxrows

public void setMaxrows(double maxrows)
Specifies the maximum number of entries for LDAP queries.

Parameters:
maxrows - The maxrows to set.

setTimeout

public void setTimeout(double timeout)
Specifies the maximum amount of time, in seconds, to wait for LDAP processing. Defaults to 60 seconds.

Parameters:
timeout - The timeout to set.

setPassword

public void setPassword(String password)
Parameters:
password - The password to set.

setPort

public void setPort(double port)
Port defaults to the standard LDAP port, 389.

Parameters:
port - The port to set.

setReferral

public void setReferral(double referral)
Identifies the type of security to employ, CFSSL_BASIC or CFSSL_CLIENT_AUTH, and additional information that is required by the specified security type.

Parameters:
referral - The referral to set.

setServer

public void setServer(String server)
Host name "biff.upperlip.com" or IP address "192.1.2.225" of the LDAP server.

Parameters:
server - The server to set.

setUsername

public void setUsername(String username)
If no user name is specified, the LDAP connection is anonymous.

Parameters:
username - The username to set.

setSecure

public void setSecure(String secure)
               throws ApplicationException
Parameters:
secure - The secureLevel to set.
Throws:
ApplicationException

setScope

public void setScope(String strScope)
              throws ApplicationException
Specifies the scope of the search from the entry specified in the Start attribute for action = "Query".

Parameters:
strScope - The scope to set.
Throws:
ApplicationException

setModifytype

public void setModifytype(String modifyType)
                   throws ApplicationException
Indicates whether to add, delete, or replace an attribute in a multi-value list of attributes.

Parameters:
modifyType - The modifyType to set.
Throws:
ApplicationException

setReturnasbinary

public void setReturnasbinary(String returnAsBinary)
                       throws PageException
Parameters:
returnAsBinary - The returnAsBinary to set.
Throws:
PageException

setSort

public void setSort(String sort)
             throws PageException
Indicates the attribute or attributes by which to sort query results. Use a comma [,] to separate attributes.

Parameters:
sort - The sort to set.
Throws:
PageException

setSortcontrol

public void setSortcontrol(String sortControl)
                    throws PageException
Specifies how to sort query results.

Parameters:
sortControl - sortControl to set
Throws:
PageException

setAttributes

public void setAttributes(String strAttributes)
Parameters:
strAttributes -

setAction

public void setAction(String action)
Specifies the LDAP action.

Parameters:
action - The action to set.

setDn

public void setDn(String dn)
Specifies the distinguished name for update actions.

Parameters:
dn - The dn to set.

setName

public void setName(String name)
The name you assign to the LDAP query.

Parameters:
name - The name to set.

setSeparator

public void setSeparator(String separator)
Specifies the character that cfldap uses to separate attribute values in multi-value attributes. This character is used by the query, add, and modify action attributes, and by cfldap to output multi-value attributes. The default character is the comma (,).

Parameters:
separator - The separator to set.

setStart

public void setStart(String start)
Specifies the distinguished name of the entry to be used to start the search.

Parameters:
start - The start to set.

setFilter

public void setFilter(String filter)
Parameters:
filter - The filter to set.

setRebind

public void setRebind(boolean rebind)
If you set rebind to Yes, cfldap attempts to rebind the referral callback and reissue the query by the referred address using the original credentials. The default is No, which means referred connections are anonymous.

Parameters:
rebind - The rebind to set.

doStartTag

public int doStartTag()
               throws PageException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
PageException
See Also:
TagImpl.doStartTag()


Copyright © 2012 Railo