net.nicholaswilliams.java.licensing.encryption

Class FilePrivateKeyDataProvider

java.lang.Object

net.nicholaswilliams.java.licensing.encryption.FilePrivateKeyDataProvider

All Implemented Interfaces:

PrivateKeyDataProvider

public class FilePrivateKeyDataProvider
extends Object
implements PrivateKeyDataProvider

A default implementation of PrivateKeyDataProvider that reads the private key from a file.

This provider is immutable. Once created, the file that the private key is located at cannot be changed.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Constructor Summary

Constructors

Constructor and Description
FilePrivateKeyDataProvider(File privateKeyFile) Create a new provider, specifying the file from which the private key can be read.
FilePrivateKeyDataProvider(String privateKeyFileName) Create a new provider, specifying the name of the file from which the private key can be read.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getEncryptedPrivateKeyData() This method returns the data from the file containing the encrypted private key from the public/private key pair.
File	getPrivateKeyFile() Gets the file that the private key is located at.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilePrivateKeyDataProvider

public FilePrivateKeyDataProvider(File privateKeyFile)

Create a new provider, specifying the file from which the private key can be read.

Parameters:

privateKeyFile - the private key file

FilePrivateKeyDataProvider

public FilePrivateKeyDataProvider(String privateKeyFileName)

Create a new provider, specifying the name of the file from which the private key can be read.

Parameters:

privateKeyFileName - The private key file name

Method Detail

getEncryptedPrivateKeyData

public byte[] getEncryptedPrivateKeyData()
                                  throws KeyNotFoundException

This method returns the data from the file containing the encrypted private key from the public/private key pair. The contract for this method can be fulfilled by storing the data in a byte array literal in the source code itself.

It is imperative that you obfuscate the bytecode for the implementation of this class. It is also imperative that the byte array exist only for the life of this method (i.e., DO NOT store it as an instance or class field).

Specified by:

getEncryptedPrivateKeyData in interface PrivateKeyDataProvider

Returns:

the encrypted file contents from the private key file.

Throws:

KeyNotFoundException - if the key data could not be retrieved; an acceptable message or chained cause must be provided.

getPrivateKeyFile

public File getPrivateKeyFile()

Gets the file that the private key is located at.

Returns:

the file.