Package com.apicatalog.jsonld.loader

Class HttpLoader

java.lang.Object

com.apicatalog.jsonld.loader.HttpLoader

All Implemented Interfaces:

DocumentLoader

public class HttpLoader
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_REDIRECTIONS

Constructor Summary

Constructors

Constructor	Description
HttpLoader(HttpClient httpClient)
HttpLoader(HttpClient httpClient, int maxRedirections)
HttpLoader(HttpClient httpClient)	Deprecated. use HttpLoader(com.apicatalog.jsonld.http.HttpClient httpClient)
HttpLoader(HttpClient httpClient, int maxRedirections)	Deprecated. use HttpLoader(com.apicatalog.jsonld.http.HttpClient httpClient, int maxRedirection)

Method Summary

Modifier and Type	Method	Description
static com.apicatalog.jsonld.loader.DefaultHttpLoader	defaultInstance()
com.apicatalog.jsonld.loader.DefaultHttpLoader	fallbackContentType(MediaType fallbackContentType)	Set fallback content-type used when received content-type is not supported.
static String	getAcceptHeader()
static String	getAcceptHeader(Collection<String> profiles)
Document	loadDocument(URI uri, DocumentLoaderOptions options)	Retrieve a remote document.
void	setFallbackContentType(MediaType fallbackContentType)	Deprecated. use DefaultHttpLoader#fallbackContentType(MediaType) Set fallback content-type used when received content-type is not supported.
com.apicatalog.jsonld.loader.DefaultHttpLoader	timeount(Duration timeount)	Set read timeout

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REDIRECTIONS

public static final int MAX_REDIRECTIONS

See Also:

Constant Field Values

Constructor Detail

HttpLoader

@Deprecated(since="1.0.3")
public HttpLoader(HttpClient httpClient)

Deprecated.

use HttpLoader(com.apicatalog.jsonld.http.HttpClient httpClient)

Parameters:

httpClient -

HttpLoader

@Deprecated(since="1.0.3")
public HttpLoader(HttpClient httpClient,
                  int maxRedirections)

Deprecated.

use HttpLoader(com.apicatalog.jsonld.http.HttpClient httpClient, int maxRedirection)

Parameters:

httpClient -

maxRedirections -

HttpLoader

public HttpLoader(HttpClient httpClient)

HttpLoader

public HttpLoader(HttpClient httpClient,
                  int maxRedirections)

Method Detail

defaultInstance

public static final com.apicatalog.jsonld.loader.DefaultHttpLoader defaultInstance()

loadDocument

public Document loadDocument(URI uri,
                             DocumentLoaderOptions options)
                      throws JsonLdError

Description copied from interface: DocumentLoader

Retrieve a remote document.

Specified by:

loadDocument in interface DocumentLoader

Parameters:

uri - of the remote document to fetch

options - to set the behavior of the loader

Returns:

Document representing a remote document

Throws:

JsonLdError

getAcceptHeader

public static final String getAcceptHeader()

getAcceptHeader

public static final String getAcceptHeader(Collection<String> profiles)

setFallbackContentType

@Deprecated
public void setFallbackContentType(MediaType fallbackContentType)

Deprecated.

use DefaultHttpLoader#fallbackContentType(MediaType) Set fallback content-type used when received content-type is not supported. e.g. setFallbackContentType(MediaType.JSON_LD)

Parameters:

fallbackContentType - a content type that overrides unsupported received content-type

fallbackContentType

public com.apicatalog.jsonld.loader.DefaultHttpLoader fallbackContentType(MediaType fallbackContentType)

Set fallback content-type used when received content-type is not supported. e.g. setFallbackContentType(MediaType.JSON_LD)

Parameters:

fallbackContentType - a content type that overrides unsupported received content-type

Returns:

DefaultHttpLoader instance

Since:

1.4.0

timeount

public com.apicatalog.jsonld.loader.DefaultHttpLoader timeount(Duration timeount)

Set read timeout

Parameters:

timeount - to set or null for no timeout

Returns:

DefaultHttpLoader instance

Since:

1.4.0