PHP Class AppserverIo\Appserver\Core\Api\Node\AppserverNode

See link: https://github.com/appserver-io/appserver

Author: Tim Wagner ([email protected])

Inheritance: extends AppserverIo\Appserver\Core\Api\Node\AbstractNode, implements AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface, use trait ParamsNodeTrait, use trait AppserverIo\Appserver\Core\Api\Node\ConsolesNodeTrait

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

Protected Properties

Property	Type	Description
$apps	array	Array with the information about the deployed applications.
$containers	array	Array with nodes for the registered containers.
$datasources	array	Array with nodes for the registered datasources.
$extractors	array	Array with nodes for the registered extractors.
$initialContext	InitialContextNode	The node containing information about the initial context.
$loggers	array	Array with nodes for the registered loggers.
$scanners	array	Array with nodes for the registered scanners.

Public Methods

Method	Description
__construct ( )	Initializes the node with default values.
attachApp ( AppNode $app ) : void	Attaches the passed app node.
attachContainer ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $container ) : void	Attaches the passed container node.
attachDatasource ( DatasourceNode $datasource ) : void	Attaches the passed datasource node.
getAllowApplicationConfiguration ( ) : boolean	Queries whether application configuration for container, server and virtual host is allowed or not.
getApps ( ) : array	Returns an array with the information about the deployed applications.
getBaseDirectory ( ) : string	Returns the node with the base directory information.
getContainer ( string $name ) : AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	Returns the container with the passed name.
getContainers ( ) : array	Returns the array with all available containers.
getContainersAsArray ( ) : array	Returns the containers as array with the container name as key.
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.
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.

Protected Methods

Method	Description
initDefaultDirectories ( ) : void	Initialize the default directories.
initDefaultExtractors ( ) : void	Initializes the default extractors for archive based deployment.
initDefaultFiles ( ) : void	Initialize the default files.
initDefaultInitialContext ( ) : void	Initializes the default initial context configuration.

Method Details

__construct() public method

Initializes the node with default values.

public __construct ( )

attachApp() public method

Attaches the passed app node.

public attachApp ( AppNode $app ) : void
$app	AppNode	The app node to attach
return	void

attachContainer() public method

Attaches the passed container node.

public attachContainer ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $container ) : void
$container	AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	The container node to attach
return	void

attachDatasource() public method

Attaches the passed datasource node.

public attachDatasource ( DatasourceNode $datasource ) : void
$datasource	DatasourceNode	The datasource node to attach
return	void

getAllowApplicationConfiguration() public method

Queries whether application configuration for container, server and virtual host is allowed or not.

public getAllowApplicationConfiguration ( ) : boolean
return	boolean	TRUE if applications can provide additional configuration, else FALSE

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

getContainer() public method

Returns the container with the passed name.

public getContainer ( string $name ) : AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface
$name	string	The name of the container to return
return	AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	The container node matching the passed name

getContainers() public method

Returns the array with all available containers.

public getContainers ( ) : array
return	array	The available containers

getContainersAsArray() public method

Returns the containers as array with the container name as key.

public getContainersAsArray ( ) : array
return	array	The array with the 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	InitialContextNode	The initial context information

getLoggers() public method

Returns the array with all available loggers.

public getLoggers ( ) : array
return	array	The available loggers

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

initDefaultDirectories() protected method

Initialize the default directories.

protected initDefaultDirectories ( ) : void
return	void

initDefaultExtractors() protected method

Initializes the default extractors for archive based deployment.

protected initDefaultExtractors ( ) : void
return	void

initDefaultFiles() protected method

Initialize the default files.

protected initDefaultFiles ( ) : void
return	void

initDefaultInitialContext() protected method

Initializes the default initial context configuration.

protected initDefaultInitialContext ( ) : void
return	void

Property Details

$apps protected property

Array with the information about the deployed applications.

protected array $apps
return	array

$containers protected property

Array with nodes for the registered containers.

protected array $containers
return	array

$datasources protected property

Array with nodes for the registered datasources.

protected array $datasources
return	array

$extractors protected property

Array with nodes for the registered extractors.

protected array $extractors
return	array

$initialContext protected property

The node containing information about the initial context.

protected InitialContextNode,AppserverIo\Appserver\Core\Api\Node $initialContext
return	InitialContextNode

$loggers protected property

Array with nodes for the registered loggers.

protected array $loggers
return	array

$scanners protected property

Array with nodes for the registered scanners.

protected array $scanners
return	array