PHP Interface AppserverIo\Appserver\Core\Api\ServiceInterface

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Show file Open project: appserver-io/appserver

Public Methods

Method Description
findAll ( ) : array Returns all nodes.
getDeployDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string Returns the servers deploy directory.
getInitialContext ( ) : InitialContext Returns the initial context instance.
getLogDir ( string $relativePathToAppend = '' ) : string Returns the servers log directory.
getSystemConfiguration ( ) : AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface Returns the system configuration.
getTmpDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string Returns the servers tmp directory, append with the passed directory.
getWebappsDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string Returns the servers webapps directory.
load ( integer $uuid ) : AppserverIo\Configuration\Interfaces\NodeInterface Returns the node with the passed UUID.
setSystemConfiguration ( AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface $systemConfiguration ) : AppserverIo\Appserver\Core\Api\ServiceInterface Allows to set the system configuration.

Method Details

findAll() public method

Returns all nodes.
public findAll ( ) : array
return array An array with all nodes

getDeployDir() public method

Returns the servers deploy directory.
public getDeployDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container to return the deployment directory for
$relativePathToAppend string A relative path to append
return string

getInitialContext() public method

Returns the initial context instance.
public getInitialContext ( ) : InitialContext
return AppserverIo\Appserver\Core\InitialContext The initial Context

getLogDir() public method

Returns the servers log directory.
public getLogDir ( string $relativePathToAppend = '' ) : string
$relativePathToAppend string A relative path to append
return string

getSystemConfiguration() public method

Returns the system configuration.
public getSystemConfiguration ( ) : AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface
return AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface The system configuration

getTmpDir() public method

Returns the servers tmp directory, append with the passed directory.
public getTmpDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container to return the temporary directory for
$relativePathToAppend string A relative path to append
return string

getWebappsDir() public method

Returns the servers webapps directory.
public getWebappsDir ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $relativePathToAppend = '' ) : string
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container to return the temporary directory for
$relativePathToAppend string A relative path to append
return string

load() public method

Returns the node with the passed UUID.
public load ( integer $uuid ) : AppserverIo\Configuration\Interfaces\NodeInterface
$uuid integer UUID of the node to return
return AppserverIo\Configuration\Interfaces\NodeInterface The node with the UUID passed as parameter

setSystemConfiguration() public method

Allows to set the system configuration.
public setSystemConfiguration ( AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface $systemConfiguration ) : AppserverIo\Appserver\Core\Api\ServiceInterface
$systemConfiguration AppserverIo\Appserver\Core\Interfaces\SystemConfigurationInterface The system configuration
return AppserverIo\Appserver\Core\Api\ServiceInterface