org.jasig.portlet.proxy.service.web

Class ExampleCustomFormModifier

java.lang.Object

org.jasig.portlet.proxy.service.web.ExampleCustomFormModifier

All Implemented Interfaces:

IAuthenticationFormModifier

public class ExampleCustomFormModifier
extends Object
implements IAuthenticationFormModifier

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Fields inherited from interface org.jasig.portlet.proxy.service.web.IAuthenticationFormModifier

PROXY_LOCATION_OVERRIDE

Constructor Summary

Constructors

Constructor and Description
ExampleCustomFormModifier()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFieldName() Returns the form field name.
String	getResult(javax.portlet.PortletPreferences preferences) Example of modifications to a login form that invokes the system to gateway to in order to obtain a token from that system that must be submitted with the login form and inserts the token into the url to submit.
void	setFieldName(String fieldName)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

ExampleCustomFormModifier

public ExampleCustomFormModifier()

Method Detail

getResult

public String getResult(javax.portlet.PortletPreferences preferences)
                 throws IOException

Example of modifications to a login form that invokes the system to gateway to in order to obtain a token from that system that must be submitted with the login form and inserts the token into the url to submit. Also demonstrates that you can custom-calculate the url to submit to by having the fieldname of proxiedLocation (per the configuration in gateway-sso-portlet.xml).

Specified by:

getResult in interface IAuthenticationFormModifier

Parameters:

preferences - PortletPreferences that may be useful when calculating the return result

Returns:

value of the form field

Throws:

IOException

MalformedURLException

getFieldName

public String getFieldName()

Description copied from interface: IAuthenticationFormModifier

Returns the form field name. The form field "proxiedLocation" is a special field name that modifies the form's action URL.

Specified by:

getFieldName in interface IAuthenticationFormModifier

Returns:

the name of the field being calculated and returned.

setFieldName

public void setFieldName(String fieldName)