Package org.codehaus.plexus.resource

Interface ResourceManager

All Known Implementing Classes:

DefaultResourceManager

public interface ResourceManager

Version:

$Id$

Author:

Trygve Laugstøl, Jason van Zyl

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE

Method Summary

Modifier and Type	Method	Description
void	addSearchPath(String resourceLoaderId, String searchPath)
void	createResourceAsFile(PlexusResource resource, File outputFile)	Downloads the resource to the given output file.
PlexusResource	getResource(String name)	Searches for a resource with the given name.
File	getResourceAsFile(String name)
File	getResourceAsFile(String name, String outputFile)
File	getResourceAsFile(PlexusResource resource)	Returns a file with the given resources contents.
InputStream	getResourceAsInputStream(String name)
File	resolveLocation(String location)	Deprecated.
File	resolveLocation(String location, String localfile)	Deprecated.
void	setOutputDirectory(File outputDirectory)

Field Detail

ROLE

static final String ROLE

Method Detail

getResourceAsInputStream

InputStream getResourceAsInputStream(String name)
                              throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getResourceAsFile

File getResourceAsFile(String name)
                throws ResourceNotFoundException,
                       FileResourceCreationException

Throws:

ResourceNotFoundException

FileResourceCreationException

getResourceAsFile

File getResourceAsFile(String name,
                       String outputFile)
                throws ResourceNotFoundException,
                       FileResourceCreationException

Throws:

ResourceNotFoundException

FileResourceCreationException

setOutputDirectory

void setOutputDirectory(File outputDirectory)

addSearchPath

void addSearchPath(String resourceLoaderId,
                   String searchPath)

resolveLocation

File resolveLocation(String location,
                     String localfile)
              throws IOException

Deprecated.

Provides compatibility with the Locator utility used by several Maven Plugins.

Throws:

IOException

resolveLocation

File resolveLocation(String location)
              throws IOException

Deprecated.

Provides compatibility with the Locator utility used by several Maven Plugins.

Throws:

IOException

getResource

PlexusResource getResource(String name)
                    throws ResourceNotFoundException

Searches for a resource with the given name.

Throws:

ResourceNotFoundException

Since:

1.0-alpha-5

getResourceAsFile

File getResourceAsFile(PlexusResource resource)
                throws FileResourceCreationException

Returns a file with the given resources contents. If the resource is already available as a file, returns that file. Otherwise, a file in the resource managers output directory is created and the resource is downloaded to that file.

Throws:

FileResourceCreationException

Since:

1.0-alpha-5

createResourceAsFile

void createResourceAsFile(PlexusResource resource,
                          File outputFile)
                   throws FileResourceCreationException

Downloads the resource to the given output file.

Throws:

FileResourceCreationException

Since:

1.0-alpha-5