MessageDigestSpi (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.security.MessageDigestSpi

• Direct Known Subclasses:
  [MessageDigest](../../java/security/MessageDigest.html "class in java.security")

public abstract class MessageDigestSpi
extends Object
This class defines the Service Provider Interface (SPI) for the MessageDigest class, which provides the functionality of a message digest algorithm, such as MD5 or SHA. Message digests are secure one-way hash functions that take arbitrary-sized data and output a fixed-length hash value.
All the abstract methods in this class must be implemented by a cryptographic service provider who wishes to supply the implementation of a particular message digest algorithm.
Implementations are free to implement the Cloneable interface.
Since:
1.2
See Also:
MessageDigest

• • Constructor Summary

  Constructors

  Constructor	Description
  MessageDigestSpi​()

  • Method Summary

  All Methods Instance Methods Abstract Methods Concrete Methods

  Modifier and Type	Method	Description
  Object	clone​()	Returns a clone if the implementation is cloneable.
  protected abstract byte[]	engineDigest​()	Completes the hash computation by performing final operations such as padding.
  protected int	engineDigest​(byte[] buf, int offset, int len)	Completes the hash computation by performing final operations such as padding.
  protected int	engineGetDigestLength​()	Returns the digest length in bytes.
  protected abstract void	engineReset​()	Resets the digest for further use.
  protected abstract void	engineUpdate​(byte input)	Updates the digest using the specified byte.
  protected abstract void	engineUpdate​(byte[] input, int offset, int len)	Updates the digest using the specified array of bytes, starting at the specified offset.
  protected void	engineUpdate​(ByteBuffer input)	Update the digest using the specified ByteBuffer.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### MessageDigestSpi  
     public MessageDigestSpi​()  

  • Method Detail

    * #### engineGetDigestLength  
    protected int engineGetDigestLength​()  
    Returns the digest length in bytes.  
    This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.)  
    The default behavior is to return 0.  
    This method may be overridden by a provider to return the digest length.  
    Returns:  
    the digest length in bytes.  
    Since:  
    1.2  
    * #### engineUpdate  
    protected abstract void engineUpdate​(byte input)  
    Updates the digest using the specified byte.  
    Parameters:  
    `input` \- the byte to use for the update.  
    * #### engineUpdate  
    protected abstract void engineUpdate​(byte[] input,  
                                         int offset,  
                                         int len)  
    Updates the digest using the specified array of bytes, starting at the specified offset.  
    Parameters:  
    `input` \- the array of bytes to use for the update.  
    `offset` \- the offset to start from in the array of bytes.  
    `len` \- the number of bytes to use, starting at`offset`.  
    * #### engineUpdate  
    protected void engineUpdate​([ByteBuffer](../../java/nio/ByteBuffer.html "class in java.nio") input)  
    Update the digest using the specified ByteBuffer. The digest is updated using the `input.remaining()` bytes starting at `input.position()`. Upon return, the buffer's position will be equal to its limit; its limit will not have changed.  
    Parameters:  
    `input` \- the ByteBuffer  
    Since:  
    1.5  
    * #### engineDigest  
    protected abstract byte[] engineDigest​()  
    Completes the hash computation by performing final operations such as padding. Once `engineDigest` has been called, the engine should be reset (see[engineReset](../../java/security/MessageDigestSpi.html#engineReset--)). Resetting is the responsibility of the engine implementor.  
    Returns:  
    the array of bytes for the resulting hash value.  
    * #### engineDigest  
    protected int engineDigest​(byte[] buf,  
                               int offset,  
                               int len)  
                        throws [DigestException](../../java/security/DigestException.html "class in java.security")  
    Completes the hash computation by performing final operations such as padding. Once `engineDigest` has been called, the engine should be reset (see[engineReset](../../java/security/MessageDigestSpi.html#engineReset--)). Resetting is the responsibility of the engine implementor. This method should be abstract, but we leave it concrete for binary compatibility. Knowledgeable providers should override this method.  
    Parameters:  
    `buf` \- the output buffer in which to store the digest  
    `offset` \- offset to start from in the output buffer  
    `len` \- number of bytes within buf allotted for the digest. Both this default implementation and the SUN provider do not return partial digests. The presence of this parameter is solely for consistency in our API's. If the value of this parameter is less than the actual digest length, the method will throw a DigestException. This parameter is ignored if its value is greater than or equal to the actual digest length.  
    Returns:  
    the length of the digest stored in the output buffer.  
    Throws:  
    `[DigestException](../../java/security/DigestException.html "class in java.security")` \- if an error occurs.  
    Since:  
    1.2  
    * #### engineReset  
    protected abstract void engineReset​()  
    Resets the digest for further use.  
    * #### clone  
    public [Object](../../java/lang/Object.html "class in java.lang") clone​()  
                 throws [CloneNotSupportedException](../../java/lang/CloneNotSupportedException.html "class in java.lang")  
    Returns a clone if the implementation is cloneable.  
    Overrides:  
    `[clone](../../java/lang/Object.html#clone--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a clone if the implementation is cloneable.  
    Throws:  
    `[CloneNotSupportedException](../../java/lang/CloneNotSupportedException.html "class in java.lang")` \- if this is called on an implementation that does not support `Cloneable`.  
    See Also:  
    [Cloneable](../../java/lang/Cloneable.html "interface in java.lang")

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.