- java.lang.Object
-
- javax.crypto.MacSpi
-
public abstract class MacSpi extends Object
This class defines the Service Provider Interface (SPI) for theMacclass. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a particular MAC algorithm.Implementations are free to implement the Cloneable interface.
- Since:
- 1.4
-
-
Constructor Summary
Constructors Constructor and Description MacSpi()
-
Method Summary
Methods Modifier and Type Method and Description Objectclone()Returns a clone if the implementation is cloneable.protected abstract byte[]engineDoFinal()Completes the MAC computation and resets the MAC for further use, maintaining the secret key that the MAC was initialized with.protected abstract intengineGetMacLength()Returns the length of the MAC in bytes.protected abstract voidengineInit(Key key, AlgorithmParameterSpec params)Initializes the MAC with the given (secret) key and algorithm parameters.protected abstract voidengineReset()Resets the MAC for further use, maintaining the secret key that the MAC was initialized with.protected abstract voidengineUpdate(byte input)Processes the given byte.protected abstract voidengineUpdate(byte[] input, int offset, int len)Processes the firstlenbytes ininput, starting atoffsetinclusive.protected voidengineUpdate(ByteBuffer input)Processesinput.remaining()bytes in the ByteBufferinput, starting atinput.position().
-
-
-
Method Detail
-
engineGetMacLength
protected abstract int engineGetMacLength()
Returns the length of the MAC in bytes.- Returns:
- the MAC length in bytes.
-
engineInit
protected abstract void engineInit(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException
Initializes the MAC with the given (secret) key and algorithm parameters.- Parameters:
key- the (secret) key.params- the algorithm parameters.- Throws:
InvalidKeyException- if the given key is inappropriate for initializing this MAC.InvalidAlgorithmParameterException- if the given algorithm parameters are inappropriate for this MAC.
-
engineUpdate
protected abstract void engineUpdate(byte input)
Processes the given byte.- Parameters:
input- the input byte to be processed.
-
engineUpdate
protected abstract void engineUpdate(byte[] input, int offset, int len)Processes the firstlenbytes ininput, starting atoffsetinclusive.- Parameters:
input- the input buffer.offset- the offset ininputwhere the input starts.len- the number of bytes to process.
-
engineUpdate
protected void engineUpdate(ByteBuffer input)
Processesinput.remaining()bytes in the ByteBufferinput, starting atinput.position(). Upon return, the buffer's position will be equal to its limit; its limit will not have changed.Subclasses should consider overriding this method if they can process ByteBuffers more efficiently than byte arrays.
- Parameters:
input- the ByteBuffer- Since:
- 1.5
-
engineDoFinal
protected abstract byte[] engineDoFinal()
Completes the MAC computation and resets the MAC for further use, maintaining the secret key that the MAC was initialized with.- Returns:
- the MAC result.
-
engineReset
protected abstract void engineReset()
Resets the MAC for further use, maintaining the secret key that the MAC was initialized with.
-
clone
public Object clone() throws CloneNotSupportedException
Returns a clone if the implementation is cloneable.- Overrides:
clonein classObject- Returns:
- a clone if the implementation is cloneable.
- Throws:
CloneNotSupportedException- if this is called on an implementation that does not supportCloneable.- See Also:
Cloneable
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/crypto/macspi.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
