HMACParameterSpec (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.xml.crypto.dsig.spec.HMACParameterSpec

• All Implemented Interfaces:
  AlgorithmParameterSpec, SignatureMethodParameterSpec

public final class HMACParameterSpec
extends Object
implements SignatureMethodParameterSpec
Parameters for the XML Signature HMAC Algorithm. The parameters include an optional output length which specifies the MAC truncation length in bits. The resulting HMAC will be truncated to the specified number of bits. If the parameter is not specified, then this implies that all the bits of the hash are to be output. The XML Schema Definition of the HMACOutputLength element is defined as:

 <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/>  
 <simpleType name="HMACOutputLengthType">  
   <restriction base="integer"/>  
 </simpleType>  
   

Since:
1.6
See Also:
SignatureMethod, RFC 2104

• • Constructor Summary

  Constructors

  Constructor	Description
  HMACParameterSpec(int outputLength)	Creates an HMACParameterSpec with the specified truncation length.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  int	getOutputLength()	Returns the truncation length.

     * ### Methods inherited from class java.lang.[Object](../../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../../java/lang/Object.html#clone--), [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

     * #### HMACParameterSpec  
     public HMACParameterSpec(int outputLength)  
     Creates an `HMACParameterSpec` with the specified truncation length.  
     Parameters:  
     `outputLength` \- the truncation length in number of bits  

  • Method Detail

    * #### getOutputLength  
    public int getOutputLength()  
    Returns the truncation length.  
    Returns:  
    the truncation length in number of bits

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.