PHP Interface AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface

Show file Open project: appserver-io/appserver Interface Usage Examples

Public Methods

Method Description
attachApp ( AppNode $app ) : void Attaches the passed app node.
attachDatasource ( DatasourceNode $datasource ) : void Attaches the passed datasource node.
getApps ( ) : array Returns an array with the information about the deployed applications.
getBaseDirectory ( ) : string Returns the node with the base directory information.
getContainers ( ) : array Returns the array with all available containers.
getDatasources ( ) : array Returns an array with the information about the deployed datasources.
getExtractors ( ) : array Returns the array with registered extractors.
getGroup ( ) : string Returns the groupname configured in the system configuration.
getInitialContext ( ) : InitialContextNode Returns the node containing information about the initial context.
getLoggers ( ) : array Returns the array with all available loggers.
getParam ( string $name ) : mixed Returns the param with the passed name casted to the specified type.
getParams ( ) : array Array with the handler params to use.
getParamsAsArray ( ) : array Returns the params casted to the defined type as associative array.
getProvisioners ( ) : array Returns the array with registered provisioners.
getScanners ( ) : array Returns the array with all available scanners.
getUmask ( ) : string Returns the umask configured in the system configuration.
getUser ( ) : string Returns the username configured in the system configuration.

Method Details

attachApp() public method

Attaches the passed app node.
public attachApp ( AppNode $app ) : void
$app AppserverIo\Appserver\Core\Api\Node\AppNode The app node to attach
return void

attachDatasource() public method

Attaches the passed datasource node.
public attachDatasource ( DatasourceNode $datasource ) : void
$datasource AppserverIo\Appserver\Core\Api\Node\DatasourceNode The datasource node to attach
return void

getApps() public method

Returns an array with the information about the deployed applications.
public getApps ( ) : array
return array The array with the information about the deployed applications

getBaseDirectory() public method

Returns the node with the base directory information.
public getBaseDirectory ( ) : string
return string The base directory information

getContainers() public method

Returns the array with all available containers.
public getContainers ( ) : array
return array The available containers

getDatasources() public method

Returns an array with the information about the deployed datasources.
public getDatasources ( ) : array
return array The array with the information about the deployed datasources

getExtractors() public method

Returns the array with registered extractors.
public getExtractors ( ) : array
return array The registered extractors

getGroup() public method

Returns the groupname configured in the system configuration.
public getGroup ( ) : string
return string The groupname

getInitialContext() public method

Returns the node containing information about the initial context.
public getInitialContext ( ) : InitialContextNode
return AppserverIo\Appserver\Core\Api\Node\InitialContextNode The initial context information

getLoggers() public method

Returns the array with all available loggers.
public getLoggers ( ) : array
return array The available loggers

getParam() public method

Returns the param with the passed name casted to the specified type.
public getParam ( string $name ) : mixed
$name string The name of the param to be returned
return mixed The requested param casted to the specified type

getParams() public method

Array with the handler params to use.
public getParams ( ) : array
return array

getParamsAsArray() public method

Returns the params casted to the defined type as associative array.
public getParamsAsArray ( ) : array
return array The array with the casted params

getProvisioners() public method

Returns the array with registered provisioners.
public getProvisioners ( ) : array
return array The registered provisioners

getScanners() public method

Returns the array with all available scanners.
public getScanners ( ) : array
return array The available scanners

getUmask() public method

Returns the umask configured in the system configuration.
public getUmask ( ) : string
return string The umask

getUser() public method

Returns the username configured in the system configuration.
public getUser ( ) : string
return string The username