net.nicholaswilliams.java.licensing

Class FileLicenseProvider

java.lang.Object

net.nicholaswilliams.java.licensing.DeserializingLicenseProvider

net.nicholaswilliams.java.licensing.FileLicenseProvider

All Implemented Interfaces:

LicenseProvider

public class FileLicenseProvider
extends DeserializingLicenseProvider

A default implementation of the LicenseProvider that assumes the binary data from the signed and serialized license is stored in a file. Various properties of this provider allow configuration of file prefixes (such as a directory), file suffixes (such as an extension), whether or not the file can be found on the classpath, and whether or not the contents of the file are Base64 encoded.

This implementation also assumes that license contexts (lookup keys) are always either strings or have a meaningful Object.toString() implementation that can be used within the file name.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader

Constructor Summary

Constructors

Constructor and Description
FileLicenseProvider() Constructs a file-based license provider with the same class loader as the loader of this class and fileOnClasspath set to false.
FileLicenseProvider(ClassLoader classLoader) Constructs a file-based license provider with the provided class loader and fileOnClasspath set to true.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFilePrefix() Gets the prefix that will be prepended to the file name before looking for it.
String	getFileSuffix() Gets the file suffix that will be appended to the file name before looking for it.
protected byte[]	getLicenseData(Object context) Gets the stored, still-encrypted, still-serialized license content and signature from the persistence store.
protected File	getLicenseFile(Object context) Gets the license file handle.
boolean	isBase64Encoded() Indicates whether the file is Base64 encoded.
boolean	isFileOnClasspath() Indicates whether the file should be found on the file system or on the classpath via a class loader.
void	setBase64Encoded(boolean base64Encoded) Sets whether the file is Base64 encoded.
void	setFileOnClasspath(boolean fileOnClasspath) Sets whether the file should be found on the file system or on the classpath via a class loader.
void	setFilePrefix(String filePrefix) Sets the prefix that will be prepended to the file name before looking for it.
void	setFileSuffix(String fileSuffix) Sets the file suffix that will be appended to the file name before looking for it.

Methods inherited from class net.nicholaswilliams.java.licensing.DeserializingLicenseProvider

deserializeLicense, getLicense

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

protected ClassLoader classLoader

Constructor Detail

FileLicenseProvider

public FileLicenseProvider()

Constructs a file-based license provider with the same class loader as the loader of this class and fileOnClasspath set to false. The class loader is only used if fileOnClasspath is subsequently changed to true.

FileLicenseProvider

public FileLicenseProvider(ClassLoader classLoader)

Constructs a file-based license provider with the provided class loader and fileOnClasspath set to true. The class loader will be used to locate the file unless fileOnClasspath is subsequently changed to false.

Parameters:

classLoader - The class loader to use for finding the file

Method Detail

getLicenseData

protected byte[] getLicenseData(Object context)

Gets the stored, still-encrypted, still-serialized license content and signature from the persistence store. Returns null (not an empty array) if no license is found.

Specified by:

getLicenseData in class DeserializingLicenseProvider

Parameters:

context - The context for which to get the license

Returns:

the signed license data.

getLicenseFile

protected File getLicenseFile(Object context)

Gets the license file handle. Returns null if if no license is found, but if a license is found, this may return a file handle to a non-existent file. So, the file should be checked for existence and readability.

Parameters:

context - The context for which to get the license

Returns:

the license file handle.

getFilePrefix

public String getFilePrefix()

Gets the prefix that will be prepended to the file name before looking for it. For example, if a license context was "customer01" and the file name was "C:\product\licenses\file-customer01.lic", then the prefix would be "C:\product\licenses\file-" and the suffix would be ".lic".

Returns:

the file prefix.

setFilePrefix

public void setFilePrefix(String filePrefix)

Sets the prefix that will be prepended to the file name before looking for it. For example, if a license context was "customer01" and the file name was "C:\product\licenses\file-customer01.lic", then the prefix would be "C:\product\licenses\file-" and the suffix would be ".lic".

Parameters:

filePrefix - The file prefix

getFileSuffix

public String getFileSuffix()

Gets the file suffix that will be appended to the file name before looking for it. For example, if a license context was "customer01" and the file name was "C:\product\licenses\file-customer01.lic", then the prefix would be "C:\product\licenses\file-" and the suffix would be ".lic".

Returns:

the file suffix.

setFileSuffix

public void setFileSuffix(String fileSuffix)

Sets the file suffix that will be appended to the file name before looking for it. For example, if a license context was "customer01" and the file name was "C:\product\licenses\file-customer01.lic", then the prefix would be "C:\product\licenses\file-" and the suffix would be ".lic".

Parameters:

fileSuffix - The file suffix

isFileOnClasspath

public boolean isFileOnClasspath()

Indicates whether the file should be found on the file system or on the classpath via a class loader. If false it will be looked for on the file system; if true it will be looked for on the classpath. If true, the file prefix should be the package-path and prefix and the suffix the suffix.

For example, if a license context was "customer02" and the file name was "file-customer02.lic" and was located in the package net.nicholaswilliams.java.licensing.licenses, then the prefix would be "net/nicholaswilliams/java/licensing/licenses/file-" and the suffix should be ".lic".

Returns:

whether the file is on the classpath.

setFileOnClasspath

public void setFileOnClasspath(boolean fileOnClasspath)

Sets whether the file should be found on the file system or on the classpath via a class loader. If false it will be looked for on the file system; if true it will be looked for on the classpath. If true, the file prefix should be the package-path and prefix and the suffix the suffix.

For example, if a license context was "customer02" and the file name was "file-customer02.lic" and was located in the package net.nicholaswilliams.java.licensing.licenses, then the prefix would be "net/nicholaswilliams/java/licensing/licenses/file-" and the suffix should be ".lic".

Parameters:

fileOnClasspath - Whether the file is on the classpath

isBase64Encoded

public boolean isBase64Encoded()

Indicates whether the file is Base64 encoded. If the file is Base64 encoded, its data will be decoded before being returned by getLicenseData(Object).

Returns:

whether the file is Base64 encoded.

setBase64Encoded

public void setBase64Encoded(boolean base64Encoded)

Sets whether the file is Base64 encoded. If the file is Base64 encoded, its data will be decoded before being returned by getLicenseData(Object).

Parameters:

base64Encoded - Whether the file is Base64 encoded.