org.apache.struts2.servlet.interceptor: public class: ServletPrincipalProxy

org.apache.struts2.servlet.interceptor
public class: ServletPrincipalProxy [javadoc | source]

java.lang.Object
   org.apache.struts2.servlet.interceptor.ServletPrincipalProxy

All Implemented Interfaces:
PrincipalProxy

PrincipalProxy implementation for using HttpServletRequest Principal related methods.

Constructor:

Constructor:
public ServletPrincipalProxy(HttpServletRequest request) { this.request = request; } Constructs a proxy Parameters: `request` - The underlying request

 public ServletPrincipalProxy(HttpServletRequest request) {
        this.request = request;
}

Constructs a proxy

Parameters:

request - The underlying request

Method from org.apache.struts2.servlet.interceptor.ServletPrincipalProxy Summary:
getRemoteUser, getRequest, getUserPrincipal, isRequestSecure, isUserInRole

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.struts2.servlet.interceptor.ServletPrincipalProxy Detail:
public String getRemoteUser() { return request.getRemoteUser(); } Gets the user id
public HttpServletRequest getRequest() { return request; } Deprecated! `To` - obtain the HttpServletRequest in your action, use org.apache.struts2.servlet.ServletRequestAware , since this method will be dropped in future. Gets the request.
public Principal getUserPrincipal() { return request.getUserPrincipal(); } Gets the user principal
public boolean isRequestSecure() { return request.isSecure(); } Is the request using https?
public boolean isUserInRole(String role) { return request.isUserInRole(role); } True if the user is in the given role

Method from org.apache.struts2.servlet.interceptor.ServletPrincipalProxy Detail:

 public String getRemoteUser() {
        return request.getRemoteUser();
}

Gets the user id

 public HttpServletRequest getRequest() {
        return request;
}

Deprecated! To - obtain the HttpServletRequest in your action, use org.apache.struts2.servlet.ServletRequestAware , since this method will be dropped in future.

Gets the request.

 public Principal getUserPrincipal() {
        return request.getUserPrincipal();
}

Gets the user principal

 public boolean isRequestSecure() {
        return request.isSecure();
}

Is the request using https?

 public boolean isUserInRole(String role) {
        return request.isUserInRole(role);
}

True if the user is in the given role