org.mdiutil.net

Class NestableURLConnection

java.lang.Object

java.net.URLConnection

org.mdiutil.net.NestableURLConnection

public class NestableURLConnection
extends URLConnection

An URLConnection that can access URLs in nested archives (for example a resource in a jar nested in another jar). Note that:

• this class does not allow to get an OutputStream to write in the archive. The getOutputStream() will invariably return null
• For an URL which does not correspond to a nested archive, the regular Java getInputStream() method will be used internally, so this class may be used even for not nested URLs

Note that to be able to use this connection with nested archives, you will need to install the ZipStreamHandlerFactory, because by default Java does not accept to handle nested jar protocols (and the jar protocol is used even for zip files).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	firstEntry
protected String	urlPath

Fields inherited from class java.net.URLConnection

allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches

Constructor Summary

Constructors

Constructor and Description
NestableURLConnection() Constructs a new connection.
NestableURLConnection(URL url) Constructs a new connection for the URL.
NestableURLConnection(URL url, boolean firstEntry) Constructs a new connection for the URL.

Method Summary

Modifier and Type	Method and Description
void	connect() Advertise that this connection is connected.
InputStream	getInputStream() Creates the input stream for the URL.
OutputStream	getOutputStream() Return null.
boolean	isAcceptingAlternateProtocols() Return true if the connection accept alternate protocols, in addition to zip.
void	setAcceptAlternateProtocols(boolean acceptAltProtocols) Set if the connection accept alternate protocols, in addition to zip.
void	setURL(URL url) Set the connection URL.

Methods inherited from class java.net.URLConnection

addRequestProperty, getAllowUserInteraction, getConnectTimeout, getContent, getContent, getContentEncoding, getContentLength, getContentLengthLong, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldDate, getHeaderFieldInt, getHeaderFieldKey, getHeaderFieldLong, getHeaderFields, getIfModifiedSince, getLastModified, getPermission, getReadTimeout, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setConnectTimeout, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setReadTimeout, setRequestProperty, setUseCaches, toString

Methods inherited from class java.lang.Object

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

Field Detail

urlPath

protected String urlPath

firstEntry

protected boolean firstEntry

Constructor Detail

NestableURLConnection

public NestableURLConnection(URL url)

Constructs a new connection for the URL.

Parameters:

url - the URL of this connection.

NestableURLConnection

public NestableURLConnection()

Constructs a new connection.

NestableURLConnection

public NestableURLConnection(URL url,
                             boolean firstEntry)

Constructs a new connection for the URL.

Parameters:

url - the URL of this connection.

firstEntry - true for the first entry

Method Detail

setAcceptAlternateProtocols

public void setAcceptAlternateProtocols(boolean acceptAltProtocols)

Set if the connection accept alternate protocols, in addition to zip. For the moment, the only alternate protocol which is handled is gzip. The connection will consider that an entry with the ".gz" extension is a gzip file.

Parameters:

acceptAltProtocols - true if the connection accept alternate protocols

isAcceptingAlternateProtocols

public boolean isAcceptingAlternateProtocols()

Return true if the connection accept alternate protocols, in addition to zip.

Returns:

true if the connection accept alternate protocols

setURL

public void setURL(URL url)

Set the connection URL.

Parameters:

url - the url

connect

public void connect()
             throws IOException

Advertise that this connection is connected. The URLConnection.connected field will be set to true.

Specified by:

connect in class URLConnection

Throws:

IOException - if an I/O error occurs while opening the connection

getInputStream

public InputStream getInputStream()
                           throws IOException

Creates the input stream for the URL. Note that for an URL which does not correspond to a nested archive, the regular Java getInputStream() method will be used internally, so this method may be used even for not nested URLs.

Overrides:

getInputStream in class URLConnection

Returns:

the input stream for the URL.

Throws:

IOException - if an I/O error occurs while creating the input stream

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Return null.

Overrides:

getOutputStream in class URLConnection

Returns:

null

Throws:

IOException