ConnectionProvider (javadoc 2024.12-174331 API)

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

AzureDevOpsOAuthProvider, BitBucketOAuthProvider, GHEOAuthProvider, GitHubOAuthProvider, GitHubOAuthProviderBase, GitLabCEorEEOAuthProvider, GitLabComOAuthProvider, GoogleOAuthProvider, OAuthProvider, SpaceOAuthProvider, TfsAuthProvider, UnknownConnectionProvider
```
public interface ConnectionProvider
extends ServerExtension
```
Successor of the OAuthProvider, created for the same purpose as BuildFeature and RunType but for new Connection-type features.

Since:

2023.05

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`describeConnection(Map<String,String> connectionProperties)`
`Map<String,String>`	`getDefaultProperties()`
`String`	`getDisplayName()`
`default int`	`getDisplayOrderRank()`	Used as first rank when sorting providers for display purposes.
`String`	`getEditParametersUrl()`
`default PropertiesProcessor`	`getPropertiesProcessor()`
`String`	`getType()`
`default String`	`getTypeForUrl()`
`boolean`	`isAvailable()`

- Method Detail
  - getType
```
@NotNull
String getType()
```
    Returns:
    
    String used to identify the Connection Provider type. All Connection features store this property in parameters.
  - getPropertiesProcessor
```
@Nullable
default PropertiesProcessor getPropertiesProcessor()
```
    Returns:
    
    processor for connection provider parameters. Properties processor performs validation function and is called when connection is edited or created.
  - getDefaultProperties
```
@Nullable
Map<String,String> getDefaultProperties()
```
    Returns:
    
    all default parameters related to this ConnectionProvider. Defaults for all possible parameter names.
  - getDisplayName
```
@NotNull
String getDisplayName()
```
    Returns:
    
    human friendly provider name
  - getDisplayOrderRank
```
default int getDisplayOrderRank()
```
    Used as first rank when sorting providers for display purposes. It is a way to (de-)prioritize specific providers.
    
    Returns:
    
    0 by default
  - describeConnection
```
@NotNull
default String describeConnection(@NotNull
                                  Map<String,String> connectionProperties)
```
    Returns:
    
    specific information about the connection
  - getEditParametersUrl
```
@Nullable
String getEditParametersUrl()
```
    Returns:
    
    URL to edit connection parameters page
  - isAvailable
```
boolean isAvailable()
```
  - getTypeForUrl
```
default String getTypeForUrl()
```