Package jetbrains.buildServer.serverSide.auth

Class ServerPrincipal

java.lang.Object

jetbrains.buildServer.serverSide.auth.ServerPrincipal

All Implemented Interfaces:

Principal

Direct Known Subclasses:

BuildPrincipal, GuestPrincipal, PresignedTokenPrincipal, SuperUserPrincipal

public class ServerPrincipal
extends Object
implements Principal

Represents authenticated user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServerPrincipal.AuthenticationResult

Constructor Summary

Constructors

Constructor	Description
ServerPrincipal(String realm, String name)
ServerPrincipal(String realm, String name, PermissionsHolder permissionsHolder)
ServerPrincipal(String realm, String name, AuthPropertyKey usernamePropertyKey, boolean creatingNewUserAllowed, Map<PropertyKey,String> newUserProperties)
ServerPrincipal(String realm, String name, AuthPropertyKey usernamePropertyKey, boolean creatingNewUserAllowed, Map<PropertyKey,String> newUserProperties, PermissionsHolder permissionsHolder)

Method Summary

Modifier and Type	Method	Description
String	getName()
Map<PropertyKey,String>	getNewUserProperties()
PermissionsHolder	getPermissionsRestrictor()
String	getRealm()
AuthPropertyKey	getUsernamePropertyKey()
boolean	isCreatingNewUserAllowed()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Constructor Detail

ServerPrincipal

public ServerPrincipal(@Nullable
                       String realm,
                       @NotNull
                       String name)

Parameters:

realm - - obsolete, should generally be null

name - TeamCity's username

ServerPrincipal

public ServerPrincipal(@Nullable
                       String realm,
                       @NotNull
                       String name,
                       @Nullable
                       PermissionsHolder permissionsHolder)

ServerPrincipal

public ServerPrincipal(@Nullable
                       String realm,
                       @NotNull
                       String name,
                       @Nullable
                       AuthPropertyKey usernamePropertyKey,
                       boolean creatingNewUserAllowed,
                       @NotNull
                       Map<PropertyKey,String> newUserProperties)

Parameters:

realm - - obsolete, should generally be null

name - either TeamCity's username (if usernamePropertyKey is null) or custom username that is held in user usernamePropertyKey property

usernamePropertyKey - the name of the user property to look for the custom username specified in the name parameter

creatingNewUserAllowed - true to allow creating the user if he/she does not exist yet, false otherwise

newUserProperties - Adds user properties to the user in case he/she is created during login. Has no effect for already existing users. Also has no effect if creatingNewUserAllowed is set to false.

Since:

8.0

ServerPrincipal

public ServerPrincipal(@Nullable
                       String realm,
                       @NotNull
                       String name,
                       @Nullable
                       AuthPropertyKey usernamePropertyKey,
                       boolean creatingNewUserAllowed,
                       @NotNull
                       Map<PropertyKey,String> newUserProperties,
                       @Nullable
                       PermissionsHolder permissionsHolder)

Parameters:

realm - - obsolete, should generally be null

name - either TeamCity's username (if usernamePropertyKey is null) or custom username that is held in user usernamePropertyKey property

usernamePropertyKey - the name of the user property to look for the custom username specified in the name parameter

creatingNewUserAllowed - true to allow creating the user if he/she does not exist yet, false otherwise

newUserProperties - Adds user properties to the user in case he/she is created during login. Has no effect for already existing users. Also has no effect if creatingNewUserAllowed is set to false.

permissionsRestrictor - Won't have any effect if null. If not null the the user created from this Principal will be restricted: remember me won't be used; permissions of the user will be restricted with this instance;

Since:

2020.1.1

Method Detail

getName

@NotNull
public String getName()

Specified by:

getName in interface Principal

getPermissionsRestrictor

@Nullable
public PermissionsHolder getPermissionsRestrictor()

getRealm

@Nullable
public String getRealm()

getUsernamePropertyKey

@Nullable
public AuthPropertyKey getUsernamePropertyKey()

Returns:

user property key to look for the specified username in

Since:

8.0

See Also:

UserModel.findUserByUsername(String, jetbrains.buildServer.users.AuthPropertyKey)

isCreatingNewUserAllowed

public boolean isCreatingNewUserAllowed()

Returns:

true, iff TeamCity is allowed to create the specified user in case he/she does not exist yet.

Since:

8.0

See Also:

getNewUserProperties()

getNewUserProperties

@NotNull
public Map<PropertyKey,String> getNewUserProperties()

Returns:

user properties to add to user in case he/she was created during login

Since:

8.0

See Also:

isCreatingNewUserAllowed()