Package org.faceless.publisher.type

Class URL2ConnectionBase

java.lang.Object

org.faceless.publisher.type.URL2ConnectionBase

All Implemented Interfaces:

URL2Connection

public class URL2ConnectionBase
extends Object
implements URL2Connection

A base class implementing an instance of URL2Connection

Constructor Summary

Constructors

Constructor	Description
URL2ConnectionBase(int code, URL2 uri, InputStream in)	Create a URL2Connection with no headers and which will return the specified InputStream when getInputStream() is called
URL2ConnectionBase(URL2 uri, URLConnection con)	Create a URL2Connection which will wrap the specified URLConnection

Method Summary

Modifier and Type	Method	Description
void	connect()	"Connect" to the URL.
CallbackHandler	getCallbackHandler()	Return the CallbackHandler set by URL2Connection.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
int	getCode()	Return the response code, the logic for this will depend on the scheme but which ideally should match HTTP Will trigger a connection
InputStream	getInputStream()	Return the InputStream for the response.
URLConnection	getLegacyURLConnection()	If this instance wraps a URLConnection, return that, otherwise return null
final Date	getRequestDateHeader(String key)	Return a request header as a Date (if set and a valid date), or null otherwise.
final String	getRequestHeader(String key)	Return a previously-set Request header
Map<String,List<String>>	getRequestHeaders()	Return a modifiable map of the Request headers It's usually preferable to call URL2Connection.getRequestHeader(java.lang.String) to retrieve a single header, as that handles case folding.
final Date	getResponseDateHeader(String key)	Return a response header as a Date if set and a valid date, or null otherwise.
final String	getResponseHeader(String key)	Return a response header if set, or null otherwise.
Map<String,List<String>>	getResponseHeaders()	Return a modifiable map of the Response headers.
URL2	getURL()	Get the URL.
boolean	isConnected()	Return true if the connection has been made
void	setCallbackHandler(CallbackHandler handler)	Set the CallbackHandler that should be used for any authorization callbacks required on this connection
void	setInputStream(InputStream in)	Set the InputStream to return from getInputStream(), overriding the parameter passed into the constructor
final void	setRequestDateHeader(String key, Date value)	Set a request header as a Date.
void	setRequestHeader(String key, String value)	Set a request header.
final void	setResponseDateHeader(String key, Date value)	Set a response header as a Date.
void	setResponseHeader(String key, String value)	Set a response header.
void	setURL(URL2 uri)	Set the URL, overriding the parameter passed into the constructor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faceless.publisher.type.URL2Connection

getIfModifiedSince, getLastModified, getMethod, getRequestInputStream

Constructor Details

URL2ConnectionBase

public URL2ConnectionBase(int code,
 URL2 uri,
 InputStream in)

Create a URL2Connection with no headers and which will return the specified InputStream when getInputStream() is called

Parameters:

code - the code to return from getCode(), which should be between 1 and 999

uri - the URL - the origin of which must be set to the referrer URL that would be sent, with referrer-policy and include-credentials

in - the InputStream to return from getInputStream() - may be null (although that method should be overridden if it is)

URL2ConnectionBase

public URL2ConnectionBase(URL2 uri,
 URLConnection con)

Create a URL2Connection which will wrap the specified URLConnection

Parameters:

uri - the URL - the origin of which must be set to the referrer URL that would be sent, with referrer-policy and include-credentials

con - the URLConnection to wrap (required)

Method Details

connect

public void connect()
             throws IOException

"Connect" to the URL. This populates the responseHeaders. It's called automatically when the responseHeaders or InputStream is requested

Specified by:

connect in interface URL2Connection

Throws:

IOException

isConnected

public boolean isConnected()

Description copied from interface: URL2Connection

Return true if the connection has been made

Specified by:

isConnected in interface URL2Connection

setCallbackHandler

public void setCallbackHandler(CallbackHandler handler)

Description copied from interface: URL2Connection

Set the CallbackHandler that should be used for any authorization callbacks required on this connection

Specified by:

setCallbackHandler in interface URL2Connection

getCallbackHandler

public CallbackHandler getCallbackHandler()

Description copied from interface: URL2Connection

Return the CallbackHandler set by URL2Connection.setCallbackHandler(javax.security.auth.callback.CallbackHandler)

Specified by:

getCallbackHandler in interface URL2Connection

setURL

public void setURL(URL2 uri)

Set the URL, overriding the parameter passed into the constructor

Parameters:

uri - the URL

setInputStream

public void setInputStream(InputStream in)

Set the InputStream to return from getInputStream(), overriding the parameter passed into the constructor

Parameters:

in - the InputStream

getURL

public URL2 getURL()

Description copied from interface: URL2Connection

Get the URL. Note the origin's ReferrerPolicy is used

Specified by:

getURL in interface URL2Connection

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: URL2Connection

Return the InputStream for the response. Will trigger a connection

Specified by:

getInputStream in interface URL2Connection

Throws:

IOException

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()
                                            throws IOException

Description copied from interface: URL2Connection

Return a modifiable map of the Response headers. It's usually preferable to call URL2Connection.getResponseHeader(java.lang.String) to retrieve a single header, as that handles case folding. Will trigger a connection.

Specified by:

getResponseHeaders in interface URL2Connection

Throws:

IOException

setResponseHeader

public void setResponseHeader(String key,
 String value)
                       throws IOException

Set a response header. Replaces all other headers with this name.

Parameters:

key - the header name, which is case-insensitive

value - the value name, or null to remove the header.

Throws:

IllegalStateException - if we're already connected

IOException

See Also:

• setResponseDateHeader(java.lang.String, java.util.Date)

getRequestHeaders

public Map<String,List<String>> getRequestHeaders()

Description copied from interface: URL2Connection

Return a modifiable map of the Request headers It's usually preferable to call URL2Connection.getRequestHeader(java.lang.String) to retrieve a single header, as that handles case folding.

Specified by:

getRequestHeaders in interface URL2Connection

setRequestHeader

public void setRequestHeader(String key,
 String value)

Description copied from interface: URL2Connection

Set a request header. Replaces all other headers with this name.

Specified by:

setRequestHeader in interface URL2Connection

Parameters:

key - the header name, which is case-insensitive

value - the value name, or null to remove the header.

getLegacyURLConnection

public URLConnection getLegacyURLConnection()
                                     throws IOException

Description copied from interface: URL2Connection

If this instance wraps a URLConnection, return that, otherwise return null

Specified by:

getLegacyURLConnection in interface URL2Connection

Throws:

IOException

getCode

public int getCode()
            throws IOException

Description copied from interface: URL2Connection

Return the response code, the logic for this will depend on the scheme but which ideally should match HTTP Will trigger a connection

Specified by:

getCode in interface URL2Connection

Throws:

IOException

getRequestHeader

public final String getRequestHeader(String key)

Description copied from interface: URL2Connection

Return a previously-set Request header

Specified by:

getRequestHeader in interface URL2Connection

getResponseHeader

public final String getResponseHeader(String key)
                               throws IOException

Description copied from interface: URL2Connection

Return a response header if set, or null otherwise. If multiple headers, returns the first.

Specified by:

getResponseHeader in interface URL2Connection

Parameters:

key - the header name, which is case-insensitive

Throws:

IOException

getResponseDateHeader

public final Date getResponseDateHeader(String key)
                                 throws IOException

Description copied from interface: URL2Connection

Return a response header as a Date if set and a valid date, or null otherwise. If multiple headers, returns the first.

Specified by:

getResponseDateHeader in interface URL2Connection

Parameters:

key - the header name, which is case-insensitive

Throws:

IOException

getRequestDateHeader

public final Date getRequestDateHeader(String key)

Description copied from interface: URL2Connection

Return a request header as a Date (if set and a valid date), or null otherwise. If multiple headers, returns the first.

Specified by:

getRequestDateHeader in interface URL2Connection

Parameters:

key - the header name, which is case-insensitive

setRequestDateHeader

public final void setRequestDateHeader(String key,
 Date value)

Description copied from interface: URL2Connection

Set a request header as a Date.

Specified by:

setRequestDateHeader in interface URL2Connection

Parameters:

key - the header name, which is case-insensitive

value - the date value

setResponseDateHeader

public final void setResponseDateHeader(String key,
 Date value)
                                 throws IOException

Set a response header as a Date.

Parameters:

key - the header name, which is case-insensitive

value - the date value

Throws:

IllegalStateException - if we're already connected

IOException

See Also:

• setResponseHeader(java.lang.String, java.lang.String)