Class EbicsSecurityMedium

Helper methods for dealing with IEbicsSecurityMedium instances.

Inheritance

object

EbicsSecurityMedium

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Syntax

public static class EbicsSecurityMedium

Methods

CreateSecurityMedium(string, string)

Instantiates an IEbicsSecurityMedium implementation for a given assembly and class name.

Declaration

public static IEbicsSecurityMedium CreateSecurityMedium(string sAssemblyName, string sClassName)

Parameters

Type	Name	Description
string	sAssemblyName
string	sClassName

Returns

Type	Description
IEbicsSecurityMedium	If the named implementation could be created, then it is returned. If the class cannot be created, then null is returned. This method never throws any exceptions, but always returned null on failure.

CreateSecurityMediumKeyFile(string, string)

Instantiates an IEbicsSecurityMedium implementation for a given class name.

Declaration

public static IEbicsSecurityMedium CreateSecurityMediumKeyFile(string sAssemblyName, string sClassName)

Parameters

Type	Name	Description
string	sAssemblyName	Assembly from which to load the class that implements IEbicsSecurityMedium. If this is null or empty, then the default EBICS assembly will be tried.
string	sClassName	The class name of the desired implementation. If this is null or empty, then the default implementation will be instantiated, and sAssemblyName is ignored.

Returns

Type	Description
IEbicsSecurityMedium	If the requested class is unknown, then null is returned.

CreateSecurityMediumSmartCard(string, string)

Declaration

public static IEbicsSecurityMedium CreateSecurityMediumSmartCard(string sAssemblyName, string sClassName)

Parameters

Type	Name	Description
string	sAssemblyName	Assembly from which to load the class that implements IEbicsSecurityMedium. If this is null or empty, then the default assembly "Subsembly.EBICS.SmartCard" will be tried.
string	sClassName	Full class name of the class that implements IEbicsSecurityMedium. If this is null or empty, then the default SECCOS implementation will be instantiated, and sAssemblyName is ignored.

Returns

Type	Description
IEbicsSecurityMedium	If the requested class is unknown, then null is returned.

DetectSecurityMediumKeyFile(string)

Tries to detect the type of a key file.

Declaration

public static string DetectSecurityMediumKeyFile(string sKeyFilePath)

Parameters

Type	Name	Description
string	sKeyFilePath

Returns

Type	Description
string	If the type of the key file could be detected, then the class name of the matching IEbicsSecurityMedium implementation will be returned. If the file format is unknown, then null is returned.

Exceptions

Type	Condition
ArgumentNullException	The parameter sKeyFilePath was null.
ArgumentException	The parameter sKeyFilePath was not a valid path specification.

GetAvailableKeys(IEbicsSecurityOperations)

Declaration

public static EbicsSecurityCode GetAvailableKeys(IEbicsSecurityOperations aSecurityOperations)

Parameters

Type	Name	Description
IEbicsSecurityOperations	aSecurityOperations

Returns

Type	Description
EbicsSecurityCode	Returns a bit mask of the keys that are available in the given security medium.

ProduceKey(EbicsContact, IEbicsSecurityMedium, EbicsSecurityCode)

Produce a required key from a security medium. If the key does not exist, then an attempt is made to create it. This shall only be used for key initialization!

Declaration

public static EbicsPubKeyInfo ProduceKey(EbicsContact aContact, IEbicsSecurityMedium aSecurityMedium, EbicsSecurityCode nKeyCode)

Parameters

Type	Name	Description
EbicsContact	aContact
IEbicsSecurityMedium	aSecurityMedium
EbicsSecurityCode	nKeyCode

Returns

Type	Description
EbicsPubKeyInfo

Remarks

In order to submit a key with EBICS 3.0 it must have a certificate. Thus, if the security media does not come with a certificate, then we add a self-signed-certificate to the returned public key on-the-fly.