FileDocCategorySizeDatePackage
PrincipalProxy.javaAPI DocExample2113Mon Jul 23 13:26:52 BST 2007org.apache.struts2.interceptor

PrincipalProxy

public interface PrincipalProxy
Proxy interface used together with PrincipalAware interface. It allows to get indirect access to HttpServletRequest or PortletRequest Principal related methods.

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetRemoteUser()
Gets the user id

return
The user id

public javax.servlet.http.HttpServletRequestgetRequest()
Gets the request.

return
The request
deprecated
To obtain the HttpServletRequest in your action, use {@link org.apache.struts2.servlet.ServletRequestAware}, since this method will be dropped in future.

public java.security.PrincipalgetUserPrincipal()
Gets the user principal

return
The principal

public booleanisRequestSecure()
Is the request using https?

return
True if using https

public booleanisUserInRole(java.lang.String role)
True if the user is in the given role

param
role The role
return
True if the user is in that role