Package org.codehaus.plexus.resource

Class DefaultResourceManager

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.resource.DefaultResourceManager

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled, ResourceManager

@Component(role=ResourceManager.class,
           instantiationStrategy="per-lookup")
public class DefaultResourceManager
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ResourceManager

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	outputDirectory
private java.util.Map<java.lang.String,ResourceLoader>	resourceLoaders

Fields inherited from interface org.codehaus.plexus.resource.ResourceManager

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultResourceManager()

Method Summary

Modifier and Type	Method	Description
void	addSearchPath(java.lang.String id, java.lang.String path)
void	createResourceAsFile(PlexusResource resource, java.io.File outputFile)	Downloads the resource to the given output file.
PlexusResource	getResource(java.lang.String name)	Searches for a resource with the given name.
java.io.File	getResourceAsFile(java.lang.String name)
java.io.File	getResourceAsFile(java.lang.String name, java.lang.String outputPath)
java.io.File	getResourceAsFile(PlexusResource resource)	Returns a file with the given resources contents.
java.io.InputStream	getResourceAsInputStream(java.lang.String name)
java.io.File	resolveLocation(java.lang.String name)	Provides compatibility with the Locator utility used by several Maven Plugins.
java.io.File	resolveLocation(java.lang.String name, java.lang.String outputPath)	Provides compatibility with the Locator utility used by several Maven Plugins.
void	setOutputDirectory(java.io.File outputDirectory)

Methods inherited from class org.codehaus.plexus.logging.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

resourceLoaders

@Requirement(role=ResourceLoader.class)
private java.util.Map<java.lang.String,ResourceLoader> resourceLoaders

outputDirectory

private java.io.File outputDirectory

Constructor Detail

DefaultResourceManager

public DefaultResourceManager()

Method Detail

getResourceAsInputStream

public java.io.InputStream getResourceAsInputStream(java.lang.String name)
                                             throws ResourceNotFoundException

Specified by:

getResourceAsInputStream in interface ResourceManager

Throws:

ResourceNotFoundException

getResourceAsFile

public java.io.File getResourceAsFile(java.lang.String name)
                               throws ResourceNotFoundException,
                                      FileResourceCreationException

Specified by:

getResourceAsFile in interface ResourceManager

Throws:

ResourceNotFoundException

FileResourceCreationException

getResourceAsFile

public java.io.File getResourceAsFile(java.lang.String name,
                                      java.lang.String outputPath)
                               throws ResourceNotFoundException,
                                      FileResourceCreationException

Specified by:

getResourceAsFile in interface ResourceManager

Throws:

ResourceNotFoundException

FileResourceCreationException

resolveLocation

public java.io.File resolveLocation(java.lang.String name,
                                    java.lang.String outputPath)
                             throws java.io.IOException

Description copied from interface: ResourceManager

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

Specified by:

resolveLocation in interface ResourceManager

Throws:

java.io.IOException

resolveLocation

public java.io.File resolveLocation(java.lang.String name)
                             throws java.io.IOException

Description copied from interface: ResourceManager

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

Specified by:

resolveLocation in interface ResourceManager

Throws:

java.io.IOException

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

Specified by:

setOutputDirectory in interface ResourceManager

addSearchPath

public void addSearchPath(java.lang.String id,
                          java.lang.String path)

Specified by:

addSearchPath in interface ResourceManager

getResource

public PlexusResource getResource(java.lang.String name)
                           throws ResourceNotFoundException

Description copied from interface: ResourceManager

Searches for a resource with the given name.

Specified by:

getResource in interface ResourceManager

Throws:

ResourceNotFoundException

getResourceAsFile

public java.io.File getResourceAsFile(PlexusResource resource)
                               throws FileResourceCreationException

Description copied from interface: ResourceManager

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.

Specified by:

getResourceAsFile in interface ResourceManager

Throws:

FileResourceCreationException

createResourceAsFile

public void createResourceAsFile(PlexusResource resource,
                                 java.io.File outputFile)
                          throws FileResourceCreationException

Description copied from interface: ResourceManager

Downloads the resource to the given output file.

Specified by:

createResourceAsFile in interface ResourceManager

Throws:

FileResourceCreationException