org.kapott.hbci.manager.HBCIKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbci4j-adorsys Show documentation
HBCI4j - Home Banking Computer Interface for Java - Clone from https://github.com/hbci4j/hbci4java
There is a newer version: 3.5.46
/*  $Id: HBCIKey.java,v 1.1 2011/05/04 22:37:46 willuhn Exp $

    This file is part of HBCI4Java
    Copyright (C) 2001-2008  Stefan Palme

    HBCI4Java is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    HBCI4Java is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

package org.kapott.hbci.manager;

import java.io.Serializable;
import java.security.Key;

/**
 * Diese Klasse repräsentiert einen von HBCI4Javaverwendeten Schlüssel.
 * Ein solcher HBCI-Schlüssel besteht aus
 * administrativen Daten zu diesem Schlüssel (Besitzer, Version) sowie den eigentlichen
 * kryptographischen Daten. Bei Verwendung von asymmetrischen Sicherheitsverfahren
 * (RDH) werden sowohl für den öffentlichen als auch für den privaten Schlüsselteil
 * intern je ein HBCIKey-Objekt verwendet!
 * Bei einigen Sicherheitsverfahren (DDV, PinTan) werden
 * die kryptografischen Daten nicht in diesem Objekt gespeichert, sondern nur die
 * administrativen.
 */
public final class HBCIKey
    implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * Ländercode des Schlüsselbesitzers
     */
    public String country;
    /**
     * Bankleitzahl des Schlüsselbesitzers
     */
    public String blz;
    /**
     * Nutzerkennung des Schlüsselbesitzers. Wenn der Schlüssel
     * einem "richtigen" Nutzer gehört, so wird hier seine HBCI-Userkennung eingestellt;
     * gehört der Schlüssel der Bank, so steht hier eine bankinterne
     * ID (u.U. die Bankleitzahl o.ä.)
     */
    public String userid;
    /**
     * Schlüsselnummer
     */
    public String num;
    /**
     * Schlüsselversion
     */
    public String version;
    /**
     * kryptographische Schlüsseldaten (kann null sein)
     */
    public Key key;

    /**
     * Neues HBCIKey-Objekt erzeugen
     */
    public HBCIKey() {
        // empty constructor
    }

    public HBCIKey(String country, String blz, String userid, String num, String version, Key key) {
        this.country = country;
        this.blz = blz;
        this.userid = userid;
        this.num = num;
        this.version = version;
        this.key = key;
    }

    @Override
    public String toString() {
        StringBuffer ret = new StringBuffer();

        ret.append("country=" + this.country);
        ret.append(", blz=" + this.blz);
        ret.append(", userid=" + this.userid);
        ret.append(", num=" + this.num);
        ret.append(", version=" + this.version);
        ret.append(", key=" + this.key);

        return ret.toString();
    }
}