|
IP*Works! SSL V6 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--ipworksssl.Ldaps
The LDAPS bean is used to communicate with LDAP Directory Servers using the LDAP (Lightweight Directory Access) protocol.
The LDAPS bean is the SSL-enabled equivalent of the
IP*Works! LDAP bean. The main difference is the introduction of a set of
new configuration settings, properties and events that deal
with SSL security. TheSSLProviderconfiguration setting chooses a security
provider subsystem. TheSSLEnabledProtocolsandSSLCipherStrengthconfiguration settings determine which protocols are enabled and at what security level.
The SSLCertStore , SSLCertSubject , and SSLCertEncoded properties are
used to select a
client certificate if the server is requesting client authentication.
TheSSLSecurityFlagsconfiguration setting, together with the SSLServerAuthentication event
allow you to check the server identity and other security attributes.
Finally, the SSLStatus event provides information about the SSL handshake.
The LDAPS 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 exception are search requests which result in
one or more SearchResult events, followed by a final SearchComplete event.
Attributes are set and returned through attribute arrays such as AttrType and AttrValue . 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 |
amoAdd
|
static int |
amoDelete
|
static int |
amoReplace
|
static int |
fwNone
|
static int |
fwSOCKS4
|
static int |
fwSOCKS5
|
static int |
fwTunnel
|
static int |
sdaAlways
|
static int |
sdaFindingBaseObject
|
static int |
sdaInSearching
|
static int |
sdaNever
|
static int |
ssBaseObject
|
static int |
sslAutomatic
|
static int |
sslExplicit
|
static int |
sslImplicit
|
static int |
sslNone
|
static int |
ssSingleLevel
|
static int |
sstMachine
|
static int |
sstPEMKey
|
static int |
sstPFXBlob
|
static int |
sstPFXFile
|
static int |
sstUser
|
static int |
ssWholeSubtree
|
| Constructor Summary | |
Ldaps()
|
|
| Method Summary | |
void |
abandon(int messageId)
Ask the server to abandon a request. |
void |
add()
Add an entry specified by DN to the directory server using the attributes defined in AttrType and AttrValue . |
void |
addLdapsEventListener(LdapsEventListener l)
|
void |
bind()
Connect and bind to the directory server. |
void |
compare()
Compare attributes and values with those of the entry specified by DN . |
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a beanconfiguration setting. |
void |
delete()
Delete 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)
Perform an LDAP V3 Extended Operation. |
int |
getAttrCount()
Number of attributes values for the current entry. |
int |
getAttrModOp(int attrIndex)
Array of operations to apply on attributes during an LDAP modify operation. |
java.lang.String |
getAttrType(int attrIndex)
Array of attribute types for the current entry. |
byte[] |
getAttrValue(int attrIndex)
Array of attribute values for the current entry. |
java.lang.String |
getDN()
The Distinguished Name used as the base for LDAP operations. |
java.lang.String |
getFirewallHost()
Name or IP address of firewall (optional). |
java.lang.String |
getFirewallPassword()
A password if authentication is to be used when connecting through the firewall. |
int |
getFirewallPort()
Port of the firewall to connect to. |
int |
getFirewallType()
Determines the type of firewall to connect through. |
java.lang.String |
getFirewallUser()
A user name if authentication is to be used connecting through a firewall. |
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 id 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. |
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 LDAP (default 389). |
java.lang.String |
getSortAttributes()
A string of attribute names to sort on with optional relative matching rules. |
byte[] |
getSSLAcceptServerCert()
Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate. |
byte[] |
getSSLCertEncoded()
The SSL certificate (PEM/base64 encoded). |
byte[] |
getSSLCertStore()
The name of the certificate store for the client certificate. |
java.lang.String |
getSSLCertStorePassword()
The password for the certificate store (if any). |
int |
getSSLCertStoreType()
The type of certificate store for the client certificate. |
java.lang.String |
getSSLCertSubject()
The subject of the certificate used for client authentication. |
byte[] |
getSSLServerCert()
The server certificate for the last established connection. |
java.lang.String |
getSSLServerCertStatus()
The verification status of the server certificate for the last established connection. |
int |
getSSLStartMode()
Determines how the bean starts the SSL negotiation. |
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()
Perform an LDAP 'modify' operation on the entry specified by DN . |
void |
modifyRDN(java.lang.String newRDN)
Perform an LDAP 'modify RDN' operation an entry specified by DN . |
void |
removeLdapsEventListener(LdapsEventListener l)
|
void |
search(java.lang.String searchFilter)
Search 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 |
setAttrCount(int attrCount)
Number of attributes values for the current entry. |
void |
setAttrModOp(int attrIndex,
int attrModOp)
Array of operations to apply on attributes during an LDAP modify operation. |
void |
setAttrType(int attrIndex,
java.lang.String attrType)
Array of attribute types for the current entry. |
void |
setAttrValue(int attrIndex,
byte[] attrValue)
Array of attribute values for the current entry. |
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 |
setFirewallHost(java.lang.String firewallHost)
Name or IP address of firewall (optional). |
void |
setFirewallPassword(java.lang.String firewallPassword)
A password if authentication is to be used when connecting through the firewall. |
void |
setFirewallPort(int firewallPort)
Port of the firewall to connect to. |
void |
setFirewallType(int firewallType)
Determines the type of firewall to connect through. |
void |
setFirewallUser(java.lang.String firewallUser)
A user name if authentication is to be used connecting through a firewall. |
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 id 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 LDAP (default 389). |
void |
setSortAttributes(java.lang.String sortAttributes)
A string of attribute names to sort on with optional relative matching rules. |
void |
setSSLAcceptServerCert(byte[] SSLAcceptServerCert)
Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate. |
void |
setSSLCertEncoded(byte[] SSLCertEncoded)
The SSL certificate (PEM/base64 encoded). |
void |
setSSLCertStore(byte[] SSLCertStore)
The name of the certificate store for the client certificate. |
void |
setSSLCertStorePassword(java.lang.String SSLCertStorePassword)
The password for the certificate store (if any). |
void |
setSSLCertStoreType(int SSLCertStoreType)
The type of certificate store for the client certificate. |
void |
setSSLCertSubject(java.lang.String SSLCertSubject)
The subject of the certificate used for client authentication. |
void |
setSSLStartMode(int SSLStartMode)
Determines how the bean starts the SSL negotiation. |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
unbind()
Unbind 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 amoAdd
public static final int amoDelete
public static final int amoReplace
public static final int fwNone
public static final int fwTunnel
public static final int fwSOCKS4
public static final int fwSOCKS5
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
public static final int sstUser
public static final int sstMachine
public static final int sstPFXFile
public static final int sstPFXBlob
public static final int sstPEMKey
public static final int sslAutomatic
public static final int sslImplicit
public static final int sslExplicit
public static final int sslNone
| Constructor Detail |
public Ldaps()
| Method Detail |
public boolean isAcceptData()
Setting the property to False, temporarily disables data reception. Setting the property to True, reenables data reception.
public void setAcceptData(boolean acceptData)
throws IPWorksSSLException
Setting the property to False, temporarily disables data reception. Setting the property to True, reenables data reception.
IPWorksSSLExceptionpublic int getAttrCount()
Setting AttrCount to 0 clears the AttrType and AttrValue arrays.
public void setAttrCount(int attrCount)
throws IPWorksSSLException
Setting AttrCount to 0 clears the AttrType and AttrValue arrays.
IPWorksSSLException
public int getAttrModOp(int attrIndex)
throws IPWorksSSLException
Possible values include:
AttrCount - 1.
IPWorksSSLException
public void setAttrModOp(int attrIndex,
int attrModOp)
throws IPWorksSSLException
Possible values include:
AttrCount - 1.
IPWorksSSLException
public java.lang.String getAttrType(int attrIndex)
throws IPWorksSSLException
If the value of AttrType for a particular array index
is an empty string, then the corresponding value is part
of a set of values, and the attribute type for the set
is specified in the nearest AttrType with a lower
index that has a value other than an empty string.
The number of valid members in the array is specified by AttrCount .
The indexes start at 0 and end at AttrCount - 1.
IPWorksSSLException
public void setAttrType(int attrIndex,
java.lang.String attrType)
throws IPWorksSSLException
If the value of AttrType for a particular array index
is an empty string, then the corresponding value is part
of a set of values, and the attribute type for the set
is specified in the nearest AttrType with a lower
index that has a value other than an empty string.
The number of valid members in the array is specified by AttrCount .
The indexes start at 0 and end at AttrCount - 1.
IPWorksSSLException
public byte[] getAttrValue(int attrIndex)
throws IPWorksSSLException
If the value is part of a set of values, the corresponding AttrType is an empty string, and the attribute type for
the set is specified in the nearest AttrType with a lower
index that has a value other than an empty string.
The number of valid members in the array is specified by AttrCount .
The indexes start at 0 and end at AttrCount - 1.
IPWorksSSLException
public void setAttrValue(int attrIndex,
byte[] attrValue)
throws IPWorksSSLException
If the value is part of a set of values, the corresponding AttrType is an empty string, and the attribute type for
the set is specified in the nearest AttrType with a lower
index that has a value other than an empty string.
The number of valid members in the array is specified by AttrCount .
The indexes start at 0 and end at AttrCount - 1.
IPWorksSSLExceptionpublic boolean isConnected()
Use this property to determine whether the bean is connected to the remote host or not.
public void setConnected(boolean connected)
throws IPWorksSSLException
Use this property to determine whether the bean is connected to the remote host or not.
IPWorksSSLExceptionpublic boolean isDeleteOldRDN()
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 IPWorksSSLException
Used when ModifyRDN is called. The default value is True, which instructs
the server to delete the old RDN.
IPWorksSSLExceptionpublic 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 IPWorksSSLException
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"
IPWorksSSLExceptionpublic java.lang.String getFirewallHost()
If a FirewallHost is given, requested connections will be
authenticated through the specified firewall when connecting.
If the FirewallHost property is set to a Domain Name, a DNS request
is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the
search is not successful, an error is returned.
public void setFirewallHost(java.lang.String firewallHost)
throws IPWorksSSLException
If a FirewallHost is given, requested connections will be
authenticated through the specified firewall when connecting.
If the FirewallHost property is set to a Domain Name, a DNS request
is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the
search is not successful, an error is returned.
IPWorksSSLExceptionpublic java.lang.String getFirewallPassword()
if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate
to the given firewall. If the authentication fails, a trappable error is fired.
public void setFirewallPassword(java.lang.String firewallPassword)
throws IPWorksSSLException
if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate
to the given firewall. If the authentication fails, a trappable error is fired.
IPWorksSSLExceptionpublic int getFirewallPort()
The TCP port for the FirewallHost . See the
description of the FirewallHost property for
details.
Note that the FirewallPort is set automatically
when FirewallType is set to a valid value. See the
description of the FirewallType property for
details.
public void setFirewallPort(int firewallPort)
throws IPWorksSSLException
The TCP port for the FirewallHost . See the
description of the FirewallHost property for
details.
Note that the FirewallPort is set automatically
when FirewallType is set to a valid value. See the
description of the FirewallType property for
details.
IPWorksSSLExceptionpublic int getFirewallType()
The applicable values are the following:
FirewallPort is set to 80.
FirewallPort is set to 1080.
FirewallPort is set to 1080.
public void setFirewallType(int firewallType)
throws IPWorksSSLException
The applicable values are the following:
FirewallPort is set to 80.
FirewallPort is set to 1080.
FirewallPort is set to 1080.
IPWorksSSLExceptionpublic java.lang.String getFirewallUser()
if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate
to the given firewall. If the authentication fails, a trappable error is fired.
public void setFirewallUser(java.lang.String firewallUser)
throws IPWorksSSLException
if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate
to the given firewall. If the authentication fails, a trappable error is fired.
IPWorksSSLExceptionpublic 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()
The default value is 2 (for LDAPv2).
public void setLDAPVersion(int LDAPVersion)
throws IPWorksSSLException
The default value is 2 (for LDAPv2).
IPWorksSSLExceptionpublic 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 multihomed 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 multihomed
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 IPWorksSSLException
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 multihomed 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 multihomed
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.
IPWorksSSLExceptionpublic int getMessageId()
If a custom value is needed for MessageId , the property must be set
before calling any other methods. The bean increments MessageId automatically after each request.
public void setMessageId(int messageId)
throws IPWorksSSLException
If a custom value is needed for MessageId , the property must be set
before calling any other methods. The bean increments MessageId automatically after each request.
IPWorksSSLExceptionpublic int getPageSize()
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 IPWorksSSLException
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.
IPWorksSSLExceptionpublic java.lang.String getPassword()
Leave this value empty if no password is required.
public void setPassword(java.lang.String password)
throws IPWorksSSLException
Leave this value empty if no password is required.
IPWorksSSLExceptionpublic int getResultCode()
This is identical to the corresponding parameter provided by the last Result 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 is identical to the corresponding parameter provided by the last Result or SearchComplete event.
public java.lang.String getResultDN()
This is identical to the corresponding parameter provided by the last Result or SearchComplete event.
public int getSearchDerefAliases()
Possible values are:
Default is to never dereference aliases.
public void setSearchDerefAliases(int searchDerefAliases)
throws IPWorksSSLException
Possible values are:
Default is to never dereference aliases.
IPWorksSSLExceptionpublic boolean isSearchReturnValues()
If only attributes are needed, disabling returning of values will enhance performance.
public void setSearchReturnValues(boolean searchReturnValues)
throws IPWorksSSLException
If only attributes are needed, disabling returning of values will enhance performance.
IPWorksSSLExceptionpublic int getSearchScope()
Possible values are:
Default is to search the whole subtree.
public void setSearchScope(int searchScope)
throws IPWorksSSLException
Possible values are:
Default is to search the whole subtree.
IPWorksSSLExceptionpublic int getSearchSizeLimit()
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 IPWorksSSLException
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.
IPWorksSSLExceptionpublic int getSearchTimeLimit()
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 IPWorksSSLException
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.
IPWorksSSLExceptionpublic java.lang.String getServerName()
The ServerName 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 the ServerName property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the ServerName 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 IPWorksSSLException
The ServerName 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 the ServerName property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the ServerName property is set to the corresponding address. If the
search is not successful, an error is returned.
IPWorksSSLExceptionpublic 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.
For implicit SSL, use port 636 (please refer to the SSLStartMode property
for more information).
public void setServerPort(int serverPort)
throws IPWorksSSLException
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.
For implicit SSL, use port 636 (please refer to the SSLStartMode property
for more information).
IPWorksSSLExceptionpublic java.lang.String getSortAttributes()
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"
public void setSortAttributes(java.lang.String sortAttributes)
throws IPWorksSSLException
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"
IPWorksSSLExceptionpublic byte[] getSSLAcceptServerCert()
If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert .
If the certificate supplied in SSLAcceptServerCert is the same as the
certificate presented by the server, then the server
certificate is accepted unconditionally, and the connection will continue
normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, these property will create a security breach. Use it at your own risk.
public void setSSLAcceptServerCert(byte[] SSLAcceptServerCert)
throws IPWorksSSLException
If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert .
If the certificate supplied in SSLAcceptServerCert is the same as the
certificate presented by the server, then the server
certificate is accepted unconditionally, and the connection will continue
normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, these property will create a security breach. Use it at your own risk.
IPWorksSSLExceptionpublic byte[] getSSLCertEncoded()
This property is used to assign a specific certificate for
SSL client authentication (SSL server authentication in
the case of the IPDaemonS bean).
The SSLCertStore and SSLCertSubject properties may also be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key
is found, SSLCertSubject is updated to reflect the full subject
of the selected certificate, otherwise SSLCertSubject is set
to empty string.
public void setSSLCertEncoded(byte[] SSLCertEncoded)
throws IPWorksSSLException
This property is used to assign a specific certificate for
SSL client authentication (SSL server authentication in
the case of the IPDaemonS bean).
The SSLCertStore and SSLCertSubject properties may also be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key
is found, SSLCertSubject is updated to reflect the full subject
of the selected certificate, otherwise SSLCertSubject is set
to empty string.
IPWorksSSLExceptionpublic byte[] getSSLCertStore()
The SSLCertStoreType property specifies the type of the
certificate store specified by SSLCertStore . If the store
is password protected, specify the password in SSLCertStorePassword .
SSLCertStore is used in conjunction with the SSLCertSubject property in order to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please refer to the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.
public void setSSLCertStore(byte[] SSLCertStore)
throws IPWorksSSLException
The SSLCertStoreType property specifies the type of the
certificate store specified by SSLCertStore . If the store
is password protected, specify the password in SSLCertStorePassword .
SSLCertStore is used in conjunction with the SSLCertSubject property in order to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please refer to the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.
IPWorksSSLExceptionpublic java.lang.String getSSLCertStorePassword()
If the certificate store is of a type that requires a password, the value of this property is used to open the certificate store.
public void setSSLCertStorePassword(java.lang.String SSLCertStorePassword)
throws IPWorksSSLException
If the certificate store is of a type that requires a password, the value of this property is used to open the certificate store.
IPWorksSSLExceptionpublic int getSSLCertStoreType()
This property can take one of the following values:
public void setSSLCertStoreType(int SSLCertStoreType)
throws IPWorksSSLException
This property can take one of the following values:
IPWorksSSLExceptionpublic java.lang.String getSSLCertSubject()
When this property is set, a search is performed in the current certificate store certificate with matching subject.
If an exact match is not found, the store is searched for subjects containing the value of the property.
When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US
Example (Searching with partial subject)
Control.CertSubject = "Test" If a match is not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
If a matching certificate is found, the SSLCertSubject property
is set to the full subject of the matching certificate.
public void setSSLCertSubject(java.lang.String SSLCertSubject)
throws IPWorksSSLException
When this property is set, a search is performed in the current certificate store certificate with matching subject.
If an exact match is not found, the store is searched for subjects containing the value of the property.
When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US
Example (Searching with partial subject)
Control.CertSubject = "Test" If a match is not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
If a matching certificate is found, the SSLCertSubject property
is set to the full subject of the matching certificate.
IPWorksSSLExceptionpublic byte[] getSSLServerCert()
SSLServerCert contains the server certificate for the
last established connection.
SSLServerCert is reset every time a new connection is attempted.
public java.lang.String getSSLServerCertStatus()
When the verification fails, SSLServerCertStatus contains
a string that indicates the reason(s) why, otherwise, it
contains the string "OK".
Please note that the value of SSLServerCertStatus must
be considered as only a suggestion as to the validity of the
certificate. Application software must use its own logic
to determine whether to accept the certificate or not, by using
the SSLServerCert to access other certificate
properties, or other application-specific information.
SSLServerCertStatus is reset an empty string every time a new
connection is attempted.
public int getSSLStartMode()
The SSLStartMode property may have one of the following values:
SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit
( sslImplicit ).
public void setSSLStartMode(int SSLStartMode)
throws IPWorksSSLException
The SSLStartMode property may have one of the following values:
SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit
( sslImplicit ).
IPWorksSSLExceptionpublic 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 IPWorksException
raises an IPWorksException exception
.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout seconds when
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 theAbsoluteTimeoutconfiguration setting.
The default value for the Timeout property is 60 seconds.
public void setTimeout(int timeout)
throws IPWorksSSLException
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 IPWorksException
raises an IPWorksException exception
.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout seconds when
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 theAbsoluteTimeoutconfiguration setting.
The default value for the Timeout property is 60 seconds.
IPWorksSSLException
public java.lang.String config(java.lang.String configurationString)
throws IPWorksSSLException
Config is a generic method available in every bean.
It is used to set and retrieveconfiguration settingsfor 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.
IPWorksSSLException
public void abandon(int messageId)
throws IPWorksSSLException
Ask the server to abandon the request specified by MessageId .
The result of the operation is returned via the Result event.
IPWorksSSLException
public void add()
throws IPWorksSSLException
DN to the directory server using the attributes defined in AttrType and AttrValue . All Entries are required to have an objectClass attribute.
Add the entry specified by DN to the directory.
The result of the operation is returned via the Result event.
Example (Add a New Entry)
LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server"
LDAPControl.AttrCount = 7
LDAPControl.AttrType(0) = "objectClass"
LDAPControl.AttrValue(0) = "top"
LDAPControl.AttrType(1) = "objectClass"
LDAPControl.AttrValue(1) = "Person"
LDAPControl.AttrType(2) = "objectClass"
LDAPControl.AttrValue(2) = "organizationalPerson"
LDAPControl.AttrType(3) = "objectClass"
LDAPControl.AttrValue(3) = "inetorgperson"
LDAPControl.AttrType(4) = "sn"
LDAPControl.AttrValue(4) = "UserName"
LDAPControl.AttrType(5) = "cn"
LDAPControl.AttrValue(5) = "New S. UserName"
LDAPControl.AttrType(6) = "uid"
LDAPControl.AttrValue(6) = "NewUser"
LDAPControl.Add()
IPWorksSSLException
public void bind()
throws IPWorksSSLException
Connect and bind to the directory server. If the Password property has a value, it is used for authentication. If not, the Bind is performed
anonymously.
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()
IPWorksSSLException
public void compare()
throws IPWorksSSLException
DN .
Compare attributes and values specified via the AttrType and AttrValue properties, with the values in the directory for the
entry specified by DN .
The result of the operation is returned via the Result event.
IPWorksSSLException
public void delete()
throws IPWorksSSLException
DN from the directory server.
Delete the entry specified by DN from the directory.
The result of the operation is returned via the Result event.
IPWorksSSLException
public void doEvents()
throws IPWorksSSLException
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.
IPWorksSSLException
public void extendedRequest(java.lang.String requestName,
byte[] requestValue)
throws IPWorksSSLException
RequestName must contain the OID of the operation, and RequestValue may contain an optional value.
IPWorksSSLException
public void interrupt()
throws IPWorksSSLException
If there is no method in progress, Interrupt simply returns doing nothing.
IPWorksSSLException
public void modify()
throws IPWorksSSLException
DN .
Perform an LDAP 'modify' operation on the entry specified by DN . The attribute(s) to
modify should be set via the AttrCount and AttrType property array. The new value(s)
should be set in the AttrValue property array.
The modification can be a replacement, an addition (for multivalued attributes), and deletion.
See the AttrModOp property for more details.
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.AttrCount = 1
LDAPControl.AttrType(0) = "description"
LDAPControl.AttrValue(0) = "changed"
LDAPControl.AttrModOp(0) = amoReplace
LDAPControl.Modify()
IPWorksSSLException
public void modifyRDN(java.lang.String newRDN)
throws IPWorksSSLException
DN .
Perform 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.
IPWorksSSLException
public void search(java.lang.String searchFilter)
throws IPWorksSSLException
DN and the search filter SearchFilter .
Search 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.
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.
IPWorksSSLException
public void unbind()
throws IPWorksSSLException
Unbind from the directory server and break the connection.
IPWorksSSLException
public void addLdapsEventListener(LdapsEventListener l)
throws java.util.TooManyListenersException
java.util.TooManyListenersExceptionpublic void removeLdapsEventListener(LdapsEventListener l)
|
IP*Works! SSL V6 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||