Interface ProjectConnectionsManager
-
public interface ProjectConnectionsManagerSuccessor of the OAuthConnectionsManager- Since:
- 2023.05
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConnectionDescriptoraddConnection(SProject project, String providerType, Map<String,String> parameters)ConnectionDescriptorfindConnectionById(SProject project, String connectionId)Searches for connection by id starting with specified project.List<ConnectionDescriptor>getAvailableConnections(SProject project)Returns own project connections and all connections from parent projects.List<ConnectionDescriptor>getAvailableConnectionsOfType(SProject project, String providerType)Returns all connections of specified type available for current project.Collection<ConnectionProvider>getConnectionProviders()List<ConnectionDescriptor>getOwnAvailableConnections(SProject project)Returns own project connectionsvoidremoveConnection(SProject project, String connectionId)booleanupdateConnection(SProject project, String connectionId, String providerType, Map<String,String> parameters)
-
-
-
Method Detail
-
findConnectionById
@Nullable ConnectionDescriptor findConnectionById(@NotNull SProject project, @NotNull String connectionId)
Searches for connection by id starting with specified project. Search is performed in specified projects and all its parents until connection is found.- Parameters:
project- project to start withconnectionId- id of the connection- Returns:
- the first found connection or null
-
getAvailableConnectionsOfType
@NotNull List<ConnectionDescriptor> getAvailableConnectionsOfType(@NotNull SProject project, @NotNull String providerType)
Returns all connections of specified type available for current project. These include own project connections and all connections from parent projects.- Parameters:
project- current projectproviderType- type of theConnectionProvider- Returns:
- all found connections in the project hierarchy order: firstly connections from the specified project, then all connections from parent projects.
-
getAvailableConnections
@NotNull List<ConnectionDescriptor> getAvailableConnections(@NotNull SProject project)
Returns own project connections and all connections from parent projects.- Parameters:
project- current project- Returns:
- all connections in the project hierarchy order: firstly connections from the specified project, then all connections from parent projects.
-
getOwnAvailableConnections
@NotNull List<ConnectionDescriptor> getOwnAvailableConnections(@NotNull SProject project)
Returns own project connections- Parameters:
project- current project- Returns:
- all connections of a current project
-
addConnection
@NotNull ConnectionDescriptor addConnection(@NotNull SProject project, @NotNull String providerType, @NotNull Map<String,String> parameters)
-
updateConnection
boolean updateConnection(@NotNull SProject project, @NotNull String connectionId, @NotNull String providerType, @NotNull Map<String,String> parameters)
-
getConnectionProviders
@NotNull Collection<ConnectionProvider> getConnectionProviders()
- Returns:
- all available ConnectionProviders
-
-