org.apache.avalon.excalibur.source
Interface SourceResolver

All Superinterfaces:
org.apache.avalon.framework.component.Component
All Known Implementing Classes:
SourceResolverImpl

public interface SourceResolver
extends org.apache.avalon.framework.component.Component

Base interface for resolving a source by system identifiers. Instead of using the java.net.URL classes which prevent you from adding your own custom protocols in a server environment, you should use this resolver for all URLs. The resolver creates for each source a Source object, which could then be asked for an InputStream etc. When the Source object is no longer needed it must be released using the resolver. This is very similar like looking up components from a ComponentManager. In fact a source object can implement most lifecycle interfaces like Composable, Initializable, Disposable etc.

Version:
CVS $Revision: 1.8 $ $Date: 2002/01/25 21:12:56 $
Author:
Carsten Ziegeler

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 void release(Source source)
          Releases a resolved resource
 Source resolve(java.lang.String location)
          Get a Source object.
 Source resolve(java.lang.String location, SourceParameters parameters)
          Get a Source object.
 Source resolve(java.net.URL base, java.lang.String location)
          Get a Source object.
 Source resolve(java.net.URL base, java.lang.String location, SourceParameters parameters)
          Get a Source object.
 

Field Detail

ROLE

public static final java.lang.String ROLE
Method Detail

resolve

public Source resolve(java.lang.String location)
               throws java.net.MalformedURLException,
                      java.io.IOException,
                      org.apache.avalon.framework.component.ComponentException
Get a Source object.

resolve

public Source resolve(java.net.URL base,
                      java.lang.String location)
               throws java.net.MalformedURLException,
                      java.io.IOException,
                      org.apache.avalon.framework.component.ComponentException
Get a Source object.

resolve

public Source resolve(java.lang.String location,
                      SourceParameters parameters)
               throws java.net.MalformedURLException,
                      java.io.IOException,
                      org.apache.avalon.framework.component.ComponentException
Get a Source object.

resolve

public Source resolve(java.net.URL base,
                      java.lang.String location,
                      SourceParameters parameters)
               throws java.net.MalformedURLException,
                      java.io.IOException,
                      org.apache.avalon.framework.component.ComponentException
Get a Source object.

release

public void release(Source source)
Releases a resolved resource


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.