public class LivelinkAuthority extends BaseAuthorityConnector
| Modifier and Type | Class and Description |
|---|---|
protected static class |
LivelinkAuthority.AuthorizationResponseDescription
This is the cache object descriptor for cached access tokens from
this connector.
|
| Modifier and Type | Field and Description |
|---|---|
static String |
_rcsid |
protected ICacheManager |
cacheManager
Cache manager.
|
protected static StringSet |
emptyStringSet |
RESPONSE_UNREACHABLE, RESPONSE_UNREACHABLE_ADDITIVE, RESPONSE_USERNOTFOUND, RESPONSE_USERNOTFOUND_ADDITIVE, RESPONSE_USERUNAUTHORIZED, RESPONSE_USERUNAUTHORIZED_ADDITIVEcurrentContext, paramsGLOBAL_DENY_TOKEN| Constructor and Description |
|---|
LivelinkAuthority()
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
protected static int |
assessRetry(int sanityRetryCount,
ManifoldCFException e)
Do a retry, or throw an exception if the retry count has been exhausted
|
String |
check()
Check connection for sanity.
|
void |
clearThreadContext()
Clear thread context.
|
void |
connect(ConfigParams configParams)
Connect.
|
void |
disconnect()
Close the connection.
|
AuthorizationResponse |
getAuthorizationResponse(String userName)
Obtain the access tokens for a given user name.
|
protected AuthorizationResponse |
getAuthorizationResponseUncached(String userName)
Uncached method to get access tokens for a user name.
|
AuthorizationResponse |
getDefaultAuthorizationResponse(String userName)
Obtain the default access tokens for a given user name.
|
protected void |
getSession()
Set up a session.
|
protected void |
getSessionParameters()
Initialize the parameters, including the ones needed for caching.
|
protected int |
handleLivelinkRuntimeException(RuntimeException e,
int sanityRetryCount)
Interpret runtimeexception to search for livelink API errors.
|
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.
|
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.
|
void |
setThreadContext(IThreadContext tc)
Set thread context.
|
void |
viewConfiguration(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters)
View configuration.
|
getAccessTokens, getDefaultAccessTokensdeinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, processConfigurationPost, unpack, unpackFixedList, unpackList, viewConfigurationclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdeinstall, getConfiguration, installpublic static final String _rcsid
protected ICacheManager cacheManager
protected static StringSet emptyStringSet
public void setThreadContext(IThreadContext tc) throws ManifoldCFException
setThreadContext in interface IConnectorsetThreadContext in class BaseConnectorManifoldCFExceptionpublic void clearThreadContext()
clearThreadContext in interface IConnectorclearThreadContext in class BaseConnectorpublic void connect(ConfigParams configParams)
connect in interface IConnectorconnect in class BaseConnectorconfigParams - are the configuration parameters for this connection.protected void getSessionParameters()
throws ManifoldCFException
ManifoldCFExceptionprotected void getSession()
throws ManifoldCFException,
ServiceInterruption
public String check() throws ManifoldCFException
check in interface IConnectorcheck in class BaseConnectorManifoldCFExceptionpublic void poll()
throws ManifoldCFException
poll in interface IConnectorpoll in class BaseConnectorManifoldCFExceptionpublic boolean isConnected()
isConnected in interface IConnectorisConnected in class BaseConnectorpublic void disconnect()
throws ManifoldCFException
disconnect in interface IConnectordisconnect in class BaseConnectorManifoldCFExceptionpublic AuthorizationResponse getAuthorizationResponse(String userName) throws ManifoldCFException
getAuthorizationResponse in interface IAuthorityConnectorgetAuthorizationResponse in class BaseAuthorityConnectoruserName - is the user name or identifier.ManifoldCFExceptionprotected AuthorizationResponse getAuthorizationResponseUncached(String userName) throws ManifoldCFException
ManifoldCFExceptionpublic AuthorizationResponse getDefaultAuthorizationResponse(String userName)
getDefaultAuthorizationResponse in interface IAuthorityConnectorgetDefaultAuthorizationResponse in class BaseAuthorityConnectoruserName - 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 IConnectoroutputConfigurationHeader in class BaseConnectorthreadContext - 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.ManifoldCFExceptionIOExceptionpublic void outputConfigurationBody(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, String tabName) throws ManifoldCFException, IOException
outputConfigurationBody in interface IConnectoroutputConfigurationBody in class BaseConnectorthreadContext - 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.ManifoldCFExceptionIOExceptionpublic String processConfigurationPost(IThreadContext threadContext, IPostParameters variableContext, Locale locale, ConfigParams parameters) throws ManifoldCFException
processConfigurationPost in interface IConnectorprocessConfigurationPost in class BaseConnectorthreadContext - 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.ManifoldCFExceptionpublic void viewConfiguration(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters) throws ManifoldCFException, IOException
viewConfiguration in interface IConnectorviewConfiguration in class BaseConnectorthreadContext - 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.ManifoldCFExceptionIOExceptionprotected int handleLivelinkRuntimeException(RuntimeException e, int sanityRetryCount) throws ManifoldCFException, ServiceInterruption
e - is the RuntimeException caughtManifoldCFExceptionServiceInterruptionprotected static int assessRetry(int sanityRetryCount,
ManifoldCFException e)
throws ManifoldCFException
ManifoldCFException