Package com.atlassian.confluence.impl.webapp.security

Interface SecurityEnforcer

All Known Implementing Classes:

AdminEnforcer, ParameterEnforcer, WebSudoEnforcer, XsrfTokenEnforcer

public interface SecurityEnforcer

Interface for enforcing security policy criteria given a request and supplementary information for that request such as the authenticated user and mapped Struts action.

Since:

8.8

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOGIN_PATH
static final String	NOT_PERMITTED_PATH

Method Summary

Modifier and Type	Method	Description
void	enforce(ConfluenceUser user, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Enforcement action that should be taken when shouldEnforce(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.impl.webapp.security.MappedAction, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) returns true.
boolean	shouldEnforce(ConfluenceUser user, MappedAction mappedAction, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Field Details

LOGIN_PATH

static final String LOGIN_PATH

See Also:

• Constant Field Values

NOT_PERMITTED_PATH

static final String NOT_PERMITTED_PATH

See Also:

• Constant Field Values

Method Details

shouldEnforce

boolean shouldEnforce(ConfluenceUser user,
 MappedAction mappedAction,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

Returns:

true if arguments failed enforcement criteria and enforce(com.atlassian.confluence.user.ConfluenceUser, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) should be called.

enforce

void enforce(ConfluenceUser user,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
      throws IOException,
javax.servlet.ServletException

Enforcement action that should be taken when shouldEnforce(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.impl.webapp.security.MappedAction, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) returns true.

Throws:

IOException

javax.servlet.ServletException