Package oracle.stellent.ridc.protocol.http.auth

Class FormAuthHandler

java.lang.Object

oracle.stellent.ridc.protocol.http.auth.FormAuthHandler

All Implemented Interfaces:

AuthenticationHandler

Direct Known Subclasses:

OAMSSOAuthHandler, OIMSSOAuthHandler

public class FormAuthHandler
extends Object
implements AuthenticationHandler

Handler for Forms-based login to the Content Server

Constructor Summary

Constructors

Constructor	Description
FormAuthHandler(IdcHttpProtocol httpProtocol)

Method Summary

Modifier and Type	Method	Description
protected RIDCHttpClient	createHttpClient()
protected RIDCHttpPostMethod	createLoginMethod()	Create the post method for the login operation
protected int	executeLogin(RIDCHttpPostMethod postMethod)	Execute the login method
IdcContext.HttpAuthScheme	getAuthScheme()
RIDCHttpClient	getHttpClient()
IdcHttpProtocol	getHttpProtocol()
protected IdcContext.LoginForm	getLoginForm()	Retrieve the login form for this context
protected String	getLoginFormPath(IdcContext.LoginForm loginForm)	Determine the location for the login form post
RIDCHttpMethod	getPingMethod()
protected void	handleFormLogin()	Handle logging into the Content Server via a login form
protected void	handleFormResponse(RIDCHttpMethod postMethod, int status)	Handle processing the response from the form login
boolean	isAuthSupported(RIDCHttpClient httpClient, RIDCHttpMethod httpMethod)	Determine if the current handler can handle the given response to the auth scheme
int	sendAuthenticatedRequest()	Send the authenticated request to the Content Server
void	setHttpClient(RIDCHttpClient httpClient)
void	setPingMethod(RIDCHttpMethod pingMethod)
protected void	throwFormValidateException(RIDCHttpMethod postMethod)	Throw the form validation exception

Methods inherited from class java.lang.Object

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

Constructor Details

FormAuthHandler

public FormAuthHandler(IdcHttpProtocol httpProtocol)

Method Details

getHttpProtocol

public IdcHttpProtocol getHttpProtocol()

getHttpClient

public RIDCHttpClient getHttpClient()
                             throws ProtocolException

Throws:

ProtocolException

setHttpClient

public void setHttpClient(RIDCHttpClient httpClient)

getPingMethod

public RIDCHttpMethod getPingMethod()

setPingMethod

public void setPingMethod(RIDCHttpMethod pingMethod)

isAuthSupported

public boolean isAuthSupported(RIDCHttpClient httpClient,
 RIDCHttpMethod httpMethod)
                        throws ProtocolException

Determine if the current handler can handle the given response to the auth scheme

Specified by:

isAuthSupported in interface AuthenticationHandler

Parameters:

httpClient - the http client that was used to invoke the ping

httpMethod - the http method that was used to invoke the ping

Returns:

true if the handler can support the requests to the given server

Throws:

ProtocolException

getAuthScheme

public IdcContext.HttpAuthScheme getAuthScheme()

Specified by:

getAuthScheme in interface AuthenticationHandler

Returns:

the auth scheme associated with this handler

sendAuthenticatedRequest

public int sendAuthenticatedRequest()
                             throws ProtocolException

Send the authenticated request to the Content Server

Specified by:

sendAuthenticatedRequest in interface AuthenticationHandler

Returns:

the http status

Throws:

ProtocolException

handleFormLogin

protected void handleFormLogin()
                        throws ProtocolException

Handle logging into the Content Server via a login form

Throws:

ProtocolException

createHttpClient

protected RIDCHttpClient createHttpClient()
                                   throws ProtocolException

Returns:

a new http client to use for the login

Throws:

ProtocolException

executeLogin

protected int executeLogin(RIDCHttpPostMethod postMethod)
                    throws ProtocolException

Execute the login method

Parameters:

postMethod - the post method

Returns:

the status from the login operation

Throws:

ProtocolException

createLoginMethod

protected RIDCHttpPostMethod createLoginMethod()
                                        throws ProtocolException

Create the post method for the login operation

Returns:

the post method

Throws:

ProtocolException

getLoginFormPath

protected String getLoginFormPath(IdcContext.LoginForm loginForm)
                           throws ProtocolException

Determine the location for the login form post

Parameters:

loginForm - the login form

Returns:

the location as an absolute path

Throws:

ProtocolException

getLoginForm

protected IdcContext.LoginForm getLoginForm()

Retrieve the login form for this context

Returns:

the login form to use

handleFormResponse

protected void handleFormResponse(RIDCHttpMethod postMethod,
 int status)
                           throws ProtocolException

Handle processing the response from the form login

Parameters:

postMethod - the post method

status - the status of the post

Throws:

ProtocolException

throwFormValidateException

protected void throwFormValidateException(RIDCHttpMethod postMethod)
                                   throws ProtocolException

Throw the form validation exception

Parameters:

postMethod - the post method

Throws:

ProtocolException