|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.connector.appconn.ldap.ConnectionConstants com.stc.connector.ldapadapter.ldap.LDAPConnector
public class LDAPConnector
The LDAP Connector Class. This is the main class that establishes the physical connection to the LDAP server by creating an initial context.
Field Summary | |
---|---|
static java.lang.String |
AUTHENTICATION_ANON
|
static java.lang.String |
AUTHENTICATION_SIMPLE
|
static java.lang.String |
CONN_TYPE_ENABLE_SSL
|
static java.lang.String |
CONN_TYPE_NONE
|
static java.lang.String |
CONN_TYPE_TLS_ON_DEMAND
|
Constructor Summary | |
---|---|
LDAPConnector(com.stc.connector.framework.util.ConfigurationHelper aConfiguration)
Constructs an LDAPConnector |
Method Summary | |
---|---|
boolean |
checkConnection()
Method performs connection check operation |
void |
close()
Closes the connector to the external system and releases resources. |
java.lang.String |
getAuthentication()
|
static com.stc.connector.framework.util.ConfigurationHelper |
getConfiguration()
Retrieves the connection properties (stored by the constructor) used by the connector to access the external. |
javax.naming.Context |
getContext()
Returns the context if a connection was established |
java.lang.String |
getCredentials()
|
java.lang.String |
getPrincipal()
|
boolean |
isConnected()
Verifies that the connector to the external system is still available. |
void |
open()
Opens a connection to the LDAP Server. |
void |
reset()
Reset connection |
void |
setAuthentication(java.lang.String authentication)
|
void |
setCredentials(java.lang.String credentials)
|
void |
setPrincipal(java.lang.String principal)
|
Methods inherited from class com.stc.connector.appconn.ldap.ConnectionConstants |
---|
contains, getDefaultBooleanValue, getDefaultStringValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String AUTHENTICATION_ANON
public static final java.lang.String AUTHENTICATION_SIMPLE
public static final java.lang.String CONN_TYPE_NONE
public static final java.lang.String CONN_TYPE_ENABLE_SSL
public static final java.lang.String CONN_TYPE_TLS_ON_DEMAND
Constructor Detail |
---|
public LDAPConnector(com.stc.connector.framework.util.ConfigurationHelper aConfiguration)
props
- A Properties object.Method Detail |
---|
public void open() throws LDAPApplicationConnectionException
LDAPApplicationConnectionException
- when connection problems occur.public void close() throws LDAPApplicationConnectionException
LDAPApplicationConnectionException
- When connection problems occur.public boolean isConnected()
true
if the connector is still open and available;
false
otherwise.
LDAPApplicationConnectionException
- When connection problems occur.public static com.stc.connector.framework.util.ConfigurationHelper getConfiguration()
public javax.naming.Context getContext() throws LDAPApplicationConnectionException
LDAPApplicationConnectionException
public boolean checkConnection()
public void reset() throws LDAPApplicationConnectionException
LDAPApplicationConnectionException
public java.lang.String getAuthentication()
public void setAuthentication(java.lang.String authentication)
authentication
- public java.lang.String getCredentials()
public void setCredentials(java.lang.String credentials)
credentials
- public java.lang.String getPrincipal()
public void setPrincipal(java.lang.String principal)
principal
-
|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |