com.lingoport.api

Class GlobalyzerAPI

java.lang.Object

com.lingoport.api.GlobalyzerAPI

public class GlobalyzerAPI
extends java.lang.Object

The GlobalyzerAPI class provides an API used by Lite and Java programs.

Method Summary

Modifier and Type	Method and Description
static void	closeDatabaseConnection() Closes the database - must be called before your program exits if NOT using an in-memory db.
static void	createProject(java.lang.String projectName, java.lang.String projectPath) Creates a new Globalyzer project.
static void	createProjectScans(java.lang.String projectName, java.lang.String regex) Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex
static java.lang.String[]	createProjectScans(java.lang.String projectName, java.lang.String regex, GlobalyzerAPIScanDetails details) Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex
static java.lang.String[]	createProjectScans(java.lang.String projectName, java.lang.String regex, java.lang.String[] scanItems) Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex
static java.lang.String	createScan(java.lang.String projectName, java.lang.String scanName, java.lang.String ruleSetName, java.lang.String ruleSetOwner) Deprecated. Use createScanWithInfo instead
static java.lang.String[]	createScan(java.lang.String projectName, java.lang.String scanName, java.lang.String ruleSetName, java.lang.String ruleSetOwner, GlobalyzerAPIScanDetails details) Deprecated. Use createScanWithInfo instead
static java.lang.String[]	createScan(java.lang.String projectName, java.lang.String scanName, java.lang.String ruleSetName, java.lang.String ruleSetOwner, java.lang.String[] scanItems) Deprecated. Use createScanWithInfo instead
static java.lang.Object[]	createScanWithInfo(java.lang.String projectName, java.lang.String scanName, java.lang.String ruleSetName, java.lang.String ruleSetOwner, GlobalyzerAPIScanDetails details) Create a scan for the Globalyzer project.
static void	deleteProject(java.lang.String projectName) Deletes a Globalyzer project.
static void	deleteScan(java.lang.String projectName, java.lang.String scanName) Delete a scan from the Globalyzer project.
static void	deleteScanResults(java.lang.String projectName, java.lang.String scanName) Deletes the scan results for one or all scans of a project.
static java.lang.String	executeScan(java.lang.String projectName, java.lang.String scanName, java.lang.String reportPath, GlobalyzerAPIReportTypes reportType) Executes the scan and optionally generates a report for either the scan or the project.
static java.lang.Object[]	executeScan(java.lang.String projectName, java.lang.String scanName, java.lang.String reportPath, GlobalyzerAPIReportTypes reportType, boolean generatePartialResults)
static java.lang.Object[]	executeScan(java.lang.String projectName, java.lang.String scanName, java.lang.String reportPath, GlobalyzerAPIReportTypes reportType, java.lang.String reportPriorities, boolean generatePartialResults) Executes the scan and optionally generates a report for either the scan or the project.
static java.lang.String	generateDefaultScanName(java.lang.String projectName, java.lang.String ruleSetName, java.lang.String ruleSetOwner) Returns the generated scan name for the given rule set name/owner.
static java.util.Date	getAccountExpirationDate() Returns the account expiration date for the current user
static java.lang.String	getScanHistory(java.lang.String projectName, java.lang.String scanName) Returns the scan history for the provided project and scan for the current user.
static boolean	getSendScanHistory() Determine the current send scan history setting
static java.lang.String	getServerVersion() Returns the version of the server the current user is logged in to.
static boolean	isValidML(java.lang.String projectPath, java.lang.String scanName) Validates that Machine Learning files exist for this scan
static java.lang.String[]	listProjects() Lists the project names currently in the database.
static RuleSetNameAndOwner[]	listRuleSets() Lists the rule sets available for the current user.
static java.lang.String[]	listScans(java.lang.String projectName) Lists the scan names for the given project.
static void	login(java.lang.String username, java.lang.String password, java.lang.String server, java.lang.String proxyUser, java.lang.String proxyPassword, java.lang.String proxyHost, java.lang.String proxyPort) Logs a user into Globalyzer.
static void	login(java.lang.String username, java.lang.String password, java.lang.String server, java.lang.String proxyUser, java.lang.String proxyPassword, java.lang.String proxyHost, java.lang.String proxyPort, boolean useLocalRulesets, java.lang.String rulesetLocation, java.lang.String licenseLocation) Logs a user into Globalyzer.
static void	reloadRuleSets() Reloads the rule sets from the server (as opposed to using cached copies)
static void	sendUseLog() Sends the use log to the server
static void	setSendScanHistory(boolean setting) Set whether scan history will be sent to the server; default is true
static void	setSessionSettings(java.lang.String dataDictionaryLocation, java.lang.Boolean filterWithDictionary, java.lang.String scanTimeout) Override default session settings.
static void	setSessionSettings(java.lang.String dataDictionaryDir, java.lang.String dataDictionaryFilesDir, java.lang.String cfgFileDir, java.lang.String log4jPropertiesFileDir, java.lang.Boolean setLog4jProperties, java.lang.Boolean filterWithDictionary, java.lang.String scanTimeout) Override default session settings.

Methods inherited from class java.lang.Object

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

Method Detail

setSessionSettings

public static void setSessionSettings(java.lang.String dataDictionaryDir,
                                      java.lang.String dataDictionaryFilesDir,
                                      java.lang.String cfgFileDir,
                                      java.lang.String log4jPropertiesFileDir,
                                      java.lang.Boolean setLog4jProperties,
                                      java.lang.Boolean filterWithDictionary,
                                      java.lang.String scanTimeout)
                               throws GlobalyzerAPIException

Override default session settings.

Parameters:

dataDictionaryDir - Specify absolute path of new dictionary location; default is {userhome}/.globalyzer; null = use default

dataDictionaryFilesDir - Specify absolute path of directory containing data/dict; default is directory where application is executed; null = use default

cfgFileDir - Specify absolute path of directory containing globalyzer.cfg.xml; default is directory where application is executed; null = use default

log4jPropertiesFileDir - Specify absolute path of directory containing log4j2.xml; default is directory where application is executed; null = use default

setLog4jProperties - Specify whether or not to configure a log4j2.xml file; default is true; null = use default

filterWithDictionary - Specify whether or not to filter against dictionary; default is true; null = use default

scanTimeout - Specify new scanTimeOut value; default is 120 (seconds); value must be between 0 and 600; null = use default

Throws:

GlobalyzerAPIException - on failure

setSessionSettings

public static void setSessionSettings(java.lang.String dataDictionaryLocation,
                                      java.lang.Boolean filterWithDictionary,
                                      java.lang.String scanTimeout)
                               throws GlobalyzerAPIException

Override default session settings.

Parameters:

dataDictionaryLocation - Specify absolute path of new dictionary location; default is {userhome}/.globalyzer; null = use default

filterWithDictionary - Specify whether or not to filter against dictionary; default is true; null = use default

scanTimeout - Specify new scanTimeOut value; default is 120 (seconds); value must be between 0 and 600; null = use default

Throws:

GlobalyzerAPIException - on failure

login

public static void login(java.lang.String username,
                         java.lang.String password,
                         java.lang.String server,
                         java.lang.String proxyUser,
                         java.lang.String proxyPassword,
                         java.lang.String proxyHost,
                         java.lang.String proxyPort)
                  throws GlobalyzerAPIException

Logs a user into Globalyzer.

Parameters:

username - The username

password - The password

server - The server

proxyUser - If using a proxy

proxyPassword - If using a proxy

proxyHost - If using a proxy

proxyPort - If using a proxy

Throws:

GlobalyzerAPIException - on failure

login

public static void login(java.lang.String username,
                         java.lang.String password,
                         java.lang.String server,
                         java.lang.String proxyUser,
                         java.lang.String proxyPassword,
                         java.lang.String proxyHost,
                         java.lang.String proxyPort,
                         boolean useLocalRulesets,
                         java.lang.String rulesetLocation,
                         java.lang.String licenseLocation)
                  throws GlobalyzerAPIException

Logs a user into Globalyzer.

Parameters:

username - The username

password - The password

server - The server

proxyUser - If using a proxy

proxyPassword - If using a proxy

proxyHost - If using a proxy

proxyPort - If using a proxy

useLocalRulesets - true if use local rulesets from files as opposed to server

rulesetLocation - Path to exported rule sets; null to use default location (projectpath/lingoport)

licenseLocation - Path to globalyzer license file; required when using local rule sets, else null

Throws:

GlobalyzerAPIException - on failure

createProject

public static void createProject(java.lang.String projectName,
                                 java.lang.String projectPath)
                          throws GlobalyzerAPIException

Creates a new Globalyzer project.

Parameters:

projectName - The name of the project to create

projectPath - The location of the project code

Throws:

GlobalyzerAPIException - on failure

deleteProject

public static void deleteProject(java.lang.String projectName)
                          throws GlobalyzerAPIException

Deletes a Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

Throws:

GlobalyzerAPIException - on failure

createScan

@Deprecated
public static java.lang.String createScan(java.lang.String projectName,
                                                       java.lang.String scanName,
                                                       java.lang.String ruleSetName,
                                                       java.lang.String ruleSetOwner)
                                                throws GlobalyzerAPIException

Deprecated. Use createScanWithInfo instead

Create a scan for the Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan (if null, name will be generated from rule set name)

ruleSetName - The name of the rule set the scan should reference

ruleSetOwner - The owner of the rule set the scan should reference (if null, owner = current user)

Returns:

The name of the created scan

Throws:

GlobalyzerAPIException - on failure

createScan

@Deprecated
public static java.lang.String[] createScan(java.lang.String projectName,
                                                         java.lang.String scanName,
                                                         java.lang.String ruleSetName,
                                                         java.lang.String ruleSetOwner,
                                                         java.lang.String[] scanItems)
                                                  throws GlobalyzerAPIException

Deprecated. Use createScanWithInfo instead

Create a scan for the Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan (if null, name will be generated from rule set name)

ruleSetName - The name of the rule set the scan should reference

ruleSetOwner - The owner of the rule set the scan should reference (if null, owner = current user)

scanItems - Specify files and directories to scan (null = all) - Paths can be absolute or relative to project path, but must be within project path

Returns:

scanItems not found and therefore not scanned (null indicates all scanItems were found and scanned)

Throws:

GlobalyzerAPIException - on failure

createScan

@Deprecated
public static java.lang.String[] createScan(java.lang.String projectName,
                                                         java.lang.String scanName,
                                                         java.lang.String ruleSetName,
                                                         java.lang.String ruleSetOwner,
                                                         GlobalyzerAPIScanDetails details)
                                                  throws GlobalyzerAPIException

Deprecated. Use createScanWithInfo instead

Create a scan for the Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan (if null, name will be generated from rule set name)

ruleSetName - The name of the rule set the scan should reference

ruleSetOwner - The owner of the rule set the scan should reference (if null, owner = current user)

details - The optional details of the scan; null = use default settings

Returns:

scanItems not found and therefore not scanned (null indicates all scanItems were found and scanned)

Throws:

GlobalyzerAPIException - on failure

createScanWithInfo

public static java.lang.Object[] createScanWithInfo(java.lang.String projectName,
                                                    java.lang.String scanName,
                                                    java.lang.String ruleSetName,
                                                    java.lang.String ruleSetOwner,
                                                    GlobalyzerAPIScanDetails details)
                                             throws GlobalyzerAPIException

Create a scan for the Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan (if null, name will be generated from rule set name)

ruleSetName - The name of the rule set the scan should reference

ruleSetOwner - The owner of the rule set the scan should reference (if null, owner = current user)

details - The optional details of the scan; null = use default settings

Returns:

array of three Objects:

     Object[0] - String   - scanName (could have been generated)
     Object[1] - String[] - scanItems not found and therefore not scanned (null indicates all scanItems were found and scanned)
     Object[2] - boolean  - true indicates that server rule set was used because not found locally (if using local rule sets)
     
 Example of use:
     Object[] result = createScanWithInfo(...);
     String scanName = (String)result[0];
     String[] scanItemsNotFound = (String[])result[1]);
     boolean localRuleSetNotFound = (boolean)result[2];
 

Throws:

GlobalyzerAPIException - on failure

createProjectScans

public static void createProjectScans(java.lang.String projectName,
                                      java.lang.String regex)
                               throws GlobalyzerAPIException

Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex

Parameters:

projectName - The name of the Globalyzer project

regex - Specify a pattern to match only certain rule set names (if null, scans will be created for all user's rule sets)

Throws:

GlobalyzerAPIException - on failure

createProjectScans

public static java.lang.String[] createProjectScans(java.lang.String projectName,
                                                    java.lang.String regex,
                                                    java.lang.String[] scanItems)
                                             throws GlobalyzerAPIException

Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex

Parameters:

projectName - The name of the Globalyzer project

regex - Specify a pattern to match only certain rule set names (if null, scans will be created for all user's rule sets)

scanItems - Specify files and directories to scan (null = all) - Paths can be absolute or relative to project path, but must be within project path

Returns:

scanItems not found and therefore not scanned (null indicates all scanItems were found and scanned)

Throws:

GlobalyzerAPIException - on failure

createProjectScans

public static java.lang.String[] createProjectScans(java.lang.String projectName,
                                                    java.lang.String regex,
                                                    GlobalyzerAPIScanDetails details)
                                             throws GlobalyzerAPIException

Create scans for the Globalyzer project - one for each rule set available to the current user that matches regex

Parameters:

projectName - The name of the Globalyzer project

regex - Specify a pattern to match only certain rule set names (if null, scans will be created for all user's rule sets)

details - Optional scan details

Returns:

scanItems not found and therefore not scanned (null indicates all scanItems were found and scanned)

Throws:

GlobalyzerAPIException - on failure

generateDefaultScanName

public static java.lang.String generateDefaultScanName(java.lang.String projectName,
                                                       java.lang.String ruleSetName,
                                                       java.lang.String ruleSetOwner)
                                                throws GlobalyzerAPIException

Returns the generated scan name for the given rule set name/owner.

Parameters:

projectName - The name of the project

ruleSetName - The rule set name

ruleSetOwner - The owner of the rule set (if null, owner is current user)

Returns:

The scan name

Throws:

GlobalyzerAPIException - on failure

deleteScan

public static void deleteScan(java.lang.String projectName,
                              java.lang.String scanName)
                       throws GlobalyzerAPIException

Delete a scan from the Globalyzer project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan to delete

Throws:

GlobalyzerAPIException - on failure

executeScan

public static java.lang.String executeScan(java.lang.String projectName,
                                           java.lang.String scanName,
                                           java.lang.String reportPath,
                                           GlobalyzerAPIReportTypes reportType)
                                    throws GlobalyzerAPIException

Executes the scan and optionally generates a report for either the scan or the project. If scanName is null, will execute all scans in project. If reportPath is null, will not generate a report. If reportType is null, will not generate a report.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan to execute (if null, all scans within project will be executed)

reportPath - Where the generated report should be stored (if null, no report generated)

reportType - The type of report to generate (if null, no report generated) - GlobalyzerAPIReportTypes.AggregateDetailedExcel, AggregateSummaryExcel, ScanDetailedExcel, ScanDetailedXML, ScanDetailedCSV, ScanSummaryHtml, or ScanSummaryText

Returns:

The generated report name (or null)

Throws:

GlobalyzerAPIException - on failure

executeScan

public static java.lang.Object[] executeScan(java.lang.String projectName,
                                             java.lang.String scanName,
                                             java.lang.String reportPath,
                                             GlobalyzerAPIReportTypes reportType,
                                             boolean generatePartialResults)
                                      throws GlobalyzerAPIException

Throws:

GlobalyzerAPIException

executeScan

public static java.lang.Object[] executeScan(java.lang.String projectName,
                                             java.lang.String scanName,
                                             java.lang.String reportPath,
                                             GlobalyzerAPIReportTypes reportType,
                                             java.lang.String reportPriorities,
                                             boolean generatePartialResults)
                                      throws GlobalyzerAPIException

Executes the scan and optionally generates a report for either the scan or the project. If scanName is null, will execute all scans in project. If reportPath is null, will not generate a report. If reportType is null, will not generate a report.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan to execute (if null, all scans within project will be executed)

reportPath - Where the generated report should be stored (if null, no report generated)

reportType - The type of report to generate (if null, no report generated) - GlobalyzerAPIReportTypes.AggregateDetailedExcel, AggregateSummaryExcel, ScanDetailedExcel, ScanDetailedXML, ScanDetailedCSV, ScanSummaryHtml, or ScanSummaryText

reportPriorities - Comma separated list of priorities to include in the report for example "C,1,2,3,4,5"; blank indicates all

generatePartialResults - If true, will continue scanning files even if some have errors, and generate reports with partial results

Returns:

array of two Objects:

     Object[0] - String   - generated report name (or null)
     Object[1] - boolean  - true if all files in scan(s) were successfully scanned
     
 Example of use:
     Object[] result = executeScan(...);
     String reportName = (String)result[0];
     boolean success   = (boolean)result[1];
 

Throws:

GlobalyzerAPIException - on failure

getScanHistory

public static java.lang.String getScanHistory(java.lang.String projectName,
                                              java.lang.String scanName)
                                       throws GlobalyzerAPIException

Returns the scan history for the provided project and scan for the current user.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan

Returns:

String containing the scan history data

Throws:

GlobalyzerAPIException - on failure

deleteScanResults

public static void deleteScanResults(java.lang.String projectName,
                                     java.lang.String scanName)
                              throws GlobalyzerAPIException

Deletes the scan results for one or all scans of a project. If scanName is null, deletes results for all scans in the project.

Parameters:

projectName - The name of the Globalyzer project

scanName - The name of the scan

Throws:

GlobalyzerAPIException - on failure

reloadRuleSets

public static void reloadRuleSets()
                           throws GlobalyzerAPIException

Reloads the rule sets from the server (as opposed to using cached copies)

Throws:

GlobalyzerAPIException - on failure

sendUseLog

public static void sendUseLog()
                       throws GlobalyzerAPIException

Sends the use log to the server

Throws:

GlobalyzerAPIException - on failure

closeDatabaseConnection

public static void closeDatabaseConnection()
                                    throws GlobalyzerAPIException

Closes the database - must be called before your program exits if NOT using an in-memory db.

Throws:

GlobalyzerAPIException - on failure

getServerVersion

public static java.lang.String getServerVersion()
                                         throws GlobalyzerAPIException

Returns the version of the server the current user is logged in to. Note: a user must be logged in before calling this method.

Returns:

String server version, such as 6.0.0

Throws:

GlobalyzerAPIException - on failure

getAccountExpirationDate

public static java.util.Date getAccountExpirationDate()

Returns the account expiration date for the current user

Returns:

Date of account expiration (or null if can't find it)

listRuleSets

public static RuleSetNameAndOwner[] listRuleSets()
                                          throws GlobalyzerAPIException

Lists the rule sets available for the current user.

Returns:

Array of RuleSetNameAndOwner containing rule set name and rule set owner

Throws:

GlobalyzerAPIException - on failure

listProjects

public static java.lang.String[] listProjects()
                                       throws GlobalyzerAPIException

Lists the project names currently in the database.

Returns:

String array of project names

Throws:

GlobalyzerAPIException - on failure

listScans

public static java.lang.String[] listScans(java.lang.String projectName)
                                    throws GlobalyzerAPIException

Lists the scan names for the given project.

Parameters:

projectName - The name of the Globalyzer project

Returns:

String array of scan names

Throws:

GlobalyzerAPIException - on failure

setSendScanHistory

public static void setSendScanHistory(boolean setting)

Set whether scan history will be sent to the server; default is true

Parameters:

setting - true to send scan history to server; false otherwise

getSendScanHistory

public static boolean getSendScanHistory()

Determine the current send scan history setting

Returns:

true if scan history will be sent to server; false otherwise

isValidML

public static boolean isValidML(java.lang.String projectPath,
                                java.lang.String scanName)

Validates that Machine Learning files exist for this scan

Parameters:

projectPath - Absolute path to project

scanName - Name of scan

Returns:

true if valid, false otherwise