public interface

WebSudoManager

com.atlassian.confluence.security.websudo.WebSudoManager
Known Indirect Subclasses

Class Overview

Manages the WebSudo related access to Request, Response and Session objects and provides a method to determine if an XWork action should be treated as a WebSudo resource (matches(String, Class, java.lang.reflect.Method).

Summary

Public Methods
boolean hasValidSession(HttpSession session)
Check if this is a valid WebSudo session.
void invalidateSession(HttpServletRequest request, HttpServletResponse response)
Invalidate the current WebSudo session.
boolean isEnabled()
boolean isWebSudoRequest(HttpServletRequest request)
Checks if the request is a WebSudo request.
void markWebSudoRequest(HttpServletRequest request)
Marks the request as a request for a WebSudo resource.
boolean matches(String requestURI, Class<? extends Action> actionClass, Method method)
Check if the action method should be WebSudo protected for the given requestURI.
void startSession(HttpServletRequest request, HttpServletResponse response)
Start a new WebSudo session.

Public Methods

public boolean hasValidSession (HttpSession session)

Check if this is a valid WebSudo session.

Parameters
session the current javax.servlet.http.HttpSession. Can be null
Returns
  • true if the javax.servlet.http.HttpSession is a WebSudo session.

public void invalidateSession (HttpServletRequest request, HttpServletResponse response)

Invalidate the current WebSudo session. This does NOT invalidate the javax.servlet.http.HttpSession.

Parameters
request the current javax.servlet.http.HttpServletRequest
response the current javax.servlet.http.HttpServletResponse

public boolean isEnabled ()

Returns
  • true if WebSudo is enabled, false otherwise.

public boolean isWebSudoRequest (HttpServletRequest request)

Checks if the request is a WebSudo request.

Parameters
request the current javax.servlet.http.HttpServletRequest
Returns
  • true if the current request is requesting a WebSudo protected web resource, false otherwise.

public void markWebSudoRequest (HttpServletRequest request)

Marks the request as a request for a WebSudo resource.

Parameters
request the current javax.servlet.http.HttpServletRequest

public boolean matches (String requestURI, Class<? extends Action> actionClass, Method method)

Check if the action method should be WebSudo protected for the given requestURI.

Parameters
requestURI - the requestURI for this action method
actionClass - the current action class
method - the action method that is executed
Returns
  • true if the action method should be WebSudo protected, false otherwise.

public void startSession (HttpServletRequest request, HttpServletResponse response)

Start a new WebSudo session. Creates a new javax.servlet.http.HttpSession if necessary.

Parameters
request the current javax.servlet.http.HttpServletRequest
response the current javax.servlet.http.HttpServletResponse