senselogic.sitevision.api.webresource

Interface FileUtil

@Requireable(value="FileUtil")
public interface FileUtil

File utility interface that handles nodes with primary node type sv:file.

Note! This interface is used to create files. You would typically use StructureUtil to move a file and TrashcanUtil to delete a file. To check MIME/Content-Type for a file you would typically use MimeTypeUtil.

An instance of the SiteVision class implementing this interface can be obtained via Utils.getFileUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

SiteVision 2.6.2

Author:

Mikael Wikblom

Method Summary

Modifier and Type	Method and Description
Node	createFile(Node aParent, String aFileName, String anUri) Adds a file to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder residing as sub node to a file repository.
void	createFiles(Node aParent, java.util.Map<String,String> aFileMappings) Adds several files to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder residing as sub node to a file repository.
String	getContentAsString(Node aFile) Gets the contents of a file as a String using the UTF-8 character encoding.
String	getContentAsString(Node aFile, String aCharacterEncoding) Gets the contents of a file as a String using a given character encoding.
void	updateBinaryContent(Node aFile, String anUri) Updates the binary content of an existing file.

Method Detail

createFiles

void createFiles(Node aParent,
                 java.util.Map<String,String> aFileMappings)
          throws ConstraintViolationException,
                 RepositoryException

Adds several files to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder residing as sub node to a file repository.

Files are specified by a map where the keys denotes the file names (will correspond to the property fileName of the sv:file nodes) and the values denotes the URIs pointing to the file resources. The file resources (i.e. the URIs) must be accessible from the SiteVision server. SiteVision opens a stream with the URI value when creating/uploading the binary content of the file. If a firewall or such blocks outgoing communication from the server - file creation will fail.

Permission note! Current user must be authorized to alter the parent node (e.g. PermissionUtil.Permission.WRITE).

A warning will be written to the system log if SiteVision for any reason is unable to create one of the files.

Parameters:

aParent - the parent node for the files

aFileMappings - a map of file name to URI pairs

Throws:

NullPointerException - if aParent or aFileMappings is null

ConstraintViolationException - if the user is not authorized to alter the parent node or if an invalid parent node is specified

RepositoryException - if something else goes wrong

createFile

Node createFile(Node aParent,
                String aFileName,
                String anUri)
         throws ConstraintViolationException,
                RepositoryException

Adds a file to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder residing as sub node to a file repository.

Permission note! Current user must be authorized to alter the parent node (e.g. PermissionUtil.Permission.WRITE).

URI note! The file resource must be accessible from the SiteVision server! SiteVision opens a stream to an URL with the anUri value when creating/uploading the binary content of the file. If a firewall or such blocks outgoing communication from the server - file creation will fail.

Parameters:

aParent - the parent node of the file

aFileName - the fileName property of the sv:file

anUri - the URI pointing to the file resource retrievable from the SiteVision server

Returns:

a sv:file node corresponding to the newly created file. Will never return null

Throws:

NullPointerException - if aParent, aFileName or anUri is null

ConstraintViolationException - if the user is not authorized to alter the parent node or if an invalid parent node is specified

RepositoryException - if something else goes wrong

updateBinaryContent

void updateBinaryContent(Node aFile,
                         String anUri)
                  throws ConstraintViolationException,
                         RepositoryException

Updates the binary content of an existing file.

Properties related to the binary content will also be updated (e.g. length). A new version will be created if the binary content of a group file is updated.

URI note! The URI must be accessible from the SiteVision server and the ending part of the URI must match the file extension of the existing file that should be updated! SiteVision opens a stream to an URL with the anUri value when uploading the binary content of the file. If a firewall or such blocks outgoing communication from the server - file update will fail.

Permission note! Current user must be authorized to alter the file node that should be updated (e.g. PermissionUtil.Permission.WRITE).

Parameters:

aFile - the file

anUri - the URI pointing to the file resource to fetch new binary content from

Throws:

ConstraintViolationException - if the user is not authorized to alter the file node, if an invalid node is specified or if the end part of anUri doesn't match the file extension of aFile

RepositoryException - if something else goes wrong

Since:

SiteVision 3.6.3

getContentAsString

String getContentAsString(Node aFile)

Gets the contents of a file as a String using the UTF-8 character encoding.

Note! This is mere a convenience method for getContentAsString(Node, String) using UTF-8 as character encoding.

Parameters:

aFile - the file

Returns:

the UTF-8 file content, or null if aFile isn't a character-based file

Since:

SiteVision 4.1.1

See Also:

getContentAsString(Node, String)

getContentAsString

String getContentAsString(Node aFile,
                          String aCharacterEncoding)

Gets the contents of a file as a String using a given character encoding.

Note! This method operates on character-based file nodes only! That is:

• Files that are of text type (as of MimeTypeUtil.isTextType(String)).
• Files that are of xml type (as of MimeTypeUtil.isXmlType(String)).
• Common "cross-over/mixed-types" files, such as json (application type) and svg (image type).

Parameters:

aFile - the file

aCharacterEncoding - the character encoding (Note! UTF-8 will be used instead for null, empty and illegal/unsupported encoding)

Returns:

the file content using the specified character encoding, or null if aFile isn't a character-based file

Since:

SiteVision 4.1.1