Class SambaManagerBase`Abstract`

Hierarchy-Diagram

UML class diagram of SambaManagerBase

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

icon for a protected property in the UML class diagram

protected property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a private method in the UML class diagram

private method

italic abstract property/method

Hierarchy (view full)

SambaManagerBase
- SambaManagerNet
- SambaManagerConfFile

Implements

ISambaManager

Index

Constructors

Methods

addShare editGlobal editShare exportConfig getGlobalConfig getShare getShares importConfig listShareNames parseConfig parseGlobalConfig parseShareConfig recommendedGlobalDefaults recommendedShareDefaults removeShare renameShare setUserPassword unparseConfig

Constructors

constructor

new SambaManagerBase(): SambaManagerBase
Returns SambaManagerBase

Methods

`Abstract` addShare

addShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Add a new share configuration
Parameters
- share: SambaShareConfig
  share configuration to add
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.addShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:201

`Abstract` editGlobal

editGlobal(globalConfig: SambaGlobalConfig): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Update current global configuration
Parameters
- globalConfig: SambaGlobalConfig
  New global configuration
Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Implementation of ISambaManager.editGlobal
- Defined in houston-common-lib/lib/managers/samba/manager.ts:181

`Abstract` editShare

editShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Update an existing share configuration NOTE: cannot simply update share name. see ()
Parameters
- share: SambaShareConfig
  new share configuration
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.editShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:205

`Abstract` exportConfig

exportConfig(): neverthrow.ResultAsync<string, ProcessError>
Dump configuration to smb.conf format as string

Returns neverthrow.ResultAsync<string, ProcessError>
Implementation of ISambaManager.exportConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:191

`Abstract` getGlobalConfig

getGlobalConfig(): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Get current global configuration

Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Implementation of ISambaManager.getGlobalConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:179

`Abstract` getShare

getShare(shareName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Get share configuration by name
Parameters
- shareName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.getShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:187

`Abstract` getShares

getShares(): neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>
Get all share configurations

Returns neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>
Implementation of ISambaManager.getShares
- Defined in houston-common-lib/lib/managers/samba/manager.ts:189

`Abstract` importConfig

importConfig(config: string): neverthrow.ResultAsync<SambaManagerBase, ProcessError>
Import configuration from smb.conf format string
Parameters
- config: string
  smb.conf format string
Returns neverthrow.ResultAsync<SambaManagerBase, ProcessError>
Implementation of ISambaManager.importConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:193

`Abstract` listShareNames

listShareNames(): neverthrow.ResultAsync<string[], ParsingError | ProcessError>
Get list of all share names

Returns neverthrow.ResultAsync<string[], ParsingError | ProcessError>
Implementation of ISambaManager.listShareNames
- Defined in houston-common-lib/lib/managers/samba/manager.ts:185

parseConfig

parseConfig(config: string): neverthrow.Result<SambaConfig, ParsingError>
Parse complete samba configuration text (e.g. contents of smb.conf) into configuration object
Parameters
- config: string
  Complete configuration text
Returns neverthrow.Result<SambaConfig, ParsingError>
Implementation of ISambaManager.parseConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:155

parseGlobalConfig

parseGlobalConfig(globalConfig: string): neverthrow.Result<SambaGlobalConfig, ParsingError>
Parse global configuration text into global config object
Parameters
- globalConfig: string
  Global configuration text, including '[global]' header
Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
Implementation of ISambaManager.parseGlobalConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:149

parseShareConfig

parseShareConfig(shareConfig: string): neverthrow.Result<SambaShareConfig, ParsingError>
Parse configuration text into a share object
Parameters
- shareConfig: string
  Share configuration text, including '[share name]' header
Returns neverthrow.Result<SambaShareConfig, ParsingError>
Implementation of ISambaManager.parseShareConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:136

recommendedGlobalDefaults

recommendedGlobalDefaults(): neverthrow.Result<SambaGlobalConfig, ParsingError>
Recommended defaults for global configuration. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
Implementation of ISambaManager.recommendedGlobalDefaults
- Defined in houston-common-lib/lib/managers/samba/manager.ts:163

recommendedShareDefaults

recommendedShareDefaults(): neverthrow.Result<SambaShareConfig, ParsingError>
Recommended defaults for a new share. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaShareConfig, ParsingError>
Implementation of ISambaManager.recommendedShareDefaults
- Defined in houston-common-lib/lib/managers/samba/manager.ts:169

`Abstract` removeShare

removeShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Remove an existing share configuration
Parameters
- share: SambaShareConfig
  share to remove
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.removeShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:209

renameShare

renameShare(oldName: string, newName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Rename a share
Parameters
- oldName: string
- newName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.renameShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:213

setUserPassword

setUserPassword(user: string, passwd: string): neverthrow.ResultAsync<void, ProcessError>
Add samba user with specific passwd
Parameters
- user: string
- passwd: string
Returns neverthrow.ResultAsync<void, ProcessError>
Implementation of ISambaManager.setUserPassword
- Defined in houston-common-lib/lib/managers/samba/manager.ts:196

unparseConfig

unparseConfig(config: SambaConfig): neverthrow.Result<string, ParsingError>
Unparse comlete samba configuration object back into smbd.conf format text
Parameters
- config: SambaConfig
Returns neverthrow.Result<string, ParsingError>
Implementation of ISambaManager.unparseConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:159