org.apache.cocoon.components.source
Interface SourceHandler

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

SourceHandlerImpl

public interface SourceHandler

extends org.apache.avalon.framework.component.Component

Version:

$Id: SourceHandler.java,v 1.3 2002/02/22 07:00:13 cziegeler Exp $

Author:

Carsten Ziegeler

Field Summary

static java.lang.String

ROLE

Method Summary

void	addFactory(java.lang.String protocol, SourceFactory factory) Add a new source factory.
Source	getSource(Environment environment, java.lang.String location) Get a Source object.
Source	getSource(Environment environment, java.net.URL base, java.lang.String location) Get a Source object.

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

getSource

public Source getSource(Environment environment,
                        java.lang.String location)
                 throws ProcessingException,
                        java.net.MalformedURLException,
                        java.io.IOException

Get a Source object.

Parameters:

environment - This is optional.

getSource

public Source getSource(Environment environment,
                        java.net.URL base,
                        java.lang.String location)
                 throws ProcessingException,
                        java.net.MalformedURLException,
                        java.io.IOException

Get a Source object.

Parameters:

environment - This is optional.

addFactory

public void addFactory(java.lang.String protocol,
                       SourceFactory factory)
                throws ProcessingException

Add a new source factory. The factory is initialized by the handler, this means the handler test for the Avalon interfaces Composable, Contextualizable and Loggable. When the handler is disposed it should also test the Disposable interface. If a factory with the protocol already exists it is overridden by this new factory.