org.apache.manifoldcf.authorities.authorities.confluence.v6

Class ConfluenceAuthorityConnector

java.lang.Object

org.apache.manifoldcf.core.connector.BaseConnector

org.apache.manifoldcf.authorities.authorities.BaseAuthorityConnector

org.apache.manifoldcf.authorities.authorities.confluence.v6.ConfluenceAuthorityConnector

All Implemented Interfaces:

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

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

Confluence Authority Connector class

ManifoldCF Authority connector to deal with Confluence documents

Author:

Antonio David Perez Morales <adperezmorales@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConfluenceAuthorityConnector.AuthorizationResponseDescription This is the cache object descriptor for cached access tokens from this connector.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfluenceClient	confluenceClient
protected java.lang.String	connectionTimeout
protected static org.apache.manifoldcf.core.interfaces.StringSet	emptyStringSet
protected java.lang.String	host
protected java.lang.String	password
protected java.lang.String	path
protected java.lang.String	port
protected java.lang.String	protocol
protected java.lang.String	proxyHost
protected java.lang.String	proxyPassword
protected java.lang.String	proxyPort
protected java.lang.String	proxyProtocol
protected java.lang.String	proxyUsername
protected java.lang.String	socketTimeout
protected java.lang.String	username

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

_rcsid, 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 and Description
ConfluenceAuthorityConnector() Default constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	check() Checks if connection is available
void	clearThreadContext() Clear thread context.
void	connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParams) Makes connection to server
void	disconnect() Close the connection.
org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse	getAuthorizationResponse(java.lang.String userName)
org.apache.manifoldcf.authorities.interfaces.AuthorizationResponse	getDefaultAuthorizationResponse(java.lang.String userName)
protected void	initConfluenceClient() Initialize Confluence client using the configured parameters
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)
java.lang.String	processConfigurationPost(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
void	setCacheManager(org.apache.manifoldcf.core.interfaces.ICacheManager cm) Used Mainly for testing
void	setConfluenceClient(ConfluenceClient client) Used Mainly for testing
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

deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, poll, 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

deinstall, getConfiguration, install, poll, processConfigurationPost

Field Detail

protocol

protected java.lang.String protocol

host

protected java.lang.String host

port

protected java.lang.String port

path

protected java.lang.String path

username

protected java.lang.String username

password

protected java.lang.String password

socketTimeout

protected java.lang.String socketTimeout

connectionTimeout

protected java.lang.String connectionTimeout

proxyUsername

protected java.lang.String proxyUsername

proxyPassword

protected java.lang.String proxyPassword

proxyProtocol

protected java.lang.String proxyProtocol

proxyHost

protected java.lang.String proxyHost

proxyPort

protected java.lang.String proxyPort

confluenceClient

protected ConfluenceClient confluenceClient

emptyStringSet

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

Constructor Detail

ConfluenceAuthorityConnector

public ConfluenceAuthorityConnector()

Default constructor

Method Detail

setCacheManager

public void setCacheManager(org.apache.manifoldcf.core.interfaces.ICacheManager cm)

Used Mainly for testing

Parameters:

cm -

setConfluenceClient

public void setConfluenceClient(ConfluenceClient client)

Used Mainly for testing

Parameters:

client - Injected Confluence Client

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

clearThreadContext

public void clearThreadContext()

Clear thread context.

Specified by:

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

Overrides:

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

disconnect

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

Close the connection. Call this before discarding the connection.

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

connect

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

Makes connection to server

Specified by:

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

Overrides:

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

check

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

Checks if connection is available

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

initConfluenceClient

protected void initConfluenceClient()
                             throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Initialize Confluence client using the configured parameters

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.

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

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,
                                                 org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
                                          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Overrides:

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

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getDefaultAuthorizationResponse

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

Specified by:

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

Overrides:

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

getAuthorizationResponse

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

Specified by:

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

Overrides:

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

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException