API Documentation
\
CloudMunch
datamanager
helper
integrations
loghandling

\CloudMunchAppContext

Class AppContext This class is the Applictaion Context , that has all the context data needed for plugin runtime.

Summary

Methods
Properties
Constants
getLogLevel()
setLogLevel()
getMainbuildnumber()
setMainbuildnumber()
getEnvironment()
setEnvironment()
getTier()
setTier()
getStepName()
setStepName()
getWorkSpaceLocation()
setWorkSpaceLocation()
getArchiveLocation()
setArchiveLocation()
getStepID()
setStepID()
setTargetServer()
getTargetServer()
getMasterURL()
setMasterURL()
getDomainName()
setDomainName()
getProject()
setProject()
getJob()
setJob()
getReportsLocation()
setReportsLocation()
getRunNumber()
setRunNumber()
getAPIKey()
setAPIKey()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$masterurl
$domainName
$project
$job
$workspaceLocation
$archiveLocation
$stepid
$targetServer
$reportsLocation
$runnumber
$apikey
$stepname
$environmentId
$mainbuildnumber
$tierid
$logLevel
N/A

Properties

$masterurl

$masterurl : string

URL to cloudmunch service

Type

string

$domainName

$domainName : string

Domain of the current runtime.

Type

string

$project

$project : string

Current application name.

Type

string

$job

$job : string

current task name.

Type

string

$workspaceLocation

$workspaceLocation : string

Workspace location.

Type

string

$archiveLocation

$archiveLocation : string

Archive location.

Type

string

$stepid

$stepid : string

Current step id.

Type

string

$targetServer

$targetServer : string

Target server if selected to execute the job.

Type

string

$reportsLocation

$reportsLocation : string

Report location.

Type

string

$runnumber

$runnumber : string

Current job run number.

Type

string

$apikey

$apikey : string

API key to connect to cloudmunch service.

Type

string

$stepname

$stepname : string

Current step name.

Type

string

$environmentId

$environmentId : string

ID of the environment in which job is executed.

Type

string

$mainbuildnumber

$mainbuildnumber : string

Number of main build.

Type

string

$tierid

$tierid : string

role/tier id

Type

string

$logLevel

$logLevel : string

Log level

Type

string

Methods

getLogLevel()

getLogLevel() : string

Get log level of the plugin runtime.

Log level that can be either INFO,ERROR,DEBUG

Returns

string —

Log level

setLogLevel()

setLogLevel(string  $logLevel = "INFO")

Set log level of plugin runtime.

Parameters

string $logLevel

Log level

getMainbuildnumber()

getMainbuildnumber() : string

Get the main build number of the application.

Returns

string —

main build number

setMainbuildnumber()

setMainbuildnumber(string  $number)

Set the main build number of the application.

Parameters

string $number

main build number

getEnvironment()

getEnvironment() : string

Get the ID of the environment in which the plugin is getting executed.

Returns

string —

environment Id

setEnvironment()

setEnvironment(string  $env)

Set the ID of the environment in which the plugin is getting executed.

Parameters

string $env

Environment ID

getTier()

getTier() : string

Get the role/applictaion tier.

Returns

string —

tier/role id

setTier()

setTier(string  $tier)

Set role/applictaion tier.

Parameters

string $tier

tier/role id

getStepName()

getStepName() : string

Get the step name.

Returns

string —

step name

setStepName()

setStepName(string  $step)

Set step name

Parameters

string $step

Step name

getWorkSpaceLocation()

getWorkSpaceLocation() : string

Get workspace location of the job.

Returns

string —

workspace location

setWorkSpaceLocation()

setWorkSpaceLocation(string  $workspaceloc)

Set workspace location.

Parameters

string $workspaceloc

workspace location

getArchiveLocation()

getArchiveLocation() : string

Archive Location of the build.

Returns

string —

archive location

setArchiveLocation()

setArchiveLocation(string  $archiveLoc)

Set archive location of build.

Parameters

string $archiveLoc

archive location

getStepID()

getStepID() : string

Get ID of current step.

Returns

string —

step id

setStepID()

setStepID(string  $stepid)

Set ID of current step.

Parameters

string $stepid

step id

setTargetServer()

setTargetServer(string  $targetServer)

Set target server ,if selected for the job.

Parameters

string $targetServer

target server

getTargetServer()

getTargetServer() : string

Retrieve target server.

Returns

string —

target server

getMasterURL()

getMasterURL() : string

Get Cloudmunch service URL.

Returns

string —

Cloudmunch service URL

setMasterURL()

setMasterURL(string  $mURL)

Set Cloudmunch service URL.

Parameters

string $mURL

Cloudmunch service URL

getDomainName()

getDomainName() : string

Get domain name of current application.

Returns

string —

domain name

setDomainName()

setDomainName(string  $dname)

Set domain name of current application.

Parameters

string $dname

domain name

getProject()

getProject() : string

Get name of current application.

Returns

string —

project

setProject()

setProject(string  $proj)

Set name of current application.

Parameters

string $proj

project

getJob()

getJob() : string

Get job name

Returns

string —

job name

setJob()

setJob(string  $job)

Set job name.

Parameters

string $job

job name

getReportsLocation()

getReportsLocation() : string

Get report location.

Returns

string —

reports location

setReportsLocation()

setReportsLocation(string  $reportLoc)

Set report location.

Parameters

string $reportLoc

reports location

getRunNumber()

getRunNumber() : string

Get rum number of job.

Returns

string —

run number

setRunNumber()

setRunNumber(string  $runno)

Set rum number of job.

Parameters

string $runno

run number

getAPIKey()

getAPIKey() : string

Get API key to connect to cloudmunch.

Returns

string —

api key

setAPIKey()

setAPIKey(string  $ak)

Set API key to connect to cloudmunch.

Parameters

string $ak

api key