Added in API level 1

URLClassLoader

open class URLClassLoader : SecureClassLoader, Closeable
kotlin.Any
   ↳ java.lang.ClassLoader
   ↳ java.security.SecureClassLoader
   ↳ java.net.URLClassLoader

This class loader is used to load classes and resources from a search path of URLs referring to both JAR files and directories. Any URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be opened as needed.

The AccessControlContext of the thread that created the instance of URLClassLoader will be used when subsequently loading classes and resources.

The classes that are loaded are by default granted permission only to access the URLs specified when the URLClassLoader was created.

Summary

Public constructors
URLClassLoader(urls: Array<URL!>!, parent: ClassLoader!)

Constructs a new URLClassLoader for the given URLs.

Constructs a new URLClassLoader for the specified URLs using the default delegation parent ClassLoader.

URLClassLoader(urls: Array<URL!>!, parent: ClassLoader!, factory: URLStreamHandlerFactory!)

Constructs a new URLClassLoader for the specified URLs, parent class loader, and URLStreamHandlerFactory.

Public methods
open Unit

Closes this URLClassLoader, so that it can no longer be used to load new classes or resources that are defined by this loader.

open URL!

Finds the resource with the specified name on the URL search path.

open Enumeration<URL!>!

Returns an Enumeration of URLs representing all of the resources on the URL search path having the specified name.

open InputStream!

Returns an input stream for reading the specified resource.

open Array<URL!>!

Returns the search path of URLs for loading classes and resources.

open static URLClassLoader!
newInstance(urls: Array<URL!>!, parent: ClassLoader!)

Creates a new instance of URLClassLoader for the specified URLs and parent class loader.

open static URLClassLoader!
newInstance(urls: Array<URL!>!)

Creates a new instance of URLClassLoader for the specified URLs and default parent class loader.

Protected methods
open Unit
addURL(url: URL!)

Appends the specified URL to the list of URLs to search for classes and resources.

open Package!
definePackage(name: String!, man: Manifest!, url: URL!)

Defines a new package by name in this ClassLoader.

open Class<*>!
findClass(name: String!)

Finds and loads the class with the specified name from the URL search path.

open PermissionCollection!
getPermissions(codesource: CodeSource!)

Returns the permissions for the given codesource object.

Inherited functions

Public constructors

URLClassLoader

Added in API level 1
URLClassLoader(
    urls: Array<URL!>!,
    parent: ClassLoader!)

Constructs a new URLClassLoader for the given URLs. The URLs will be searched in the order specified for classes and resources after first searching in the specified parent class loader. Any URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be downloaded and opened as needed.

If there is a security manager, this method first calls the security manager's checkCreateClassLoader method to ensure creation of a class loader is allowed.

Parameters
urls Array<URL!>!: the URLs from which to load classes and resources
parent ClassLoader!: the parent class loader for delegation
Exceptions
java.lang.SecurityException if a security manager exists and its checkCreateClassLoader method doesn't allow creation of a class loader.
java.lang.NullPointerException if urls is null.

URLClassLoader

Added in API level 1
URLClassLoader(urls: Array<URL!>!)

Constructs a new URLClassLoader for the specified URLs using the default delegation parent ClassLoader. The URLs will be searched in the order specified for classes and resources after first searching in the parent class loader. Any URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be downloaded and opened as needed.

If there is a security manager, this method first calls the security manager's checkCreateClassLoader method to ensure creation of a class loader is allowed.

Parameters
urls Array<URL!>!: the URLs from which to load classes and resources
Exceptions
java.lang.SecurityException if a security manager exists and its checkCreateClassLoader method doesn't allow creation of a class loader.
java.lang.NullPointerException if urls is null.

URLClassLoader

Added in API level 1
URLClassLoader(
    urls: Array<URL!>!,
    parent: ClassLoader!,
    factory: URLStreamHandlerFactory!)

Constructs a new URLClassLoader for the specified URLs, parent class loader, and URLStreamHandlerFactory. The parent argument will be used as the parent class loader for delegation. The factory argument will be used as the stream handler factory to obtain protocol handlers when creating new jar URLs.

If there is a security manager, this method first calls the security manager's checkCreateClassLoader method to ensure creation of a class loader is allowed.

Parameters
urls Array<URL!>!: the URLs from which to load classes and resources
parent ClassLoader!: the parent class loader for delegation
factory URLStreamHandlerFactory!: the URLStreamHandlerFactory to use when creating URLs
Exceptions
java.lang.SecurityException if a security manager exists and its checkCreateClassLoader method doesn't allow creation of a class loader.
java.lang.NullPointerException if urls is null.

Public methods

close

Added in API level 24
open fun close(): Unit

Closes this URLClassLoader, so that it can no longer be used to load new classes or resources that are defined by this loader. Classes and resources defined by any of this loader's parents in the delegation hierarchy are still accessible. Also, any classes or resources that are already loaded, are still accessible.

In the case of jar: and file: URLs, it also closes any files that were opened by it. If another thread is loading a class when the close method is invoked, then the result of that load is undefined.

The method makes a best effort attempt to close all opened files, by catching IOExceptions internally. Unchecked exceptions and errors are not caught. Calling close on an already closed loader has no effect.

Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException if an I/O error occurs
java.io.IOException if closing any file opened by this class loader resulted in an IOException. Any such exceptions are caught internally. If only one is caught, then it is re-thrown. If more than one exception is caught, then the second and following exceptions are added as suppressed exceptions of the first one caught, which is then re-thrown.
java.lang.SecurityException if a security manager is set, and it denies RuntimePermission("closeClassLoader")

findResource

Added in API level 1
open fun findResource(name: String!): URL!

Finds the resource with the specified name on the URL search path.

Parameters
name String!: the name of the resource
Return
URL! a URL for the resource, or null if the resource could not be found, or if the loader is closed.

findResources

Added in API level 1
open fun findResources(name: String!): Enumeration<URL!>!

Returns an Enumeration of URLs representing all of the resources on the URL search path having the specified name.

Parameters
name String!: the resource name
Return
Enumeration<URL!>! an Enumeration of URLs If the loader is closed, the Enumeration will be empty.
Exceptions
java.io.IOException If I/O errors occur
java.io.IOException if an I/O exception occurs

getResourceAsStream

Added in API level 1
open fun getResourceAsStream(name: String!): InputStream!

Returns an input stream for reading the specified resource. If this loader is closed, then any resources opened by this method will be closed.

The search order is described in the documentation for getResource(java.lang.String).

Parameters
name String!: The resource name
Return
InputStream! An input stream for reading the resource, or null if the resource could not be found
Exceptions
java.lang.NullPointerException If name is null

getURLs

Added in API level 1
open fun getURLs(): Array<URL!>!

Returns the search path of URLs for loading classes and resources. This includes the original list of URLs specified to the constructor, along with any URLs subsequently appended by the addURL() method.

Return
Array<URL!>! the search path of URLs for loading classes and resources.

newInstance

Added in API level 1
open static fun newInstance(
    urls: Array<URL!>!,
    parent: ClassLoader!
): URLClassLoader!

Creates a new instance of URLClassLoader for the specified URLs and parent class loader. If a security manager is installed, the loadClass method of the URLClassLoader returned by this method will invoke the SecurityManager.checkPackageAccess method before loading the class.

Parameters
urls Array<URL!>!: the URLs to search for classes and resources
parent ClassLoader!: the parent class loader for delegation
Return
URLClassLoader! the resulting class loader
Exceptions
java.lang.NullPointerException if urls is null.

newInstance

Added in API level 1
open static fun newInstance(urls: Array<URL!>!): URLClassLoader!

Creates a new instance of URLClassLoader for the specified URLs and default parent class loader. If a security manager is installed, the loadClass method of the URLClassLoader returned by this method will invoke the SecurityManager.checkPackageAccess before loading the class.

Parameters
urls Array<URL!>!: the URLs to search for classes and resources
Return
URLClassLoader! the resulting class loader
Exceptions
java.lang.NullPointerException if urls is null.

Protected methods

addURL

Added in API level 1
protected open fun addURL(url: URL!): Unit

Appends the specified URL to the list of URLs to search for classes and resources.

If the URL specified is null or is already in the list of URLs, or if this loader is closed, then invoking this method has no effect.

Parameters
url URL!: the URL to be added to the search path of URLs

definePackage

Added in API level 1
protected open fun definePackage(
    name: String!,
    man: Manifest!,
    url: URL!
): Package!

Defines a new package by name in this ClassLoader. The attributes contained in the specified Manifest will be used to obtain package version and sealing information. For sealed packages, the additional URL specifies the code source URL from which the package was loaded.

Parameters
name String!: the package name
man Manifest!: the Manifest containing package version and sealing information
url URL!: the code source url for the package, or null if none
Return
Package! the newly defined Package object
Exceptions
java.lang.IllegalArgumentException if the package name duplicates an existing package either in this class loader or one of its ancestors

findClass

Added in API level 1
protected open fun findClass(name: String!): Class<*>!

Finds and loads the class with the specified name from the URL search path. Any URLs referring to JAR files are loaded and opened as needed until the class is found.

Parameters
name String!: the name of the class
Return
Class<*>! the resulting class
Exceptions
java.lang.ClassNotFoundException If the class could not be found
java.lang.ClassNotFoundException if the class could not be found, or if the loader is closed.
java.lang.NullPointerException if name is null.

getPermissions

Added in API level 1
protected open fun getPermissions(codesource: CodeSource!): PermissionCollection!

Returns the permissions for the given codesource object. The implementation of this method first calls super.getPermissions and then adds permissions based on the URL of the codesource.

If the protocol of this URL is "jar", then the permission granted is based on the permission that is required by the URL of the Jar file.

If the protocol is "file" and there is an authority component, then permission to connect to and accept connections from that authority may be granted. If the protocol is "file" and the path specifies a file, then permission to read that file is granted. If protocol is "file" and the path is a directory, permission is granted to read all files and (recursively) all files and subdirectories contained in that directory.

If the protocol is not "file", then permission to connect to and accept connections from the URL's host is granted.

Parameters
codesource CodeSource!: the codesource
Return
PermissionCollection! the permissions granted to the codesource
Exceptions
java.lang.NullPointerException if codesource is null.