UserRoleAuthorizationInterceptor

extends HandlerInterceptorAdapter

java.lang.Object
↳	org.springframework.web.portlet.handler.HandlerInterceptorAdapter
	↳	org.springframework.web.portlet.handler.UserRoleAuthorizationInterceptor

Class Overview

Interceptor that checks the authorization of the current user via the user's roles, as evaluated by PortletRequest's isUserInRole method.

Summary

Public Constructors
	UserRoleAuthorizationInterceptor()

Public Methods
final boolean	preHandle(PortletRequest request, PortletResponse response, Object handler) Default callback that all "pre*" methods delegate to.
final void	setAuthorizedRoles(String[] authorizedRoles) Set the roles that this interceptor should treat as authorized.

Protected Methods
void	handleNotAuthorized(PortletRequest request, PortletResponse response, Object handler) Handle a request that is not authorized according to this interceptor.

[Expand]

Inherited Methods

From class org.springframework.web.portlet.handler.HandlerInterceptorAdapter

From class java.lang.Object

From interface org.springframework.web.portlet.HandlerInterceptor

abstract void	afterActionCompletion(ActionRequest request, ActionResponse response, Object handler, Exception ex) Callback after completion of request processing in the action phase, that is, after rendering the view.
abstract void	afterEventCompletion(EventRequest request, EventResponse response, Object handler, Exception ex) Callback after completion of request processing in the action phase, that is, after rendering the view.
abstract void	afterRenderCompletion(RenderRequest request, RenderResponse response, Object handler, Exception ex) Callback after completion of request processing, that is, after rendering the view.
abstract void	afterResourceCompletion(ResourceRequest request, ResourceResponse response, Object handler, Exception ex) Callback after completion of request processing, that is, after rendering the view.
abstract void	postHandleRender(RenderRequest request, RenderResponse response, Object handler, ModelAndView modelAndView) Intercept the execution of a handler in the render phase.
abstract void	postHandleResource(ResourceRequest request, ResourceResponse response, Object handler, ModelAndView modelAndView) Intercept the execution of a handler in the render phase.
abstract boolean	preHandleAction(ActionRequest request, ActionResponse response, Object handler) Intercept the execution of a handler in the action phase.
abstract boolean	preHandleEvent(EventRequest request, EventResponse response, Object handler) Intercept the execution of a handler in the action phase.
abstract boolean	preHandleRender(RenderRequest request, RenderResponse response, Object handler) Intercept the execution of a handler in the render phase.
abstract boolean	preHandleResource(ResourceRequest request, ResourceResponse response, Object handler) Intercept the execution of a handler in the render phase.

Public Constructors

public UserRoleAuthorizationInterceptor ()

Public Methods

public final boolean preHandle (PortletRequest request, PortletResponse response, Object handler)

Default callback that all "pre*" methods delegate to.

This implementation always returns true.

Throws

IOException
PortletException

public final void setAuthorizedRoles (String[] authorizedRoles)

Set the roles that this interceptor should treat as authorized.

Parameters

authorizedRoles	array of role names

Protected Methods

protected void handleNotAuthorized (PortletRequest request, PortletResponse response, Object handler)

Handle a request that is not authorized according to this interceptor. Default implementation throws a new PortletSecurityException.

This method can be overridden to write a custom message, forward or redirect to some error page or login page, or throw a PortletException.

Parameters

request	current portlet request
response	current portlet response
handler	chosen handler to execute, for type and/or instance evaluation

Throws

	if there is an internal error
IOException	in case of an I/O error when writing the response
PortletException

Interfaces

Classes

UserRoleAuthorizationInterceptor

Class Overview

See Also

Summary

Public Constructors

public UserRoleAuthorizationInterceptor ()

Public Methods

public final boolean preHandle (PortletRequest request, PortletResponse response, Object handler)

Throws

public final void setAuthorizedRoles (String[] authorizedRoles)

Parameters

Protected Methods

protected void handleNotAuthorized (PortletRequest request, PortletResponse response, Object handler)

Parameters

Throws