public class AuthorityConnector extends BaseAuthorityConnector
Modifier and Type | Class and Description |
---|---|
protected static class |
AuthorityConnector.AuthorizationResponseDescription
This is the cache object descriptor for cached access tokens from
this connector.
|
protected class |
AuthorityConnector.CheckConnectionThread |
protected class |
AuthorityConnector.DestroySessionThread |
protected class |
AuthorityConnector.GetAccessTokensThread |
protected class |
AuthorityConnector.GetSessionThread |
protected class |
AuthorityConnector.GetUserAccessIDThread |
Modifier and Type | Field and Description |
---|---|
protected ICacheManager |
cacheManager
Cache manager.
|
protected boolean |
caseInsensitive |
static String |
CONFIG_PARAM_CACHELIFETIME |
static String |
CONFIG_PARAM_CACHELRUSIZE |
static String |
CONFIG_PARAM_CASEINSENSITIVE |
static String |
CONFIG_PARAM_DOCBASE |
static String |
CONFIG_PARAM_DOMAIN |
static String |
CONFIG_PARAM_PASSWORD |
static String |
CONFIG_PARAM_USERNAME |
static String |
CONFIG_PARAM_USESYSTEMACLS |
protected String |
docbaseName |
protected String |
domain |
protected static StringSet |
emptyStringSet |
protected boolean |
hasSessionParameters |
protected long |
lastSessionFetch |
protected String |
password |
protected IDocumentum |
session |
protected static long |
timeToRelease |
protected String |
userName |
protected boolean |
useSystemAcls |
_rcsid, RESPONSE_UNREACHABLE, RESPONSE_UNREACHABLE_ADDITIVE, RESPONSE_USERNOTFOUND, RESPONSE_USERNOTFOUND_ADDITIVE, RESPONSE_USERUNAUTHORIZED, RESPONSE_USERUNAUTHORIZED_ADDITIVE
currentContext, params
GLOBAL_DENY_TOKEN
Constructor and Description |
---|
AuthorityConnector() |
Modifier and Type | Method and Description |
---|---|
String |
check()
Test the connection.
|
protected void |
checkConnection()
Check connection, with appropriate retries
|
void |
clearThreadContext()
Clear thread context.
|
void |
connect(ConfigParams configParams) |
void |
disconnect()
Disconnect from Documentum.
|
AuthorizationResponse |
getAuthorizationResponse(String strUserNamePassedIn)
Obtain the access tokens for a given user name.
|
protected AuthorizationResponse |
getAuthorizationResponseUncached(String strUserNamePassedIn)
Uncached get response method.
|
AuthorizationResponse |
getDefaultAuthorizationResponse(String userName)
Obtain the default access tokens for a given user name.
|
protected IDocumentumObject |
getObjectByQualification(String qualification)
Perform getObjectByQualification, with appropriate reset
|
protected String |
getServerVersion()
Get server version, with appropriate retries
|
protected void |
getSession()
Get a DFC session.
|
protected void |
getSessionParameters()
Get session parameters.
|
protected static String |
insensitiveMatch(boolean insensitive,
String field,
String value) |
boolean |
isConnected()
This method is called to assess whether to count this connector instance should
actually be counted as being connected.
|
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.
|
protected IDocumentumResult |
performDQLQuery(String query)
Perform a DQL query, with appropriate reset on a remote exception
|
void |
poll()
This method is periodically called for all connectors that are connected but not
in active use.
|
String |
processConfigurationPost(IThreadContext threadContext,
IPostParameters variableContext,
Locale locale,
ConfigParams parameters)
Process a configuration post.
|
protected static String |
quoteDQLString(String value) |
protected void |
releaseCheck()
Release the session, if it's time.
|
void |
setThreadContext(IThreadContext tc)
Set thread context.
|
void |
viewConfiguration(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters)
View configuration.
|
getAccessTokens, getDefaultAccessTokens
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
deinstall, getConfiguration, install
public static final String CONFIG_PARAM_DOCBASE
public static final String CONFIG_PARAM_USERNAME
public static final String CONFIG_PARAM_PASSWORD
public static final String CONFIG_PARAM_DOMAIN
public static final String CONFIG_PARAM_CASEINSENSITIVE
public static final String CONFIG_PARAM_USESYSTEMACLS
public static final String CONFIG_PARAM_CACHELIFETIME
public static final String CONFIG_PARAM_CACHELRUSIZE
protected String docbaseName
protected String userName
protected String password
protected String domain
protected boolean caseInsensitive
protected boolean useSystemAcls
protected ICacheManager cacheManager
protected boolean hasSessionParameters
protected IDocumentum session
protected long lastSessionFetch
protected static final long timeToRelease
protected static StringSet emptyStringSet
public void setThreadContext(IThreadContext tc) throws ManifoldCFException
setThreadContext
in interface IConnector
setThreadContext
in class BaseConnector
ManifoldCFException
public void clearThreadContext()
clearThreadContext
in interface IConnector
clearThreadContext
in class BaseConnector
protected void getSessionParameters() throws ManifoldCFException
ManifoldCFException
protected void getSession() throws ManifoldCFException
ManifoldCFException
protected IDocumentumResult performDQLQuery(String query) throws DocumentumException, ManifoldCFException
protected void checkConnection() throws DocumentumException, ManifoldCFException
protected IDocumentumObject getObjectByQualification(String qualification) throws DocumentumException, ManifoldCFException
protected String getServerVersion() throws DocumentumException, ManifoldCFException
protected void releaseCheck() throws ManifoldCFException
ManifoldCFException
public AuthorizationResponse getAuthorizationResponse(String strUserNamePassedIn) throws ManifoldCFException
getAuthorizationResponse
in interface IAuthorityConnector
getAuthorizationResponse
in class BaseAuthorityConnector
strUserNamePassedIn
- is the user name or identifier.ManifoldCFException
protected AuthorizationResponse getAuthorizationResponseUncached(String strUserNamePassedIn) throws ManifoldCFException
ManifoldCFException
public AuthorizationResponse getDefaultAuthorizationResponse(String userName)
getDefaultAuthorizationResponse
in interface IAuthorityConnector
getDefaultAuthorizationResponse
in class BaseAuthorityConnector
userName
- is the user name or identifier.protected static String insensitiveMatch(boolean insensitive, String field, String value)
public String check() throws ManifoldCFException
check
in interface IConnector
check
in class BaseConnector
ManifoldCFException
public void connect(ConfigParams configParams)
connect
in interface IConnector
connect
in class BaseConnector
public boolean isConnected()
isConnected
in interface IConnector
isConnected
in class BaseConnector
public void disconnect() throws ManifoldCFException
disconnect
in interface IConnector
disconnect
in class BaseConnector
ManifoldCFException
public void poll() throws ManifoldCFException
poll
in interface IConnector
poll
in class BaseConnector
ManifoldCFException
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