Home How it Works Android APIMiner IDE Version More Info

to top

Added in API level 1

public abstract class

JarURLConnection

extends URLConnection

java.lang.Object
↳	java.net.URLConnection
	↳	java.net.JarURLConnection

Class Overview

This class establishes a connection to a jar: URL using the JAR protocol. A JarURLConnection instance can refer to either a JAR archive file or to an entry of such a file. jar: URLs are specified as follows: jar:{archive-url}!/{entry} where "!/" is called a separator. This separator is important to determine if an archive or an entry of an archive is referred.

Examples:

Archive: jar:http://www.example.com/applets/archive.jar!/

File Entry: jar:http://www.example.com/applets/archive.jar!/test.class

Directory Entry: jar:http://www.example.com/applets/archive.jar!/applets/

Summary

Fields
protected URLConnection	jarFileURLConnection	The location part of the represented URL.

[Expand]

Inherited Fields

From class java.net.URLConnection

Protected Constructors
	JarURLConnection( URL url) Constructs an instance of `JarURLConnection` that refers to the specified URL.

Public Methods
Attributes	getAttributes() Returns all attributes of the `JarEntry` referenced by this `JarURLConnection`.
Certificate[]	getCertificates() Returns all certificates of the `JarEntry` referenced by this `JarURLConnection` instance.
String	getEntryName() Gets the name of the entry referenced by this `JarURLConnection`.
JarEntry	getJarEntry() Gets the `JarEntry` object of the entry referenced by this `JarURLConnection`.
abstract JarFile	getJarFile() Gets the `JarFile` object referenced by this `JarURLConnection`.
URL	getJarFileURL() Gets the URL to the JAR-file referenced by this `JarURLConnection`.
Attributes	getMainAttributes() Gets all attributes of the manifest file referenced by this `JarURLConnection`.
Manifest	getManifest() Gets the manifest file associated with this JAR-URL.

[Expand]

Inherited Methods

From class java.net.URLConnection

void	addRequestProperty( String field, String newValue) Adds the given property to the request header.
abstract void	connect() Opens a connection to the resource.
boolean	getAllowUserInteraction() Returns `allowUserInteraction`.
int	getConnectTimeout() Returns the connect timeout in milliseconds.
Object	getContent() Returns an object representing the content of the resource this `URLConnection` is connected to.
Object	getContent( Class[] types) Returns an object representing the content of the resource this `URLConnection` is connected to.
String	getContentEncoding() Returns the content encoding type specified by the response header field `content-encoding` or `null` if this field is not set.
int	getContentLength() Returns the content length in bytes specified by the response header field `content-length` or `-1` if this field is not set.
String	getContentType() Returns the MIME-type of the content specified by the response header field `content-type` or `null` if type is unknown.
long	getDate() Returns the timestamp when this response has been sent as a date in milliseconds since January 1, 1970 GMT or `0` if this timestamp is unknown.
static boolean	getDefaultAllowUserInteraction() Returns the default value of `allowUserInteraction`.
static String	getDefaultRequestProperty( String field) This method was deprecated in API level 1. Use `getRequestProperty(String)`
boolean	getDefaultUseCaches() Returns the default setting whether this connection allows using caches.
boolean	getDoInput() Returns the value of the option `doInput` which specifies whether this connection allows to receive data.
boolean	getDoOutput() Returns the value of the option `doOutput` which specifies whether this connection allows to send data.
long	getExpiration() Returns the timestamp when this response will be expired in milliseconds since January 1, 1970 GMT or `0` if this timestamp is unknown.
static FileNameMap	getFileNameMap() Returns the table which is used by all `URLConnection` instances to determine the MIME-type according to a file extension.
String	getHeaderField( String key) Returns the value of the header field specified by `key` or `null` if there is no field with this name.
String	getHeaderField(int pos) Returns the header value at the field position `pos` or `null` if the header has fewer than `pos` fields.
long	getHeaderFieldDate( String field, long defaultValue) Returns the specified header value as a date in milliseconds since January 1, 1970 GMT.
int	getHeaderFieldInt( String field, int defaultValue) Returns the specified header value as a number.
String	getHeaderFieldKey(int posn) Returns the name of the header field at the given position `posn` or `null` if there are fewer than `posn` fields.
Map< String, List< String>>	getHeaderFields() Returns an unmodifiable map of the response-header fields and values.
long	getIfModifiedSince() Returns the point of time since when the data must be modified to be transmitted.
InputStream	getInputStream() Returns an `InputStream` for reading data from the resource pointed by this `URLConnection`.
long	getLastModified() Returns the value of the response header field `last-modified` or `0` if this value is not set.
OutputStream	getOutputStream() Returns an `OutputStream` for writing data to this `URLConnection`.
Permission	getPermission() Returns a `Permission` object representing all needed permissions to open this connection.
int	getReadTimeout() Returns the read timeout in milliseconds, or `0` if reads never timeout.
Map< String, List< String>>	getRequestProperties() Returns an unmodifiable map of general request properties used by this connection.
String	getRequestProperty( String field) Returns the value of the request header property specified by {code field} or `null` if there is no field with this name.
URL	getURL() Returns the URL represented by this `URLConnection`.
boolean	getUseCaches() Returns the value of the flag which specifies whether this `URLConnection` allows to use caches.
static String	guessContentTypeFromName( String url) Determines the MIME-type of the given resource `url` by resolving the filename extension with the internal FileNameMap.
static String	guessContentTypeFromStream( InputStream is) Determines the MIME-type of the resource represented by the input stream `is` by reading its first few characters.
void	setAllowUserInteraction(boolean newValue) Sets `allowUserInteraction`.
void	setConnectTimeout(int timeoutMillis) Sets the maximum time in milliseconds to wait while connecting.
synchronized static void	setContentHandlerFactory( ContentHandlerFactory contentFactory) Sets the internally used content handler factory.
static void	setDefaultAllowUserInteraction(boolean allows) Sets the default value for `allowUserInteraction`.
static void	setDefaultRequestProperty( String field, String value) This method was deprecated in API level 1. Use `setRequestProperty(String, String)`.
void	setDefaultUseCaches(boolean newValue) Sets the default value for the flag indicating whether this connection allows to use caches.
void	setDoInput(boolean newValue) Sets the flag indicating whether this `URLConnection` allows input.
void	setDoOutput(boolean newValue) Sets the flag indicating whether this `URLConnection` allows output.
static void	setFileNameMap( FileNameMap map) Sets the internal map which is used by all `URLConnection` instances to determine the MIME-type according to a filename extension.
void	setIfModifiedSince(long newValue) Sets the point of time since when the data must be modified to be transmitted.
void	setReadTimeout(int timeoutMillis) Sets the maximum time to wait for an input stream read to complete before giving up.
void	setRequestProperty( String field, String newValue) Sets the value of the specified request header field.
void	setUseCaches(boolean newValue) Sets the flag indicating whether this connection allows to use caches or not.
String	toString() Returns the string representation containing the name of this class and the URL.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Fields

protected URLConnection jarFileURLConnection

Added in API level 1

The location part of the represented URL.

Protected Constructors

protected JarURLConnection (URL url)

Added in API level 1

Constructs an instance of JarURLConnection that refers to the specified URL.

Parameters

url	the URL that contains the location to connect to.

Throws

MalformedURLException	if an invalid URL has been entered.

Public Methods

public Attributes getAttributes ()

Added in API level 1

Returns all attributes of the JarEntry referenced by this JarURLConnection.

Returns

the attributes of the referenced JarEntry.

Throws

IOException	if an I/O exception occurs while retrieving the JAR-entries.

public Certificate[] getCertificates ()

Added in API level 1

Returns all certificates of the JarEntry referenced by this JarURLConnection instance. This method will return null until the InputStream has been completely verified.

Returns

the certificates of the JarEntry as an array.

Throws

IOException	if there is an I/O exception occurs while getting the `JarEntry`.

public String getEntryName ()

Added in API level 1

Gets the name of the entry referenced by this JarURLConnection. The return value will be null if this instance refers to a JAR file rather than an JAR file entry.

Returns

the JarEntry name this instance refers to.

public JarEntry getJarEntry ()

Added in API level 1

Gets the JarEntry object of the entry referenced by this JarURLConnection.

Returns

the referenced JarEntry object or null if no entry name is specified.

Throws

IOException	if an error occurs while getting the file or file-entry.

public abstract JarFile getJarFile ()

Added in API level 1

Gets the JarFile object referenced by this JarURLConnection.

Returns

the referenced JarFile object.

Throws

IOException	if an I/O exception occurs while retrieving the JAR-file.

public URL getJarFileURL ()

Added in API level 1

Gets the URL to the JAR-file referenced by this JarURLConnection.

Returns

the URL to the JAR-file or null if there was an error retrieving the URL.

public Attributes getMainAttributes ()

Added in API level 1

Gets all attributes of the manifest file referenced by this JarURLConnection. If this instance refers to a JAR-file rather than a JAR-file entry, null will be returned.

Returns

the attributes of the manifest file or null.

Throws

IOException	if an I/O exception occurs while retrieving the `JarFile`.

public Manifest getManifest ()

Added in API level 1

Gets the manifest file associated with this JAR-URL.

Returns

the manifest of the referenced JAR-file.

Throws

IOException	if an error occurs while getting the manifest file.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Enums

Exceptions

JarURLConnection

Class Overview

Summary

Fields

protected URLConnection jarFileURLConnection

Protected Constructors

protected JarURLConnection (URL url)

Parameters

Throws

Public Methods

public Attributes getAttributes ()

Returns

Throws

public Certificate[] getCertificates ()

Returns

Throws

public String getEntryName ()

Returns

public JarEntry getJarEntry ()

Returns

Throws

public abstract JarFile getJarFile ()

Returns

Throws

public URL getJarFileURL ()

Returns

public Attributes getMainAttributes ()

Returns

Throws

public Manifest getManifest ()

Returns

Throws