| java.lang.Object
 com.knowgate.ldap.LDAPModel
All known Subclasses: com.knowgate.ldap.LDAPNovell,
| LDAPModel | | abstract public class LDAPModel (Code) | | LDAP Abstract Base Class
author:
Sergio Montoro Ten
version:
1.0 |
| Method Summary | |
| abstract public void | addAddress(Connection oJdbc, String sAddrId)
Add an address from v_ldap_contacts view to an LDAP directory
Addresses may be either public or private depending on the value of field
v_ldap_contacts.bo_private. | | abstract public void | addOrReplaceAddress(Connection oJdbc, String sAddrId)
Add or replace an Address
This method is the same as addAddress() except that it does not raise an
LDAPException if address already exists; in that case address is just replaced. | | abstract public void | addOrReplaceUser(Connection oJdbc, String sUserId)
| | abstract public void | addUser(Connection oJdbc, String sUserId)
| | abstract public void | bind(String sUser, String sPass)
Synchronously authenticates to the LDAP server using LDAP_V3.
If the object has been disconnected from an LDAP server, this method attempts to reconnect to the server. | | abstract public void | connect(String sConnStr)
Connect to LDAP Service
At this point, there is no authentication, and any operations are conducted as an anonymous client. | | abstract public void | connectAndBind(Properties oProps)
| | abstract public void | deleteAddress(Connection oJdbc, String sAddrId)
| | abstract public void | deleteUser(Connection oJdbc, String sUserId)
| | abstract public void | deleteWorkArea(String sDomainNm, String sWorkAreaNm)
| | abstract public void | disconnect()
Synchronously disconnects from the LDAP server
The disconnect method abandons any outstanding requests, issues an unbind request to the server, and then closes the socket. | | abstract public void | dropAll()
| | abstract public boolean | exists(String sSearchString)
| | abstract public void | loadDomain(Connection oJdbc, int iDomainId)
| | abstract public void | loadWorkArea(Connection oJdbc, String sDomainNm, String sWorkAreaNm)
|
| ACCOUNT_CANCELLED | | final public static short ACCOUNT_CANCELLED(Code) | | |
| ACCOUNT_DEACTIVATED | | final public static short ACCOUNT_DEACTIVATED(Code) | | |
| DOMAIN_NOT_FOUND | | final public static short DOMAIN_NOT_FOUND(Code) | | |
| INTERNAL_ERROR | | final public static short INTERNAL_ERROR(Code) | | |
| INVALID_PASSWORD | | final public static short INVALID_PASSWORD(Code) | | |
| PASSWORD_EXPIRED | | final public static short PASSWORD_EXPIRED(Code) | | |
| PWD_CLEAR_TEXT | | final public static int PWD_CLEAR_TEXT(Code) | | |
| PWD_DTIP_RC4 | | final public static int PWD_DTIP_RC4(Code) | | |
| SESSION_EXPIRED | | final public static short SESSION_EXPIRED(Code) | | |
| USER_NOT_FOUND | | final public static short USER_NOT_FOUND(Code) | | |
| WORKAREA_NOT_FOUND | | final public static short WORKAREA_NOT_FOUND(Code) | | |
| WORKAREA_NOT_SET | | final public static short WORKAREA_NOT_SET(Code) | | |
| addAddress | | abstract public void addAddress(Connection oJdbc, String sAddrId) throws LDAPException, SQLException(Code) | | Add an address from v_ldap_contacts view to an LDAP directory
Addresses may be either public or private depending on the value of field
v_ldap_contacts.bo_private. If bo_private is zero then the address is public,
if bo_private is not zero then the address is private.
Private addresses are only visible to the user that created them.
Public addresses are stored at cn=user@mail.com,dc=publicContacts,dc=workarea_name,dc=domain_name,dc=hipergate,dc=org
Private addresses are stored at cn=user@mail.com,dc=privateContacts,cn=owner_guid,dc=users,dc=domain_name,dc=hipergate,dc=org
Parameters:
oJdbc - JDBC Connection
Parameters:
sAddrId - GUID of address to be added
throws:
com.knowgate.ldap.LDAPException - If address already exists at directory
throws:
SQLException - If sAddrId is not found at v_ldap_contacts SQL view
throws:
IllegalStateException - If not connected to LDAP |
| addOrReplaceAddress | | abstract public void addOrReplaceAddress(Connection oJdbc, String sAddrId) throws LDAPException, SQLException(Code) | | Add or replace an Address
This method is the same as addAddress() except that it does not raise an
LDAPException if address already exists; in that case address is just replaced.
Parameters:
oJdbc - JDBC Connection
Parameters:
sAddrId - GUID of address to be added or replaced
throws:
LDAPException -
throws:
SQLException - |
| addUser | | abstract public void addUser(Connection oJdbc, String sUserId) throws LDAPException, SQLException(Code) | | Add a User from v_ldap_users view to an LDAP directory
Users are added under cn=user@mail.com,dc=users,dc=workarea_name,dc=domain_name,dc=hipergate,dc=org
Parameters:
oJdbc - JDBC Connection
Parameters:
sUserId - GUID of user to be added
throws:
LDAPException -
throws:
SQLException - If sUserId is not found at v_ldap_users SQL view
throws:
IllegalStateException - If not connected to LDAP |
| bind | | abstract public void bind(String sUser, String sPass) throws LDAPException(Code) | | Synchronously authenticates to the LDAP server using LDAP_V3.
If the object has been disconnected from an LDAP server, this method attempts to reconnect to the server. If the object has already authenticated, the old authentication is discarded.
Parameters:
sUser - If non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name.
Parameters:
sPass - If non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name and passwd as password.
throws:
LDAPException -
throws:
IllegalStateException - If not conencted to LDAP |
| connect | | abstract public void connect(String sConnStr) throws LDAPException(Code) | | Connect to LDAP Service
At this point, there is no authentication, and any operations are conducted as an anonymous client.
Parameters:
sConnStr - ldap://host:port/distinguished_name
Example "ldap://fobos.kg.int:389/dc=hipergate,dc=org"
throws:
LDAPException - |
| connectAndBind | | abstract public void connectAndBind(Properties oProps) throws LDAPException(Code) | | Connect to LDAP Server using a Properties object
Parameters:
oProps - Properties for connecting to LDAP server.
For example :
ldapconnect=ldap://fobos.kg.int:389/dc=hipergate,dc=org
ldapuser=cn=Manager,dc=hipergate,dc=org
ldappassword=manager
throws:
LDAPException - |
| disconnect | | abstract public void disconnect() throws LDAPException(Code) | | Synchronously disconnects from the LDAP server
The disconnect method abandons any outstanding requests, issues an unbind request to the server, and then closes the socket.
throws:
LDAPException - |
| exists | | abstract public boolean exists(String sSearchString) throws LDAPException(Code) | | Check whether or not an LDAP entry exists
The directory is searched from the connection string key.
For example if ldapconnect connection property is ldap://192.168.1.1:389/dc=hipergate,dc=org
then only entries under "dc=hipergate,dc=org" will be searched
Parameters:
sSearchString - LDAP search string, for example "cn=user@mail.com,dc=publicContacts,dc=my_workarea,dc=my_domain"
throws:
LDAPException - |
| loadWorkArea | | abstract public void loadWorkArea(Connection oJdbc, String sDomainNm, String sWorkAreaNm) throws LDAPException, SQLException(Code) | | Load all users and contact address from a WorkArea into an LDAP directory
Parameters:
oJdbc - JDBC Connection
Parameters:
sDomainNm - Name for Domain containing the WorkArea
Parameters:
sWorkAreaNm - WorkArea Name
throws:
LDAPException -
throws:
SQLException - |
|
|