Package org.apache.manifoldcf.authorities.authorities.generic

Class GenericAuthority

java.lang.Object

org.apache.manifoldcf.core.connector.BaseConnector

org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

org.apache.manifoldcf.authorities.authorities.generic.GenericAuthority

All Implemented Interfaces:

org.apache.manifoldcf.authorities.interfaces.IAuthorityConnector, org.apache.manifoldcf.core.interfaces.IConnector

public class GenericAuthority
extends org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

Author:

krycek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GenericAuthority.CheckThread
protected static class	GenericAuthority.FetchTokensThread
protected class	GenericAuthority.GenericAuthorizationResponseDescription	This is the cache object descriptor for cached access tokens from this connector.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected static org.apache.manifoldcf.core.interfaces.StringSet	emptyStringSet

Fields inherited from class org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

RESPONSE_UNREACHABLE, RESPONSE_UNREACHABLE_ADDITIVE, RESPONSE_USERNOTFOUND, RESPONSE_USERNOTFOUND_ADDITIVE, RESPONSE_USERUNAUTHORIZED, RESPONSE_USERUNAUTHORIZED_ADDITIVE

Fields inherited from class org.apache.manifoldcf.core.connector.BaseConnector

currentContext, params

Fields inherited from interface org.apache.manifoldcf.authorities.interfaces.IAuthorityConnector

GLOBAL_DENY_TOKEN

Constructor Summary

Constructors

Constructor	Description
GenericAuthority()	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	check()	Check connection for sanity.
void	connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParams)	Connect.
protected java.lang.String	createCacheConnectionString()
void	disconnect()	Close the connection.
org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse	getAuthorizationResponse(java.lang.String userName)	Obtain the access tokens for a given user name.
protected org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse	getAuthorizationResponseUncached(org.apache.http.client.HttpClient client, java.lang.String userName)
protected org.apache.http.impl.client.DefaultHttpClient	getClient()
org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse	getDefaultAuthorizationResponse(java.lang.String userName)	Obtain the default access tokens for a given user name.
boolean	isConnected()	This method is called to assess whether to count this connector instance should actually be counted as being connected.
void	outputConfigurationBody(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.lang.String tabName)
void	outputConfigurationHeader(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.util.List<java.lang.String> tabsArray)
void	poll()	Poll.
java.lang.String	processConfigurationPost(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
void	setThreadContext(org.apache.manifoldcf.core.interfaces.IThreadContext tc)	Set thread context.
void	viewConfiguration(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)

Methods inherited from class org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

getAccessTokens, getDefaultAccessTokens

Methods inherited from class org.apache.manifoldcf.core.connector.BaseConnector

clearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, processConfigurationPost, unpack, unpackFixedList, unpackList, viewConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IConnector

clearThreadContext, deinstall, getConfiguration, install

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

emptyStringSet

protected static org.apache.manifoldcf.core.interfaces.StringSet emptyStringSet

Constructor Detail

GenericAuthority

public GenericAuthority()

Constructor.

Method Detail

setThreadContext

public void setThreadContext(org.apache.manifoldcf.core.interfaces.IThreadContext tc)
                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Set thread context.

Specified by:

setThreadContext in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

setThreadContext in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

connect

public void connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParams)

Connect. The configuration parameters are included.

Specified by:

connect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

connect in class org.apache.manifoldcf.core.connector.BaseConnector

Parameters:

configParams - are the configuration parameters for this connection.

getClient

protected org.apache.http.impl.client.DefaultHttpClient getClient()
                                                           throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

poll

public void poll()
          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Poll. The connection should be closed if it has been idle for too long.

Specified by:

poll in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

poll in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

isConnected

public boolean isConnected()

This method is called to assess whether to count this connector instance should actually be counted as being connected.

Specified by:

isConnected in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

isConnected in class org.apache.manifoldcf.core.connector.BaseConnector

Returns:

true if the connector instance is actually connected.

check

public java.lang.String check()
                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Check connection for sanity.

Specified by:

check in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

check in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

disconnect

public void disconnect()
                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Close the connection. Call this before discarding the repository connector.

Specified by:

disconnect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

disconnect in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

createCacheConnectionString

protected java.lang.String createCacheConnectionString()

getAuthorizationResponse

public org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse getAuthorizationResponse(java.lang.String userName)
                                                                                            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Obtain the access tokens for a given user name.

Specified by:

getAuthorizationResponse in interface org.apache.manifoldcf.authorities.interfaces.IAuthorityConnector

Overrides:

getAuthorizationResponse in class org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

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:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getAuthorizationResponseUncached

protected org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse getAuthorizationResponseUncached(org.apache.http.client.HttpClient client,
                                                                                                              java.lang.String userName)
                                                                                                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getDefaultAuthorizationResponse

public org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse getDefaultAuthorizationResponse(java.lang.String userName)

Obtain the default access tokens for a given user name.

Specified by:

getDefaultAuthorizationResponse in interface org.apache.manifoldcf.authorities.interfaces.IAuthorityConnector

Overrides:

getDefaultAuthorizationResponse in class org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

Parameters:

userName - is the user name or identifier.

Returns:

the default response tokens, presuming that the connect method fails.

outputConfigurationHeader

public void outputConfigurationHeader(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext,
                                      org.apache.manifoldcf.core.interfaces.IHTTPOutput out,
                                      java.util.Locale locale,
                                      org.apache.manifoldcf.core.interfaces.ConfigParams parameters,
                                      java.util.List<java.lang.String> tabsArray)
                               throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                      java.io.IOException

Specified by:

outputConfigurationHeader in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

outputConfigurationHeader in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

java.io.IOException

outputConfigurationBody

public void outputConfigurationBody(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext,
                                    org.apache.manifoldcf.core.interfaces.IHTTPOutput out,
                                    java.util.Locale locale,
                                    org.apache.manifoldcf.core.interfaces.ConfigParams parameters,
                                    java.lang.String tabName)
                             throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                    java.io.IOException

Specified by:

outputConfigurationBody in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

outputConfigurationBody in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

java.io.IOException

processConfigurationPost

public java.lang.String processConfigurationPost(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext,
                                                 org.apache.manifoldcf.core.interfaces.IPostParameters variableContext,
                                                 java.util.Locale locale,
                                                 org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
                                          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Specified by:

processConfigurationPost in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

processConfigurationPost in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

viewConfiguration

public void viewConfiguration(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext,
                              org.apache.manifoldcf.core.interfaces.IHTTPOutput out,
                              java.util.Locale locale,
                              org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                              java.io.IOException

Specified by:

viewConfiguration in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

viewConfiguration in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

java.io.IOException