Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-02


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

java.lang.Object
  extended by oracle.stellent.ridc.protocol.http.auth.FormAuthHandler
      extended by 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
protected  java.lang.String m_strAuthLocation
           
protected  java.lang.String m_strSiteToken
           
static java.lang.String SITE_FORM_TOKEN
           
static java.lang.String SITE_QUERY_PARAM_TOKEN
           

 

Constructor Summary
OIMSSOAuthHandler(IdcHttpProtocol httpProtocol)
           

 

Method Summary
protected  org.apache.commons.httpclient.methods.PostMethod createLoginMethod()
          Create the post method for the login operation
protected  org.apache.commons.httpclient.HttpMethod createPingMethod()
          Create the method used to PING the server
protected  org.apache.commons.httpclient.HttpMethod createRedirectMethod(org.apache.commons.httpclient.HttpMethod httpMethod)
          Create a method to follow a redirect, using the Location response header.
protected  java.lang.String getAuthLocation()
          Returns the location of the SSO server.
 IdcContext.HttpAuthScheme getAuthScheme()
           
protected  IdcContext.LoginForm getLoginForm()
          Retrieve the login form for this context
protected  java.lang.String getLoginFormPath(IdcContext.LoginForm loginForm)
          Determine the location for the login form post.
protected  java.lang.String getSiteToken()
          Returns the site token.
protected  void handleFormResponse(org.apache.commons.httpclient.methods.PostMethod postMethod, int status)
          Handle processing the response from the form login
 boolean isAuthSupported(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.HttpMethod httpMethod)
          Determine if the current handler can handle the given response to the auth scheme
protected  void readUnusedResponseBody(org.apache.commons.httpclient.HttpMethod method)
          Read and discard the response body from the HttpMethod.
protected  void setAuthLocation(java.lang.String authLocation)
          Record the location of the SSO server.
protected  void setSiteToken(java.lang.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 Detail

SITE_QUERY_PARAM_TOKEN

public static final java.lang.String SITE_QUERY_PARAM_TOKEN
See Also:
Constant Field Values

SITE_FORM_TOKEN

public static final java.lang.String SITE_FORM_TOKEN
See Also:
Constant Field Values

m_strSiteToken

protected java.lang.String m_strSiteToken

m_strAuthLocation

protected java.lang.String m_strAuthLocation

Constructor Detail

OIMSSOAuthHandler

public OIMSSOAuthHandler(IdcHttpProtocol httpProtocol)

Method Detail

isAuthSupported

public boolean isAuthSupported(org.apache.commons.httpclient.HttpClient httpClient,
                               org.apache.commons.httpclient.HttpMethod httpMethod)
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

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 java.lang.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 org.apache.commons.httpclient.methods.PostMethod 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(org.apache.commons.httpclient.methods.PostMethod 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 org.apache.commons.httpclient.HttpMethod createPingMethod()
Create the method used to PING the server
Returns:
the http method to ping

createRedirectMethod

protected org.apache.commons.httpclient.HttpMethod createRedirectMethod(org.apache.commons.httpclient.HttpMethod httpMethod)
Create a method to follow a redirect, using the Location response header.
Parameters:
httpMethod -
Returns:

setSiteToken

protected void setSiteToken(java.lang.String siteToken)
Set the site token - a big string used to kick off the authentication.
Parameters:
siteToken -

getSiteToken

protected java.lang.String getSiteToken()
Returns the site token.
Returns:

setAuthLocation

protected void setAuthLocation(java.lang.String authLocation)
Record the location of the SSO server.
Parameters:
authLocation -

getAuthLocation

protected java.lang.String getAuthLocation()
Returns the location of the SSO server.
Returns:

readUnusedResponseBody

protected void readUnusedResponseBody(org.apache.commons.httpclient.HttpMethod method)
                               throws java.io.IOException
Read and discard the response body from the HttpMethod.
Parameters:
method -
Throws:
java.io.IOException

Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-02


Copyright © 2008, 2011, Oracle and/or its affiliates. All rights reserved.