Package org.mapfish.print.servlet.fileloader

Class ClasspathConfigFileLoader

java.lang.Object

org.mapfish.print.servlet.fileloader.ClasspathConfigFileLoader

All Implemented Interfaces:

ConfigFileLoaderPlugin

public final class ClasspathConfigFileLoader
extends Object
implements ConfigFileLoaderPlugin

A plugin that loads the config resources from urls starting with prefix: "classpath"://.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX
static final int	PREFIX_LENGTH

Constructor Summary

Constructors

Constructor	Description
ClasspathConfigFileLoader()

Method Summary

Modifier and Type	Method	Description
String	getUriScheme()	Returns the URI scheme that this loader supports.
boolean	isAccessible(URI fileURI)	Check if the configuration File exists.
boolean	isAccessible(URI configFileUri, String pathToSubResource)	check if the file exists and can be accessed by the user/template/config/etc...
Optional<Long>	lastModified(URI fileURI)	return the last modified time of the file URI.
byte[]	loadFile(URI fileURI)	Load the config data.
byte[]	loadFile(URI configFileUri, String pathToSubResource)	Load the file related to the configuration file.
Optional<File>	toFile(URI fileUri)	Return the file object the uri refers to if it refers to a file.
Optional<File>	toFile(URI configFileUri, String pathToSubResource)	Return the file object the uri refers to if it refers to a file.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

PREFIX_LENGTH

public static final int PREFIX_LENGTH

Constructor Details

ClasspathConfigFileLoader

public ClasspathConfigFileLoader()

Method Details

toFile

public Optional<File> toFile(URI fileUri)

Description copied from interface: ConfigFileLoaderPlugin

Return the file object the uri refers to if it refers to a file. Otherwise Optional.absent().

Specified by:

toFile in interface ConfigFileLoaderPlugin

Parameters:

fileUri - the uri to use to resolve to a file (or not).

getUriScheme

public String getUriScheme()

Description copied from interface: ConfigFileLoaderPlugin

Returns the URI scheme that this loader supports.

Specified by:

getUriScheme in interface ConfigFileLoaderPlugin

lastModified

public Optional<Long> lastModified(URI fileURI)

Description copied from interface: ConfigFileLoaderPlugin

return the last modified time of the file URI.

Specified by:

lastModified in interface ConfigFileLoaderPlugin

Parameters:

fileURI - the uri of the config file to load.

Returns:

return the last modified date of the file

isAccessible

public boolean isAccessible(URI fileURI)

Description copied from interface: ConfigFileLoaderPlugin

Check if the configuration File exists.

Specified by:

isAccessible in interface ConfigFileLoaderPlugin

Parameters:

fileURI - the uri of the file to load.

loadFile

public byte[] loadFile(URI fileURI)
                throws IOException

Description copied from interface: ConfigFileLoaderPlugin

Load the config data.

Specified by:

loadFile in interface ConfigFileLoaderPlugin

Parameters:

fileURI - the uri of the config file to load.

Returns:

the file that make up the file.

Throws:

IOException

toFile

public Optional<File> toFile(URI configFileUri,
 String pathToSubResource)

Description copied from interface: ConfigFileLoaderPlugin

Return the file object the uri refers to if it refers to a file. Otherwise Optional.absent().

Specified by:

toFile in interface ConfigFileLoaderPlugin

Parameters:

configFileUri - the uri of the configuration file

pathToSubResource - a string representing a file that is accessible for use in printing templates within the configuration file. In the case of a file based URI the path could be a relative path (relative to the configuration file) or an absolute path, but it must be an allowed file (you can't allow access to any file on the file system).

isAccessible

public boolean isAccessible(URI configFileUri,
 String pathToSubResource)

Description copied from interface: ConfigFileLoaderPlugin

check if the file exists and can be accessed by the user/template/config/etc...

Specified by:

isAccessible in interface ConfigFileLoaderPlugin

Parameters:

configFileUri - the uri of the configuration file

pathToSubResource - a string representing a file that is accessible for use in printing templates within the configuration file. In the case of a file based URI the path could be a relative path (relative to the configuration file) or an absolute path, but it must be an allowed file (you can't allow access to any file on the file system).

loadFile

public byte[] loadFile(URI configFileUri,
 String pathToSubResource)
                throws IOException

Description copied from interface: ConfigFileLoaderPlugin

Load the file related to the configuration file.

Specified by:

loadFile in interface ConfigFileLoaderPlugin

Parameters:

configFileUri - the uri of the configuration file

pathToSubResource - a string representing a file that is accessible for use in printing templates within the configuration file. In the case of a file based URI the path could be a relative path (relative to the configuration file) or an absolute path, but it must be an allowed file (you can't allow access to any file on the file system).

Throws:

IOException