Package jetbrains.buildServer.serverSide.connections.credentials

Interface ConnectionCredentialsFactory

All Superinterfaces:

ServerExtension, TeamCityExtension

public interface ConnectionCredentialsFactory
extends ServerExtension

A factory for producing credentials from a ConnectionDescriptor. Knows about all supported ways of obtaining specific credentials of the ConnectionProvider type.

Since:

2023.05

Method Summary

Modifier and Type	Method	Description
String	getType()
ConnectionCredentials	requestCredentials(ConnectionDescriptor connectionDescriptor)	Deprecated. pls use instead
default ConnectionCredentials	requestCredentials(SProject project, ConnectionDescriptor connectionDescriptor)	Creates ConnectionCredentials using connection properties.

Method Detail

requestCredentials

@NotNull
@Deprecated
ConnectionCredentials requestCredentials(@NotNull
                                         ConnectionDescriptor connectionDescriptor)
                                  throws ConnectionCredentialsException

Deprecated.

pls use instead

Creates ConnectionCredentials using connection properties. The credentials type will be extracted from parameters.

Parameters:

connectionDescriptor - Connection feature descriptor with properties.

Returns:

Specific ConnectionCredentials object with specific credentials type.

Throws:

ConnectionCredentialsException

requestCredentials

@NotNull
default ConnectionCredentials requestCredentials(@NotNull
                                                 SProject project,
                                                 @NotNull
                                                 ConnectionDescriptor connectionDescriptor)
                                          throws ConnectionCredentialsException

Creates ConnectionCredentials using connection properties. The credentials type will be extracted from parameters.

Parameters:

project - project that originally requested the credentials.

connectionDescriptor - Connection feature descriptor with properties.

Returns:

Specific ConnectionCredentials object with specific credentials type.

Throws:

ConnectionCredentialsException

Since:

2023.11

getType

@NotNull
String getType()

Returns:

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