001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.security;
020
021import java.io.Serializable;
022
023/**
024 * The {@code SecureVariantKey} class wraps any keys that are secured by
025 * the security module with variant methods.
026 *
027 * @author Robert Demski
028 */
029public abstract class SecureVariantKey extends SecureKey implements Serializable {
030    /** Default constructor; no instance state to initialise. */
031    protected SecureVariantKey() {}
032
033    private static final long serialVersionUID = -3165785988271048707L;
034
035    /**
036     * Indicates key protection variant metchod appiled to this key by a security module.
037     */
038    protected Byte variant;
039
040    /**
041     * Sets key protection variant metchod appiled to this key by the security module.
042     *
043     * @param variant key variant method used to protect this key.
044     */
045    public void setVariant(byte variant) {
046        this.variant = variant;
047    }
048
049    /**
050     * Gets the key variant method used to protect this key.
051     *
052     * @return key variant method used to protect this key.
053     */
054    public abstract byte getVariant();
055
056}