org.apache.excalibur.source.impl

Class SourceResolverImpl

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.excalibur.source.impl.SourceResolverImpl

All Implemented Interfaces:

org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.thread.ThreadSafe, SourceResolver

public class SourceResolverImpl
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.activity.Disposable, SourceResolver, org.apache.avalon.framework.thread.ThreadSafe

This is the default implemenation of a SourceResolver. The source resolving is done relative to a base directory/URI (if the given location is relative). This implementation looks for the base URI in the Context object of the "container" for the "context-root" information. This information can either be a File object or a URL object. If the entry does not exist, the system property "user.dir" is used as the base URI instead.

Version:

$Id: SourceResolverImpl.java,v 1.4 2004/02/28 11:47:24 cziegeler Exp $

Author:

Avalon Development Team

See Also:

SourceResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URL	m_baseURL The base URL
protected org.apache.avalon.framework.service.ServiceSelector	m_factorySelector The special Source factories
protected org.apache.avalon.framework.service.ServiceManager	m_manager The component m_manager

Fields inherited from interface org.apache.excalibur.source.SourceResolver

METHOD, ROLE, URI_ENCODING, URI_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
SourceResolverImpl()

Method Summary

Methods

Modifier and Type	Method and Description
private java.lang.String	absolutize(SourceFactory factory, java.lang.String baseURI, java.lang.String systemID) Makes an absolute URI based on a baseURI and a relative URI.
void	contextualize(org.apache.avalon.framework.context.Context context) Get the context
void	dispose()
void	release(Source source) Releases a resolved resource
Source	resolveURI(java.lang.String location) Get a Source object.
Source	resolveURI(java.lang.String location, java.lang.String baseURI, java.util.Map parameters) Get a Source object.
void	service(org.apache.avalon.framework.service.ServiceManager manager) Set the current ComponentLocator instance used by this Composable.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

m_manager

protected org.apache.avalon.framework.service.ServiceManager m_manager

The component m_manager

m_factorySelector

protected org.apache.avalon.framework.service.ServiceSelector m_factorySelector

The special Source factories

m_baseURL

protected java.net.URL m_baseURL

The base URL

Constructor Detail

SourceResolverImpl

public SourceResolverImpl()

Method Detail

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)
                   throws org.apache.avalon.framework.context.ContextException

Get the context

Specified by:

contextualize in interface org.apache.avalon.framework.context.Contextualizable

Throws:

org.apache.avalon.framework.context.ContextException

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
             throws org.apache.avalon.framework.service.ServiceException

Set the current ComponentLocator instance used by this Composable.

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Throws:

org.apache.avalon.framework.service.ServiceException

dispose

public void dispose()

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

resolveURI

public Source resolveURI(java.lang.String location)
                  throws java.net.MalformedURLException,
                         java.io.IOException,
                         SourceException

Get a Source object.

Specified by:

resolveURI in interface SourceResolver

Returns:

the resolved source object.

Throws:

SourceNotFoundException - if the source cannot be found

java.net.MalformedURLException - if location is malformed.

java.io.IOException - if the source couldn't be created for some other reason.

SourceException

resolveURI

public Source resolveURI(java.lang.String location,
                java.lang.String baseURI,
                java.util.Map parameters)
                  throws java.net.MalformedURLException,
                         java.io.IOException,
                         SourceException

Get a Source object.

Specified by:

resolveURI in interface SourceResolver

Parameters:

location - - the URI to resolve. If this is relative it is either resolved relative to the base parameter (if not null) or relative to a base setting of the source resolver itself.

baseURI - - a base URI for resolving relative locations. This is optional and can be null.

parameters - - Additional parameters for the URI. The parameters are specific to the used scheme.

Returns:

the resolved source object.

Throws:

SourceNotFoundException - if the source cannot be found

java.net.MalformedURLException - if location is malformed.

java.io.IOException - if the source couldn't be created for some other reason.

SourceException

absolutize

private java.lang.String absolutize(SourceFactory factory,
                          java.lang.String baseURI,
                          java.lang.String systemID)

Makes an absolute URI based on a baseURI and a relative URI.

release

public void release(Source source)

Releases a resolved resource

Specified by:

release in interface SourceResolver

Parameters:

source - the source to release