Package com.atlassian.sal.api.websudo.internal

Interface InternalWebSudoManager

All Superinterfaces:

WebSudoManager

public interface InternalWebSudoManager
extends WebSudoManager

Allows the client to integrate with the product's native Websudo functionality.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
boolean	canHoldWebSudoSession(jakarta.servlet.http.HttpServletRequest request)	Returns whether the current request is allowed to hold a web sudo session.
void	createWebSudoSession(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Creates a new web sudo session for the current user.

Methods inherited from interface com.atlassian.sal.api.websudo.WebSudoManager

canExecuteRequest, enforceWebSudoProtection, willExecuteWebSudoRequest

Method Details

canHoldWebSudoSession

boolean canHoldWebSudoSession(jakarta.servlet.http.HttpServletRequest request)

Returns whether the current request is allowed to hold a web sudo session.

Reasons why a request may not be allowed to hold a web sudo session include but are not limited to:

• The request is null
• The request's session is null
• The web sudo feature is disabled
• Product is in development mode
• The requesting user does not have sufficient permissions
• The request is coming from a non-allowlisted IP address

Parameters:

request - the current request

Returns:

true if the request will be allowed to attempt web sudo access. false otherwise

createWebSudoSession

void createWebSudoSession(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Creates a new web sudo session for the current user. The session will only be created when the user is allowed to hold a web sudo session (see canHoldWebSudoSession(HttpServletRequest)).

Parameters:

request - the current request

response - the current response