ServerEngineService

commandbox.system.services

Class ServerEngineService

lucee.Component
    commandbox.system.services.ServerEngineService

Class Attributes:

singleton : true

synchronized : false

accessors : true

persistent : false

author : Brad Wood, Luis Majano, Denny Valliant

Property Summary
type	property	default	serializable	required
`any`	artifactService access = public returntype = any inject = artifactService		`true`	`false`
`any`	cr access = public returntype = any inject = cr@constants		`true`	`false`
`any`	endpointService access = public returntype = any inject = EndpointService		`true`	`false`
`any`	logger access = public returntype = any inject = logbox:logger:{this}		`true`	`false`
`any`	packageService access = public returntype = any inject = PackageService		`true`	`false`
`any`	semanticVersion access = public returntype = any inject = provider:semanticVersion@semver		`true`	`false`
`any`	shell access = public returntype = any inject = shell		`true`	`false`
`any`	tempDir access = public returntype = any inject = tempDir@constants		`true`	`false`
`any`	wirebox access = public returntype = any inject = wirebox		`true`	`false`

Method Summary
`private any`	calcLuceeRailoContextPaths([any installDetails], [any serverInfo])
`any`	configureWebXML(any cfengine, any version, any source, any destination, struct serverInfo) configure web.
`string`	getArtifactService()
`string`	getCr()
`string`	getEndpointService()
`string`	getLogger()
`string`	getPackageService()
`string`	getSemanticVersion()
`string`	getShell()
`string`	getTempDir()
`string`	getWirebox()
`any`	install(any cfengine, any baseDirectory, struct serverInfo, string serverHomeDirectory) install the server if not already installed to the target directory.
`any`	installAdobe([any installDetails], [any serverInfo]) install adobe.
`any`	installEngineArchive(string ID, string destination, struct serverInfo, string serverHomeDirectory)
`any`	installLucee([any installDetails], [any serverInfo]) install lucee.
`any`	installRailo([any installDetails], [any serverInfo]) install railo.
`any`	setArtifactService(any artifactService)
`any`	setCr(any cr)
`any`	setEndpointService(any endpointService)
`any`	setLogger(any logger)
`any`	setPackageService(any packageService)
`any`	setSemanticVersion(any semanticVersion)
`any`	setShell(any shell)
`any`	setTempDir(any tempDir)
`any`	setWirebox(any wirebox)
`private any`	unpackInPlace([any packedFile]) Take a pack200 packed jar and unpack it into the same folder, deleting the original.
`private any`	unpackLuceeJar([any libDirectory], [any luceeVersion]) Find the Lucee jar in the lib directory and if it's packed, unpack it.
`private any`	writeXMLFile([any XMLDoc], [any path]) Write an XML file to disk and format it so it's human-readable.

Methods inherited from class `lucee.Component`
None

Property Detail

artifactService

property any artifactService

Attributes:: access - public; required - false; returntype - any; inject - artifactService; serializable - true

cr

property any cr

Attributes:: access - public; required - false; returntype - any; inject - cr@constants; serializable - true

endpointService

property any endpointService

Attributes:: access - public; required - false; returntype - any; inject - EndpointService; serializable - true

logger

property any logger

Attributes:: access - public; required - false; returntype - any; inject - logbox:logger:{this}; serializable - true

packageService

property any packageService

Attributes:: access - public; required - false; returntype - any; inject - PackageService; serializable - true

semanticVersion

property any semanticVersion

Attributes:: access - public; required - false; returntype - any; inject - provider:semanticVersion@semver; serializable - true

shell

property any shell

Attributes:: access - public; required - false; returntype - any; inject - shell; serializable - true

tempDir

property any tempDir

Attributes:: access - public; required - false; returntype - any; inject - tempDir@constants; serializable - true

wirebox

property any wirebox

Attributes:: access - public; required - false; returntype - any; inject - wirebox; serializable - true

Method Detail

calcLuceeRailoContextPaths

private any calcLuceeRailoContextPaths([any installDetails], [any serverInfo])

Parameters:: installDetails; serverInfo

configureWebXML

public any configureWebXML(any cfengine, any version, any source, any destination, struct serverInfo)

configure web.xml file for Lucee and Railo

Parameters:: cfengine - lucee or railo; version; source - source web.xml; destination - target web.xml; serverInfo

getArtifactService

public string getArtifactService()

getCr

public string getCr()

getEndpointService

public string getEndpointService()

getLogger

public string getLogger()

getPackageService

public string getPackageService()

getSemanticVersion

public string getSemanticVersion()

getShell

public string getShell()

getTempDir

public string getTempDir()

getWirebox

public string getWirebox()

install

public any install(any cfengine, any baseDirectory, struct serverInfo, string serverHomeDirectory)

install the server if not already installed to the target directory

Parameters:: cfengine - CFML Engine name (lucee, adobe, railo); baseDirectory - base directory for server install; serverInfo - The struct of server settings; serverHomeDirectory - Override where the server's home with be

installAdobe

public any installAdobe([any installDetails], [any serverInfo])

install adobe

Parameters:: installDetails; serverInfo

installEngineArchive

public any installEngineArchive(string ID, string destination, struct serverInfo, string serverHomeDirectory)

Parameters:: ID; destination; serverInfo; serverHomeDirectory

installLucee

public any installLucee([any installDetails], [any serverInfo])

install lucee

Parameters:: installDetails; serverInfo

installRailo

public any installRailo([any installDetails], [any serverInfo])

install railo

Parameters:: installDetails; serverInfo

setArtifactService

public any setArtifactService(any artifactService)

Parameters:: artifactService

setCr

public any setCr(any cr)

Parameters:: cr

setEndpointService

public any setEndpointService(any endpointService)

Parameters:: endpointService

setLogger

public any setLogger(any logger)

Parameters:: logger

setPackageService

public any setPackageService(any packageService)

Parameters:: packageService

setSemanticVersion

public any setSemanticVersion(any semanticVersion)

Parameters:: semanticVersion

setShell

public any setShell(any shell)

Parameters:: shell

setTempDir

public any setTempDir(any tempDir)

Parameters:: tempDir

setWirebox

public any setWirebox(any wirebox)

Parameters:: wirebox

unpackInPlace

private any unpackInPlace([any packedFile])

Take a pack200 packed jar and unpack it into the same folder, deleting the original

Parameters:: packedFile - Path to the packed file named something.foo.pack.gz. Will be replaced with something.foo

unpackLuceeJar

private any unpackLuceeJar([any libDirectory], [any luceeVersion])

Find the Lucee jar in the lib directory and if it's packed, unpack it. If the unpacked jar is found in artifacts, use it instead. If not, unpack and store in artifacts for next time.

Parameters:: libDirectory - Directory where the libs are for the server; luceeVersion - Semver for the Lucee version so we can use artifacts

writeXMLFile

private any writeXMLFile([any XMLDoc], [any path])

Write an XML file to disk and format it so it's human-readable

Parameters:: XMLDoc - XML Doc to write (complex value); path - File path to write XML to