API Documentation
\
CloudMunch
datamanager
helper
integrations
loghandling

\CloudMunchAppAbstract

Class AppAbstract An abstract base class for Cloudmunch plugin, providing methods to read plugin inputs and handle plugin life cycle.

Summary

Methods
Properties
Constants
process()
getInput()
createLogHandler()
getLogHandler()
setAppContext()
getAppContext()
getCloudmunchServerHelper()
getCloudmunchEnvironmentHelper()
getCloudmunchInsightHelper()
getCloudmunchRoleHelper()
getCloudmunchAssetHelper()
getCloudmunchIntegrationHelper()
getCloudmunchService()
getNotificationHandler()
initialize()
getProcessInput()
performAppcompletion()
outputPipelineVariables()
outputPipelineVariablesArray()
__destruct()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$appContext
$parameterObject
$stime
$cloudmunchService
$logHandler
$contextVariables
N/A

Properties

$appContext

$appContext :

AppContext

Type

$parameterObject

$parameterObject :

String containing input parameters.

Type

$stime

$stime :

Strat time of the plugin execution.

Type

$cloudmunchService

$cloudmunchService :

Cloudmunch Service object

Type

$contextVariables

$contextVariables : \CloudMunch\Context

Type

\CloudMunch\Context — variables

Methods

process()

process(array  $processparameters)

This is an abstract method to be implemented by every plugin.

Parameters

array $processparameters

This array contains the two entries , appInput and integrationdetails

getInput()

getInput()

This method read and process the input parameters.

createLogHandler()

createLogHandler()

This function initializes log handler

getLogHandler()

getLogHandler()

This function returns the reference to log handler

setAppContext()

setAppContext(  $appContext)

This method sets the plugin context object that contains all environment variables.

Parameters

$appContext

getAppContext()

getAppContext() : \CloudMunch\AppContext

This method returns the plugin context object that contains all environment context data of plugin execution.

Returns

\CloudMunch\AppContext —

appContext

getCloudmunchServerHelper()

getCloudmunchServerHelper() : \CloudMunch\helper\ServerHelper

This method gives reference to ServerHelper,this helper class has all the methods to get/set data on servers registered with cloudmunch.

Returns

\CloudMunch\helper\ServerHelper —

serverhelper

getCloudmunchEnvironmentHelper()

getCloudmunchEnvironmentHelper() : \CloudMunch\helper\EnvironmentHelper

This method gives reference to EnvironmentHelper,this helper class has all the methods to get/set data on assets registered with cloudmunch.

Returns

\CloudMunch\helper\EnvironmentHelper —

environment helper

getCloudmunchInsightHelper()

getCloudmunchInsightHelper() : \CloudMunch\helper\InsightHelper

This method gives reference to EnvironmentHelper,this helper class has all the methods to get/set data on assets registered with cloudmunch.

Returns

\CloudMunch\helper\InsightHelper —

insight helper

getCloudmunchRoleHelper()

getCloudmunchRoleHelper() : \CloudMunch\helper\RoleHelper

This method gives reference to RoleHelper,this helper class has all the methods to get/set data on assets registered with cloudmunch.

Returns

\CloudMunch\helper\RoleHelper —

environment helper

getCloudmunchAssetHelper()

getCloudmunchAssetHelper() : \CloudMunch\helper\AssetHelper

This method gives reference to AssetHelper,this helper class has all the methods to get/set data on assets registered with cloudmunch.

Returns

\CloudMunch\helper\AssetHelper —

assethelper

getCloudmunchIntegrationHelper()

getCloudmunchIntegrationHelper() : \CloudMunch\helper\IntegrationHelper

This method gives reference to IntegrationHelper,this helper class has all the methods to get/set data on integrations registered with cloudmunch.

Returns

\CloudMunch\helper\IntegrationHelper —

integrationhelper

getCloudmunchService()

getCloudmunchService() : \CloudMunch\CloudmunchService

This method returns reference to CloudmunchService,this helper class has all the methods to get/set data to cloudmunch service.

Returns

\CloudMunch\CloudmunchService

getNotificationHandler()

getNotificationHandler() : \CloudMunch\helper\NotificationHandler

This method returns reference to NotificationHandler,this helper class has methods to notify external communication tools

Returns

\CloudMunch\helper\NotificationHandler

initialize()

initialize()

This is a lifecycle method that is invoked on the plugin to initialize itself with the incoming data.

getProcessInput()

getProcessInput() : array

This is a lifecycle method to process input.

Returns

array —

processparameters : Array containing pluginiput parameters and integration details if any.

performAppcompletion()

performAppcompletion()

This is a lifecycle method invoked at the completion of the plugin to capture some data.

outputPipelineVariables()

outputPipelineVariables(  $variablename,   $variable)

This method outputs variables from the plugin

Parameters

$variablename
$variable

outputPipelineVariablesArray()

outputPipelineVariablesArray(  $variablesArray)

This method outputs variables from the plugin

Parameters

$variablesArray

__destruct()

__destruct()

This is a lifecycle method invoked at the completion of the plugin.