Method Detail

• version

  public static String version()

  Gets version of the currently running SourceAFIS. This is useful during upgrades when the application has to deal with possible template incompatibility between versions.

  Returns:

  SourceAFIS version in a three-part 1.2.3 format

• importTemplates

  public static List<FingerprintTemplate> importTemplates(byte[] template)

  Converts non-native fingerprint template to a list of native SourceAFIS templates. Several native templates can be returned for one non-native template, because many non-native template formats can contain multiple fingerprints while native SourceAFIS templates always contain one fingerprint.

  This method accepts publicly documented template formats implemented in FingerprintIO library, specifically ANSI 378 (2004, 2009, and 2009/Am1) and ISO 19794-2 (2005 and 2011 off-card variants).

  If you just need to deserialize native SourceAFIS template, call FingerprintTemplate(byte[]) instead. To create template from fingerprint image, call FingerprintTemplate(FingerprintImage).

  Parameters:

  template - non-native template in one of the supported formats

  Returns:

  native templates containing fingerprints from the non-native template

  Throws:

  NullPointerException - if template is null

  TemplateFormatException - if template is in an unsupported format or it is corrupted

  See Also:

  importTemplate(byte[]), exportTemplates(TemplateFormat, FingerprintTemplate...), FingerprintIO

• importTemplate

  public static FingerprintTemplate importTemplate(byte[] template)

  Converts non-native fingerprint template to native SourceAFIS template. This is a convenience wrapper around importTemplates(byte[]) that returns the first fingerprint in the template or throws if there are none.

  This method accepts publicly documented template formats implemented in FingerprintIO library, specifically ANSI 378 (2004, 2009, and 2009/Am1) and ISO 19794-2 (2005 and 2011 off-card variants).

  If you just need to deserialize native SourceAFIS template, call FingerprintTemplate(byte[]) instead. To create template from fingerprint image, call FingerprintTemplate(FingerprintImage).

  Parameters:

  template - non-native template in one of the supported formats

  Returns:

  converted native template

  Throws:

  NullPointerException - if template is null

  TemplateFormatException - if template is in an unsupported format or it is corrupted

  IllegalArgumentException - if template contains no fingerprints

  See Also:

  FingerprintTemplate(byte[]), importTemplates(byte[]), exportTemplates(TemplateFormat, FingerprintTemplate...), FingerprintIO

• exportTemplates

  public static byte[] exportTemplates(TemplateFormat format,
                                       FingerprintTemplate... templates)

  Converts one or more native templates to non-native template format. Several native templates can be provided, because many non-native template formats can encode several fingerprints in one template. Creating template with zero fingerprints is allowed by some formats.

  This method supports publicly documented template formats implemented in FingerprintIO library, specifically ANSI 378 (2004, 2009, and 2009/Am1) and ISO 19794-2 (2005 and 2011 off-card variants). To tweak contents of the exported template, deserialize it with FingerprintIO, perform required changes, and serialize it again with FingerprintIO.

  If you just need to serialize native SourceAFIS template, call FingerprintTemplate.toByteArray() instead.

  Parameters:

  format - target non-native template format

  templates - list of native SourceAFIS templates to export

  Returns:

  template in the specified non-native format

  Throws:

  NullPointerException - if format, templates, or any of the templates are null

  TemplateFormatException - if format is unsupported or export fails for some reason

  See Also:

  FingerprintTemplate.toByteArray(), importTemplates(byte[]), FingerprintIO

• convertAll

  @Deprecated
  public static List<FingerprintTemplate> convertAll(byte[] template)

  Deprecated. Use importTemplates(byte[]) instead.

  Parameters:

  template - foreign template in one of the supported formats

  Returns:

  native templates containing fingerprints from the foreign template

  Throws:

  NullPointerException - if template is null

  TemplateFormatException - if template is in an unsupported format or it is corrupted

• convert

  @Deprecated
  public static FingerprintTemplate convert(byte[] template)

  Deprecated. Use importTemplate(byte[]) instead.

  Parameters:

  template - foreign template in one of the supported formats

  Returns:

  converted native template

  Throws:

  NullPointerException - if template is null

  TemplateFormatException - if template is in an unsupported format or it is corrupted

  IllegalArgumentException - if template contains no fingerprints

• toAnsiIncits378v2004

  @Deprecated
  public static byte[] toAnsiIncits378v2004(FingerprintTemplate... templates)

  Deprecated. Use exportTemplates(TemplateFormat, FingerprintTemplate...) instead.

  Parameters:

  templates - list of native SourceAFIS templates to export

  Returns:

  ANSI 378-2004 template

  Throws:

  NullPointerException - if templates or any of its items is null

• toAnsiIncits378v2009

  @Deprecated
  public static byte[] toAnsiIncits378v2009(FingerprintTemplate... templates)

  Deprecated. Use exportTemplates(TemplateFormat, FingerprintTemplate...) instead.

  Parameters:

  templates - list of native SourceAFIS templates to export

  Returns:

  ANSI 378-2009 template

  Throws:

  NullPointerException - if templates or any of its items is null

• toAnsiIncits378v2009AM1

  @Deprecated
  public static byte[] toAnsiIncits378v2009AM1(FingerprintTemplate... templates)

  Deprecated. Use exportTemplates(TemplateFormat, FingerprintTemplate...) instead.

  Parameters:

  templates - list of native SourceAFIS templates to export

  Returns:

  ANSI 378-2009/AM1 template

  Throws:

  NullPointerException - if templates or any of its items is null