Package org.faceless.publisher.type

Class URL2ConnectionWrapper

java.lang.Object

org.faceless.publisher.type.URL2ConnectionWrapper

All Implemented Interfaces:

URL2Connection

public class URL2ConnectionWrapper
extends Object
implements URL2Connection

A URL2Connection that wraps another URL2Connection, for filtering

Constructor Summary

Constructors

Constructor	Description
URL2ConnectionWrapper(URL2Connection parent)	Create a URL2ConnectionWrapper

Method Summary

Modifier and Type	Method	Description
void	connect()	Open the network connection
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
Object	getData()	For URLConnections based around an already existing object (like a Blob), this will return the object, otherwise returns null.
InputStream	getInputStream()	Return the InputStream for the response.
URLConnection	getLegacyURLConnection()	If this instance wraps a URLConnection, return that, otherwise return null
URL2Connection	getParent()	Get the URL2Connection passed into the constructor
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.
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	setRequestDateHeader(String key, Date value)	Set a request header as a Date.
void	setRequestHeader(String key, String value)	Set a request header.

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

URL2ConnectionWrapper

public URL2ConnectionWrapper(URL2Connection parent)

Create a URL2ConnectionWrapper

Parameters:

parent - the item to wrap

Method Details

getParent

public URL2Connection getParent()

Get the URL2Connection passed into the constructor

isConnected

public boolean isConnected()

Description copied from interface: URL2Connection

Return true if the connection has been made

Specified by:

isConnected in interface URL2Connection

getData

public Object getData()

For URLConnections based around an already existing object (like a Blob), this will return the object, otherwise returns null.

Specified by:

getData 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

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

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

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

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

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 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

getRequestHeader

public final String getRequestHeader(String key)

Description copied from interface: URL2Connection

Return a previously-set Request header

Specified by:

getRequestHeader in interface URL2Connection

getRequestDateHeader

public 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

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.

setRequestDateHeader

public 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

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

connect

public void connect()
             throws IOException

Description copied from interface: URL2Connection

Open the network connection

Specified by:

connect in interface URL2Connection

Throws:

IOException