com.broadleafcommerce.data.tracking.core.mapping.cache

Class DefaultResourceProvider

java.lang.Object

com.broadleafcommerce.data.tracking.core.mapping.cache.DefaultResourceProvider

All Implemented Interfaces:

ResourceProvider

public class DefaultResourceProvider
extends Object
implements ResourceProvider

Default implementation of ResourceProvider.

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor and Description
DefaultResourceProvider()

Method Summary

Modifier and Type	Method and Description
void	clear() Delete all files in the filesystem at the location described in ResourceProvider.targetOut(String)
boolean	contains(String fileName) Whether or not the filesystem contains the file at the destination described in ResourceProvider.targetOut(String)
protected File	determineCacheResourceDir()
boolean	resourceAvailable(String fileName) Whether or not the classpath contains the resource at the destination described in ResourceProvider.targetIn(String)
InputStream	targetIn(String fileName) For the filename, provide an InputStream from which to read the file.
OutputStream	targetOut(String fileName) For the filename, provide a OutputStream to write the file to.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceProvider

public DefaultResourceProvider()

Method Detail

targetOut

public OutputStream targetOut(String fileName)

Description copied from interface: ResourceProvider

For the filename, provide a OutputStream to write the file to. Generally, this is a File in the maven resources/cache directory of the current application.

Specified by:

targetOut in interface ResourceProvider

Parameters:

fileName - The name of the file to write

Returns:

the OutputStream to write the file to

targetIn

public InputStream targetIn(String fileName)

Description copied from interface: ResourceProvider

For the filename, provide an InputStream from which to read the file. Generally, this is a resource on the classpath of the application in resources/cache.

Specified by:

targetIn in interface ResourceProvider

Parameters:

fileName - The name of the resource to fetch

Returns:

The InputStream from which to read the resource

resourceAvailable

public boolean resourceAvailable(String fileName)

Description copied from interface: ResourceProvider

Whether or not the classpath contains the resource at the destination described in ResourceProvider.targetIn(String)

Specified by:

resourceAvailable in interface ResourceProvider

Parameters:

fileName - The name of the resource to check

Returns:

Whether or not the classpath contains the resource

contains

public boolean contains(String fileName)

Description copied from interface: ResourceProvider

Whether or not the filesystem contains the file at the destination described in ResourceProvider.targetOut(String)

Specified by:

contains in interface ResourceProvider

Parameters:

fileName - The name of the file to check

Returns:

Whether or not the filesystem contains the file

clear

public void clear()

Description copied from interface: ResourceProvider

Delete all files in the filesystem at the location described in ResourceProvider.targetOut(String)

Specified by:

clear in interface ResourceProvider

determineCacheResourceDir

protected File determineCacheResourceDir()