public class LDAPAuthority extends BaseAuthorityConnector
Modifier and Type | Class and Description |
---|---|
protected class |
LDAPAuthority.LdapAuthorizationResponseDescription
This is the cache object descriptor for cached access tokens from this
connector.
|
Modifier and Type | Field and Description |
---|---|
static String |
_rcsid |
protected static StringSet |
emptyStringSet |
RESPONSE_UNREACHABLE, RESPONSE_UNREACHABLE_ADDITIVE, RESPONSE_USERNOTFOUND, RESPONSE_USERNOTFOUND_ADDITIVE, RESPONSE_USERUNAUTHORIZED, RESPONSE_USERUNAUTHORIZED_ADDITIVE
currentContext, params
GLOBAL_DENY_TOKEN
Constructor and Description |
---|
LDAPAuthority()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
check()
Check connection for sanity.
|
void |
connect(ConfigParams configParams)
Connect.
|
protected String |
createCacheConnectionString() |
protected String |
createGroupSearchString() |
protected String |
createUserSearchString() |
void |
disconnect()
Close the connection.
|
protected void |
disconnectSession()
Disconnect a session.
|
static String |
escapeDN(String name) |
static String |
escapeLDAPSearchFilter(String filter) |
AuthorizationResponse |
getAuthorizationResponse(String userName)
Obtain the access tokens for a given user name.
|
protected AuthorizationResponse |
getAuthorizationResponseUncached(String userName) |
AuthorizationResponse |
getDefaultAuthorizationResponse(String userName)
Obtain the default access tokens for a given user name.
|
protected LdapContext |
getSession()
Session setup.
|
protected SearchResult |
getUserEntry(LdapContext ctx,
String userName)
Obtain the user LDAP record for a given user logon name.
|
boolean |
isConnected()
This method is called to assess whether to count this connector instance should
actually be counted as being connected.
|
protected static String |
ldapEscape(String input)
LDAP escape a string.
|
void |
outputConfigurationBody(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
String tabName)
Output the configuration body section.
|
void |
outputConfigurationHeader(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
List<String> tabsArray)
Output the configuration header section.
|
void |
poll()
Poll.
|
String |
processConfigurationPost(IThreadContext threadContext,
IPostParameters variableContext,
Locale locale,
ConfigParams parameters)
Process a configuration post.
|
void |
setThreadContext(IThreadContext tc)
Set thread context.
|
void |
viewConfiguration(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters)
View configuration.
|
getAccessTokens, getDefaultAccessTokens
clearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, processConfigurationPost, unpack, unpackFixedList, unpackList, viewConfiguration
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clearThreadContext, deinstall, getConfiguration, install
public static final String _rcsid
protected static StringSet emptyStringSet
public void setThreadContext(IThreadContext tc) throws ManifoldCFException
setThreadContext
in interface IConnector
setThreadContext
in class BaseConnector
ManifoldCFException
public void connect(ConfigParams configParams)
connect
in interface IConnector
connect
in class BaseConnector
configParams
- are the configuration parameters for this connection.protected LdapContext getSession() throws ManifoldCFException
ManifoldCFException
public String check() throws ManifoldCFException
check
in interface IConnector
check
in class BaseConnector
ManifoldCFException
public boolean isConnected()
isConnected
in interface IConnector
isConnected
in class BaseConnector
public void poll() throws ManifoldCFException
poll
in interface IConnector
poll
in class BaseConnector
ManifoldCFException
protected void disconnectSession()
public void disconnect() throws ManifoldCFException
disconnect
in interface IConnector
disconnect
in class BaseConnector
ManifoldCFException
protected String createCacheConnectionString()
protected String createUserSearchString()
protected String createGroupSearchString()
public AuthorizationResponse getAuthorizationResponse(String userName) throws ManifoldCFException
getAuthorizationResponse
in interface IAuthorityConnector
getAuthorizationResponse
in class BaseAuthorityConnector
userName
- is the user name or identifier.ManifoldCFException
protected AuthorizationResponse getAuthorizationResponseUncached(String userName) throws ManifoldCFException
ManifoldCFException
public AuthorizationResponse getDefaultAuthorizationResponse(String userName)
getDefaultAuthorizationResponse
in interface IAuthorityConnector
getDefaultAuthorizationResponse
in class BaseAuthorityConnector
userName
- is the user name or identifier.public void outputConfigurationHeader(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, List<String> tabsArray) throws ManifoldCFException, IOException
outputConfigurationHeader
in interface IConnector
outputConfigurationHeader
in class BaseConnector
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently
exist, for this connection being configured.tabsArray
- is an array of tab names. Add to this array any tab names
that are specific to the connector.ManifoldCFException
IOException
public void outputConfigurationBody(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, String tabName) throws ManifoldCFException, IOException
outputConfigurationBody
in interface IConnector
outputConfigurationBody
in class BaseConnector
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently
exist, for this connection being configured.tabName
- is the current tab name.ManifoldCFException
IOException
public String processConfigurationPost(IThreadContext threadContext, IPostParameters variableContext, Locale locale, ConfigParams parameters) throws ManifoldCFException
processConfigurationPost
in interface IConnector
processConfigurationPost
in class BaseConnector
threadContext
- is the local thread context.variableContext
- is the set of variables available from the post,
including binary file post information.parameters
- are the configuration parameters, as they currently
exist, for this connection being configured.ManifoldCFException
public void viewConfiguration(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters) throws ManifoldCFException, IOException
viewConfiguration
in interface IConnector
viewConfiguration
in class BaseConnector
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently
exist, for this connection being configured.ManifoldCFException
IOException
protected SearchResult getUserEntry(LdapContext ctx, String userName) throws ManifoldCFException
ctx
- is the ldap context to use.userName
- (Domain Logon Name) is the user name or identifier.searchBase
- (Full Domain Name for the search ie:
DC=qa-ad-76,DC=metacarta,DC=com)ManifoldCFException