Package crypto.cryslhandler

Class CrySLModelReader

java.lang.Object

crypto.cryslhandler.CrySLModelReader

public class CrySLModelReader
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	cryslFileEnding

Constructor Summary

Constructors

Constructor	Description
CrySLModelReader()	Creates a CrySLModelReader which creates rules from classes on the runtime's classpath.
CrySLModelReader(CrySLModelReaderClassPath classPath)	Creates a CrySLModelReader which creates rules from classes on the runtime's classpath and a given virtual classpath.

Method Summary

Modifier and Type	Method	Description
static String	filterQuotes(String dirty)
CrySLRule	readRule(File ruleFile)	Reads the content of a CrySL file and returns a CrySLRule object.
CrySLRule	readRule(InputStream stream, String virtualFileName)	Reads the content of a CrySL file from an InputStream, afterwards the CrySLRule will be created.
List<CrySLRule>	readRulesFromFiles(List<File> files)	Read the crysl rules from all given files.

Methods inherited from class java.lang.Object

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

Field Detail

cryslFileEnding

public static final String cryslFileEnding

See Also:

Constant Field Values

Constructor Detail

CrySLModelReader

public CrySLModelReader()

Creates a CrySLModelReader which creates rules from classes on the runtime's classpath.

CrySLModelReader

public CrySLModelReader(CrySLModelReaderClassPath classPath)

Creates a CrySLModelReader which creates rules from classes on the runtime's classpath and a given virtual classpath.

Parameters:

classPath - Contains additional classpath elements which are not present on the current runtime's classpath.

Method Detail

readRulesFromFiles

public List<CrySLRule> readRulesFromFiles(List<File> files)
                                   throws CryptoAnalysisException

Read the crysl rules from all given files.

Parameters:

files - a list of files to read from

Returns:

the list with the parsed CrySLRules

Throws:

CryptoAnalysisException - If a file cannot be read or there is a problem with a rule

readRule

public CrySLRule readRule(InputStream stream,
                          String virtualFileName)
                   throws IllegalArgumentException,
                          IOException,
                          CryptoAnalysisException

Reads the content of a CrySL file from an InputStream, afterwards the CrySLRule will be created.

Parameters:

stream - the InputStream holds the CrySL file content

virtualFileName - the name needs following structure [HexHashedAbsoluteZipFilePath][SystemFileSeparator][ZipEntryName]

Returns:

the CrySLRule

Throws:

IllegalArgumentException - If the file for the rule cannot be found

IOException - If there is a problem with reading the file

CryptoAnalysisException - If the file is not a .crysl file

readRule

public CrySLRule readRule(File ruleFile)
                   throws CryptoAnalysisException

Reads the content of a CrySL file and returns a CrySLRule object.

Parameters:

ruleFile - the CrySL file

Returns:

the CrySLRule object

Throws:

CryptoAnalysisException - If the file is not a .crysl file

filterQuotes

public static String filterQuotes(String dirty)