org.whitesource.agent.report

Class PolicyCheckReport

java.lang.Object

org.whitesource.agent.report.PolicyCheckReport

public class PolicyCheckReport
extends Object

A report generator for policy check results.

Author:

Edo.Shor

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_POLICIES_JSON_FILE
static String	DATE_FORMAT
static String	POLICY_REJECTION_SUMMARY_FILE
static String	REJECT

Constructor Summary

Constructors

Constructor and Description
PolicyCheckReport(BaseCheckPoliciesResult result) Constructor
PolicyCheckReport(BaseCheckPoliciesResult result, String buildName, String buildNumber) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	copyReportResources(File workDir) Copy required resources for the report.
protected org.apache.velocity.VelocityContext	createTemplateContext() Create the context holding all the information of the report.
protected org.apache.velocity.app.VelocityEngine	createTemplateEngine(Properties properties) Create and initialize a template engine to use for generating reports.
File	generate(File outputDir, boolean pack) The method generate the policy check report
File	generate(File outputDir, boolean pack, Properties properties) The method generate the policy check report
File	generateJson(File outputDir)
String	getBuildName()
String	getBuildNumber()
BaseCheckPoliciesResult	getResult()
void	setBuildName(String buildName)
void	setBuildNumber(String buildNumber)
void	setResult(BaseCheckPoliciesResult result)
protected void	writeToFile(File file, String json)

Methods inherited from class java.lang.Object

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

Field Detail

REJECT

public static final String REJECT

See Also:

Constant Field Values

CHECK_POLICIES_JSON_FILE

public static final String CHECK_POLICIES_JSON_FILE

See Also:

Constant Field Values

POLICY_REJECTION_SUMMARY_FILE

public static final String POLICY_REJECTION_SUMMARY_FILE

See Also:

Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

PolicyCheckReport

public PolicyCheckReport(BaseCheckPoliciesResult result)

Constructor

Parameters:

result -

PolicyCheckReport

public PolicyCheckReport(BaseCheckPoliciesResult result,
                         String buildName,
                         String buildNumber)

Constructor

Parameters:

result - report

buildName - of the report

buildNumber - of the report

Method Detail

generate

public File generate(File outputDir,
                     boolean pack)
              throws IOException

The method generate the policy check report

Parameters:

outputDir - Directory where report files will be created.

pack - True to create a zip file from the resulting directory.

Returns:

File reference to the resulting report.

Throws:

IOException - In case of errors during report generation process.

generate

public File generate(File outputDir,
                     boolean pack,
                     Properties properties)
              throws IOException

The method generate the policy check report

Parameters:

outputDir - Directory where report files will be created.

pack - True to create a zip file from the resulting directory.

properties - Properties for template engine.

Returns:

File reference to the resulting report.

Throws:

IOException - In case of errors during report generation process.

generateJson

public File generateJson(File outputDir)
                  throws IOException

Throws:

IOException

createTemplateEngine

protected org.apache.velocity.app.VelocityEngine createTemplateEngine(Properties properties)

Create and initialize a template engine to use for generating reports.

Parameters:

properties - properties to use for engine initialization. May be null.

Returns:

A new instance of th template engine to use.

createTemplateContext

protected org.apache.velocity.VelocityContext createTemplateContext()

Create the context holding all the information of the report.

Returns:

the velocity context

copyReportResources

protected void copyReportResources(File workDir)
                            throws IOException

Copy required resources for the report.

Parameters:

workDir - Report work directory.

Throws:

IOException - exception5

writeToFile

protected void writeToFile(File file,
                           String json)
                    throws IOException

Throws:

IOException

getResult

public BaseCheckPoliciesResult getResult()

setResult

public void setResult(BaseCheckPoliciesResult result)

getBuildName

public String getBuildName()

setBuildName

public void setBuildName(String buildName)

getBuildNumber

public String getBuildNumber()

setBuildNumber

public void setBuildNumber(String buildNumber)