com.levelaccess.continuum

Class AMPReportingService

java.lang.Object

com.levelaccess.continuum.AMPReportingService

public class AMPReportingService
extends Object

This class encapsulates all of functionality for submitting accessibility concerns identified using Continuum to AMP. Reporting test results from Continuum to AMP is accomplished through a kind of state machine, where you set the active AMP instance, organization, asset, report, and module to use; once these are set, they remain set for as long as they're not set again and for as long as Continuum is initialized. Depending on the report and module management strategies you decide to use (see AMPReportingService.ReportManagementStrategy and AMPReportingService.ModuleManagementStrategy, respectively), invoking submitAccessibilityConcernsToAMP(List) will first create, overwrite, and/or delete reports and modules from AMP, then publish your test results to the active AMP module. You can set the active report and module management strategies using setActiveReportManagementStrategy(ReportManagementStrategy) and setActiveModuleManagementStrategy(ModuleManagementStrategy), respectively. Only once all of these active items are set should you invoke submitAccessibilityConcernsToAMP(List) using the list of accessibility concerns you'd like to report. More on report and module management strategies: they are designed with two primary use cases in mind: continuous integration (CI) workflows (where you usually want to retain the results of previously published reports), and more manual workflows (e.g. when Continuum is run from a developer's local workstation, where you usually don't want to retain the results of previously published reports). Choosing the correct report and module management strategies to meet your business objectives is critical to using Continuum's AMP reporting functionality correctly, so please consult our support documentation for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AMPReportingService.Module This class encapsulates all the metadata relevant to an AMP module.
static class	AMPReportingService.ModuleManagementStrategy Defines supported strategies with which to create new modules and edit existing ones.
class	AMPReportingService.Report This class encapsulates all the metadata relevant to an AMP report.
static class	AMPReportingService.ReportManagementStrategy Defines supported strategies with which to create new reports and edit existing ones.

Method Summary

Modifier and Type	Method and Description
AMPReportingService.Module	getActiveModule() Gets the active module.
AMPReportingService.Report	getActiveReport() Gets the active report.
void	setActiveAsset(Integer assetId) Validates the specified ID of an existing asset in AMP, then sets it as the active asset in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active asset.
void	setActiveModule(Integer moduleId) Validates the specified ID of an existing module in AMP, then sets it as the active module in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active module.
Integer	setActiveModule(String moduleName, String moduleLocation) Sets the active module in AMP to submit test results to next time submitAccessibilityConcernsToAMP(List) is invoked.
void	setActiveModuleManagementStrategy(AMPReportingService.ModuleManagementStrategy moduleManagementStrategy) Sets the active module management strategy to use next time submitAccessibilityConcernsToAMP(List) is invoked.
void	setActiveOrganization(Integer organizationId) Validates the specified ID of an existing organization in AMP, then sets it as the active organization in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active organization.
void	setActiveReport(Integer reportId) Validates the specified ID of an existing report in AMP, then sets it as the active report in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active report.
Integer	setActiveReport(String reportName) Sets the active report in AMP to submit test results to next time submitAccessibilityConcernsToAMP(List) is invoked.
void	setActiveReportManagementStrategy(AMPReportingService.ReportManagementStrategy reportManagementStrategy) Sets the active report management strategy to use next time submitAccessibilityConcernsToAMP(List) is invoked.
boolean	submitAccessibilityConcernsToAMP(List<AccessibilityConcern> accessibilityConcerns) Submits accessibility concerns to the active AMP instance, organization, asset, report, and module.

Methods inherited from class java.lang.Object

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

Method Detail

getActiveModule

public AMPReportingService.Module getActiveModule()

Gets the active module. This is null if setActiveModule(Integer) or setActiveModule(String, String) hasn't been invoked to set an active module yet. Use this to access the active module's metadata, e.g. its ID in AMP, its name, etc.

Returns:

the active module

getActiveReport

public AMPReportingService.Report getActiveReport()

Gets the active report. This is null if setActiveReport(Integer) or setActiveReport(String) hasn't been invoked to set an active report yet. Use this to access the active report's metadata, e.g. its ID in AMP, its name, etc.

Returns:

the active report

setActiveAsset

public void setActiveAsset(Integer assetId)
                    throws IllegalArgumentException,
                           HttpErrorException,
                           NotFoundException

Validates the specified ID of an existing asset in AMP, then sets it as the active asset in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active asset. Make sure you first set the active organization for this asset prior to invoking this function using setActiveOrganization(Integer).

Parameters:

assetId - the ID of the AMP asset to make active

Throws:

IllegalStateException - if the active organization is not set

IllegalArgumentException - if the specified asset ID is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified asset ID

NotFoundException - if the specified asset may not exist in the active AMP instance or is otherwise not accessible

setActiveModule

public void setActiveModule(Integer moduleId)
                     throws IllegalStateException,
                            IllegalArgumentException,
                            HttpErrorException,
                            NotFoundException

Validates the specified ID of an existing module in AMP, then sets it as the active module in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active module. Make sure you first set the active organization, asset, and report for this module prior to invoking this function using setActiveOrganization(Integer), setActiveAsset(Integer), and setActiveReport(Integer) or setActiveReport(String), respectively. While using AMPReportingService.ReportManagementStrategy.OVERWRITE as your report management strategy, use setActiveModule(String, String) instead of this method; see the documentation for AMPReportingService.ReportManagementStrategy.OVERWRITE for details as to why.

Parameters:

moduleId - the ID of the AMP module to make active

Throws:

IllegalStateException - if the active organization, asset, or report is not set

IllegalArgumentException - if the specified module ID is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified module ID

NotFoundException - if the specified module may not exist in the active AMP report

setActiveModule

public Integer setActiveModule(String moduleName,
                               String moduleLocation)
                        throws IllegalStateException,
                               IllegalArgumentException,
                               HttpErrorException

Sets the active module in AMP to submit test results to next time submitAccessibilityConcernsToAMP(List) is invoked. The module name specified is validated if the active report already exists in AMP, but unlike setActiveModule(Integer), this method will not throw an exception if the specified module does not yet exist in AMP; it will be created next time submitAccessibilityConcernsToAMP(List) is invoked. Make sure you first set the active organization, asset, and report for this module prior to invoking this function using setActiveOrganization(Integer), setActiveAsset(Integer), and setActiveReport(Integer) or setActiveReport(String), respectively.

Parameters:

moduleName - the name of the AMP module to make active

moduleLocation - the name of the location in the website or app being tested; this can be a fully qualified URL, or simply a page title like "Login Page"

Returns:

the ID of the AMP module, if it already exists; null if the module does not yet exist in AMP

Throws:

IllegalStateException - if the active organization, asset, or report is not set

IllegalArgumentException - if the specified module name or location is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified module name

setActiveModuleManagementStrategy

public void setActiveModuleManagementStrategy(AMPReportingService.ModuleManagementStrategy moduleManagementStrategy)

Sets the active module management strategy to use next time submitAccessibilityConcernsToAMP(List) is invoked. Choosing the correct report and module management strategies to meet your business objectives is critical to using Continuum's AMP reporting functionality correctly, so please consult our support documentation for more information.

Parameters:

moduleManagementStrategy - the preferred management strategy to use when creating and editing AMP modules

setActiveOrganization

public void setActiveOrganization(Integer organizationId)
                           throws IllegalArgumentException,
                                  HttpErrorException,
                                  NotFoundException

Validates the specified ID of an existing organization in AMP, then sets it as the active organization in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active organization.

Parameters:

organizationId - the ID of the AMP organization to make active

Throws:

IllegalArgumentException - if the specified organization ID is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified organization ID

NotFoundException - if the specified organization may not exist in the active AMP instance or is otherwise not accessible

setActiveReport

public void setActiveReport(Integer reportId)
                     throws IllegalStateException,
                            IllegalArgumentException,
                            HttpErrorException,
                            NotFoundException

Validates the specified ID of an existing report in AMP, then sets it as the active report in Continuum such that next time submitAccessibilityConcernsToAMP(List) is invoked, test results will be submitted to this active report. Make sure you first set the active organization and asset for this report prior to invoking this function using setActiveOrganization(Integer) and setActiveAsset(Integer), respectively.

Parameters:

reportId - the ID of the AMP report to make active

Throws:

IllegalStateException - if the active organization or asset is not set

IllegalArgumentException - if the specified report ID is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified report ID

NotFoundException - if the specified report may not exist in the active AMP instance or is otherwise not accessible

setActiveReport

public Integer setActiveReport(String reportName)
                        throws IllegalStateException,
                               IllegalArgumentException,
                               HttpErrorException

Sets the active report in AMP to submit test results to next time submitAccessibilityConcernsToAMP(List) is invoked. The report name specified is validated, but unlike setActiveReport(Integer), this method will not throw an exception if the specified report does not yet exist in AMP; it will be created next time submitAccessibilityConcernsToAMP(List) is invoked. Make sure you first set the active organization and asset for this report prior to invoking this function using setActiveOrganization(Integer) and setActiveAsset(Integer), respectively.

Parameters:

reportName - the name of the AMP report to make active

Returns:

the ID of the AMP report, if it already exists; null if the report does not yet exist in AMP

Throws:

IllegalStateException - if the active organization or asset is not set

IllegalArgumentException - if the specified report name is null

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the specified report name

setActiveReportManagementStrategy

public void setActiveReportManagementStrategy(AMPReportingService.ReportManagementStrategy reportManagementStrategy)

Sets the active report management strategy to use next time submitAccessibilityConcernsToAMP(List) is invoked. Choosing the correct report and module management strategies to meet your business objectives is critical to using Continuum's AMP reporting functionality correctly, so please consult our support documentation for more information.

Parameters:

reportManagementStrategy - the preferred management strategy to use when creating and editing AMP reports

submitAccessibilityConcernsToAMP

public boolean submitAccessibilityConcernsToAMP(List<AccessibilityConcern> accessibilityConcerns)
                                         throws NotFoundException,
                                                HttpErrorException

Submits accessibility concerns to the active AMP instance, organization, asset, report, and module. Make sure to set the active AMP organization (via setActiveOrganization(Integer)), asset (via setActiveAsset(Integer)), report (via setActiveReport(Integer) or setActiveReport(String)), and module (via setActiveModule(Integer) or setActiveModule(String, String)) prior to invoking this function. The active instance, organization, and asset must all already exist in AMP prior to invoking this function, otherwise an exception will be thrown; reports and modules don't need to exist in AMP yet, as they will be created if necessary. Also, make sure to set your desired report and module management strategies prior to invoking this function using setActiveReportManagementStrategy(ReportManagementStrategy) and setActiveModuleManagementStrategy(ModuleManagementStrategy), respectively, according to your use case. Choosing the correct report and module management strategies to meet your business objectives is critical to using Continuum's AMP reporting functionality correctly, so please consult our support documentation for more information.

Parameters:

accessibilityConcerns - the list of accessibility concerns to submit to AMP

Returns:

true if uploading of the specified accessibility concerns to AMP succeeded; false if it did not

Throws:

IllegalStateException - if the active instance, organization, asset, report, or module is not set

HttpErrorException - if an error is encountered while attempting to connect to AMP to validate the active organization, asset, report, or module

NotFoundException - if the active instance, organization, or asset may not exist in AMP as specified, or if an error occurs while attempting to create the necessary report or module in AMP (if applicable)