FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\DeciderJob\DeciderJobAgent Class Reference

Get the decision from Monk bulk and apply decisions. More...

Inheritance diagram for Fossology\DeciderJob\DeciderJobAgent:
Inheritance graph
Collaboration diagram for Fossology\DeciderJob\DeciderJobAgent:
Collaboration graph

Public Member Functions

 __construct ($licenseMapUsage=null)
 
 processClearingEventOfCurrentJob ()
 Process clearing events of current job handled by agent.
 
 processUploadId ($uploadId)
 Given an upload ID, process the items in it. More...
 
- Public Member Functions inherited from Fossology\Lib\Agent\Agent
 __construct ($agentName, $version, $revision)
 
 scheduler_connect ()
 Connect with scheduler and initialize options. More...
 
 heartbeat ($newProcessed)
 Send hear beat to the scheduler. More...
 
 bail ($exitvalue)
 Bail the agent, print the stack and disconnect from scheduler. More...
 
 scheduler_disconnect ($exitvalue)
 Closes connection from scheduler. More...
 
 scheduler_greet ()
 Greet the scheduler at the beginning of connection. More...
 
 initArsTable ()
 Initialize ARS table.
 
 run_scheduler_event_loop ()
 Runs a loop to read commands from scheduler and process them. More...
 

Public Attributes

const FORCE_DECISION = 1
 

Protected Member Functions

 processClearingEventsForItem (ItemTreeBounds $itemTreeBounds, $userId, $groupId, $additionalEventsFromThisJob)
 Get an item, process events and create new decisions. More...
 

Private Member Functions

 loopContainedItems ($itemTreeBounds)
 Get items contained inside an item tree. More...
 

Private Attributes

 $conflictStrategyId
 
 $uploadDao
 
 $clearingDecisionProcessor
 
 $agentLicenseEventProcessor
 
 $clearingDao
 
 $highlightDao
 
 $decisionIsGlobal = CLEARING_DECISION_IS_GLOBAL
 
 $decisionTypes
 
 $licenseMap = null
 
 $licenseMapUsage = null
 

Additional Inherited Members

- Static Public Member Functions inherited from Fossology\Lib\Agent\Agent
static heartbeat_handler ($signo)
 Function to handle hear beats from the agent and send them to the scheduler from STDOUT. More...
 
- Protected Attributes inherited from Fossology\Lib\Agent\Agent
 $userId
 
 $groupId
 
 $jobId
 
 $agentSpecifOptions = ""
 
 $agentSpecifLongOptions = array()
 
 $args = array()
 
 $dbManager
 
 $agentDao
 
 $container
 
 $schedulerMode
 

Detailed Description

Get the decision from Monk bulk and apply decisions.

Definition at line 53 of file DeciderJobAgent.php.

Member Function Documentation

◆ loopContainedItems()

Fossology\DeciderJob\DeciderJobAgent::loopContainedItems (   $itemTreeBounds)
private

Get items contained inside an item tree.

Parameters
ItemTreeBounds$itemTreeBoundsItem tree to be looped
Returns
ItemTreeBounds Array of items inside given item tree

Definition at line 136 of file DeciderJobAgent.php.

◆ processClearingEventsForItem()

Fossology\DeciderJob\DeciderJobAgent::processClearingEventsForItem ( ItemTreeBounds  $itemTreeBounds,
  $userId,
  $groupId,
  $additionalEventsFromThisJob 
)
protected

Get an item, process events and create new decisions.

Parameters
ItemTreeBounds$itemTreeBounds
int$userId
int$groupId
array$additionalEventsFromThisJob

Definition at line 181 of file DeciderJobAgent.php.

◆ processUploadId()

Fossology\DeciderJob\DeciderJobAgent::processUploadId (   $uploadId)

Given an upload ID, process the items in it.

This function is implemented by agent and should call heartbeat() at regular intervals.

Parameters
int$uploadIdUpload to be processed by the agent.
Returns
bool Process status
See also
Fossology::Lib::Agent::Agent::processUploadId()

Reimplemented from Fossology\Lib\Agent\Agent.

Definition at line 154 of file DeciderJobAgent.php.

Member Data Documentation

◆ $agentLicenseEventProcessor

AgentLicenseEventProcessor Fossology\DeciderJob\DeciderJobAgent::$agentLicenseEventProcessor
private

AgentLicenseEventProcessor to be used

Definition at line 72 of file DeciderJobAgent.php.

◆ $clearingDao

ClearingDao Fossology\DeciderJob\DeciderJobAgent::$clearingDao
private

ClearingDao object

Definition at line 76 of file DeciderJobAgent.php.

◆ $clearingDecisionProcessor

ClearingDecisionProcessor Fossology\DeciderJob\DeciderJobAgent::$clearingDecisionProcessor
private

ClearingDecisionProcessor to be used

Definition at line 68 of file DeciderJobAgent.php.

◆ $conflictStrategyId

int Fossology\DeciderJob\DeciderJobAgent::$conflictStrategyId
private

Conflict resolution strategy to be used (0=>unhandled events,1=>force)

Definition at line 60 of file DeciderJobAgent.php.

◆ $decisionIsGlobal

boolean Fossology\DeciderJob\DeciderJobAgent::$decisionIsGlobal = CLEARING_DECISION_IS_GLOBAL
private

If the decision is global

Definition at line 84 of file DeciderJobAgent.php.

◆ $decisionTypes

DecisionTypes Fossology\DeciderJob\DeciderJobAgent::$decisionTypes
private

DecisionTypes object

Definition at line 88 of file DeciderJobAgent.php.

◆ $highlightDao

HighlightDao Fossology\DeciderJob\DeciderJobAgent::$highlightDao
private

HighlightDao object

Definition at line 80 of file DeciderJobAgent.php.

◆ $licenseMap

LicenseMap Fossology\DeciderJob\DeciderJobAgent::$licenseMap = null
private

LicenseMap object

Definition at line 92 of file DeciderJobAgent.php.

◆ $licenseMapUsage

int Fossology\DeciderJob\DeciderJobAgent::$licenseMapUsage = null
private
See also
LicenseMap

Definition at line 96 of file DeciderJobAgent.php.

◆ $uploadDao

UploadDao Fossology\DeciderJob\DeciderJobAgent::$uploadDao
private

UploadDao object

Definition at line 64 of file DeciderJobAgent.php.


The documentation for this class was generated from the following file: