org.jasig.portlet.proxy.mvc.portlet.gateway

Class GatewayEntry

java.lang.Object

org.jasig.portlet.proxy.mvc.portlet.gateway.GatewayEntry

public class GatewayEntry
extends Object

GatewayEntry represents a user-facing link in the Gateway SSO portlet.

Author:

Jen Bourey, jennifer.bourey@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GatewayEntry.GatewayEntryOperations Represents the set of config or administrative actions that may be performed by a user on a GatewayEntry.

Constructor Summary

Constructors

Constructor and Description
GatewayEntry()

Method Summary

Modifier and Type	Method and Description
boolean	entryIsAccessible(javax.portlet.PortletRequest request) Returns true if the entry is accessible to the user.
boolean	equals(Object obj) Entries are equal if the names are equal
List<IAuthenticationFormModifier>	getAuthenticationFormModifier()
LinkedHashMap<HttpContentRequestImpl,List<IPreInterceptor>>	getContentRequests() Get a map of content requests to be executed for this link.
String	getIconUrl() Get the icon for this link.
String	getJavascriptFile()
String	getName() Get the display text for this link (user-friendly system name)
GatewayEntry.GatewayEntryOperations	getOperations()
List<String>	getRoleWhitelist()
int	hashCode() Return a hashcode of the name.
boolean	isRequireSecure()
void	setAuthenticationFormModifier(List<IAuthenticationFormModifier> authenticationFormModifier)
void	setContentRequests(LinkedHashMap<HttpContentRequestImpl,List<IPreInterceptor>> contentRequests) Set the map of content requests to be executed for this link.
void	setIconUrl(String iconUrl) Set an icon for this link.
void	setJavascriptFile(String javascriptFile)
void	setName(String name) Set the display text (user-friendly system name) for this link.
void	setRequireSecure(boolean requireSecure)
void	setRoleWhitelist(List<String> roleWhitelist)

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayEntry

public GatewayEntry()

Method Detail

getName

public String getName()

Get the display text for this link (user-friendly system name)

Returns:

setName

public void setName(String name)

Set the display text (user-friendly system name) for this link.

Parameters:

name -

getIconUrl

public String getIconUrl()

Get the icon for this link.

Returns:

setIconUrl

public void setIconUrl(String iconUrl)

Set an icon for this link.

Parameters:

iconUrl -

getJavascriptFile

public String getJavascriptFile()

setJavascriptFile

public void setJavascriptFile(String javascriptFile)

getRoleWhitelist

public List<String> getRoleWhitelist()

setRoleWhitelist

public void setRoleWhitelist(List<String> roleWhitelist)

getContentRequests

public LinkedHashMap<HttpContentRequestImpl,List<IPreInterceptor>> getContentRequests()

Get a map of content requests to be executed for this link.

Returns:

setContentRequests

public void setContentRequests(LinkedHashMap<HttpContentRequestImpl,List<IPreInterceptor>> contentRequests)

Set the map of content requests to be executed for this link. Each entry should have a key consisting of the desired configured content request pointing to a list of interceptor keys. Each request will be executed in the given order after being processed by any interceptors.

Parameters:

contentRequests -

getAuthenticationFormModifier

public List<IAuthenticationFormModifier> getAuthenticationFormModifier()

setAuthenticationFormModifier

public void setAuthenticationFormModifier(List<IAuthenticationFormModifier> authenticationFormModifier)

isRequireSecure

public boolean isRequireSecure()

setRequireSecure

public void setRequireSecure(boolean requireSecure)

getOperations

public GatewayEntry.GatewayEntryOperations getOperations()

entryIsAccessible

public boolean entryIsAccessible(javax.portlet.PortletRequest request)

Returns true if the entry is accessible to the user. An entry is accessible if there are no whitelist roles defined, or if the user has at least one of the roles in the whitelist.

Parameters:

request - PortletRequest

Returns:

true if the entry is accessible to the user.

hashCode

public int hashCode()

Return a hashcode of the name.

Overrides:

hashCode in class Object

Returns:

Hashcode value.

equals

public boolean equals(Object obj)

Entries are equal if the names are equal

Overrides:

equals in class Object

Parameters:

obj - 2nd object to test

Returns:

true if entries are equal