Package crypto.analysis

Class CrySLRulesetSelector

java.lang.Object

crypto.analysis.CrySLRulesetSelector

public class CrySLRulesetSelector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrySLRulesetSelector.RuleFormat	the supported rule formats
static class	CrySLRulesetSelector.Ruleset	current RuleSets

Constructor Summary

Constructors

Constructor	Description
CrySLRulesetSelector()

Method Summary

Modifier and Type	Method	Description
static List<CrySLRule>	makeFromPath(File resourcesPath, CrySLRulesetSelector.RuleFormat ruleFormat)	Deprecated.
static List<CrySLRule>	makeFromRuleset(String rulesBasePath, CrySLRulesetSelector.RuleFormat ruleFormat, CrySLRulesetSelector.Ruleset... set)	Creates CrySLRule objects for the given RuleSet argument and returns them as List.
static List<CrySLRule>	makeFromRulesetString(String rulesBasePath, CrySLRulesetSelector.RuleFormat ruleFormat, String rulesetString)	Computes the ruleset from a string.
static List<CrySLRule>	makeFromZip(File resourcesPath)	Deprecated.
static CrySLRule	makeSingleRule(String rulesBasePath, CrySLRulesetSelector.RuleFormat ruleFormat, CrySLRulesetSelector.Ruleset ruleset, String rulename)	Creates and returns a single CrySLRule object for the given RuleSet argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrySLRulesetSelector

public CrySLRulesetSelector()

Method Detail

makeFromRuleset

public static List<CrySLRule> makeFromRuleset(String rulesBasePath,
                                              CrySLRulesetSelector.RuleFormat ruleFormat,
                                              CrySLRulesetSelector.Ruleset... set)
                                       throws CryptoAnalysisException

Creates CrySLRule objects for the given RuleSet argument and returns them as List.

Parameters:

rulesBasePath - a String path giving the location of the CrySL ruleset base folder

ruleFormat - the file extension of the CrySL files

set - the CrySLRulesetSelector.Ruleset for which the CrySLRule objects should be created for

Returns:

the List with CrySLRule objects

Throws:

CryptoAnalysisException - If there is an error reading a ruleset

makeFromRulesetString

public static List<CrySLRule> makeFromRulesetString(String rulesBasePath,
                                                    CrySLRulesetSelector.RuleFormat ruleFormat,
                                                    String rulesetString)
                                             throws CryptoAnalysisException

Computes the ruleset from a string.

Parameters:

rulesBasePath - a String path giving the location of the CrySL ruleset base folder

ruleFormat - the file extension of the CrySL file

rulesetString - String

Returns:

a list of the rules from the ruleset

Throws:

CryptoAnalysisException - If there is no ruleset

makeSingleRule

public static CrySLRule makeSingleRule(String rulesBasePath,
                                       CrySLRulesetSelector.RuleFormat ruleFormat,
                                       CrySLRulesetSelector.Ruleset ruleset,
                                       String rulename)
                                throws CryptoAnalysisException

Creates and returns a single CrySLRule object for the given RuleSet argument.

Parameters:

rulesBasePath - a String path giving the location of the CrySL ruleset base folder

ruleFormat - the file extension of the CrySL file

ruleset - the CrySLRulesetSelector.Ruleset where the rule belongs to

rulename - the name of the rule

Returns:

the CrySLRule object

Throws:

CryptoAnalysisException - If the rule cannot be found

makeFromPath

@Deprecated
public static List<CrySLRule> makeFromPath(File resourcesPath,
                                           CrySLRulesetSelector.RuleFormat ruleFormat)
                                    throws CryptoAnalysisException

Deprecated.

Creates the CrySLRule objects for the given File argument and returns them as List.

Parameters:

resourcesPath - a File with the path giving the location of the CrySL file folder

ruleFormat - the CrySLRulesetSelector.Ruleset where the rules belongs to

Returns:

the List with CrySLRule objects. If no rules are found it returns an empty list.

Throws:

CryptoAnalysisException - Throws when a file could not get processed to a CrySLRule

makeFromZip

@Deprecated
public static List<CrySLRule> makeFromZip(File resourcesPath)
                                   throws CryptoAnalysisException

Deprecated.

Creates CrySLRule objects from a Zip file and returns them as List.

Parameters:

resourcesPath - the Zip File which contains the CrySL files

Returns:

the List with CrySLRule objects from the Zip file. If no rules are found it returns an empty list.

Throws:

CryptoAnalysisException - Throws when a file could not get processed to a CrySLRule