io.github.astrapi69.crypt.data.factory.CryptModelFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crypt-data Show documentation

Utility project that provides data beans, writers and readers for encryption and decryption

There is a newer version: 10

/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.crypt.data.factory;

import java.security.PrivateKey;
import java.security.PublicKey;

import javax.crypto.Cipher;

import io.github.astrapi69.crypt.api.algorithm.Algorithm;
import io.github.astrapi69.crypt.data.model.CryptModel;

/**
 * The factory class {@link CryptModelFactory} holds methods for creating {@link CryptModel} objects
 */
public class CryptModelFactory
{

	private CryptModelFactory()
	{
	}

	/**
	 * Factory method for creating a new {@link CryptModel} from the given {@link PublicKey}
	 *
	 * @param publicKey
	 *            the public key
	 * @return the new created {@link CryptModel} object
	 */
	public static CryptModel newCryptModel(PublicKey publicKey)
	{
		return CryptModel.of(publicKey);
	}

	/**
	 * Factory method for creating a new {@link CryptModel} from the given {@link PrivateKey}
	 *
	 * @param privateKey
	 *            the private key
	 * @return the new created {@link CryptModel} object
	 */
	public static CryptModel newCryptModel(PrivateKey privateKey)
	{
		return CryptModel.of(privateKey);
	}

	/**
	 * Factory method for creating a new {@link CryptModel} from the given {@link Algorithm} and the
	 * given key as {@link String} object. The key has to fulfill the requirements, for instance,
	 * the length has to be 16 characters
	 *
	 * Examples: for the key: 'D1D15ED36B887AF1' 
	 *     String key;
	 *     key = "1234567890123456";
	 *     // or
	 *     key = "D1D15ED36B887AF1";
	 * 
	 *
	 * @param key
	 *            the key
	 * @param algorithm
	 *            the algorithm
	 * @return the new created {@link CryptModel} object
	 */
	public static CryptModel newCryptModel(Algorithm algorithm, String key)
	{
		return CryptModel. builder().key(key).algorithm(algorithm).build();
	}

}