Package jetbrains.buildServer.serverSide

Interface SecurityContextEx

All Superinterfaces:

SecurityContext

All Known Implementing Classes:

SecurityContextImpl

public interface SecurityContextEx
extends SecurityContext

Author:

Pavel.Sher Date: 18.08.2007

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SecurityContextEx.RunAsAction
static interface	SecurityContextEx.RunAsActionWithResult<T>

Method Summary

Modifier and Type	Method	Description
void	clearContext()	Removes any authority holder from the context
String	describeAuthorityHolder(AuthorityHolder authorityHolder)
AccessChecker	getAccessChecker()	Returns AccessChecker instance that should be used for various security asserts.
Permissions	getGloballyAllowedPermissions()
AuthorityHolder	getOriginalAuthority()	Normally permissions that are not available on the current node are filtered out from all authority holders.
boolean	isSystemAccess()
AuthorityHolder	restrictByServerPermissions(AuthorityHolder authorityHolder)	Filters out permissions that are not available on the server - due to current server responsibilities
void	runAs(AuthorityHolder authority, SecurityContextEx.RunAsAction action)
<T> T	runAs(AuthorityHolder authority, SecurityContextEx.RunAsActionWithResult<T> action)
void	runAsSystem(SecurityContextEx.RunAsAction action)	Runs specified Runnable with system privileges (in all permissions mode)
<T> T	runAsSystem(SecurityContextEx.RunAsActionWithResult<T> action)
void	runAsSystemUnchecked(SecurityContextEx.RunAsAction action)	Runs specified Runnable with system privileges (in all permissions mode) Occured exceptions will be rethrown as RuntimeException Method can be used instead of runAsSystem(jetbrains.buildServer.serverSide.SecurityContextEx.RunAsAction) in case {@param action} does not throw checked exception or no specific exception handling is required.
<T> T	runAsSystemUnchecked(SecurityContextEx.RunAsActionWithResult<T> action)
void	runAsUnchecked(AuthorityHolder authority, SecurityContextEx.RunAsAction action)	Runs specified Runnable with {@param authority} privileges (in all permissions mode) Occured exceptions will be rethrown as RuntimeException Method can be used instead of runAs(jetbrains.buildServer.serverSide.auth.AuthorityHolder, jetbrains.buildServer.serverSide.SecurityContextEx.RunAsAction) in case {@param action} does not throw checked exception or no specific exception handling is required.
<T> T	runAsUnchecked(AuthorityHolder authority, SecurityContextEx.RunAsActionWithResult<T> action)
void	setAuthorityHolder(AuthorityHolder authority)	Sets AuthorityHolder in the context

Methods inherited from interface jetbrains.buildServer.serverSide.auth.SecurityContext

getAuthorityHolder

Method Detail

setAuthorityHolder

void setAuthorityHolder(@NotNull
                        AuthorityHolder authority)

Sets AuthorityHolder in the context

Parameters:

authority - authority

clearContext

void clearContext()

Removes any authority holder from the context

runAsSystem

void runAsSystem(@NotNull
                 SecurityContextEx.RunAsAction action)
          throws Throwable

Runs specified Runnable with system privileges (in all permissions mode)

Parameters:

action - action to run

Throws:

Throwable - exception

runAsSystem

<T> T runAsSystem(@NotNull
                  SecurityContextEx.RunAsActionWithResult<T> action)
           throws Throwable

Throws:

Throwable

runAs

void runAs(@NotNull
           AuthorityHolder authority,
           @NotNull
           SecurityContextEx.RunAsAction action)
    throws Throwable

Throws:

Throwable

runAs

<T> T runAs(@NotNull
            AuthorityHolder authority,
            @NotNull
            SecurityContextEx.RunAsActionWithResult<T> action)
     throws Throwable

Throws:

Throwable

runAsSystemUnchecked

void runAsSystemUnchecked(@NotNull
                          SecurityContextEx.RunAsAction action)

Runs specified Runnable with system privileges (in all permissions mode) Occured exceptions will be rethrown as RuntimeException Method can be used instead of runAsSystem(jetbrains.buildServer.serverSide.SecurityContextEx.RunAsAction) in case {@param action} does not throw checked exception or no specific exception handling is required.

Parameters:

action - action to run

Since:

2019.2

runAsSystemUnchecked

<T> T runAsSystemUnchecked(@NotNull
                           SecurityContextEx.RunAsActionWithResult<T> action)

runAsUnchecked

void runAsUnchecked(@NotNull
                    AuthorityHolder authority,
                    @NotNull
                    SecurityContextEx.RunAsAction action)

Runs specified Runnable with {@param authority} privileges (in all permissions mode) Occured exceptions will be rethrown as RuntimeException Method can be used instead of runAs(jetbrains.buildServer.serverSide.auth.AuthorityHolder, jetbrains.buildServer.serverSide.SecurityContextEx.RunAsAction) in case {@param action} does not throw checked exception or no specific exception handling is required.

Parameters:

authority - autority holder those privileges will be used to run action

action - action to run

Since:

2019.2

runAsUnchecked

<T> T runAsUnchecked(@NotNull
                     AuthorityHolder authority,
                     @NotNull
                     SecurityContextEx.RunAsActionWithResult<T> action)

isSystemAccess

boolean isSystemAccess()

Returns:

true if current authority holder is system

getOriginalAuthority

@NotNull
AuthorityHolder getOriginalAuthority()

Normally permissions that are not available on the current node are filtered out from all authority holders. This method allows to obtain original set of authority holder' permissions without filtering. See ServerPermissionsRestrictor.getAllowedPermissions()

Since:

2018.1.2

restrictByServerPermissions

@NotNull
AuthorityHolder restrictByServerPermissions(@NotNull
                                            AuthorityHolder authorityHolder)

Filters out permissions that are not available on the server - due to current server responsibilities

Since:

2018.1.2

getGloballyAllowedPermissions

@NotNull
Permissions getGloballyAllowedPermissions()

Returns:

Permissions containing all permissions which are allowed on this server. Any permission not available in this set won't be working for any user even if granted - except for Super User.

Since:

2020.1.1

describeAuthorityHolder

@NotNull
String describeAuthorityHolder(@NotNull
                               AuthorityHolder authorityHolder)

Returns:

Human-readable description of authrity holder instamce.

Since:

2024.12

getAccessChecker

@NotNull
AccessChecker getAccessChecker()

Returns AccessChecker instance that should be used for various security asserts.

Since:

2018.1.2