Class EbicsConfig

Access to the system environment variables that configure the Subsembly EBICS API.

Inheritance
object
EbicsConfig
Inherited Members
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public static class EbicsConfig

Fields

SUBSEMBLY_EBICS_CONTACTFOLDERPATH

The name of the enviroment variable that should be set to configure the ContactFolderPath.

Declaration
public const string SUBSEMBLY_EBICS_CONTACTFOLDERPATH = "SUBSEMBLY_EBICS_CONTACTFOLDERPATH"
Field Value
Type Description
string

SUBSEMBLY_EBICS_SPOOLERBINARYPATH

The name of the enviroment variable that should be set to configure the SpoolerBinaryPath.

Declaration
public const string SUBSEMBLY_EBICS_SPOOLERBINARYPATH = "SUBSEMBLY_EBICS_SPOOLERBINARYPATH"
Field Value
Type Description
string

SUBSEMBLY_EBICS_SPOOLERFOLDERPATH

The name of the enviroment variable that should be set to configure the SpoolerFolderPath.

Declaration
public const string SUBSEMBLY_EBICS_SPOOLERFOLDERPATH = "SUBSEMBLY_EBICS_SPOOLERFOLDERPATH"
Field Value
Type Description
string

SUBSEMBLY_EBICS_SPOOLERPASSCODE

The name of the enviroment variable that holds the encrypted password of the user that is used by the EbicsSpooler tool.

Declaration
public const string SUBSEMBLY_EBICS_SPOOLERPASSCODE = "SUBSEMBLY_EBICS_SPOOLERPASSCODE"
Field Value
Type Description
string

SUBSEMBLY_EBICS_SPOOLERUSERNAME

The name of the enviroment variable that holds the name of the user that is used by the EbicsSpooler tool.

Declaration
public const string SUBSEMBLY_EBICS_SPOOLERUSERNAME = "SUBSEMBLY_EBICS_SPOOLERUSERNAME"
Field Value
Type Description
string

Properties

ContactFolderPath

File system path to the default EBICS contact storage.

Declaration
public static string ContactFolderPath { get; set; }
Property Value
Type Description
string
Remarks

This may be set explicitly through an environment variable named SUBSEMBLY_EBICS_CONTACTFOLDERPATH. If the environment variable is set, it must contain a complete, rooted file system path. If the environment variable is not set, then this property is null.

Setting this property is only supported on Windows. It will set the environment variable named SUBSEMBLY_EBICS_CONTACTFOLDERPATH for the current users environment. Setting this property to null will delete that environment variable. Changing this property also updates Default to return a new object for the new path.

See Also

DefaultContactFolderPath

Returns the default path that shall be used if the ContactFolderPath is not set.

Declaration
public static string DefaultContactFolderPath { get; }
Property Value
Type Description
string

SpoolerBinaryPath

File system path to the directory where the EBICS binaries, e.g. the EbicsAdmin.exe and the EbicsSpooler.dll are located.

Declaration
public static string SpoolerBinaryPath { get; set; }
Property Value
Type Description
string
Remarks

This does not have a default value and must be set explicitly through the environment variable named SUBSEMBLY_EBICS_SPOOLERBINARYPATH. The value must be a complete, rooted file system path. If the environment variable is not set, then this property is null.

Setting this property is only supported on Windows. It will set the environment variable named SUBSEMBLY_EBICS_SPOOLERBINARYPATH for the current users environment. Setting this property to null will delete that environment variable.

SpoolerFolderPath

File system path to the default EBICS spooler root directory.

Declaration
public static string SpoolerFolderPath { get; set; }
Property Value
Type Description
string
Remarks

This does not have a default value and must be set explicitly through the environment variable named SUBSEMBLY_EBICS_SPOOLERFOLDERPATH. If the environment variable is set, it must contain a complete, rooted file system path.

Setting this property is only supported on Windows. It will set the environment variable named SUBSEMBLY_EBICS_SPOOLERFOLDERPATH for the current users environment. Setting this property to null will delete that environment variable. Changing this property only affects subsequently created EbicsFileSpooler instances.

SpoolerPassCode

Declaration
public static string SpoolerPassCode { get; set; }
Property Value
Type Description
string

SpoolerUserName

Declaration
public static string SpoolerUserName { get; set; }
Property Value
Type Description
string

Methods

GetSpoolerCredentials()

Declaration
public static EbicsFileSpoolerCredentials GetSpoolerCredentials()
Returns
Type Description
EbicsFileSpoolerCredentials

StoreSpoolerCredentials(EbicsFileSpoolerCredentials)

Declaration
public static void StoreSpoolerCredentials(EbicsFileSpoolerCredentials aCredentials)
Parameters
Type Name Description
EbicsFileSpoolerCredentials aCredentials