io.vertigo.commons.codec.CodecManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-commons-api Show documentation
There is a newer version: 2.1.0
/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013, KleeGroup, [email protected] (http://www.kleegroup.com)
 * KleeGroup, Centre d'affaire la Boursidiere - BP 159 - 92357 Le Plessis Robinson Cedex - France
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.vertigo.commons.codec;

import io.vertigo.lang.Manager;

import java.io.Serializable;

/**
 * Gestion centralisée des mécanismes de codage/décodage.
 * Tous les codecs sont threadSafe et StateLess.
 *
 * - CSV null donne ""
 * - HTML null donne ""
 * - les fonctions de Hachage MD5 et SHA1 n'autorisent pas les null.
 * - pour tous les autres cas null  donne null
 *
 * @author pchretien
 */
public interface CodecManager extends Manager {
	/**
	 * @return Codec HTML.
	 */
	Codec getHtmlCodec();

	/**
	 * @return Encoder CSV.
	 */
	Encoder getCsvEncoder();

	//-----
	/**
	 * @return Encoder MD5. (128 bits)
	 */
	Encoder getMD5Encoder();

	/**
	 * @return Encoder SHA-1. (160 bits)
	 */
	Encoder getSha1Encoder();

	/**
	 * @return Encoder SHA-2. (256 bits)
	 */
	Encoder getSha256Encoder();

	/**
	 * @return Codec Hexadecimal.
	 */
	Encoder getHexEncoder();

	/**
	 * Le codage base 64 proposé autorise l'utilisation dans les URL en restreignant certains caractères.
	 * Attention : A utiliser sur la totalité des données ou sur un multiple de 3 octets (un buffer de 1024 NE MARCHE PAS)
	 * @return Codec Base 64.
	 */
	Codec getBase64Codec();

	/**
	 * @return Codec cryptographique.
	 */
	Codec getTripleDESCodec();

	/**
	 * @return Codec cryptographique.
	 */
	Codec getAES128Codec();

	/**
	 * @return Codec de compression de données.
	 */
	Codec getCompressionCodec();

	/**
	 * @return Codec de sérialisation de données.
	 */
	Codec getSerializationCodec();

	/**
	 * @return Codec de sérialisation compressée de données.
	 */
	Codec getCompressedSerializationCodec();

}