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

Class OIMSSOAuthHandler

java.lang.Object

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

oracle.stellent.ridc.protocol.http.auth.OIMSSOAuthHandler

All Implemented Interfaces:

AuthenticationHandler

public class OIMSSOAuthHandler
extends FormAuthHandler

Oracle Single Sign-on via the Oracle Identity Management (OIM) authentication handler.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_strAuthLocation
protected String	m_strSiteToken
static final String	SITE_FORM_TOKEN
static final String	SITE_QUERY_PARAM_TOKEN

Constructor Summary

Constructors

Constructor	Description
OIMSSOAuthHandler(IdcHttpProtocol httpProtocol)

Method Summary

Modifier and Type	Method	Description
protected RIDCHttpPostMethod	createLoginMethod()	Create the post method for the login operation
protected RIDCHttpMethod	createPingMethod()	Create the method used to PING the server
protected RIDCHttpMethod	createRedirectMethod(RIDCHttpMethod httpMethod)	Create a method to follow a redirect, using the Location response header.
protected String	getAuthLocation()	Returns the location of the SSO server.
IdcContext.HttpAuthScheme	getAuthScheme()
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.
protected String	getSiteToken()	Returns the site token.
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
protected void	readUnusedResponseBody(RIDCHttpMethod method)	Read and discard the response body from the HttpMethod.
protected void	setAuthLocation(String authLocation)	Record the location of the SSO server.
protected void	setSiteToken(String siteToken)	Set the site token - a big string used to kick off the authentication.

Methods inherited from class oracle.stellent.ridc.protocol.http.auth.FormAuthHandler

createHttpClient, executeLogin, getHttpClient, getHttpProtocol, getPingMethod, handleFormLogin, sendAuthenticatedRequest, setHttpClient, setPingMethod, throwFormValidateException

Methods inherited from class java.lang.Object

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

Field Details

SITE_QUERY_PARAM_TOKEN

public static final String SITE_QUERY_PARAM_TOKEN

See Also:

• Constant Field Values

SITE_FORM_TOKEN

public static final String SITE_FORM_TOKEN

See Also:

• Constant Field Values

m_strSiteToken

protected String m_strSiteToken

m_strAuthLocation

protected String m_strAuthLocation

Constructor Details

OIMSSOAuthHandler

public OIMSSOAuthHandler(IdcHttpProtocol httpProtocol)

Method Details

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

Overrides:

isAuthSupported in class FormAuthHandler

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

Overrides:

getAuthScheme in class FormAuthHandler

Returns:

the authentication scheme associated with this handler

getLoginForm

protected IdcContext.LoginForm getLoginForm()

Retrieve the login form for this context

Overrides:

getLoginForm in class FormAuthHandler

Returns:

the login form to use

getLoginFormPath

protected String getLoginFormPath(IdcContext.LoginForm loginForm)
                           throws ProtocolException

Determine the location for the login form post.

Overrides:

getLoginFormPath in class FormAuthHandler

Parameters:

loginForm - the login form

Returns:

the location as an absolute path

Throws:

ProtocolException

createLoginMethod

protected RIDCHttpPostMethod createLoginMethod()
                                        throws ProtocolException

Create the post method for the login operation

Overrides:

createLoginMethod in class FormAuthHandler

Returns:

the post method

Throws:

ProtocolException

handleFormResponse

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

Handle processing the response from the form login

Overrides:

handleFormResponse in class FormAuthHandler

Parameters:

postMethod - the post method

status - the status of the post

Throws:

ProtocolException - if the POST was invalid

createPingMethod

protected RIDCHttpMethod createPingMethod()
                                   throws ProtocolException

Create the method used to PING the server

Returns:

the http method to ping

Throws:

ProtocolException

createRedirectMethod

protected RIDCHttpMethod createRedirectMethod(RIDCHttpMethod httpMethod)
                                       throws ProtocolException

Create a method to follow a redirect, using the Location response header.

Parameters:

httpMethod -

Returns:

Throws:

ProtocolException

setSiteToken

protected void setSiteToken(String siteToken)

Set the site token - a big string used to kick off the authentication.

Parameters:

siteToken -

getSiteToken

protected String getSiteToken()

Returns the site token.

Returns:

setAuthLocation

protected void setAuthLocation(String authLocation)

Record the location of the SSO server.

Parameters:

authLocation -

getAuthLocation

protected String getAuthLocation()

Returns the location of the SSO server.

Returns:

readUnusedResponseBody

protected void readUnusedResponseBody(RIDCHttpMethod method)
                               throws IOException,
ProtocolException

Read and discard the response body from the HttpMethod.

Parameters:

method -

Throws:

IOException

ProtocolException