org.jasig.portlet.notice.service.rest

Class UserAttributeParameterEvaluator

java.lang.Object

org.jasig.portlet.notice.service.rest.AbstractParameterEvaluator

org.jasig.portlet.notice.service.rest.UserAttributeParameterEvaluator

All Implemented Interfaces:

IParameterEvaluator

public class UserAttributeParameterEvaluator
extends AbstractParameterEvaluator

Concrete implementation of IParameterEvaluator based on user attributes. Works with both PortletRequest (though deprecated) and HttpServletRequest.

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
UserAttributeParameterEvaluator()

Method Summary

Modifier and Type	Method and Description
java.lang.String	evaluate(javax.servlet.http.HttpServletRequest req) Provides a value for the configured parameter, or null if none is available.
java.lang.String	evaluate(javax.portlet.PortletRequest request) Provides a value for the configured parameter, or null if none is available.
void	setClaimName(java.lang.String claimName) Defines the name of the user attribute that will be evaluated using the Servlet API and Open ID Connect (OIDC).
void	setUserAttributeKey(java.lang.String userAttributeKey) Deprecated. Prefer interactions that are not based on the Portlet API

Methods inherited from class org.jasig.portlet.notice.service.rest.AbstractParameterEvaluator

getToken, setToken

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAttributeParameterEvaluator

public UserAttributeParameterEvaluator()

Method Detail

setUserAttributeKey

@Deprecated
public void setUserAttributeKey(java.lang.String userAttributeKey)

Deprecated. Prefer interactions that are not based on the Portlet API

Defines the name of the user attribute that will be evaluated using the Portlet API.

Parameters:

userAttributeKey - The name of a user attribute, e.g. "user.login.id"

setClaimName

public void setClaimName(java.lang.String claimName)

Defines the name of the user attribute that will be evaluated using the Servlet API and Open ID Connect (OIDC).

Parameters:

claimName - The name of a claim in the OIDC Id token

evaluate

public java.lang.String evaluate(javax.portlet.PortletRequest request)

Description copied from interface: IParameterEvaluator

Provides a value for the configured parameter, or null if none is available.

Parameters:

request - The current, active PortletRequest

Returns:

A valid value or null

evaluate

public java.lang.String evaluate(javax.servlet.http.HttpServletRequest req)

Description copied from interface: IParameterEvaluator

Provides a value for the configured parameter, or null if none is available.

Parameters:

req - The current, active HttpServletRequest

Returns:

A valid value or null