org.jasig.portlet.proxy.service.web

Interface IAuthenticationFormModifier

All Known Implementing Classes:

ExampleCustomFormModifier

public interface IAuthenticationFormModifier

IAuthenticationFormModifier is the interface for a bean that encapsulates logic that must be executed in order to populate additional fields, which will be returned by the GatewayPortletController. The GatewayPortletController actionRequest processor returns a list of values that will be included in a form to submit to an external system. If those values require complex business logic, that business logic can be developed externally and called during the controller execution. Any class that implements this interface will be able to define any needed logic to build that field to be passed to that form. Special form field names: - proxiedLocation: if present the form should be posted to this URL

Author:

mgillian

See Also:

org.jasig.portlet.proxy.mvc.portlet.gateway.GatewayPortletController#showTarget(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse, int)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROXY_LOCATION_OVERRIDE

Method Summary

Methods

Modifier and Type	Method and Description
String	getFieldName() Returns the form field name.
String	getResult(javax.portlet.PortletPreferences preferences) getResult() returns the value for the field name

Field Detail

PROXY_LOCATION_OVERRIDE

static final String PROXY_LOCATION_OVERRIDE

See Also:

Constant Field Values

Method Detail

getResult

String getResult(javax.portlet.PortletPreferences preferences)
                 throws MalformedURLException,
                        IOException

getResult() returns the value for the field name

Parameters:

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

Returns:

the value of the field being returned

Throws:

MalformedURLException

IOException

getFieldName

String getFieldName()

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

Returns:

the name of the field being calculated and returned.