Package com.seclore.fs.helper.core

Class ProtectedFile

java.lang.Object

com.seclore.fs.helper.core.ProtectedFile

public class ProtectedFile
extends Object

This class represents protected file.

Constructor Summary

Constructors

Constructor	Description
ProtectedFile(String pFileId, String pFilePath)	Constructor to initialize this class.
ProtectedFile(String pFileId, String pFilePath, String pHtmlCustomMetaData)	Constructor to initialize this class.

Method Summary

Modifier and Type	Method	Description
String	getFileId()	This method returns the file identifier of the protected file.
String	getFilePath()	This method returns the path of the protected file or wrapped file.
String	getHtmlCustomMetaData()
void	setHtmlCustomMetaData(String pHtmlCustomMetaData)

Methods inherited from class java.lang.Object

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

Constructor Details

ProtectedFile

public ProtectedFile(String pFileId,
 String pFilePath)

Constructor to initialize this class.

Parameters:

pFileId - : ID of the protected file.

pFilePath - : Path of the protected file or HTML wrapped file.

ProtectedFile

public ProtectedFile(String pFileId,
 String pFilePath,
 String pHtmlCustomMetaData)

Constructor to initialize this class.

Parameters:

pFileId - : ID of the protected file.

pFilePath - : Path of the protected file or HTML wrapped file.

pHtmlCustomMetaData - : Any Metadata to be stored in HTML wrapped file.

Method Details

getFileId

public String getFileId()

This method returns the file identifier of the protected file.

Returns:

: The File Identifier for the protected file.

getFilePath

public String getFilePath()

This method returns the path of the protected file or wrapped file.

Note - In case of protectAndWrap() and wrap() methods, file path is HTML wrapped file. In case of unwrap() method file path is protected file.

Returns:

: File Path.

getHtmlCustomMetaData

public String getHtmlCustomMetaData()

setHtmlCustomMetaData

public void setHtmlCustomMetaData(String pHtmlCustomMetaData)