org.springframework.extensions.webscripts.connector

Class AlfrescoAuthenticator

java.lang.Object

org.springframework.extensions.webscripts.connector.AbstractAuthenticator

org.springframework.extensions.webscripts.connector.AlfrescoAuthenticator

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, Authenticator

public class AlfrescoAuthenticator
extends AbstractAuthenticator

An implementation of an Alfresco ticket or cookie-based Authenticator.

This Authenticator can be plugged into a connector to allow the connector to handshake with an Alfresco Repository. This handshake involves POSTing the username and password to the /api/login WebScript.

A ticket or cookie is returned that is then stored in a connector session.

Author:

muzquiano, Kevin Roast

Field Summary

Fields

Modifier and Type	Field and Description
static String	CS_PARAM_ALF_TICKET

Constructor Summary

Constructors

Constructor and Description
AlfrescoAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
ConnectorSession	authenticate(String endpoint, Credentials credentials, ConnectorSession connectorSession) Authenticate against the given Endpoint URL with the supplied Credentials
protected String	getLoginURL()
boolean	isAuthenticated(String endpoint, ConnectorSession connectorSession) Returns whether the current connector session has been authenticated or not

Methods inherited from class org.springframework.extensions.webscripts.connector.AbstractAuthenticator

buildRemoteClient, processResponse, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

CS_PARAM_ALF_TICKET

public static final String CS_PARAM_ALF_TICKET

See Also:

Constant Field Values

Constructor Detail

AlfrescoAuthenticator

public AlfrescoAuthenticator()

Method Detail

authenticate

public ConnectorSession authenticate(String endpoint,
                            Credentials credentials,
                            ConnectorSession connectorSession)
                              throws AuthenticationException

Description copied from interface: Authenticator

Authenticate against the given Endpoint URL with the supplied Credentials

Returns:

The connector session instance

Throws:

AuthenticationException - on error

isAuthenticated

public boolean isAuthenticated(String endpoint,
                      ConnectorSession connectorSession)

Description copied from interface: Authenticator

Returns whether the current connector session has been authenticated or not

Parameters:

endpoint - String

connectorSession - ConnectorSession

Returns:

boolean

getLoginURL

protected String getLoginURL()

Returns:

the REST URL to be used for login requests