PHP Class AppserverIo\Appserver\Core\ServerNodeConfiguration

Inheritance: implements AppserverIo\Server\Interfaces\ServerConfigurationInterface
Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$accesses array The accesses array.
$analytics array The analytics array.
$authentications array The authentications array.
$connectionHandlers array Hold's the connection handler array
$environmentVariables array The environmentVariables array.
$handlers array The handlers array.
$headers array The headers array.
$locations array The locations array.
$modules array The modules array.
$node AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface The server node instance.
$rewriteMaps array The array with the rewrite maps.
$rewrites array The rewrites array.
$virtualHosts array The virtual hosts array.

Public Methods

Method Description
__construct ( AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface $node ) Initializes the configuration with the values found in the passed server configuration node.
getAccesses ( ) : array Returns the access configuration.
getAddress ( ) : string Returns address
getAdmin ( ) : string Returns admin
getAllowSelfSigned ( ) : boolean Return's TRUE if self-signed certificates has to be allowed, but requires verify_peer to be FALSE
getAnalytics ( ) : string Returns analytics
getAuthentications ( ) : array Returns the authentication configuration.
getAutoIndex ( ) : boolean Returns the auto index configuration
getAutoIndexTemplatePath ( ) : string Returns template path for possible configured auto index page
getCertPath ( ) : string Returns cert path
getCertificates ( ) : array Returns the certificates used by the server
getCiphers ( ) : string Return's the list of available ciphers.
getConnectionHandlers ( ) : array Returns connection handlers
getCryptoMethod ( ) : string Return's the crypto method to use
getDhParamPath ( ) : string Returns DH param path
getDirectoryIndex ( ) : string Returns directory index definition
getDisableCompression ( ) : boolean Return's TRUE to disable TLS compression. This can help mitigate the CRIME attack vector
getDocumentRoot ( ) : string Returns document root
getEcdhCurve ( ) : string Return's the curve to use with ECDH ciphers, if not specified prime256v1 will be used
getEnvironmentVariables ( ) : array Returns the environment variable configuration
getErrorsPageTemplatePath ( ) : string Returns template file path for errors page
getFlags ( ) : string Returns the server socket flags.
getGroup ( ) : string Returns the groupname we want to execute the processes with.
getHandlers ( ) : array Returns handlers
getHeaders ( ) : array Returns headers
getHonorCipherOrder ( ) : boolean Return's TRUE if control cipher ordering preferences during negotiation has to be allowed
getKeepAliveMax ( ) : integer Returns keep-alive max connection
getKeepAliveTimeout ( ) : integer Returns keep-alive timeout
getLocations ( ) : array Returns the locations.
getLoggerName ( ) : string Returns logger name
getModules ( ) : array Returns modules
getName ( ) : string Returns servers name
getPassphrase ( ) : string Returns passphrase
getPeerName ( ) : string Return's the peer name to be used, if this value is not set, then the name is guessed based on the hostname used when opening the stream
getPort ( ) : integer Returns port
getPrivateKeyPath ( ) : string Return's private key path
getRequestContextType ( ) : string Returns request type
getRewriteMaps ( ) : array Returns the locations.
getRewrites ( ) : array Returns the rewrite configuration.
getServerContextType ( ) : string Returns context type
getSingleDhUse ( ) : boolean Return's TRUE if new key pair has to be created created when using DH parameters (improves forward secrecy)
getSingleEcdhUse ( ) : boolean Return's TRUE if a new key pair has to be created in scenarios where ECDH cipher suites are negotiated (instead of the preferred ECDHE ciphers)
getSocketType ( ) : string Returns socket type
getSoftware ( ) : string Returns software
getStreamContextType ( ) : string Returns stream context type
getTransport ( ) : string Returns transport
getType ( ) : string Returns type
getUser ( ) : string Returns the username we want to execute the processes with.
getVerifyPeer ( ) : boolean Return's TRUE it the verification of use SSL certificate has to be required
getVerifyPeerName ( ) : boolean Return's TRUE it the peer name has to be verified
getVirtualHosts ( ) : array Returns virtual hosts
getWelcomePageTemplatePath ( ) : string Returns template path for possible configured welcome page
getWorkerAcceptMax ( ) : integer Returns worker's accept max count
getWorkerAcceptMin ( ) : integer Returns worker's accept min count
getWorkerNumber ( ) : integer Returns worker number
getWorkerType ( ) : string Returns worker type

Method Details

__construct() public method

Initializes the configuration with the values found in the passed server configuration node.
public __construct ( AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface $node )
$node AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface The server node instance

getAccesses() public method

Returns the access configuration.
public getAccesses ( ) : array
return array

getAddress() public method

Returns address
public getAddress ( ) : string
return string

getAdmin() public method

Returns admin
public getAdmin ( ) : string
return string

getAllowSelfSigned() public method

Return's TRUE if self-signed certificates has to be allowed, but requires verify_peer to be FALSE
public getAllowSelfSigned ( ) : boolean
return boolean

getAnalytics() public method

Returns analytics
public getAnalytics ( ) : string
return string

getAuthentications() public method

Returns the authentication configuration.
public getAuthentications ( ) : array
return array The array with the authentication configuration

getAutoIndex() public method

Returns the auto index configuration
public getAutoIndex ( ) : boolean
return boolean

getAutoIndexTemplatePath() public method

Returns template path for possible configured auto index page
public getAutoIndexTemplatePath ( ) : string
return string

getCertPath() public method

Returns cert path
public getCertPath ( ) : string
return string

getCertificates() public method

Returns the certificates used by the server
public getCertificates ( ) : array
return array

getCiphers() public method

Return's the list of available ciphers.
public getCiphers ( ) : string
return string

getConnectionHandlers() public method

Returns connection handlers
public getConnectionHandlers ( ) : array
return array

getCryptoMethod() public method

Return's the crypto method to use
public getCryptoMethod ( ) : string
return string

getDhParamPath() public method

Returns DH param path
public getDhParamPath ( ) : string
return string

getDirectoryIndex() public method

Returns directory index definition
public getDirectoryIndex ( ) : string
return string

getDisableCompression() public method

Return's TRUE to disable TLS compression. This can help mitigate the CRIME attack vector
public getDisableCompression ( ) : boolean
return boolean

getDocumentRoot() public method

Returns document root
public getDocumentRoot ( ) : string
return string

getEcdhCurve() public method

Return's the curve to use with ECDH ciphers, if not specified prime256v1 will be used
public getEcdhCurve ( ) : string
return string

getEnvironmentVariables() public method

Returns the environment variable configuration
public getEnvironmentVariables ( ) : array
return array

getErrorsPageTemplatePath() public method

Returns template file path for errors page

getFlags() public method

Returns the server socket flags.
public getFlags ( ) : string
return string

getGroup() public method

Returns the groupname we want to execute the processes with.
public getGroup ( ) : string
return string

getHandlers() public method

Returns handlers
public getHandlers ( ) : array
return array

getHeaders() public method

Returns headers
public getHeaders ( ) : array
return array

getHonorCipherOrder() public method

Return's TRUE if control cipher ordering preferences during negotiation has to be allowed
public getHonorCipherOrder ( ) : boolean
return boolean

getKeepAliveMax() public method

Returns keep-alive max connection
public getKeepAliveMax ( ) : integer
return integer

getKeepAliveTimeout() public method

Returns keep-alive timeout
public getKeepAliveTimeout ( ) : integer
return integer

getLocations() public method

Returns the locations.
public getLocations ( ) : array
return array

getLoggerName() public method

Returns logger name
public getLoggerName ( ) : string
return string

getModules() public method

Returns modules
public getModules ( ) : array
return array

getName() public method

Returns servers name
public getName ( ) : string
return string

getPassphrase() public method

Returns passphrase
public getPassphrase ( ) : string
return string

getPeerName() public method

Return's the peer name to be used, if this value is not set, then the name is guessed based on the hostname used when opening the stream
public getPeerName ( ) : string
return string

getPort() public method

Returns port
public getPort ( ) : integer
return integer

getPrivateKeyPath() public method

Return's private key path
public getPrivateKeyPath ( ) : string
return string

getRequestContextType() public method

Returns request type
public getRequestContextType ( ) : string
return string

getRewriteMaps() public method

Returns the locations.
public getRewriteMaps ( ) : array
return array

getRewrites() public method

Returns the rewrite configuration.
public getRewrites ( ) : array
return array

getServerContextType() public method

Returns context type
public getServerContextType ( ) : string
return string

getSingleDhUse() public method

Return's TRUE if new key pair has to be created created when using DH parameters (improves forward secrecy)
public getSingleDhUse ( ) : boolean
return boolean

getSingleEcdhUse() public method

Return's TRUE if a new key pair has to be created in scenarios where ECDH cipher suites are negotiated (instead of the preferred ECDHE ciphers)
public getSingleEcdhUse ( ) : boolean
return boolean

getSocketType() public method

Returns socket type
public getSocketType ( ) : string
return string

getSoftware() public method

Returns software
public getSoftware ( ) : string
return string

getStreamContextType() public method

Returns stream context type
public getStreamContextType ( ) : string
return string

getTransport() public method

Returns transport
public getTransport ( ) : string
return string

getType() public method

Returns type
public getType ( ) : string
return string

getUser() public method

Returns the username we want to execute the processes with.
public getUser ( ) : string
return string

getVerifyPeer() public method

Return's TRUE it the verification of use SSL certificate has to be required
public getVerifyPeer ( ) : boolean
return boolean

getVerifyPeerName() public method

Return's TRUE it the peer name has to be verified
public getVerifyPeerName ( ) : boolean
return boolean

getVirtualHosts() public method

Returns virtual hosts
public getVirtualHosts ( ) : array
return array

getWelcomePageTemplatePath() public method

Returns template path for possible configured welcome page

getWorkerAcceptMax() public method

Returns worker's accept max count
public getWorkerAcceptMax ( ) : integer
return integer

getWorkerAcceptMin() public method

Returns worker's accept min count
public getWorkerAcceptMin ( ) : integer
return integer

getWorkerNumber() public method

Returns worker number
public getWorkerNumber ( ) : integer
return integer

getWorkerType() public method

Returns worker type
public getWorkerType ( ) : string
return string

Property Details

$accesses protected property

The accesses array.
protected array $accesses
return array

$analytics protected property

The analytics array.
protected array $analytics
return array

$authentications protected property

The authentications array.
protected array $authentications
return array

$connectionHandlers protected property

Hold's the connection handler array
protected array $connectionHandlers
return array

$environmentVariables protected property

The environmentVariables array.
protected array $environmentVariables
return array

$handlers protected property

The handlers array.
protected array $handlers
return array

$headers protected property

The headers array.
protected array $headers
return array

$locations protected property

The locations array.
protected array $locations
return array

$modules protected property

The modules array.
protected array $modules
return array

$node protected property

The server node instance.
protected ServerNodeInterface,AppserverIo\Appserver\Core\Api\Node $node
return AppserverIo\Appserver\Core\Api\Node\ServerNodeInterface

$rewriteMaps protected property

The array with the rewrite maps.
protected array $rewriteMaps
return array

$rewrites protected property

The rewrites array.
protected array $rewrites
return array

$virtualHosts protected property

The virtual hosts array.
protected array $virtualHosts
return array