org.tinymediamanager.scraper.http

Class Url

java.lang.Object

org.tinymediamanager.scraper.http.Url

Direct Known Subclasses:

CachedUrl, StreamingUrl

public class Url
extends Object

The Class Url. Used to make simple, blocking URL requests. The request is temporarily streamed into a ByteArrayInputStream, before the InputStream is passed to the caller.

Author:

Manuel Laggner / Myron Boyle

Field Summary

Fields

Modifier and Type	Field and Description
protected okhttp3.Call	call
protected static okhttp3.OkHttpClient	client
protected List<Pair<String,String>>	headersRequest
protected okhttp3.Headers	headersResponse
protected okhttp3.Request	request
protected okhttp3.Response	response
protected Charset	responseCharset
protected int	responseCode
protected long	responseContentLength
protected String	responseContentType
protected String	responseMessage
protected URI	uri
protected String	url
protected static String	USER_AGENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Url() A constructor for inherited classes which needs a special setup
	Url(String url) Instantiates a new url / httpclient with default user-agent.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(Pair<String,String> header) Adds the header.
void	addHeader(String key, String value) Adds the header.
void	addHeaders(List<Pair<String,String>> headers) Adds the headers.
protected void	cleanup() Cleanup the connection
boolean	download(File file) Download an Url to a file via NIO FileChannel (synchron)
boolean	download(Path file) Download an Url to a file via NIO FileChannel (synchron)
byte[]	getBytes() Gets the bytes.
Charset	getCharset() Gets the charset.
String	getContentEncoding() Gets the content encoding.
long	getContentLength() the number of bytes of the content, or a negative number if unknown.
String	getHeader(String header) gets the specified header value from this connection You need to call this AFTER getInputstream().
okhttp3.Headers	getHeadersResponse() get all response headers
InputStream	getInputStream() Gets the input stream.
int	getStatusCode() http status code
String	getStatusLine() http status string
URL	getUrl() Gets the url.
boolean	isFault() is the HTTP status code a 4xx/5xx?
protected URI	morphStringToUri(String urlToMorph) morph the url (string) to an URI to check the syntax and escape the path
void	setUserAgent(String userAgent) set a specified User-Agent
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

client

protected static okhttp3.OkHttpClient client

USER_AGENT

protected static final String USER_AGENT

See Also:

Constant Field Values

responseCode

protected int responseCode

responseMessage

protected String responseMessage

responseCharset

protected Charset responseCharset

responseContentType

protected String responseContentType

responseContentLength

protected long responseContentLength

url

protected String url

headersResponse

protected okhttp3.Headers headersResponse

headersRequest

protected List<Pair<String,String>> headersRequest

uri

protected URI uri

call

protected okhttp3.Call call

request

protected okhttp3.Request request

response

protected okhttp3.Response response

Constructor Detail

Url

public Url(String url)
    throws MalformedURLException

Instantiates a new url / httpclient with default user-agent.

Parameters:

url - the url

Throws:

MalformedURLException

Url

protected Url()

A constructor for inherited classes which needs a special setup

Method Detail

getHeader

public String getHeader(String header)

gets the specified header value from this connection
You need to call this AFTER getInputstream().

Parameters:

header - the header you want to know (like Content-Length)

Returns:

the header value

getHeadersResponse

public okhttp3.Headers getHeadersResponse()

get all response headers

Returns:

the response headers

morphStringToUri

protected URI morphStringToUri(String urlToMorph)
                        throws MalformedURLException,
                               URISyntaxException

morph the url (string) to an URI to check the syntax and escape the path

Parameters:

urlToMorph - the url to morph

Returns:

the morphed URI

Throws:

MalformedURLException

URISyntaxException

setUserAgent

public void setUserAgent(String userAgent)

set a specified User-Agent

Parameters:

userAgent - the user agent to be set

getUrl

public URL getUrl()
           throws IOException,
                  InterruptedException

Gets the url.

Returns:

the url

Throws:

IOException - Signals that an I/O exception has occurred.

InterruptedException

addHeader

public void addHeader(String key,
             String value)

Adds the header.

Parameters:

key - the key

value - the value

addHeader

public void addHeader(Pair<String,String> header)

Adds the header.

Parameters:

header - the header

addHeaders

public void addHeaders(List<Pair<String,String>> headers)

Adds the headers.

Parameters:

headers - the headers

getInputStream

public InputStream getInputStream()
                           throws IOException,
                                  InterruptedException

Gets the input stream.

Returns:

the input stream

Throws:

IOException - Signals that an I/O exception has occurred.

InterruptedException

cleanup

protected void cleanup()

Cleanup the connection

isFault

public boolean isFault()

is the HTTP status code a 4xx/5xx?

Returns:

true/false

getStatusCode

public int getStatusCode()

http status code

getStatusLine

public String getStatusLine()

http status string

getBytes

public byte[] getBytes()
                throws IOException,
                       InterruptedException

Gets the bytes.

Returns:

the bytes

Throws:

IOException - Signals that an I/O exception has occurred.

InterruptedException

download

public boolean download(File file)

Download an Url to a file via NIO FileChannel (synchron)

Parameters:

file -

Returns:

successful or not

download

public boolean download(Path file)

Download an Url to a file via NIO FileChannel (synchron)

Parameters:

file -

Returns:

successful or not

getCharset

public Charset getCharset()

Gets the charset.

Returns:

the charset

getContentEncoding

public String getContentEncoding()

Gets the content encoding.

Returns:

the content encoding

getContentLength

public long getContentLength()

the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

Returns:

the content length

toString

public String toString()

Overrides:

toString in class Object