jadex.bridge.service.library

Class LibraryService

java.lang.Object

jadex.bridge.service.BasicService

jadex.bridge.service.library.LibraryService

All Implemented Interfaces:

IInternalService, IService, ILibraryService, IPropertiesProvider

public class LibraryService
extends BasicService
implements ILibraryService, IPropertiesProvider

Library service for loading classpath elements.

Field Summary

Fields inherited from interface jadex.bridge.service.library.ILibraryService

LIBRARY_SERVICE

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor and Description
LibraryService(IServiceProvider provider) Creates a new LibraryService.
LibraryService(Object[] urls, IServiceProvider provider) Creates a new LibraryService.
LibraryService(Object[] urls, IServiceProvider provider, Map properties) Creates a new LibraryService.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLibraryServiceListener(ILibraryServiceListener listener) Add an Library Service listener.
void	addPath(String path) Add a path.
void	addURL(URL url) Add a new url.
IFuture<List<URL>>	getAllURLs() Get all urls (managed and non-managed).
IFuture<byte[]>	getClassDefinition(String name) Get a class definition.
ClassLoader	getClassLoader() Returns the current ClassLoader
IFuture<List<URL>>	getNonManagedURLs() Get other contained (but not directly managed) URLs.
IFuture<List<String>>	getNonManagedURLStrings() Get the non-managed classpath entries.
IFuture<Properties>	getProperties() Write current state into properties.
IFuture<List<URL>>	getURLs() Get all managed entries as URLs.
IFuture<List<String>>	getURLStrings() Get the non-managed classpath entries as strings.
static int	indexOfFilename(String url, List urlstrings) Test if a file name is contained.
void	removeLibraryServiceListener(ILibraryServiceListener listener) Remove an Library Service listener.
void	removeURL(URL url) Remove a url.
void	removeURLCompletely(URL url) Remove a url completely (all references).
IFuture<Void>	setProperties(Properties props) Update from given properties.
IFuture<Void>	shutdownService() Shutdown the service.
IFuture<Void>	startService() Start the service.
static URL	toURL(Object url) Convert a file/string/url.
static File	urlToFile(String url) Convert an URL to a file.

Methods inherited from class jadex.bridge.service.BasicService

createServiceIdentifier, createServiceIdentifier, equals, generateServiceName, getPropertyMap, getServiceIdentifier, isValid, setPropertyMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.bridge.service.IService

getPropertyMap, getServiceIdentifier, isValid

Constructor Detail

LibraryService

public LibraryService(IServiceProvider provider)

Creates a new LibraryService.

LibraryService

public LibraryService(Object[] urls,
              IServiceProvider provider)

Creates a new LibraryService.

Parameters:

urls - Urls may be specified as java.net.URLs, java.io.Files or java.lang.Strings. Strings are interpreted as relative files (relative to current directory), absolute files or URLs (whatever can be found).

LibraryService

public LibraryService(Object[] urls,
              IServiceProvider provider,
              Map properties)

Creates a new LibraryService.

Parameters:

urls - Urls may be specified as java.net.URLs, java.io.Files or java.lang.Strings. Strings are interpreted as relative files (relative to current directory), absolute files or URLs (whatever can be found).

Method Detail

addPath

public void addPath(String path)

Add a path.

Parameters:

path - The path.

addURL

public void addURL(URL url)

Add a new url.

Specified by:

addURL in interface ILibraryService

Parameters:

url - The url.

removeURL

public void removeURL(URL url)

Remove a url.

Specified by:

removeURL in interface ILibraryService

Parameters:

url - The url.

removeURLCompletely

public void removeURLCompletely(URL url)

Remove a url completely (all references).

Specified by:

removeURLCompletely in interface ILibraryService

Parameters:

url - The url.

getURLs

public IFuture<List<URL>> getURLs()

Get all managed entries as URLs.

Specified by:

getURLs in interface ILibraryService

Returns:

url The urls.

getNonManagedURLs

public IFuture<List<URL>> getNonManagedURLs()

Get other contained (but not directly managed) URLs.

Specified by:

getNonManagedURLs in interface ILibraryService

Returns:

The list of urls.

getAllURLs

public IFuture<List<URL>> getAllURLs()

Get all urls (managed and non-managed).

Specified by:

getAllURLs in interface ILibraryService

Returns:

The list of urls.

getClassLoader

public ClassLoader getClassLoader()

Returns the current ClassLoader

Specified by:

getClassLoader in interface ILibraryService

Returns:

the current ClassLoader

startService

public IFuture<Void> startService()

Start the service.

Specified by:

startService in interface IInternalService

Overrides:

startService in class BasicService

Returns:

A future that is done when the service has completed starting.

shutdownService

public IFuture<Void> shutdownService()

Shutdown the service. Releases all cached resources and shuts down the library service.

Specified by:

shutdownService in interface IInternalService

Overrides:

shutdownService in class BasicService

Parameters:

listener - The listener.

Returns:

A future that is done when the service has completed its shutdown.

addLibraryServiceListener

public void addLibraryServiceListener(ILibraryServiceListener listener)

Add an Library Service listener. The listener is registered for changes in the loaded library states.

Specified by:

addLibraryServiceListener in interface ILibraryService

Parameters:

listener - The listener to be added.

removeLibraryServiceListener

public void removeLibraryServiceListener(ILibraryServiceListener listener)

Remove an Library Service listener.

Specified by:

removeLibraryServiceListener in interface ILibraryService

Parameters:

listener - The listener to be removed.

toURL

public static URL toURL(Object url)

Convert a file/string/url.

getURLStrings

public IFuture<List<String>> getURLStrings()

Get the non-managed classpath entries as strings.

Specified by:

getURLStrings in interface ILibraryService

Returns:

Classpath entries as a list of strings.

getNonManagedURLStrings

public IFuture<List<String>> getNonManagedURLStrings()

Get the non-managed classpath entries.

Specified by:

getNonManagedURLStrings in interface ILibraryService

Returns:

Classpath entries as a list of strings.

getClassDefinition

public IFuture<byte[]> getClassDefinition(String name)

Get a class definition.

Specified by:

getClassDefinition in interface ILibraryService

Parameters:

name - The class name.

Returns:

The class definition as byte array.

setProperties

public IFuture<Void> setProperties(Properties props)

Update from given properties.

Specified by:

setProperties in interface IPropertiesProvider

getProperties

public IFuture<Properties> getProperties()

Write current state into properties.

Specified by:

getProperties in interface IPropertiesProvider

indexOfFilename

public static int indexOfFilename(String url,
                  List urlstrings)

Test if a file name is contained.

urlToFile

public static File urlToFile(String url)

Convert an URL to a file.

Returns:

null, if the URL is neither 'file:' nor 'jar:file:' URL and no path point to an existing file.