CvPublicKey.java

package de.persosim.simulator.crypto.certificates;

import java.security.PublicKey;

import de.persosim.simulator.tlv.ConstructedTlvDataObject;
import de.persosim.simulator.tlv.TlvConstants;

/**
 * This class represents a public key to be used in the context of CV certificates.
 * 
 * @author slutters
 *
 */
public abstract class CvPublicKey extends CvKey implements PublicKey, TlvConstants {
	
	private static final long serialVersionUID = 1L;
	
	public CvPublicKey(CvOid cvOid, PublicKey publicKey) {
		super(cvOid, publicKey);
	}
	
	/**
	 * This method returns a TLV representation of this object.
	 * Conditional objects may be included in the encoding if available or applicable
	 * @param includeConditionalObjects include conditional objects in encoding
	 * @return a TLV representation of this object
	 */
	public abstract ConstructedTlvDataObject toTlvDataObject(boolean includeConditionalObjects);
	
	/**
	 * This method returns whether this object represents a fully usable or only partial basic key
	 * @return true if the key is complete, i.e. fully usable, false otherwise
	 */
	public abstract boolean isComplete();
	
	/**
	 * This method updates this object to the parameters of the provided key.
	 * @param publicKey the reference key providing the parameters
	 * @return true if key was incomplete AND has been successfully updated, false otherwise
	 */
	public abstract boolean updateKey(PublicKey publicKey);
	
	/**
	 * Matches this key to the given parameters core values. This check is done
	 * under exemption of e.g. domain parameters.
	 * 
	 * @return true, iff the keys match
	 */
	public abstract boolean matchesCoreMaterial(CvPublicKey publicKey);

}