com.sap.portal.httpconnectivity.httpauthentication.services.clientauthservices

Class AbstractDefaultClientAuthService

java.lang.Object

com.sap.portal.httpconnectivity.httpauthentication.services.AbstractAuthService

com.sap.portal.httpconnectivity.httpauthentication.services.clientauthservices.AbstractDefaultClientAuthService

All Implemented Interfaces:

IClientProviderAuth, IService

public abstract class AbstractDefaultClientAuthService
extends AbstractAuthService
implements IClientProviderAuth

This class is used by all the client services. This class manage all the authetication process, so the client services will only have to plant the html fragment code.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_autoClose Parameter defining if the auth window will bw closed authomatically

Fields inherited from class com.sap.portal.httpconnectivity.httpauthentication.services.AbstractAuthService

mm_serviceContext

Constructor Summary

Constructors

Constructor and Description
AbstractDefaultClientAuthService()

Method Summary

Modifier and Type	Method and Description
void	ActivateClientAuthenticationAssistant(IPortalComponentRequest request, IPortalComponentResponse response, IAuthMethodInformation methodInformation) A function called in order to activate the client authentication.
abstract void	AddParamToList(String name, String value) Adds a parameter to the param list
abstract void	ClearPrivateParams() clears the param list
protected String	getActionURL(IAuthMethodInformation methodInformation) Gets the auth url from the system
protected String	getEmptyComponentURI(IPortalComponentRequest request) An URI used by an empty Iframe, used by the client post auth service
abstract com.sapportals.htmlb.HTMLFragment	GetHTMLFragment(IAuthMethodInformation methodInformation, IPortalComponentRequest request) The html fragment that holds the iframe that does the authentication
void	setBody(com.sapportals.htmlb.GridLayout grid) Set the window body message, by creating a new GridLayoutCell
void	setBody(String text) Set the window body message

Methods inherited from class com.sap.portal.httpconnectivity.httpauthentication.services.AbstractAuthService

afterInit, configure, destroy, getContext, getKey, init, release

Methods inherited from class java.lang.Object

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

Field Detail

m_autoClose

protected boolean m_autoClose

Parameter defining if the auth window will bw closed authomatically

Constructor Detail

AbstractDefaultClientAuthService

public AbstractDefaultClientAuthService()

Method Detail

GetHTMLFragment

public abstract com.sapportals.htmlb.HTMLFragment GetHTMLFragment(IAuthMethodInformation methodInformation,
                                                                  IPortalComponentRequest request)
                                                           throws Exception

The html fragment that holds the iframe that does the authentication

Parameters:

methodInformation - holds the system properties

request - the request

Returns:

The HTML Fragment

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

AddParamToList

public abstract void AddParamToList(String name,
                                    String value)

Adds a parameter to the param list

Parameters:

name - param name

value - param value

ClearPrivateParams

public abstract void ClearPrivateParams()

clears the param list

ActivateClientAuthenticationAssistant

public void ActivateClientAuthenticationAssistant(IPortalComponentRequest request,
                                                  IPortalComponentResponse response,
                                                  IAuthMethodInformation methodInformation)
                                           throws Exception

Description copied from interface: IClientProviderAuth

A function called in order to activate the client authentication.

Specified by:

ActivateClientAuthenticationAssistant in interface IClientProviderAuth

Parameters:

request - Engine PRT Component Request Object

response - Engine PRT Component Response Object

methodInformation - An object representing the system

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

setBody

public void setBody(com.sapportals.htmlb.GridLayout grid)

Set the window body message, by creating a new GridLayoutCell

Parameters:

grid - the GridLayout

setBody

public void setBody(String text)

Set the window body message

Parameters:

text - the actuall message

getActionURL

protected String getActionURL(IAuthMethodInformation methodInformation)
                       throws Exception

Gets the auth url from the system

Parameters:

methodInformation - holds the system properties

Returns:

The auth URL

Throws:

Exception - An exception including the suitible HTTP Authentication error message.

getEmptyComponentURI

protected String getEmptyComponentURI(IPortalComponentRequest request)

An URI used by an empty Iframe, used by the client post auth service

Parameters:

request - the request

Returns:

the empty URI