Package jetbrains.buildServer.serverSide.oauth

Class TokenStorageQuery

java.lang.Object

jetbrains.buildServer.serverSide.oauth.TokenStorageQuery

Direct Known Subclasses:

TokenStorageUserQuery

public class TokenStorageQuery
extends Object

Represents a query for retrieving tokens from the OAuth token storage.

Since:

2024.07

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TokenStorageQuery.Builder<B extends TokenStorageQuery.Builder<B>>	A builder class for creating instances of TokenStorageQuery.
static class	TokenStorageQuery.ProjectScopeMatchMode	Determines how the token's project scope will be matched against the storage query.
static class	TokenStorageQuery.UserMatchMode	Determines how the token user will be matched against the storage query.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TokenStorageQuery(TokenStorageQuery.Builder<B> builder)

Method Summary

Modifier and Type	Method	Description
static <B extends TokenStorageQuery.Builder<B>> TokenStorageQuery.Builder<B>	builder(SProject project)	Creates a new builder instance to facilite creation of a TokenStorageQuery.
boolean	equals(Object o)
Set<String>	getAccessibleEntities()
String	getConnectionId()
Predicate<OAuthToken>	getCustomFilter()
SProject	getProject()
Set<SProject>	getProjectScope()
Set<String>	getProjectScopeExtracted()
TokenStorageQuery.ProjectScopeMatchMode	getProjectScopeMatchMode()
TokenIntent	getTokenIntent()
String	getTokenName()	The name to filter tokens by.
Long	getUserId()
TokenStorageQuery.UserMatchMode	getUserMatchMode()
int	hashCode()
boolean	isRefreshIfNecessary()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TokenStorageQuery

protected TokenStorageQuery(@NotNull
                            TokenStorageQuery.Builder<B> builder)

Method Detail

getProject

@NotNull
public SProject getProject()

Returns:

the project determines the context of the connection

getConnectionId

@Nullable
public String getConnectionId()

Returns:

the connection that was used to issue the queried token

getUserId

@Nullable
public Long getUserId()

Returns:

TeamCity user ID to whom the queried tokens are issued

isRefreshIfNecessary

public boolean isRefreshIfNecessary()

Returns:

true, if refreshing of expired tokens was requested

getTokenIntent

@NotNull
public TokenIntent getTokenIntent()

Returns:

the intended token usage, to correlate against OAuth scopes

getAccessibleEntities

@Nullable
public Set<String> getAccessibleEntities()

Returns:

the accessible entities the tokens should match against, if not null

getProjectScope

@Nullable
public Set<SProject> getProjectScope()

Returns:

the project scope of the queried tokens, if not null

getProjectScopeExtracted

@Nullable
public Set<String> getProjectScopeExtracted()

Returns:

a representation of myProjectScope already transformed into the internal context-key format used in token storage

getProjectScopeMatchMode

@NotNull
public TokenStorageQuery.ProjectScopeMatchMode getProjectScopeMatchMode()

Returns:

how the token's project scope will be matched against the storage query.

getTokenName

@Nullable
public String getTokenName()

The name to filter tokens by.

Returns:

(partial) token name, or null if no filtering is desired.

Since:

2024.07

See Also:

myTokenName

getUserMatchMode

@NotNull
public TokenStorageQuery.UserMatchMode getUserMatchMode()

Returns:

how the token's user ID will be matched against the storage query.

getCustomFilter

@NotNull
public Predicate<OAuthToken> getCustomFilter()

Returns:

the custom filter to apply to tokens.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static <B extends TokenStorageQuery.Builder<B>> TokenStorageQuery.Builder<B> builder(@NotNull
                                                                                            SProject project)

Creates a new builder instance to facilite creation of a TokenStorageQuery.

Parameters:

project - The project associated with the query.

Returns:

A new builder

Since:

2024.07