Class FinAdmin

Manages the contacts stored in a contact folder.

Inheritance

object

FinAdmin

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Subsembly.FinTS.Forms

Assembly: Subsembly.FinTS.Win32.dll

Syntax

public class FinAdmin

Constructors

FinAdmin(IFinContactFolder, FinBanksFile)

Declaration

public FinAdmin(IFinContactFolder aContactFolder, FinBanksFile aBanksFile)

Parameters

Type	Name	Description
IFinContactFolder	aContactFolder	An IFinContactFolder implementation that provides access to the storage of the FinContact instances that are managed by this adminstrator. This could be the FinContactFolder.Default storage folder, or your own implementation. Thus must not be null.
FinBanksFile	aBanksFile	Optional FinBanksFile instance that provides the bank data database which significantly eases contact setup for the user. If this is null, then the user must manually provide all contact data.

Exceptions

Type	Condition
ArgumentNullException	The parameter aContactFolder was null.

Properties

BanksFile

The FinBanksFile instance that was passed to the constructor. May be null.

Declaration

public FinBanksFile BanksFile { get; }

Property Value

Type	Description
FinBanksFile

ContactCount

The number of contacts stored in the ContactFolder.

Declaration

public int ContactCount { get; }

Property Value

Type	Description
int

ContactFolder

The IFinContactFolder implementation that was passed to the constructor.

Declaration

public IFinContactFolder ContactFolder { get; }

Property Value

Type	Description
IFinContactFolder

DefaultCaption

Provides the default caption for all FinAdmin dialogs.

Declaration

public static string DefaultCaption { get; set; }

Property Value

Type	Description
string

HelpProvider

Optional HelpProvider instance that will be used to provide Help on all dialogs spawned by this FinAdmin instance.

Declaration

public HelpProvider HelpProvider { get; set; }

Property Value

Type	Description
HelpProvider

Remarks

A HelpProvider instance attached through this property will be associated with all dialogs that are spawed by this FinAdmin instance. The different dialogs are associated with different help keywords as shown in the following table:

Dialog Box	Help Keyword
Dialog box for editing the contact details that is shown by the EditContact(IWin32Window, FinContact) method.	FinContactForm
Wizard that has been started by one of the NewContact methods of this class.	FinWizardForm
Dialog box for changing the PIN or password that is shown by the ChangeMediaPin(IWin32Window, FinContact) method.	FinChangePasswordForm

HideAccounts

Flag that controls whether UPD accounts shall be hidden in all dialogs.

Declaration

public static bool HideAccounts { get; set; }

Property Value

Type	Description
bool

Remarks

The default value is false.

Methods

AddContact(IWin32Window, FinContact, bool)

Declaration

public void AddContact(IWin32Window aParentWindow, FinContact aContact, bool fSync)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact
bool	fSync	If true, then the added contact will automatically be synchronized, if needed. If false, then it will just be added to the contact folder.

BrowseForKeyFile(string, bool)

Declaration

public static string BrowseForKeyFile(string sFileName, bool fCreate)

Parameters

Type	Name	Description
string	sFileName
bool	fCreate

Returns

Type	Description
string

ChangeMediaPin(IWin32Window, FinContact)

Change the PIN of the security media associated with the given contact.

Declaration

public void ChangeMediaPin(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact	FinContact instance to change the PIN (or passphrase) for.

ChangeOnlinePin(IWin32Window, FinContact)

Change the online PIN of the given contact.

Declaration

public void ChangeOnlinePin(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact	FinContact instance to change the PIN (or passphrase) for.

DeleteContact(IWin32Window, FinContact)

Declaration

public DialogResult DeleteContact(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

Returns

Type	Description
DialogResult

DetectCommService(string)

Detects the type of communication service from the specified address and also validates the address.

Declaration

public static FinCommService DetectCommService(string sCommAddress)

Parameters

Type	Name	Description
string	sCommAddress

Returns

Type	Description
FinCommService

EditContact(IWin32Window, FinContact)

Show Form where the user can edit the contact data details.

Declaration

public DialogResult EditContact(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact	FinContact instance to be edited by the user. Must not be null.

Returns

Type	Description
DialogResult

FindContactName(string)

Declaration

public FinContact FindContactName(string sContactName)

Parameters

Type	Name	Description
string	sContactName

Returns

Type	Description
FinContact

FormatFingerprint(byte[])

Declaration

public static string FormatFingerprint(byte[] vbFingerprint)

Parameters

Type	Name	Description
byte[]	vbFingerprint

Returns

Type	Description
string

GenerateIniLetter(FinContact, IFinSecurityMedia)

Declaration

public void GenerateIniLetter(FinContact aContact, IFinSecurityMedia aSecMedia)

Parameters

Type	Name	Description
FinContact	aContact	Required FinContact object. This is solely used in order to extract the general contact information that will appear on the Ini-letter. This is not used to obtain the actual key data!
IFinSecurityMedia	aSecMedia	Authenticated security media object that will be used in order to extract the key data that will appear on the Ini-letter.

GenerateIniLetter(string, FinContact, FinSecureKey)

Generates an Ini-Letter for the given key of the given contact.

Declaration

public static string GenerateIniLetter(string sIniLetterTemplate, FinContact aContact, FinSecureKey aKey)

Parameters

Type	Name	Description
string	sIniLetterTemplate	Template string with placeholders.
FinContact	aContact	Required FinContact object. This is solely used in order to extract the general contact information that will appear on the Ini-letter. This is not used to obtain the actual key data!
FinSecureKey	aKey	The public key that shall appear on the Ini-letter.

Returns

Type	Description
string

GenerateIniLetter(IWin32Window, FinContact)

Declaration

public void GenerateIniLetter(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

ImportContact(string)

Declaration

public FinContact ImportContact(string sContactFileName)

Parameters

Type	Name	Description
string	sContactFileName

Returns

Type	Description
FinContact

InternalizeKeyFile(IWin32Window, FinContact)

Reads the secret keys from a key file and stores them in the FinContact.

Declaration

public void InternalizeKeyFile(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

Remarks

In addition to reading the secret keys, the FinContact is changed to use the FinSecurityMediaVoid implementation which will use the secret keys that are now stored in the FinContact. This means, that the key file is no longer needed or referenced.

Exceptions

Type	Condition
ArgumentNullException	The parameter aContact was null.
ArgumentException	The SecurityMediaType of the given FinContact was not KeyFile.

KeyChange(IWin32Window, FinContact)

Declaration

public void KeyChange(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

NewContact(IWin32Window)

Declaration

public FinContact NewContact(IWin32Window aParentWindow)

Parameters

Type	Name	Description
IWin32Window	aParentWindow

Returns

Type	Description
FinContact

NewContact(IWin32Window, bool)

Declaration

public FinContact NewContact(IWin32Window aParentWindow, bool fSync)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
bool	fSync	If true, then the new contact will be immediately synchronised after it was created.

Returns

Type	Description
FinContact

ProfileChange(IWin32Window, FinContact)

Declaration

public FinContact ProfileChange(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

Returns

Type	Description
FinContact

RequestBankKeys(IWin32Window, FinContact)

Declaration

public void RequestBankKeys(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

RevokePinBlock(IWin32Window, FinContact)

Declaration

public void RevokePinBlock(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

ShowIniLetter(string)

Called to present the given Ini-Letter file to the user.

Declaration

public virtual bool ShowIniLetter(string sFilePath)

Parameters

Type	Name	Description
string	sFilePath	Complete file path to the Ini-Letter file. This is only valid during the call and may go away after this method returns. The file type must be derived from the file extension. Currently the Ini-Letter is generated as a HTML file with .html extension. In the future this may be a PDF file with .pdf extension.

Returns

Type	Description
bool	If the Ini-Letter file was successfully presented, then true shall be returned. If the attempt to present the Ini-Letter file failed, then false shall be returned.

Remarks

The default implementation just starts a new Process with the given file. This means that the default application that handles the file type will be started.

SubmitUserKeys(IWin32Window, FinContact)

Declaration

public void SubmitUserKeys(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

SuggestNewContactName(string)

Helper that suggests a simple but unique default bank contact name.

Declaration

public string SuggestNewContactName(string sBaseName)

Parameters

Type	Name	Description
string	sBaseName

Returns

Type	Description
string

SyncContact(IWin32Window, FinContact)

Declaration

public void SyncContact(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

TanGeneratorSync(IWin32Window, FinContact)

Declaration

public void TanGeneratorSync(IWin32Window aParentWindow, FinContact aContact)

Parameters

Type	Name	Description
IWin32Window	aParentWindow
FinContact	aContact

ValidateCommAddress(FinCommService, string)

Declaration

public static bool ValidateCommAddress(FinCommService nCommService, string sCommAddress)

Parameters

Type	Name	Description
FinCommService	nCommService
string	sCommAddress

Returns

Type	Description
bool