Package jetbrains.buildServer.issueTracker

Class IssueFetcherUtil

java.lang.Object

jetbrains.buildServer.issueTracker.IssueFetcherUtil

public class IssueFetcherUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IssueFetcherUtil.HttpErrorHandler	Deprecated. since 2018.1.

Field Summary

Fields

Modifier and Type	Field	Description
static HTTPRequestBuilder.ResponseConsumer	DEFAULT_GENERAL_HTTP_ERROR_HANDLER
static IssueFetcherUtil.HttpErrorHandler	DEFAULT_HTTP_ERROR_HANDLER	Deprecated. since 2018.1.

Constructor Summary

Constructors

Constructor	Description
IssueFetcherUtil()

Method Summary

Modifier and Type	Method	Description
static java.io.InputStream	getHttpFile(java.lang.String url, SimpleCredentials credentials, boolean usePreemptiveAuthentication, java.security.KeyStore trustStore, HTTPRequestBuilder.ResponseConsumer errorsConsumer)	Fetches the document from HTTP resource specified by url with the specified credentials.
static java.io.InputStream	getHttpFile(java.lang.String url, IssueFetcherAuthenticator authenticator, java.security.KeyStore trustStore, HTTPRequestBuilder.ResponseConsumer errorsConsumer)
static java.io.InputStream	getHttpFile(java.lang.String url, IssueFetcherAuthenticator authenticator, IssueFetcherUtil.HttpErrorHandler httpErrorHandler)	Deprecated. since 2018.1.
static SimpleCredentials	retrieveCredentials(IssueFetcherAuthenticator authenticator)	Convert deprecated IssueFetcherAuthenticator object to SimpleCredentials.
static SimpleCredentials	retrieveCredentials(org.apache.commons.httpclient.Credentials credentials)	Convert Apache Credentials object to SimpleCredentials.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_ERROR_HANDLER

@NotNull
@Deprecated
public static final IssueFetcherUtil.HttpErrorHandler DEFAULT_HTTP_ERROR_HANDLER

Deprecated.

since 2018.1. Use DEFAULT_GENERAL_HTTP_ERROR_HANDLER

DEFAULT_GENERAL_HTTP_ERROR_HANDLER

@NotNull
public static final HTTPRequestBuilder.ResponseConsumer DEFAULT_GENERAL_HTTP_ERROR_HANDLER

Constructor Detail

IssueFetcherUtil

public IssueFetcherUtil()

Method Detail

getHttpFile

@NotNull
@Deprecated
public static java.io.InputStream getHttpFile(@NotNull
                                              java.lang.String url,
                                              @NotNull
                                              IssueFetcherAuthenticator authenticator,
                                              @NotNull
                                              IssueFetcherUtil.HttpErrorHandler httpErrorHandler)
                                       throws java.io.IOException

Deprecated.

since 2018.1. Use getHttpFile(String, IssueFetcherAuthenticator, KeyStore, HTTPRequestBuilder.ResponseConsumer) instead

Fetches the document from HTTP resource specified by url with the specified credentials.

Parameters:

url - the url of file to fetch

authenticator - authenticator

Returns:

result input stream, or null in case of HTTP error

Throws:

java.io.IOException - if I/O error occurs

getHttpFile

@NotNull
public static java.io.InputStream getHttpFile(@NotNull
                                              java.lang.String url,
                                              @Nullable
                                              SimpleCredentials credentials,
                                              boolean usePreemptiveAuthentication,
                                              @Nullable
                                              java.security.KeyStore trustStore,
                                              @NotNull
                                              HTTPRequestBuilder.ResponseConsumer errorsConsumer)
                                       throws java.io.IOException,
                                              java.net.URISyntaxException

Fetches the document from HTTP resource specified by url with the specified credentials. You have to close returned input stream. If authentication requires setting specific properties to request or uses custom logic implemented in authenticator, use getHttpFile(String, IssueFetcherAuthenticator, KeyStore, HTTPRequestBuilder.ResponseConsumer)

Parameters:

url - the url of file to fetch

credentials - the data for authentication

usePreemptiveAuthentication - is it necessary to use preemptive authentication

trustStore - store with trusted SSL certificates

errorsConsumer - the handler of HTTP errors after unsuccessful GET request

Returns:

result input stream

Throws:

java.io.IOException - if I/O error occurs

java.net.URISyntaxException - if url parameter is not a valid uri

Since:

2018.1

getHttpFile

public static java.io.InputStream getHttpFile(@NotNull
                                              java.lang.String url,
                                              @NotNull
                                              IssueFetcherAuthenticator authenticator,
                                              @Nullable
                                              java.security.KeyStore trustStore,
                                              @NotNull
                                              HTTPRequestBuilder.ResponseConsumer errorsConsumer)
                                       throws java.io.IOException,
                                              java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

retrieveCredentials

@Nullable
public static SimpleCredentials retrieveCredentials(@NotNull
                                                    IssueFetcherAuthenticator authenticator)

Convert deprecated IssueFetcherAuthenticator object to SimpleCredentials.

Parameters:

authenticator - not null object to retrieve credentials

Returns:

converted SimpleCredentials object or null

Since:

2018.1

retrieveCredentials

@Nullable
public static SimpleCredentials retrieveCredentials(@Nullable
                                                    org.apache.commons.httpclient.Credentials credentials)

Convert Apache Credentials object to SimpleCredentials.

Parameters:

credentials - nullable object to retrieve credentials

Returns:

converted SimpleCredentials object or null

Since:

2018.1