Class EbicsConfig

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

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

public static class EbicsConfig

Inheritance

object

EbicsConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SUBSEMBLY_EBICS_CONTACTFOLDERPATH

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

public const string SUBSEMBLY_EBICS_CONTACTFOLDERPATH = "SUBSEMBLY_EBICS_CONTACTFOLDERPATH"

Field Value

string

SUBSEMBLY_EBICS_SPOOLERBINARYPATH

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

public const string SUBSEMBLY_EBICS_SPOOLERBINARYPATH = "SUBSEMBLY_EBICS_SPOOLERBINARYPATH"

Field Value

string

SUBSEMBLY_EBICS_SPOOLERFOLDERPATH

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

public const string SUBSEMBLY_EBICS_SPOOLERFOLDERPATH = "SUBSEMBLY_EBICS_SPOOLERFOLDERPATH"

Field Value

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.

public const string SUBSEMBLY_EBICS_SPOOLERPASSCODE = "SUBSEMBLY_EBICS_SPOOLERPASSCODE"

Field Value

string

SUBSEMBLY_EBICS_SPOOLERUSERNAME

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

public const string SUBSEMBLY_EBICS_SPOOLERUSERNAME = "SUBSEMBLY_EBICS_SPOOLERUSERNAME"

Field Value

string

Properties

ContactFolderPath

File system path to the default EBICS contact storage.

public static string ContactFolderPath { get; set; }

Property Value

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

Default

DefaultContactFolderPath

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

public static string DefaultContactFolderPath { get; }

Property Value

string

SpoolerBinaryPath

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

public static string SpoolerBinaryPath { get; set; }

Property Value

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.

public static string SpoolerFolderPath { get; set; }

Property Value

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

public static string SpoolerPassCode { get; set; }

Property Value

string

SpoolerUserName

public static string SpoolerUserName { get; set; }

Property Value

string

Methods

GetSpoolerCredentials()

public static EbicsFileSpoolerCredentials GetSpoolerCredentials()

Returns

EbicsFileSpoolerCredentials

StoreSpoolerCredentials(EbicsFileSpoolerCredentials)

public static void StoreSpoolerCredentials(EbicsFileSpoolerCredentials aCredentials)

Parameters

aCredentials EbicsFileSpoolerCredentials