com.exlibris.dps.sdk.risks

Interface RiskExtractor

public interface RiskExtractor

Interface for risk extractors
This plugin interface only supports java implementation.

The risk analysis framework calls the init() function once for each registered RiskExtractor. The isAtRisk functions should be thread-safe. Currently the RiskExtractorResult class holds only atRisk boolean attributes.

Author:

tsachm

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String paramKey) This function is usually called by the isAtRisk method.
void	init(java.util.Map<java.lang.String,java.lang.String> initParameters) Initialization function - called once, should implement specific initialization tasks.
boolean	isAtRisk(DnxDocument dnxDocument, java.lang.String pathToFile) Check if a given file is at risk.

Method Detail

init

void init(java.util.Map<java.lang.String,java.lang.String> initParameters)
   throws java.lang.Exception

Initialization function - called once, should implement specific initialization tasks.

Parameters:

initParameters - Initialization parameters for the risk extraction tool.

Throws:

java.lang.Exception

getParameter

java.lang.String getParameter(java.lang.String paramKey)

This function is usually called by the isAtRisk method.

Parameters:

paramKey -

Returns:

The parameter value or null if the parameter was not found.

isAtRisk

boolean isAtRisk(DnxDocument dnxDocument,
                 java.lang.String pathToFile)
          throws java.lang.Exception

Check if a given file is at risk.

Parameters:

dnxDocument - The DNX document of the file that should be checked.

pathToFile - - The absolute path to the file that needs to be checked.

Returns:

true if the risk exists, otherwise false.

Throws:

java.lang.Exception