Class HMACParameterSpec

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:

Constructor Summary

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

Method Summary

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

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

HMACParameterSpec

public HMACParameterSpec(int outputLength)

Creates an HMACParameterSpec with the specified truncation length.

Parameters:: outputLength - the truncation length in number of bits

Method Details

getOutputLength

public int getOutputLength()

Returns the truncation length.

Returns:: the truncation length in number of bits

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.