PHP Class AppserverIo\Appserver\Core\Api\DeploymentService

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends AppserverIo\Appserver\Core\Api\AbstractFileOperationService
Show file Open project: appserver-io/appserver Class Usage Examples

Public Methods

Method Description
findAll ( ) : array Returns all deployment configurations.
load ( integer $uuid ) : DeploymentNode Returns the deployment with the passed UUID.
loadContainerInstance ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface $systemConfiguration, string $webappPath ) : void Loads the container instances from the META-INF/containers.xml configuration file of the passed web application path and add/merge them to/with the system configuration.
loadContainerInstances ( ) : AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface Loads the containers, defined by the applications, merges them into the system configuration and returns the merged system configuration.
loadContextInstance ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $webappPath ) : ContextNode Initializes the context instance for the passed webapp path.
loadContextInstancesByContainer ( AppserverIo\Appserver\Core\Interfaces\ContainerInterface $container ) : ContextNode[] Initializes the available application contexts and returns them.

Protected Methods

Method Description
prepareSystemProperties ( AppserverIo\Properties\PropertiesInterface $properties, string $webappPath ) : void Prepares the system properties for the actual mode.

Method Details

findAll() public method

Returns all deployment configurations.
See also: AppserverIo\Appserver\Core\Api\ServiceInterface::findAll()
public findAll ( ) : array
return array An array with all deployment configurations

load() public method

Returns the deployment with the passed UUID.
See also: ServiceInterface::load()
public load ( integer $uuid ) : DeploymentNode
$uuid integer UUID of the deployment to return
return AppserverIo\Appserver\Core\Api\Node\DeploymentNode The deployment with the UUID passed as parameter

loadContainerInstance() public method

Loads the container instances from the META-INF/containers.xml configuration file of the passed web application path and add/merge them to/with the system configuration.
public loadContainerInstance ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface $systemConfiguration, string $webappPath ) : void
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container node used for property replacement
$systemConfiguration AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface The system configuration to add/merge the found containers to/with
$webappPath string The path to the web application to search for a META-INF/containers.xml file
return void

loadContainerInstances() public method

Loads the containers, defined by the applications, merges them into the system configuration and returns the merged system configuration.
public loadContainerInstances ( ) : AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface
return AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface The merged system configuration

loadContextInstance() public method

Initializes the context instance for the passed webapp path.
public loadContextInstance ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $webappPath ) : ContextNode
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container to load the context for
$webappPath string The path to the web application
return AppserverIo\Appserver\Core\Api\Node\ContextNode The initialized context instance

loadContextInstancesByContainer() public method

Initializes the available application contexts and returns them.
public loadContextInstancesByContainer ( AppserverIo\Appserver\Core\Interfaces\ContainerInterface $container ) : ContextNode[]
$container AppserverIo\Appserver\Core\Interfaces\ContainerInterface The container we want to add the applications to
return AppserverIo\Appserver\Core\Api\Node\ContextNode[] The array with the application contexts

prepareSystemProperties() protected method

Prepares the system properties for the actual mode.
protected prepareSystemProperties ( AppserverIo\Properties\PropertiesInterface $properties, string $webappPath ) : void
$properties AppserverIo\Properties\PropertiesInterface The properties to prepare
$webappPath string The path of the web application to prepare the properties with
return void