com.redhat.rhn.manager.audit

Class ScapManager

java.lang.Object

com.redhat.rhn.manager.BaseManager

com.redhat.rhn.manager.audit.ScapManager

public class ScapManager
extends BaseManager

ScapManager

Constructor Summary

Constructors

Constructor and Description
ScapManager()

Method Summary

Modifier and Type	Method and Description
static DataResult	allScans(Server server) Show brief results of all scans for given system
static java.lang.Boolean	deleteScan(java.lang.Long xid) Delete given XccdfTestResult together with stored files
static java.lang.Long	deleteScansInSet(java.lang.Iterable<XccdfTestResultDto> set) Delete XccdfTestResults specified by set.
static void	ensureAvailableToUser(User user, java.lang.Long testResultId) Check if the user has permission to see the XCCDF scan.
static java.util.List<XccdfIdentDto>	identsPerRuleResult(java.lang.Long ruleResultId) Show xccdf:ident results for given rule-result
static boolean	isAvailableToUser(User user, java.lang.Long testResultId) Checks if the user has permission to see the XCCDF scan.
static boolean	isScapEnabled(Server server, User user) Returns the given system is scap enabled.
static java.util.List<XccdfTestResultDto>	latestTestResultByServerId(User user, java.lang.Long systemId) Show brief results of all scans accessible by user.
static DataResult	latestTestResultByUser(User user) Show brief results of all scans accessible by user.
static java.lang.Long	previousComparableTestResult(java.lang.Long testResultId) Get a TestResult with metadata similar to the given.
static XccdfRuleResultDto	ruleResultById(java.lang.Long ruleResultId) Get xccdf:rule-result by id
static java.util.List<XccdfRuleResultDto>	ruleResultsPerScan(java.lang.Long testResultId) Show xccdf:rule-result results for given test
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	ruleResultTypeLabels() Return list of possible results of xccdf:rule evaluation
static DataResult<XccdfTestResultDto>	scansInSet(User user, java.lang.String setLabel) Show brief results of scans in given set
static DataResult	scapCapableSystemsInSsm(User scheduler) Show scap capable systems which are currently in SSM
static ScapAction	scheduleXccdfEvalInSsm(User scheduler, java.lang.String path, java.lang.String parameters, java.util.Date earliest) Schedule scap.xccdf_eval action for systems in user's SSM.
static DataResult	searchByIdentIds(java.util.Map inParams, java.util.List<java.lang.Long> identIds, boolean returnTestResults) Get xccdf:rule-result-s or xccdf:TestResult-s by ident's ids
static DataResult	systemsInSsmAndScapCapability(User scheduler) Show systems in SSM and their true/false scap capability

Methods inherited from class com.redhat.rhn.manager.BaseManager

makeDataResult, makeDataResult, makeDataResult, makeDataResult, makeDataResultNoPagination, makeDataResultNoPagination, processListControl, processPageControl

Methods inherited from class java.lang.Object

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

Constructor Detail

ScapManager

public ScapManager()

Method Detail

isScapEnabled

public static boolean isScapEnabled(Server server,
                                    User user)

Returns the given system is scap enabled.

Parameters:

server - The system for which to seach scap capability

user - The user requesting to view the system

Returns:

true if the system is scap capable

latestTestResultByUser

public static DataResult latestTestResultByUser(User user)

Show brief results of all scans accessible by user. Sorted by date, descending.

Parameters:

user - The user requesting.

Returns:

The list of scan results

latestTestResultByServerId

public static java.util.List<XccdfTestResultDto> latestTestResultByServerId(User user,
                                                                            java.lang.Long systemId)

Show brief results of all scans accessible by user. Sorted by date, descending.

Parameters:

user - The user requesting the data.

systemId - The id of system

Returns:

The list of scan results.

allScans

public static DataResult allScans(Server server)

Show brief results of all scans for given system

Parameters:

server - The system for which to search

Returns:

The list of scan results in brief

scansInSet

public static DataResult<XccdfTestResultDto> scansInSet(User user,
                                                        java.lang.String setLabel)

Show brief results of scans in given set

Parameters:

user - The user owning the set

setLabel - The label of the set

Returns:

The list of scan results in brief

ruleResultsPerScan

public static java.util.List<XccdfRuleResultDto> ruleResultsPerScan(java.lang.Long testResultId)

Show xccdf:rule-result results for given test

Parameters:

testResultId - of XccdfTestResult of the test for which to search

Returns:

the list of rule-results

ruleResultById

public static XccdfRuleResultDto ruleResultById(java.lang.Long ruleResultId)

Get xccdf:rule-result by id

Parameters:

ruleResultId - of the XccdfRuleResult

Returns:

the result

previousComparableTestResult

public static java.lang.Long previousComparableTestResult(java.lang.Long testResultId)

Get a TestResult with metadata similar to the given. Which has been evaluated on the same machine just before the given. So it makes a sence to compare these two.

Parameters:

testResultId - referential TestResult

Returns:

result or null (if not any)

searchByIdentIds

public static DataResult searchByIdentIds(java.util.Map inParams,
                                          java.util.List<java.lang.Long> identIds,
                                          boolean returnTestResults)

Get xccdf:rule-result-s or xccdf:TestResult-s by ident's ids

Parameters:

inParams - direct parameters for query. user_id is the only compulsory

identIds - list of xccdf:ident ids

returnTestResults - what to return (true - list of testresults, false - list of rule-results)

Returns:

the result

identsPerRuleResult

public static java.util.List<XccdfIdentDto> identsPerRuleResult(java.lang.Long ruleResultId)

Show xccdf:ident results for given rule-result

Parameters:

ruleResultId - of XccdfRuleResultDto

Returns:

the list of idents

scapCapableSystemsInSsm

public static DataResult scapCapableSystemsInSsm(User scheduler)

Show scap capable systems which are currently in SSM

Parameters:

scheduler - user requesting the systems

Returns:

the list of systems in SSM

systemsInSsmAndScapCapability

public static DataResult systemsInSsmAndScapCapability(User scheduler)

Show systems in SSM and their true/false scap capability

Parameters:

scheduler - user requesting the systems

Returns:

the list of systems in SSM

scheduleXccdfEvalInSsm

public static ScapAction scheduleXccdfEvalInSsm(User scheduler,
                                                java.lang.String path,
                                                java.lang.String parameters,
                                                java.util.Date earliest)

Schedule scap.xccdf_eval action for systems in user's SSM.

Parameters:

scheduler - user which commits the schedule

path - path to xccdf document on systems file system

parameters - additional parameters for xccdf scan

earliest - time of earliest action occurence

Returns:

the newly created ScapAction

ensureAvailableToUser

public static void ensureAvailableToUser(User user,
                                         java.lang.Long testResultId)

Check if the user has permission to see the XCCDF scan.

Parameters:

user - User being checked.

testResultId - ID of XCCDF scan being checked.

Throws:

LookupException - if user cannot access the scan.

ruleResultTypeLabels

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> ruleResultTypeLabels()

Return list of possible results of xccdf:rule evaluation

Returns:

the result

isAvailableToUser

public static boolean isAvailableToUser(User user,
                                        java.lang.Long testResultId)

Checks if the user has permission to see the XCCDF scan.

Parameters:

user - User being checked.

testResultId - ID of the XCCDF scan being checked.

Returns:

true if the user can access the TestResult, false otherwise.

deleteScansInSet

public static java.lang.Long deleteScansInSet(java.lang.Iterable<XccdfTestResultDto> set)

Delete XccdfTestResults specified by set.

Parameters:

set - Set of TestResults to delete

Returns:

a number of successfully removed testResult

deleteScan

public static java.lang.Boolean deleteScan(java.lang.Long xid)

Delete given XccdfTestResult together with stored files

Parameters:

xid - ID of TestResult to delete

Returns:

true if the deletion was successfull