Package de.mid.innovator.m2msdk.util

Class FileAccess

java.lang.Object

de.mid.innovator.m2msdk.util.FileAccess

public class FileAccess
extends Object

Class reading and writing a file. It can access files from file system or from class path. It reads files from absolute paths or relative to the arguments file. It can retrieve the content of a file either as string, as stream or as document.

Version:

10.1.1

Author:

jmback

Constructor Summary

Constructors

Constructor	Description
FileAccess(SessionInterface iSession, File file)	Construct a file reader for a file name.
FileAccess(SessionInterface iSession, String iFilename, boolean bUseAlternativeLocations)	Construct a file reader for a file name.
FileAccess(SessionInterface iSession, String directoryName, String fileName)

Method Summary

Modifier and Type	Method	Description
boolean	exists()	Does the file exist?
org.jdom2.Document	getDocument()	Get document from file.
org.jdom2.Document	getDocument(boolean optional)	Get document from file.
String	getFileContent()	Get file content from file.
String	getFilename()	Get the file name of this file.
static String	getFilenameWithExtension(String sFilename, String extension)
FileWriter	getStringWriter()
static String	getTempDirectory(SessionInterface session)
void	setDirectory(String iDir)	Change the directory of the file without renaming the file.
void	setDocument(org.jdom2.Document iDocument)	Set content of document to file.
void	setFilecontent(String iFilecontent)	Set file content to file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FileAccess

public FileAccess(SessionInterface iSession,
 String iFilename,
 boolean bUseAlternativeLocations)

Construct a file reader for a file name.

Parameters:

iSession -

iFilename - path and file name

bUseAlternativeLocations - use alternative locations for file if not found on preferred location

FileAccess

public FileAccess(SessionInterface iSession,
 String directoryName,
 String fileName)
           throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

FileAccess

public FileAccess(SessionInterface iSession,
 File file)
           throws RemoteException,
M2MException

Construct a file reader for a file name.

Parameters:

iSession -

file - construction File instance for determine file name

Throws:

RemoteException

M2MException

Method Details

setDirectory

public void setDirectory(String iDir)

Change the directory of the file without renaming the file.

Parameters:

iDir - new directory for the file

getFilename

public String getFilename()

Get the file name of this file.

Returns:

The fully qualified path and file name.

exists

public boolean exists()

Does the file exist?

Returns:

true if the file exists

getFileContent

public String getFileContent()
                      throws SevereException,
RemoteException

Get file content from file.

Returns:

file content

Throws:

SevereException

RemoteException

getDocument

public org.jdom2.Document getDocument()
                               throws M2MException,
RemoteException

Get document from file.

Returns:

JDOM document if found, else an exception is thrown

Throws:

M2MException

AbortException

SevereException

RemoteException

getDocument

public org.jdom2.Document getDocument(boolean optional)
                               throws M2MException,
RemoteException

Get document from file.

Parameters:

optional - if true and document is not found, a null is returned if false and document is not found, an exception is thrown

Returns:

JDOM document if found

Throws:

M2MException

AbortException

SevereException

RemoteException

setDocument

public void setDocument(org.jdom2.Document iDocument)
                 throws SevereException,
RemoteException,
UncriticalException

Set content of document to file.

Parameters:

iDocument - JDOM document

Throws:

SevereException

RemoteException

UncriticalException

setFilecontent

public void setFilecontent(String iFilecontent)
                    throws SevereException,
RemoteException

Set file content to file.

Parameters:

iFilecontent - content of file

Throws:

SevereException

RemoteException

toString

public String toString()

Overrides:

toString in class Object

getTempDirectory

public static String getTempDirectory(SessionInterface session)
                               throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

getFilenameWithExtension

public static String getFilenameWithExtension(String sFilename,
 String extension)

getStringWriter

public FileWriter getStringWriter()
                           throws IOException

Throws:

IOException