Package jetbrains.buildServer.serverSide.oauth.space

Class SpaceOAuthProvider

java.lang.Object

jetbrains.buildServer.serverSide.oauth.OAuthProvider

jetbrains.buildServer.serverSide.oauth.space.SpaceOAuthProvider

All Implemented Interfaces:

ConnectionProvider, ServerExtension, TeamCityExtension

public class SpaceOAuthProvider
extends OAuthProvider

Nested Class Summary

Nested classes/interfaces inherited from class jetbrains.buildServer.serverSide.oauth.OAuthProvider

OAuthProvider.CapabilityResolver

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE
static String	URL_TYPE

Fields inherited from class jetbrains.buildServer.serverSide.oauth.OAuthProvider

COMPOUND_STORAGE_ID_PREFIX, myCapabilityResolvers, NOPE

Constructor Summary

Constructors

Constructor	Description
SpaceOAuthProvider(WebLinks webLinks, SpaceClientFactory clientFactory, ApplicationInformationCapabilityResolver appInfoCapabilityResolver)

Method Summary

Modifier and Type	Method	Description
boolean	connectionIsHidden(OAuthConnectionDescriptor connection)
String	describeConnection(OAuthConnectionDescriptor connection)
String	describeConnectionForUI(OAuthConnectionDescriptor connection)	Will be combined with getAdditionalUIConnectionDescription return value
String	getAdditionalUIConnectionDescription(OAuthConnectionDescriptor connection)	Will not be escaped, and so should not include any unvalidated user input
String	getCapabilitiesUrl()	Get the URL to rendering the dynamic description of a connection's capabilities.
Map<String,String>	getDefaultProperties()
String	getDisplayName()
String	getEditParametersUrl()
String	getFallbackRedirectPath()	Returns the path to be included in redirect URLs.
PropertiesProcessor	getPropertiesProcessor()
String	getProviderTypeForUniqueRedirect()	Returns the provider type to be included in unique redirect URLs.
String	getScopeForIntent(OAuthConnectionDescriptor connection, TokenIntent intent)	Returns the provider-specific OAuth scope to request for the given token intent.
Set<TokenIntentType>	getSupportedTokenIntentTypes()	Gets the token intent types this provider fully supports.
String	getTokenPopupPath()
String	getTokenStorageId(OAuthConnectionDescriptor connection)	Returns an id of the token storage used by connection.
Set<String>	getTokenStorageParameters()	Returns the parameters used when constructing the token storage ID for connections of this provider type.
Map<String,String>	getTokenUsageParamsForVcsRoot(OAuthConnectionDescriptor connection, OAuthToken token)	Returns the necessary parameters for usage of the provided token for authentication in a SVcsRoot.
String	getType()
String	getTypeForUrl()
boolean	isAcquiringTokenSupported()	Whether acquiring tokens is supported for this provider.
boolean	isCapabilitiesEnabledForProject(SProject project)	Whether capabilities (if supported) are enabled in the scope of the given project.
boolean	isCapabilitiesSupported()	Whether this provider supports resolving of ConnectionCapability for individual connections.
boolean	isSuitableToken(OAuthToken token, TokenIntent intent)
boolean	isTokenRefreshSupported()
boolean	isUniqueRedirectsSupported()	Whether this provider supports the creation of unique redirect URLs.
protected String	redirectUri(OAuthConnectionDescriptor connectionDescriptor)
OAuthToken	refreshToken(OAuthConnectionDescriptor connection, OAuthToken token)

Methods inherited from class jetbrains.buildServer.serverSide.oauth.OAuthProvider

applyAccessibleEntities, buildCompoundTokenStorageId, connectionHasCapability, getAccessibleEntitiesEndpoint, getCapabilityResolver, getScope, isAccessibleEntitiesSupported, isAcquiringTokenSupportedForConnection, isAvailable, registerCapabilityResolver, testConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.connections.ConnectionProvider

describeConnection, getDisplayOrderRank

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

URL_TYPE

public static final String URL_TYPE

See Also:

Constant Field Values

Constructor Detail

SpaceOAuthProvider

public SpaceOAuthProvider(@NotNull
                          WebLinks webLinks,
                          @NotNull
                          SpaceClientFactory clientFactory,
                          @NotNull
                          ApplicationInformationCapabilityResolver appInfoCapabilityResolver)

Method Detail

getType

@NotNull
public String getType()

Returns:

String used to identify the Connection Provider type. All Connection features store this property in parameters.

getTypeForUrl

public String getTypeForUrl()

getDisplayName

@NotNull
public String getDisplayName()

Returns:

human friendly provider name

describeConnection

@NotNull
public String describeConnection(@NotNull
                                 OAuthConnectionDescriptor connection)

Overrides:

describeConnection in class OAuthProvider

Returns:

human friendly description of OAuth connection

describeConnectionForUI

@NotNull
public String describeConnectionForUI(@NotNull
                                      OAuthConnectionDescriptor connection)

Description copied from class: OAuthProvider

Will be combined with getAdditionalUIConnectionDescription return value

Overrides:

describeConnectionForUI in class OAuthProvider

Returns:

Description of OAuth connection for ui

getAdditionalUIConnectionDescription

@NotNull
public String getAdditionalUIConnectionDescription(@NotNull
                                                   OAuthConnectionDescriptor connection)

Description copied from class: OAuthProvider

Will not be escaped, and so should not include any unvalidated user input

Overrides:

getAdditionalUIConnectionDescription in class OAuthProvider

Returns:

Additional description for ui

getTokenStorageId

@NotNull
public String getTokenStorageId(@NotNull
                                OAuthConnectionDescriptor connection)

Description copied from class: OAuthProvider

Returns an id of the token storage used by connection. Depending on the connection type multiple connections can use the same token storage. In case of OAuth2 apps, this id may be based on the client/application id of the OAuth2 app configured in a third party system.

Overrides:

getTokenStorageId in class OAuthProvider

Parameters:

connection - descriptor

Returns:

token storage id

getPropertiesProcessor

@Nullable
public PropertiesProcessor getPropertiesProcessor()

Specified by:

getPropertiesProcessor in interface ConnectionProvider

Overrides:

getPropertiesProcessor in class OAuthProvider

Returns:

processor for connection provider parameters. Properties processor performs validation function and is called when connection is edited or created.

getEditParametersUrl

@Nullable
public String getEditParametersUrl()

Specified by:

getEditParametersUrl in interface ConnectionProvider

Overrides:

getEditParametersUrl in class OAuthProvider

Returns:

URL to edit connection parameters page

getDefaultProperties

@Nullable
public Map<String,String> getDefaultProperties()

Specified by:

getDefaultProperties in interface ConnectionProvider

Overrides:

getDefaultProperties in class OAuthProvider

Returns:

all default parameters related to this ConnectionProvider. Defaults for all possible parameter names.

isTokenRefreshSupported

public boolean isTokenRefreshSupported()

Overrides:

isTokenRefreshSupported in class OAuthProvider

refreshToken

@NotNull
public OAuthToken refreshToken(@NotNull
                               OAuthConnectionDescriptor connection,
                               @NotNull
                               OAuthToken token)

Overrides:

refreshToken in class OAuthProvider

redirectUri

@NotNull
protected String redirectUri(@NotNull
                             OAuthConnectionDescriptor connectionDescriptor)

isSuitableToken

public boolean isSuitableToken(@NotNull
                               OAuthToken token,
                               @NotNull
                               TokenIntent intent)

Overrides:

isSuitableToken in class OAuthProvider

getScopeForIntent

@Nullable
public String getScopeForIntent(@NotNull
                                OAuthConnectionDescriptor connection,
                                @NotNull
                                TokenIntent intent)

Description copied from class: OAuthProvider

Returns the provider-specific OAuth scope to request for the given token intent.

Overrides:

getScopeForIntent in class OAuthProvider

Parameters:

connection - the connection to be used for issuing the token

intent - the intended token usage

Returns:

specific OAuth scope, if any

isAcquiringTokenSupported

public boolean isAcquiringTokenSupported()

Description copied from class: OAuthProvider

Whether acquiring tokens is supported for this provider. See also: JSP Tag oauth:obtainToken

Overrides:

isAcquiringTokenSupported in class OAuthProvider

Returns:

true, if supported

getTokenPopupPath

public String getTokenPopupPath()

Overrides:

getTokenPopupPath in class OAuthProvider

isCapabilitiesSupported

public boolean isCapabilitiesSupported()

Description copied from class: OAuthProvider

Whether this provider supports resolving of ConnectionCapability for individual connections.

Overrides:

isCapabilitiesSupported in class OAuthProvider

Returns:

true if supported

isCapabilitiesEnabledForProject

public boolean isCapabilitiesEnabledForProject(@NotNull
                                               SProject project)

Description copied from class: OAuthProvider

Whether capabilities (if supported) are enabled in the scope of the given project.

Overrides:

isCapabilitiesEnabledForProject in class OAuthProvider

Parameters:

project - project scope

Returns:

true if enabled

getCapabilitiesUrl

@Nullable
public String getCapabilitiesUrl()

Description copied from class: OAuthProvider

Get the URL to rendering the dynamic description of a connection's capabilities. Can only be used if capabilities are supported by this provider.

Overrides:

getCapabilitiesUrl in class OAuthProvider

Returns:

relative URL or null if not supported

connectionIsHidden

public boolean connectionIsHidden(@NotNull
                                  OAuthConnectionDescriptor connection)

Overrides:

connectionIsHidden in class OAuthProvider

isUniqueRedirectsSupported

public boolean isUniqueRedirectsSupported()

Description copied from class: OAuthProvider

Whether this provider supports the creation of unique redirect URLs. Providers wanting to support this feature should return true here and ensure that the respective access token controllers are registered via BaseAccessTokenController.registerController(WebControllerManager, String). Also, the two related methods OAuthProvider.getProviderTypeForUniqueRedirect() and OAuthProvider.getFallbackRedirectPath() must be implemented.

Overrides:

isUniqueRedirectsSupported in class OAuthProvider

Returns:

false, by default

getProviderTypeForUniqueRedirect

@NotNull
public String getProviderTypeForUniqueRedirect()

Description copied from class: OAuthProvider

Returns the provider type to be included in unique redirect URLs.

Overrides:

getProviderTypeForUniqueRedirect in class OAuthProvider

Returns:

URL-compatible provider type

See Also:

OAuthProvider.isUniqueRedirectsSupported()

getFallbackRedirectPath

@Nullable
public String getFallbackRedirectPath()

Description copied from class: OAuthProvider

Returns the path to be included in redirect URLs. Normally this should be the access token controller path. This will be used as a fallback if this provider does not support unique redirect URLs. This will be used as a fallback if a connection does not have a redirect ID parameter.

Overrides:

getFallbackRedirectPath in class OAuthProvider

Returns:

a controller path starting with a slash

See Also:

OAuthProvider.isUniqueRedirectsSupported()

getSupportedTokenIntentTypes

@NotNull
public Set<TokenIntentType> getSupportedTokenIntentTypes()

Description copied from class: OAuthProvider

Gets the token intent types this provider fully supports. Full support means that the methods OAuthProvider.getScopeForIntent(OAuthConnectionDescriptor, TokenIntent) and OAuthProvider.isSuitableToken(OAuthToken, TokenIntent) are implemented with sufficient logic to cater for the claimed token intent types.

Overrides:

getSupportedTokenIntentTypes in class OAuthProvider

Returns:

set of supported token intent types

getTokenUsageParamsForVcsRoot

@NotNull
public Map<String,String> getTokenUsageParamsForVcsRoot(@NotNull
                                                              OAuthConnectionDescriptor connection,
                                                              @NotNull
                                                              OAuthToken token)

Description copied from class: OAuthProvider

Returns the necessary parameters for usage of the provided token for authentication in a SVcsRoot. By default, this provides the following values:

oauthUsername

OauthToken#getOauthLogin

tokenType

refreshable (if refreshable tokens are enabled)

Overrides:

getTokenUsageParamsForVcsRoot in class OAuthProvider

Parameters:

connection - the token's connection

token - the token to be potentially used on a VCS root

Returns:

mutable map of parameters

getTokenStorageParameters

@NotNull
public Set<String> getTokenStorageParameters()

Description copied from class: OAuthProvider

Returns the parameters used when constructing the token storage ID for connections of this provider type. Implementors must make sure this corresponds with the implementation of OAuthProvider.getTokenStorageId(OAuthConnectionDescriptor).

Overrides:

getTokenStorageParameters in class OAuthProvider

Returns:

set of parameter names

See Also:

OAuthProvider.getTokenStorageId(OAuthConnectionDescriptor)