Package org.frankframework.core

Class Resource

java.lang.Object

org.frankframework.core.Resource

All Implemented Interfaces:

IScopeProvider

Direct Known Subclasses:

BytesResource, URLResource

public abstract class Resource
extends Object
implements IScopeProvider

Reference to a resource, for instance on the classpath. Can be accessed multiple times.

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Resource.GlobalScopeProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected IScopeProvider	scopeProvider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Resource(IScopeProvider scopeProvider)

Method Summary

Modifier and Type	Method	Description
InputSource	asInputSource()
Source	asSource()
org.apache.xerces.xni.parser.XMLInputSource	asXMLInputSource()
final ClassLoader	getConfigurationClassLoader()	This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
String	getName()
static Resource	getResource(String resource)
static Resource	getResource(IScopeProvider scopeProvider, String resource)
static Resource	getResource(IScopeProvider scopeProvider, String resource, String allowedProtocols)
abstract String	getSystemId()
abstract InputStream	openStream()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

scopeProvider

protected IScopeProvider scopeProvider

Constructor Details

Resource

protected Resource(IScopeProvider scopeProvider)

Method Details

getResource

@Nullable
public static Resource getResource(@Nonnull
 String resource)

getResource

@Nullable
public static Resource getResource(@Nullable
 IScopeProvider scopeProvider,
 @Nonnull
 String resource)

getResource

@Nullable
public static Resource getResource(@Nullable
 IScopeProvider scopeProvider,
 @Nonnull
 String resource,
 String allowedProtocols)

getName

public String getName()

Returns:

Name of the resource

asSource

public Source asSource()
                throws SAXException,
IOException

Throws:

SAXException

IOException

asInputSource

public InputSource asInputSource()
                          throws IOException

Throws:

IOException

asXMLInputSource

public org.apache.xerces.xni.parser.XMLInputSource asXMLInputSource()
                                                             throws IOException

Throws:

IOException

getSystemId

public abstract String getSystemId()

Returns:

Canonical path of the resource

openStream

public abstract InputStream openStream()
                                throws IOException

Throws:

IOException

getConfigurationClassLoader

public final ClassLoader getConfigurationClassLoader()

Description copied from interface: IScopeProvider

This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.

Specified by:

getConfigurationClassLoader in interface IScopeProvider

Returns:

returns the ClassLoader created by the ClassLoaderManager.

toString

public String toString()

Overrides:

toString in class Object