com.gooddata.http.client.SSTRetrievalStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gooddata-http-client Show documentation

HTTP client with ability to handle GoodData authentication

There is a newer version: 1.0.0+java7.fix1

/*
 * Copyright (C) 2007-2015, GoodData(R) Corporation. All rights reserved.
 * This program is made available under the terms of the BSD License.
 */
package com.gooddata.http.client;

import org.apache.http.HttpHost;
import org.apache.http.client.HttpClient;

import java.io.IOException;

/**
 * Interface for class which encapsulates SST retrieval.
 */
public interface SSTRetrievalStrategy {

    /**
     * Obtains SST using given HTTP client and host.
     * @return SST
     * @param httpClient HTTP client
     * @param httpHost HTTP host
     */
    String obtainSst(final HttpClient httpClient, final HttpHost httpHost) throws IOException;

    /**
     * Performs the logout using given HTTP client, host and logout parameters.
     * Should throw {@link GoodDataLogoutException} in case of logout problem.
     *
     * @param httpClient HTTP client
     * @param httpHost HTTP host
     * @param url url for logout
     * @param sst SST
     * @param tt TT
     * @throws IOException in case of connection error
     * @throws GoodDataLogoutException when the logout is not possible or failed
     */
    void logout(final HttpClient httpClient, final HttpHost httpHost, final String url, final String sst, final String tt)
            throws IOException, GoodDataLogoutException;
}