IAuthorityConnector

All Superinterfaces:

IConnector

All Known Implementing Classes:

BaseAuthorityConnector
```
public interface IAuthorityConnector
extends IConnector
```
An authority connector supplies an ACL of some kind for a given user. This is necessary so that the search UI can find the documents that can be legally seen. An instance of this interface provides this functionality. Authority connector instances are pooled, so that session setup does not need to be done repeatedly. The pool is segregated by specific sets of configuration parameters.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String GLOBAL_DENY_TOKEN
This is the global deny token.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AuthorizationResponse`	`getAuthorizationResponse(java.lang.String userName)`	Obtain the access tokens for a given Active Directory user name.
`AuthorizationResponse`	`getDefaultAuthorizationResponse(java.lang.String userName)`	Obtain the default access tokens for a given user name.

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IConnector
check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

- Field Detail
  - GLOBAL_DENY_TOKEN
```
static final java.lang.String GLOBAL_DENY_TOKEN
```
    This is the global deny token. This should be ingested with all documents.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAuthorizationResponse
```
AuthorizationResponse getAuthorizationResponse(java.lang.String userName)
                                        throws ManifoldCFException
```
    Obtain the access tokens for a given Active Directory user name.
    
    Parameters:
    
    userName - is the user name or identifier.
    
    Returns:
    
    the response tokens (according to the current authority). (Should throws an exception only when a condition cannot be properly described within the authorization response object.)
    
    Throws:
    
    ManifoldCFException
  - getDefaultAuthorizationResponse
```
AuthorizationResponse getDefaultAuthorizationResponse(java.lang.String userName)
```
    Obtain the default access tokens for a given user name.
    
    Parameters:
    
    userName - is the user name or identifier.
    
    Returns:
    
    the default response tokens, presuming that the connect method fails.