Package jetbrains.buildServer.serverSide.impl.auth

Class SecurityContextImpl

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.SecurityContextImpl

All Implemented Interfaces:

SecurityContext, SecurityContextEx

public class SecurityContextImpl
extends Object
implements SecurityContextEx

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.SecurityContextEx

SecurityContextEx.RunAsAction, SecurityContextEx.RunAsActionWithResult<T>

Field Summary

Fields

Modifier and Type	Field	Description
static AuthorityHolder	NO_PERMISSIONS

Constructor Summary

Constructors

Constructor	Description
SecurityContextImpl(ServerResponsibility serverResponsibility)

Method Summary

Modifier and Type	Method	Description
void	clearContext()	Removes current authority holder from the context
String	describeAuthorityHolder(AuthorityHolder authorityHolder)
AccessChecker	getAccessChecker()	Returns AccessChecker instance that should be used for various security asserts.
AuthorityHolder	getAuthorityHolder()	Retrieves authority holder from current context.
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 SecurityContextEx.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 SecurityContextEx.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	setAccessChecker(AccessChecker accessChecker)
void	setAuthorityHolder(AuthorityHolder authority)	Sets AuthorityHolder in the context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_PERMISSIONS

@NotNull
public static final AuthorityHolder NO_PERMISSIONS

Constructor Detail

SecurityContextImpl

public SecurityContextImpl(@NotNull
                           ServerResponsibility serverResponsibility)

Method Detail

setAccessChecker

public void setAccessChecker(@NotNull
                             AccessChecker accessChecker)

getAuthorityHolder

@NotNull
public AuthorityHolder getAuthorityHolder()

Retrieves authority holder from current context.

Specified by:

getAuthorityHolder in interface SecurityContext

Returns:

AuthorityHolder, never null

getOriginalAuthority

@NotNull
public AuthorityHolder getOriginalAuthority()

Description copied from interface: SecurityContextEx

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()

Specified by:

getOriginalAuthority in interface SecurityContextEx

setAuthorityHolder

public void setAuthorityHolder(@NotNull
                               AuthorityHolder authority)

Sets AuthorityHolder in the context

Specified by:

setAuthorityHolder in interface SecurityContextEx

Parameters:

authority -

clearContext

public void clearContext()

Removes current authority holder from the context

Specified by:

clearContext in interface SecurityContextEx

runAsSystem

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

Description copied from interface: SecurityContextEx

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

Specified by:

runAsSystem in interface SecurityContextEx

Parameters:

action - action to run

Throws:

Throwable - exception

runAsSystem

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

Specified by:

runAsSystem in interface SecurityContextEx

Throws:

Throwable

runAsSystemUnchecked

public void runAsSystemUnchecked(@NotNull
                                 SecurityContextEx.RunAsAction action)

Description copied from interface: SecurityContextEx

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

Specified by:

runAsSystemUnchecked in interface SecurityContextEx

Parameters:

action - action to run

runAsSystemUnchecked

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

Specified by:

runAsSystemUnchecked in interface SecurityContextEx

runAs

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

Specified by:

runAs in interface SecurityContextEx

Throws:

Throwable

runAsUnchecked

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

Description copied from interface: SecurityContextEx

Runs specified Runnable with {@param authority} privileges (in all permissions mode) Occured exceptions will be rethrown as RuntimeException Method can be used instead of SecurityContextEx.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.

Specified by:

runAsUnchecked in interface SecurityContextEx

Parameters:

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

action - action to run

runAsUnchecked

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

Specified by:

runAsUnchecked in interface SecurityContextEx

runAs

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

Specified by:

runAs in interface SecurityContextEx

Throws:

Throwable

isSystemAccess

public boolean isSystemAccess()

Specified by:

isSystemAccess in interface SecurityContextEx

Returns:

true if current authority holder is system

restrictByServerPermissions

@NotNull
public AuthorityHolder restrictByServerPermissions(@NotNull
                                                   AuthorityHolder authorityHolder)

Description copied from interface: SecurityContextEx

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

Specified by:

restrictByServerPermissions in interface SecurityContextEx

getGloballyAllowedPermissions

@NotNull
public Permissions getGloballyAllowedPermissions()

Specified by:

getGloballyAllowedPermissions in interface SecurityContextEx

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.

describeAuthorityHolder

@NotNull
public String describeAuthorityHolder(@NotNull
                                      AuthorityHolder authorityHolder)

Specified by:

describeAuthorityHolder in interface SecurityContextEx

Returns:

Human-readable description of authrity holder instamce.

getAccessChecker

@NotNull
public AccessChecker getAccessChecker()

Description copied from interface: SecurityContextEx

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

Specified by:

getAccessChecker in interface SecurityContextEx