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

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Author: Johann Zelger ([email protected])
Inheritance: extends AppserverIo\Description\Api\Node\AbstractNode, implements AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface, use trait AppserverIo\Appserver\Core\Api\Node\ClassLoadersNodeTrait
Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$deployment DeploymentNode The deployment configuration information.
$description DescriptionNode Container description
$factory string The container's factory class name.
$host HostNode The host configuration information.
$name string The container's name.
$provisioning boolean En-/Disables application application provisioning.
$receiver ReceiverNode The receiver used to start the container's socket.
$servers array The servers used in container
$threadType string The thread class name that start's the container.
$type string The container's class name.
$upstreams array The upstreams used in container

Public Methods

Method Description
attachServer ( AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface $server ) : void Attaches the passed server node.
getDeployment ( ) : DeploymentNode Returns the deployment configuration information.
getDescription ( ) : DescriptionNode Returns the receiver description.
getFactory ( ) : string Returns the container's factory class name.
getHost ( ) : HostNode Returns the host configuration information.
getName ( ) : string Returns the unique container name.
getProvisioning ( ) : boolean Returns TRUE if application provisioning for the container is enabled, else FALSE.
getServer ( string $name ) : AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface Returns the server with the passed name.
getServers ( ) : array Return's all server nodes
getServersAsArray ( ) : array Returns the servers as array with the server name as key.
getThreadType ( ) : string Returns the thread class name that start's the containere.
getType ( ) : string Returns the container's class name.
getUpstreams ( ) : array Return's all upstream nodes
merge ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode ) : void This method merges the passed container node into this one.

Method Details

attachServer() public method

Attaches the passed server node.
public attachServer ( AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface $server ) : void
$server AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface The server node to attach
return void

getDeployment() public method

Returns the deployment configuration information.
public getDeployment ( ) : DeploymentNode
return DeploymentNode The deployment configuration information

getDescription() public method

Returns the receiver description.
public getDescription ( ) : DescriptionNode
return DescriptionNode The receiver description

getFactory() public method

Returns the container's factory class name.
public getFactory ( ) : string
return string The container's factory class name

getHost() public method

Returns the host configuration information.
public getHost ( ) : HostNode
return HostNode The host configuration information

getName() public method

Returns the unique container name.
public getName ( ) : string
return string The unique container name

getProvisioning() public method

Returns TRUE if application provisioning for the container is enabled, else FALSE.
public getProvisioning ( ) : boolean
return boolean TRUE if application provisioning is enabled, else FALSE

getServer() public method

Returns the server with the passed name.
public getServer ( string $name ) : AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface
$name string The name of the server to return
return AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface The server node matching the passed name

getServers() public method

Return's all server nodes
public getServers ( ) : array
return array

getServersAsArray() public method

Returns the servers as array with the server name as key.
public getServersAsArray ( ) : array
return array The array with the servers

getThreadType() public method

Returns the thread class name that start's the containere.
public getThreadType ( ) : string
return string The thread class name that start's the container

getType() public method

Returns the container's class name.
public getType ( ) : string
return string The container's class name

getUpstreams() public method

Return's all upstream nodes
public getUpstreams ( ) : array
return array

merge() public method

This method merges the passed container node into this one.
public merge ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode ) : void
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container node to merge
return void

Property Details

$deployment protected property

The deployment configuration information.
protected DeploymentNode,AppserverIo\Appserver\Core\Api\Node $deployment
return DeploymentNode

$description protected property

Container description
protected DescriptionNode,AppserverIo\Appserver\Core\Api\Node $description
return DescriptionNode

$factory protected property

The container's factory class name.
protected string $factory
return string

$host protected property

The host configuration information.
protected HostNode,AppserverIo\Appserver\Core\Api\Node $host
return HostNode

$name protected property

The container's name.
protected string $name
return string

$provisioning protected property

En-/Disables application application provisioning.
protected bool $provisioning
return boolean

$receiver protected property

The receiver used to start the container's socket.
protected ReceiverNode,AppserverIo\Appserver\Core\Api\Node $receiver
return ReceiverNode

$servers protected property

The servers used in container
protected array $servers
return array

$threadType protected property

The thread class name that start's the container.
protected string $threadType
return string

$type protected property

The container's class name.
protected string $type
return string

$upstreams protected property

The upstreams used in container
protected array $upstreams
return array