org.openml.apiconnector.io

Class HttpCacheController

java.lang.Object

org.openml.apiconnector.io.HttpConnector

org.openml.apiconnector.io.HttpCacheController

All Implemented Interfaces:

Serializable

public class HttpCacheController
extends HttpConnector

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpCacheController()

Method Summary

Modifier and Type	Method and Description
static OpenmlApiResponse	doApiGetRequest(URL url, String cacheSuffix, String ash, int apiVerboseLevel) Performs a HTTP get call, and caches it locally, if allowed
static File	getCachedFileFromUrl(URL url, String cacheSuffix) Returns a file from the openml server and if allowed, caches it locally (otherwise returns a temp file)
static File	getCacheLocation(URL url, String cacheSuffix) Given a URL to retrieve and a cache suffix, returns the file where it will reside.

Methods inherited from class org.openml.apiconnector.io.HttpConnector

doApiDeleteRequest, doApiGetRequest, doApiPostRequest, getFileFromUrl, getTempFileFromUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpCacheController

public HttpCacheController()

Method Detail

doApiGetRequest

public static OpenmlApiResponse doApiGetRequest(URL url,
                                                String cacheSuffix,
                                                String ash,
                                                int apiVerboseLevel)
                                         throws Exception

Performs a HTTP get call, and caches it locally, if allowed

Parameters:

url - - The URL to do the request on

cacheSuffix - - where to store this file in the cache tree

apiVerboseLevel - - for verbosity

ash - - api key to authenticate

Returns:

Object - string response wrapped as object

Throws:

Exception - - Can be: server down, problem with URL, etc

getCachedFileFromUrl

public static File getCachedFileFromUrl(URL url,
                                        String cacheSuffix)
                                 throws Exception

Returns a file from the openml server and if allowed, caches it locally (otherwise returns a temp file)

Parameters:

url - - The URL to obtain

cacheSuffix - - path to save the file

Returns:

File - a pointer to the file that was saved.

Throws:

Exception - - Can be: server down, problem with URL, etc

getCacheLocation

public static File getCacheLocation(URL url,
                                    String cacheSuffix)
                             throws MalformedURLException

Given a URL to retrieve and a cache suffix, returns the file where it will reside.

Parameters:

url - - The URL to obtain

cacheSuffix - - path to save the file

Returns:

File - a pointer to the file where it will be saved

Throws:

MalformedURLException - - problem with URL