Package io.wcm.devops.conga.generator.plugins.urlfile

Class FilesystemUrlFilePlugin

java.lang.Object

io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin

All Implemented Interfaces:

Plugin, UrlFilePlugin

public class FilesystemUrlFilePlugin
extends Object
implements UrlFilePlugin

Get file from local filesystem.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Plugin name

Constructor Summary

Constructors

Constructor	Description
FilesystemUrlFilePlugin()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String url, UrlFilePluginContext context)	Checks if the plugin can be applied to the given URL.
void	deleteFile(String url, UrlFilePluginContext context)	Delete file with given URL.
InputStream	getFile(String url, UrlFilePluginContext context)	Get binary data of external file.
String	getFileName(String url, UrlFilePluginContext context)	Get filename for external file.
URL	getFileUrl(String url, UrlFilePluginContext context)	Get URL to external file.
String	getName()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.wcm.devops.conga.generator.spi.UrlFilePlugin

getFileUrlsWithDependencies, getLocalFile, isLocalFile

Field Detail

NAME

public static final String NAME

Plugin name

See Also:

Constant Field Values

Constructor Detail

FilesystemUrlFilePlugin

public FilesystemUrlFilePlugin()

Method Detail

getName

public String getName()

Specified by:

getName in interface Plugin

Returns:

Plugin name to be referenced in definition file

accepts

public boolean accepts(String url,
                       UrlFilePluginContext context)

Description copied from interface: UrlFilePlugin

Checks if the plugin can be applied to the given URL.

Specified by:

accepts in interface UrlFilePlugin

Parameters:

url - URL string (including prefix)

context - Context objects

Returns:

true when the plugin can be applied to the given URL.

getFileName

public String getFileName(String url,
                          UrlFilePluginContext context)

Description copied from interface: UrlFilePlugin

Get filename for external file.

Specified by:

getFileName in interface UrlFilePlugin

Parameters:

url - URL string (including prefix)

context - Context objects

Returns:

Filename

getFile

public InputStream getFile(String url,
                           UrlFilePluginContext context)
                    throws IOException

Description copied from interface: UrlFilePlugin

Get binary data of external file.

Specified by:

getFile in interface UrlFilePlugin

Parameters:

url - URL string (including prefix)

context - Context objects

Returns:

Binary data

Throws:

IOException - If the access to the file failed

getFileUrl

public URL getFileUrl(String url,
                      UrlFilePluginContext context)
               throws IOException

Description copied from interface: UrlFilePlugin

Get URL to external file.

Specified by:

getFileUrl in interface UrlFilePlugin

Parameters:

url - URL string (including prefix)

context - Context objects

Returns:

URL to file

Throws:

IOException - If the access to the file failed

deleteFile

public void deleteFile(String url,
                       UrlFilePluginContext context)
                throws IOException

Description copied from interface: UrlFilePlugin

Delete file with given URL. This is only supported by few implementations of this interface - all other throw an UnsupportedOperationException.

Specified by:

deleteFile in interface UrlFilePlugin

Parameters:

url - URL string (including prefix)

context - Context objects

Throws:

IOException - If deleting the file is supported but failes for some reason