|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Ldap
public class Ldap
The LDAP Bean is used to communicate with LDAP Directory Servers using the LDAP (Lightweight Directory Access) protocol.
The LDAP Bean implements a standard LDAP client as specified in RFC 1777, 2251, and other LDAP RFCs. Support for both LDAP v2 and v3 is provided.
The first step in using the bean is specifying the ServerName
,
a DN
(Distinguished Name) to bind as, and optionally a Password
.
Then you can call one or more of the bean methods to act
upon the server. Server responses are normally received through the Result
event. The only exceptions are search requests which result in
one or more SearchResult
events, followed by a final SearchComplete
event.
Attributes are set and returned through the Attributes
collection
. Other command arguments are specified
through other properties. These are specified in detail in each method.
Search filters are to be specified as string arguments to the Search
method.
The format must be a standard LDAP search string as specified in
RFC 1558. Other search attributes are set in properties such as SearchScope
, SearchTimeLimit
, SearchSizeLimit
, SearchReturnValues
,
and SearchDerefAliases
.
The bean operates synchronously by default (waits for a response before
returning control to the caller), however, the bean may also operate
asynchronously (return control immediately), by setting Timeout
to 0.
Please refer to the Timeout
property for more information.
Field Summary | |
---|---|
static int |
amDigestMD5
|
static int |
amNegotiate
|
static int |
amSimple
|
static int |
sdaAlways
|
static int |
sdaFindingBaseObject
|
static int |
sdaInSearching
|
static int |
sdaNever
|
static int |
ssBaseObject
|
static int |
ssSingleLevel
|
static int |
ssWholeSubtree
|
Constructor Summary | |
---|---|
Ldap()
Creates an instance of Ldap Bean. |
|
Ldap(java.lang.String runtimeLicense)
Creates an instance of Ldap Bean with specified run-time license. |
Method Summary | |
---|---|
void |
abandon(int messageId)
Asks the server to abandon a request. |
void |
add()
Adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes collection
. |
void |
addLdapEventListener(LdapEventListener l)
|
java.lang.String |
attr(java.lang.String attrType)
Returns the value of the specified LDAP attribute. |
void |
bind()
Connects and binds to the directory server. |
void |
compare()
Compares attributes and values with those of the entry specified by DN . |
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
delete()
Deletes an entry specified by DN from the directory server. |
void |
doEvents()
Processes events from the internal message queue. |
void |
extendedRequest(java.lang.String requestName,
byte[] requestValue)
Performs an LDAP V3 Extended Operation. |
LDAPAttributeList |
getAttributes()
Attributes for the current entry. |
int |
getAuthMechanism()
The authentication mechanism to be used when connecting to the LDAP server. |
java.lang.String |
getDN()
The Distinguished Name used as the base for LDAP operations. |
Firewall |
getFirewall()
A set of properties related to firewall access. |
int |
getLDAPVersion()
The version of LDAP used. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
int |
getMessageId()
The message identifier for the next LDAP request. |
int |
getPageSize()
The maximum number of results per page for the Search method. |
java.lang.String |
getPassword()
The password used to authenticate to the LDAP server. |
LDAPReferenceList |
getReferences()
Collection of references returned from the server. |
int |
getResultCode()
The result code returned in the last server response. |
java.lang.String |
getResultDescription()
The descriptive text returned in the last server response (if any). |
java.lang.String |
getResultDN()
The Distinguished Name returned in the last server response (if any). |
int |
getSearchDerefAliases()
Controls alias dereferencing during searching. |
int |
getSearchScope()
Controls the scope of LDAP search operations. |
int |
getSearchSizeLimit()
Maximum number of entries that can be returned by the next search operation. |
int |
getSearchTimeLimit()
A time limit for the next search operation (in seconds). |
java.lang.String |
getServerName()
The name or address of the LDAP server. |
int |
getServerPort()
The server port for the LDAP connection (default is 389). |
java.lang.String |
getSortAttributes()
A string of attribute names to sort on with optional relative matching rules. |
int |
getTimeout()
A timeout for the bean. |
void |
interrupt()
Interrupt the current method. |
boolean |
isAcceptData()
Enables or disables data reception from the server. |
boolean |
isConnected()
Shows whether the bean is connected. |
boolean |
isDeleteOldRDN()
Controls whether the old RDN (Relative Distinguished Name) should be deleted. |
boolean |
isIdle()
The current status of the component. |
boolean |
isSearchReturnValues()
Controls whether the search operation returns values of attributes, or only types. |
void |
modify()
Performs an LDAP 'modify' operation on the entry specified by DN . |
void |
modifyRDN(java.lang.String newRDN)
Performs an LDAP 'modify RDN' operation an entry specified by DN . |
void |
moveToDN(java.lang.String newSuperior)
Performs an LDAP 'modify' operation on the entry specified by DN by changing its superior. |
void |
removeLdapEventListener(LdapEventListener l)
|
void |
search(java.lang.String searchFilter)
Searches the directory server using the base object specified in DN and the search filter SearchFilter . |
void |
setAcceptData(boolean acceptData)
Enables or disables data reception from the server. |
void |
setAuthMechanism(int authMechanism)
The authentication mechanism to be used when connecting to the LDAP server. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
void |
setDeleteOldRDN(boolean deleteOldRDN)
Controls whether the old RDN (Relative Distinguished Name) should be deleted. |
void |
setDN(java.lang.String DN)
The Distinguished Name used as the base for LDAP operations. |
void |
setFirewall(Firewall firewall)
A set of properties related to firewall access. |
void |
setLDAPVersion(int LDAPVersion)
The version of LDAP used. |
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setMessageId(int messageId)
The message identifier for the next LDAP request. |
void |
setPageSize(int pageSize)
The maximum number of results per page for the Search method. |
void |
setPassword(java.lang.String password)
The password used to authenticate to the LDAP server. |
void |
setSearchDerefAliases(int searchDerefAliases)
Controls alias dereferencing during searching. |
void |
setSearchReturnValues(boolean searchReturnValues)
Controls whether the search operation returns values of attributes, or only types. |
void |
setSearchScope(int searchScope)
Controls the scope of LDAP search operations. |
void |
setSearchSizeLimit(int searchSizeLimit)
Maximum number of entries that can be returned by the next search operation. |
void |
setSearchTimeLimit(int searchTimeLimit)
A time limit for the next search operation (in seconds). |
void |
setServerName(java.lang.String serverName)
The name or address of the LDAP server. |
void |
setServerPort(int serverPort)
The server port for the LDAP connection (default is 389). |
void |
setSortAttributes(java.lang.String sortAttributes)
A string of attribute names to sort on with optional relative matching rules. |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
unbind()
Unbinds from the directory server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int amSimple
public static final int amDigestMD5
public static final int amNegotiate
public static final int sdaNever
public static final int sdaInSearching
public static final int sdaFindingBaseObject
public static final int sdaAlways
public static final int ssBaseObject
public static final int ssSingleLevel
public static final int ssWholeSubtree
Constructor Detail |
---|
public Ldap()
public Ldap(java.lang.String runtimeLicense)
Method Detail |
---|
public boolean isAcceptData()
This property enables or disables data reception from the server. Setting the property to False, temporarily disables data reception. Setting the property to True, re-enables data reception.
public void setAcceptData(boolean acceptData) throws IPWorksException
This property enables or disables data reception from the server. Setting the property to False, temporarily disables data reception. Setting the property to True, re-enables data reception.
IPWorksException
public LDAPAttributeList getAttributes()
This property contains a collection of all of the attributes
for the current entry. Each attribute's details are found in
the fields of the ldapattribute
type.
After a Search
, this property will be populated with the attributes of each search results and can be read
within the SearchResult
event (one event for each resulting DN).
During an LDAP Modify
operation, this property
describes the modifications that are to be made
to the attributes. You may specify the attribute,
the new value, and the operation to be executed
by the server in this property.
This collection is indexed from 0 to size - 1.
public int getAuthMechanism()
By default, AuthMechanism
is amSimple (0), and default plaintext authentication is used to login to the server.
If AuthMechanism
is set to amDigestMD5 (1), the more secure DIGEST-MD5 authentication is used instead.
If AuthMechanism
is set to amNegotiate (2) NTLM/Negotiate authentication will be used.
public void setAuthMechanism(int authMechanism) throws IPWorksException
By default, AuthMechanism
is amSimple (0), and default plaintext authentication is used to login to the server.
If AuthMechanism
is set to amDigestMD5 (1), the more secure DIGEST-MD5 authentication is used instead.
If AuthMechanism
is set to amNegotiate (2) NTLM/Negotiate authentication will be used.
IPWorksException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksException
public boolean isDeleteOldRDN()
This property controls whether the old Relative Distinguished Name (RDN) should be deleted. It is used when ModifyRDN
is called. The default value is True, which instructs
the server to delete the old RDN.
public void setDeleteOldRDN(boolean deleteOldRDN) throws IPWorksException
This property controls whether the old Relative Distinguished Name (RDN) should be deleted. It is used when ModifyRDN
is called. The default value is True, which instructs
the server to delete the old RDN.
IPWorksException
public java.lang.String getDN()
Also the base object during LDAP searches.
The Distinguished Name is provided in string format as specified by RFC 1779. Example (Setting DN)
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.DN = "Domain\\Username"
public void setDN(java.lang.String DN) throws IPWorksException
Also the base object during LDAP searches.
The Distinguished Name is provided in string format as specified by RFC 1779. Example (Setting DN)
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.DN = "Domain\\Username"
IPWorksException
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public int getLDAPVersion()
This property contains the version of LDAP used. The default value is 2 (for LDAPv2).
public void setLDAPVersion(int LDAPVersion) throws IPWorksException
This property contains the version of LDAP used. The default value is 2 (for LDAPv2).
IPWorksException
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public int getMessageId()
This property contains the message identifier for the next LDAP request. If a custom value is needed, this property must be set before calling any other methods. The bean increments this property automatically after each request.
public void setMessageId(int messageId) throws IPWorksException
This property contains the message identifier for the next LDAP request. If a custom value is needed, this property must be set before calling any other methods. The bean increments this property automatically after each request.
IPWorksException
public int getPageSize()
Search
method.
This property contains the maximum number of results per page for the Search
method. The default value is 0 (no paging). If set to a value greater than zero, results
will be paged, i.e. returned in blocks of maximum PageSize
results.
For each page sent by the server, a SearchPage
event will fire. you may
decide to cancel or continue displaying results from within this event.
Note: LDAP paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.
public void setPageSize(int pageSize) throws IPWorksException
Search
method.
This property contains the maximum number of results per page for the Search
method. The default value is 0 (no paging). If set to a value greater than zero, results
will be paged, i.e. returned in blocks of maximum PageSize
results.
For each page sent by the server, a SearchPage
event will fire. you may
decide to cancel or continue displaying results from within this event.
Note: LDAP paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.
IPWorksException
public java.lang.String getPassword()
This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.
public void setPassword(java.lang.String password) throws IPWorksException
This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.
IPWorksException
public LDAPReferenceList getReferences()
This property contains a collection of references returned from the server. References will be SearchResult references if inside
a SearchResult
or SearchResultReference
event
in which case they represent URLs to contact to continue
the search. References will be regular Result references
if inside the Result
event or SearchComplete
event in which case they represent the URLs to contact
in order to complete the requested operation.
This collection is indexed from 0 to size - 1.
public int getResultCode()
This property contains the result code returned in the last server response. This is identical to the corresponding parameter provided by the last Result
, SearchResult
, or SearchComplete
event.
Possible result codes are:
All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem, codes 32, 33, 34 and 36 indicate a NameProblem, codes 48, 49 and 50 indicate a SecurityProblem, codes 51 to 54 indicate a ServiceProblem, and codes 64 to 69 and 71 indicate an UpdateProblem.
public java.lang.String getResultDescription()
This property contains the descriptive text returned in the last server response (if any). This is identical to the corresponding parameter provided by the last Result
, SearchResult
, or SearchComplete
event.
public java.lang.String getResultDN()
This property contains the Distinguished Name returned in the last server response (if any).
This is identical to the corresponding parameter provided by the last Result
, or SearchComplete
event.
public int getSearchDerefAliases()
This property controls the alias dereferencing during searching. Possible values are:
Default is to never dereference aliases.
public void setSearchDerefAliases(int searchDerefAliases) throws IPWorksException
This property controls the alias dereferencing during searching. Possible values are:
Default is to never dereference aliases.
IPWorksException
public boolean isSearchReturnValues()
This property controls whether the search operation returns values of attributes, or only types. If only attributes are needed, disabling returning of values will enhance performance.
public void setSearchReturnValues(boolean searchReturnValues) throws IPWorksException
This property controls whether the search operation returns values of attributes, or only types. If only attributes are needed, disabling returning of values will enhance performance.
IPWorksException
public int getSearchScope()
This property controls the scope of LDAP search operations. Possible values are:
Default is to search the whole subtree.
public void setSearchScope(int searchScope) throws IPWorksException
This property controls the scope of LDAP search operations. Possible values are:
Default is to search the whole subtree.
IPWorksException
public int getSearchSizeLimit()
This property contains the maximum number of entries that can be returned by the next search operation. This limit is provided as a hint to the directory server. A value of 0 means that no size limits are in effect for the search.
public void setSearchSizeLimit(int searchSizeLimit) throws IPWorksException
This property contains the maximum number of entries that can be returned by the next search operation. This limit is provided as a hint to the directory server. A value of 0 means that no size limits are in effect for the search.
IPWorksException
public int getSearchTimeLimit()
This property contains a time limit for the next search operation (in seconds). This limit is provided as a hint to the directory server. A value of 0 means that no time limits are in effect for the search.
public void setSearchTimeLimit(int searchTimeLimit) throws IPWorksException
This property contains a time limit for the next search operation (in seconds). This limit is provided as a hint to the directory server. A value of 0 means that no time limits are in effect for the search.
IPWorksException
public java.lang.String getServerName()
This property specifies the IP address (IP number in dotted internet format) or Domain Name of the directory server. It is set before a connection is attempted and cannot be changed once a connection is in progress.
If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
public void setServerName(java.lang.String serverName) throws IPWorksException
This property specifies the IP address (IP number in dotted internet format) or Domain Name of the directory server. It is set before a connection is attempted and cannot be changed once a connection is in progress.
If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
IPWorksException
public int getServerPort()
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
public void setServerPort(int serverPort) throws IPWorksException
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
IPWorksException
public java.lang.String getSortAttributes()
This property contains a string of attribute names to sort on with optional relative matching rules. When set prior to a Search
, entries returned by the server will be sorted according to SortAttributes .
The format consists of one or more attribute names separated by spaces. Each attribute
may be followed by an optional matching rule.
If matching rules are defined, they should be separated from the attribute names with a "/".
Normally the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-".
Examples:
LDAPControl.SortAttributes = "loginTime"
LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch"
LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27"
LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27"
Matching Rules for Equality Filters
public void setSortAttributes(java.lang.String sortAttributes) throws IPWorksException
This property contains a string of attribute names to sort on with optional relative matching rules. When set prior to a Search
, entries returned by the server will be sorted according to SortAttributes .
The format consists of one or more attribute names separated by spaces. Each attribute
may be followed by an optional matching rule.
If matching rules are defined, they should be separated from the attribute names with a "/".
Normally the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-".
Examples:
LDAPControl.SortAttributes = "loginTime"
LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch"
LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27"
LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27"
Matching Rules for Equality Filters
IPWorksException
public int getTimeout()
If the Timeout
property is set to 0, all operations return
immediately, potentially failing with an error if they can't be
completed immediately.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 seconds.
public void setTimeout(int timeout) throws IPWorksException
If the Timeout
property is set to 0, all operations return
immediately, potentially failing with an error if they can't be
completed immediately.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 seconds.
IPWorksException
public void abandon(int messageId) throws IPWorksException
This method asks the server to abandon the request specified by MessageId .
The result of the operation is returned via the Result
event.
IPWorksException
public void add() throws IPWorksException
DN
to the directory server using the type and value attributes defined in the Attributes
collection
.
This method adds the entry specified by DN
to the directory. All Entries are required to have an objectClass attribute.
In order to add a new entry, first Bind
with credentials that will allow you to perform the new addition. To add attributes
instead of entries, use the Modify
method instead.
When specifying multi-valued attributes, specify the attribute type only in the first
occurrence of that attribute type in the Attributes
collection
. Additional occurrences of the same attribute type should specify an
attribute type of empty string.
The result of the operation is returned via the Result
event.
Example (Add a New Entry, including the multi-valued objectClass attribute)
LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server"
LDAPControl.Attributes.Add(new LDAPAttribute("objectClass", "top"))
LDAPControl.Attributes.Add(new LDAPAttribute("", "person"))
LDAPControl.Attributes.Add(new LDAPAttribute("", "organizationalPerson"))
LDAPControl.Attributes.Add(new LDAPAttribute("", "inetorgperson"))
LDAPControl.Attributes.Add(new LDAPAttribute("sn", "UserName"))
LDAPControl.Attributes.Add(new LDAPAttribute("cn", "New S. UserName"))
LDAPControl.Attributes.Add(new LDAPAttribute("uid", "NewUser"))
LDAPControl.Add()
IPWorksException
public java.lang.String attr(java.lang.String attrType) throws IPWorksException
This method returns the value of the specified LDAP attribute. If the attribute does not exist, an empty string is returned.
Please refer to the Attributes
collection
for more information.
IPWorksException
public void bind() throws IPWorksException
This method connects and binds to the directory server. If the Password
property has a value, it is used for authentication. If not, the Bind is performed
anonymously. Binding is often required on some directory servers like Active Directory.
The result of the operation is returned via the Result
event.
Example (Binding)
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()
LDAPControl.DN = "Domain/Username"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()
IPWorksException
public void compare() throws IPWorksException
DN
.
This method compares attributes types and values specified via the Attributes
collection
,
with the values in the directory for the entry specified by DN
.
The result of the operation is returned via the Result
event.
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for the
bean.
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
Attributes
collection
as a result of an LDAP search. This value represents the number of
LDAP attributes that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
You may still add to the Attributes
collection
when this config is set. This
config only specifies a max for returned attributes.
NOTE: This functionality is only available in Java and .NET.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
setting is set to the corresponding address. If the search is not successful,
an error is returned.
NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
RemotePort
is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The
binding (address and port) is provided through the ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings
are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set automatically when FirewallType
is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.
TCPKeepAlive
will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.
LingerTime
is 0 (default), the
system will attempt to send pending data for a connection until the default
IP protocol timeout expires.
In the second scenario, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
is reached.
If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
IPWorksException
public void delete() throws IPWorksException
DN
from the directory server.
This method deletes the entry specified by DN
from the directory.
The result of the operation is returned via the Result
event.
IPWorksException
public void doEvents() throws IPWorksException
When DoEvents
is called, the bean processes any
available events. If no events are available, it waits for a
preset period of time, and then returns.
IPWorksException
public void extendedRequest(java.lang.String requestName, byte[] requestValue) throws IPWorksException
This method performs an LDAP V3 Extended Operation. RequestName must contain the OID of the operation, and RequestValue may contain an optional value.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void modify() throws IPWorksException
DN
.
This method performs an LDAP 'modify' operation on the entry specified by DN
. The attribute(s) to
modify should be set via the Attributes
collection
. When specifying multi-valued attributes, specify the attribute type only in the first
occurrence of that attribute type in the Attributes
collection
. Additional occurrences of the same attribute type should specify an
attribute type of empty string.
The modification can be a replacement, an addition, or a deletion, depending on the ModOp field of the attribute;.
The result of the operation is returned via the Result
event.
Example (Modify an Entry - Replace an Attribute Value)
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.Attributes.Add(New LDAPAttribute("url", "www.url1.net", LDAPAttributeModOps.amoReplace))
LDAPControl.Attributes.Add(New LDAPAttribute("", "www.url2.net", LDAPAttributeModOps.amoReplace))
LDAPControl.Modify()
IPWorksException
public void modifyRDN(java.lang.String newRDN) throws IPWorksException
DN
.
This method performs an LDAP 'modify RDN' operation on the entry specified by DN
.
NewRDN is the new RDN for the entry specified by DN
The result of the operation is returned via the Result
event.
IPWorksException
public void moveToDN(java.lang.String newSuperior) throws IPWorksException
DN
by changing its superior.
This method performs an LDAP 'modify' operation on the entry specified by DN
by changing its superior.
None of the entry's attributes will change. DeleteOldRDN
property will
be set to true to delete the old entry.
The result of the operation is returned via the Result
event.
IPWorksException
public void search(java.lang.String searchFilter) throws IPWorksException
DN
and the search filter SearchFilter .
This method searches the directory server using the base object specified
in the DN
and the search filter specified in the SearchFilter parameter. Additional search parameters are specified through the SearchScope
, SearchDerefAliases
, SearchSizeLimit
, SearchTimeLimit
,
and SearchReturnValues
properties.
If Attributes
are specified before starting a search, the server will only return results that contain a value for the specified attributes.
Results are returned through
zero or more SearchResult
events, after which a SearchComplete
event is fired.
Example (Searching for a User)
LDAPControl.DN = "ou=Employees,dc=server"
LDAPControl.Search("uid=TThompson")
A DSE Search (Directory Specific Entries) will search for attributes of the server itself. Example (DSE Search)
LDAPControl.DN = ""
LDAPControl.SearchScope = 0
LDAPControl.Search("objectClass=*")
SearchFilter is a string representation of the LDAP search filter used for the search.
The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications.
The following are examples of search filters, as provided in the RFC:
(cn=Babs Jensen)
(!(cn=Tim Howes))
(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))
(o=univ*of*mich*)
The complete specification is given by the following BNF:
<filter> ::= "(" <filtercomp> ")"
<filtercomp> ::= <and> | <or> | <not> | <item>
<and> ::= "&" <filterlist>
<or> ::= "|" <filterlist>
<not> ::= "!" <filter>
<filterlist> ::= <filter> | <filter> <filterlist>
<item> ::= <simple> | <present> | <substring>
<simple> ::= <attr> <filtertype> <value>
<filtertype> ::= <equal> | <approx> | <greater> | <less>
<equal> ::= "="
<approx> ::= "~="
<greater> ::= ">="
<less> ::= "<="
<present> ::= <attr> "=*"
<substring> ::= <attr> "=" <initial> <any> <final>
<initial> ::= NULL | <value>
<any> ::= "*" <starval>
<starval> ::= NULL | <value> "*" <starval>
<final> ::= NULL | <value>
<attr> is a string representing an attribute type as defined in RFC 1777. <value> is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a <value> must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\\' character.
IPWorksException
public void unbind() throws IPWorksException
This method unbinds from the directory server and breaks the connection.
IPWorksException
public void addLdapEventListener(LdapEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeLdapEventListener(LdapEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |