wt.org.electronicIdentity
Interface SignatureEngine

All Known Implementing Classes:
LDAPFDACompliantSignatureEngine, LDAPPasswordSignatureEngine

public interface SignatureEngine

A signature engine is reponsible for exposing attributes required for a signature and the validation of those attributes against a user.

Supported API: true

Extendable: false


Method Summary
 SigVariableInfo[] getVariableInfo()
          Get array of variables needed to validate a signature instance.
 void validateSig(WTPrincipalReference user, Properties variables)
          Check if signature as defined by variables is valid for the given user.
 

Method Detail

getVariableInfo

public SigVariableInfo[] getVariableInfo()
Get array of variables needed to validate a signature instance. Typically used in generating user interfaces for users to submit information to validate their identity for sake of applying a signature.

Returns:
array of SigVariableInfo populated with user interface fields

validateSig

public void validateSig(WTPrincipalReference user,
                        Properties variables)
                 throws SignatureInvalidException
Check if signature as defined by variables is valid for the given user.

Parameters:
user - user which the signature is being validated
variables - a property sheet with attributes needed for signature. Typically a cgi form data object which contains values from user for the SigVariableInfo objects displayed in user interface.
Throws:
SignatureInvalidException - when the variables are valid for a given user