features

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 4, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const SessionHelperScript = `` /* 135-byte string literal not displayed */

Variables

This section is empty.

Functions

This section is empty.

Types

type Feature

type Feature interface {
	// Name of the feature (for debugging purposes)
	Name() string

	// IsNeeded indicates if this feature is required
	//   true will enable the feature
	//   false means it's skipped
	IsNeeded() bool

	// EnableFeature will perform the work of enabling the feature
	EnableFeature(layers layers.Layers, currentLayer layers.Layer) error
}

Feature is used to add additional features to the CNB

type FeatureConfig

type FeatureConfig struct {
	BpYAML   config.BuildpackYAML
	App      application.Application
	IsWebApp bool
	Logger   logger.Logger
}

type HttpdFeature

type HttpdFeature struct {
	// contains filtered or unexported fields
}

func NewHttpdFeature

func NewHttpdFeature(featureConfig FeatureConfig) HttpdFeature

func (HttpdFeature) EnableFeature

func (p HttpdFeature) EnableFeature(commonLayers layers.Layers, currentLayer layers.Layer) error

func (HttpdFeature) IsNeeded

func (p HttpdFeature) IsNeeded() bool

func (HttpdFeature) Name

func (p HttpdFeature) Name() string

type MemcachedFeature

type MemcachedFeature struct {
	// contains filtered or unexported fields
}

MemcachedFeature is used to enable support for session storage via Memcached

func NewMemcachedFeature

func NewMemcachedFeature(featureConfig FeatureConfig, srvs services.Services, serviceKey, platformRoot, sessionHelperPath string) MemcachedFeature

NewMemcachedFeature an object that Supports Memcached

func (MemcachedFeature) EnableFeature

func (m MemcachedFeature) EnableFeature(_ layers.Layers, layer layers.Layer) error

EnableFeature will turn on Memcached session storage for PHP

func (MemcachedFeature) IsNeeded

func (m MemcachedFeature) IsNeeded() bool

IsNeeded determines if this app needs Memcached for storing session data

func (MemcachedFeature) Name

func (m MemcachedFeature) Name() string

Name of the feature

type MemcachedSessionSupport

type MemcachedSessionSupport struct {
	// contains filtered or unexported fields
}

MemcachedSessionSupport provides functionality to locate and configure memcached as a session handler

func FromExistingMemcachedSessionSupport

func FromExistingMemcachedSessionSupport(featureConfig FeatureConfig, srvs services.Services, serviceKey string) MemcachedSessionSupport

func NewMemcachedSessionSupport

func NewMemcachedSessionSupport(platformRoot, appRoot string) (MemcachedSessionSupport, error)

func (MemcachedSessionSupport) ConfigureService

func (s MemcachedSessionSupport) ConfigureService() error

func (MemcachedSessionSupport) FindService

func (s MemcachedSessionSupport) FindService() (services.Credentials, bool)

type NginxFeature

type NginxFeature struct {
	// contains filtered or unexported fields
}

func NewNginxFeature

func NewNginxFeature(featureConfig FeatureConfig) NginxFeature

func (NginxFeature) EnableFeature

func (p NginxFeature) EnableFeature(commonLayers layers.Layers, currentLayer layers.Layer) error

func (NginxFeature) IsNeeded

func (p NginxFeature) IsNeeded() bool

func (NginxFeature) Name

func (p NginxFeature) Name() string

type PhpFeature

type PhpFeature struct {
	// contains filtered or unexported fields
}

func NewPhpFeature

func NewPhpFeature(featureConfig FeatureConfig) PhpFeature

func (PhpFeature) EnableFeature

func (p PhpFeature) EnableFeature(commonLayers layers.Layers, currentLayer layers.Layer) error

func (PhpFeature) IsNeeded

func (p PhpFeature) IsNeeded() bool

func (PhpFeature) Name

func (p PhpFeature) Name() string

type PhpFpmFeature

type PhpFpmFeature struct {
	// contains filtered or unexported fields
}

func NewPhpFpmFeature

func NewPhpFpmFeature(featureConfig FeatureConfig) PhpFpmFeature

func (PhpFpmFeature) EnableFeature

func (p PhpFpmFeature) EnableFeature(commonLayers layers.Layers, currentLayer layers.Layer) error

func (PhpFpmFeature) IsNeeded

func (p PhpFpmFeature) IsNeeded() bool

func (PhpFpmFeature) Name

func (p PhpFpmFeature) Name() string

type PhpWebServerFeature

type PhpWebServerFeature struct {
	// contains filtered or unexported fields
}

func NewPhpWebServerFeature

func NewPhpWebServerFeature(featureConfig FeatureConfig) PhpWebServerFeature

func (PhpWebServerFeature) EnableFeature

func (p PhpWebServerFeature) EnableFeature(commonLayers layers.Layers, _ layers.Layer) error

func (PhpWebServerFeature) IsNeeded

func (p PhpWebServerFeature) IsNeeded() bool

func (PhpWebServerFeature) Name

func (p PhpWebServerFeature) Name() string

type ProcMgrFeature

type ProcMgrFeature struct {
	// contains filtered or unexported fields
}

func NewProcMgrFeature

func NewProcMgrFeature(featureConfig FeatureConfig, procMgrPath string) ProcMgrFeature

func (ProcMgrFeature) EnableFeature

func (p ProcMgrFeature) EnableFeature(currentLayers layers.Layers, currentLayer layers.Layer) error

func (ProcMgrFeature) IsNeeded

func (p ProcMgrFeature) IsNeeded() bool

func (ProcMgrFeature) Name

func (p ProcMgrFeature) Name() string

type RedisFeature

type RedisFeature struct {
	// contains filtered or unexported fields
}

RedisFeature is used to enable support for session storage via Redis

func NewRedisFeature

func NewRedisFeature(featureConfig FeatureConfig, srvs services.Services, serviceKey, platformRoot, sessionHelperPath string) RedisFeature

NewRedisFeature an object that Supports Redis

func (RedisFeature) EnableFeature

func (r RedisFeature) EnableFeature(_ layers.Layers, layer layers.Layer) error

EnableFeature will turn on Redis session storage for PHP

func (RedisFeature) IsNeeded

func (r RedisFeature) IsNeeded() bool

IsNeeded determines if this app needs Redis for storing session data

func (RedisFeature) Name

func (r RedisFeature) Name() string

Name of the feature

type RedisSessionSupport

type RedisSessionSupport struct {
	// contains filtered or unexported fields
}

RedisSessionSupport provides functionality to locate and configure redis as a session handler

func FromExistingRedisSessionSupport

func FromExistingRedisSessionSupport(featureConfig FeatureConfig, srvs services.Services, serviceKey string) RedisSessionSupport

func NewRedisSessionSupport

func NewRedisSessionSupport(platformRoot, appRoot string) (RedisSessionSupport, error)

func (RedisSessionSupport) ConfigureService

func (s RedisSessionSupport) ConfigureService() error

func (RedisSessionSupport) FindService

func (s RedisSessionSupport) FindService() (services.Credentials, bool)

type ScriptsFeature

type ScriptsFeature struct {
	// contains filtered or unexported fields
}

func NewScriptsFeature

func NewScriptsFeature(featureConfig FeatureConfig) ScriptsFeature

func (ScriptsFeature) EnableFeature

func (p ScriptsFeature) EnableFeature(commonLayers layers.Layers, currentLayer layers.Layer) error

func (ScriptsFeature) IsNeeded

func (p ScriptsFeature) IsNeeded() bool

func (ScriptsFeature) Name

func (p ScriptsFeature) Name() string

type SessionConfigurer

type SessionConfigurer interface {
	ConfigureService() error
}

SessionConfigurer is used to generate configuration for session_helper

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL