Interface ResourceDiscoveryExtension

  • All Superinterfaces:
    ServerExtension, TeamCityExtension

    public interface ResourceDiscoveryExtension
    extends ServerExtension
    Accepts url and credentials, returns object that somehow describes resource behind provided URL.
    Since:
    2018.1.1
    • Method Detail

      • discover

        @Nullable
        DiscoveredObject discover​(@NotNull
                                  java.lang.String url,
                                  @Nullable
                                  SimpleCredentials credentials,
                                  @NotNull
                                  SProject project)
                           throws ResourceDiscoveryException
        Returns object describing resource behind URL or null if this extension did not recognize resource.
        Parameters:
        url - url to resource
        credentials - credentials which can be used to authenticate on resource
        project - a project where discovery is performed
        Returns:
        object describing recognized resource
        Throws:
        ResourceDiscoveryException - if resource is recognized, but some problem occurred on attempt to retrieve information about this resource (authentication failure, connection error, etc).