Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.crypto

Class MacSpi

Known Direct Subclasses:
SSLv3HMacMD5Impl, SSLv3HMacSHAImpl
public abstract class MacSpi
extends Object
This is the Service Provider Interface (SPI) for the Mac class.

Providers wishing to implement a Mac must subclass this class and provide appropriate implementations of all its abstract methods, then provide an entry pointing to this implementation in the master Provider class.

Implementations may optionally implement the Cloneable interface.

Since:
1.4

Constructor Summary

MacSpi()
Create a new MacSpi instance.

Method Summary

Object
clone()
Returns a clone of this instance if cloning is supported.
protected abstract byte[]
engineDoFinal()
Finalize the computation of this MAC and return the result as a byte array.
protected abstract int
engineGetMacLength()
Return the total length, in bytes, of the computed MAC (the length of the byte array returned by doFinal().
protected abstract void
engineInit(Key key, AlgorithmParameterSpec params)
Initialize (or re-initialize) this instance.
protected abstract void
engineReset()
Reset this instance.
protected abstract void
engineUpdate(byte input)
Update this MAC with a single byte.
protected abstract void
engineUpdate(byte[] input, int offset, int length)
Update this MAC with a portion of a byte array.
protected void
engineUpdate(ByteBuffer buffer)
Update this MAC with the remaining bytes of a buffer.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MacSpi

public MacSpi()
Create a new MacSpi instance.

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance if cloning is supported.
Overrides:
clone in interface Object
Returns:
A clone of this instance.
Throws:
CloneNotSupportedException - If this instance does not support cloneing.

engineDoFinal

protected abstract byte[] engineDoFinal()
Finalize the computation of this MAC and return the result as a byte array.
Returns:
The MAC.

engineGetMacLength

protected abstract int engineGetMacLength()
Return the total length, in bytes, of the computed MAC (the length of the byte array returned by doFinal().
Returns:
The MAC length.

engineInit

protected abstract void engineInit(Key key,
                                   AlgorithmParameterSpec params)
            throws InvalidAlgorithmParameterException,
                   InvalidKeyException
Initialize (or re-initialize) this instance.
Parameters:
key - The key to use.
params - The parameters to use.
Throws:
InvalidAlgorithmParameterException - If this instance rejects the specified parameters.
InvalidKeyException - If this instance rejects the specified key.

engineReset

protected abstract void engineReset()
Reset this instance. After this method succeeds, the state of this instance should be the same as it was before any data was input (possibly after a call to init(java.security.Key,java.security.spec.AlgorithmParameterSpec), possibly not).

engineUpdate

protected abstract void engineUpdate(byte input)
Update this MAC with a single byte.
Parameters:
input - The next byte.

engineUpdate

protected abstract void engineUpdate(byte[] input,
                                     int offset,
                                     int length)
Update this MAC with a portion of a byte array.
Parameters:
input - The next bytes.
offset - The index in input at which to start.
length - The number of bytes to update.

engineUpdate

protected void engineUpdate(ByteBuffer buffer)
Update this MAC with the remaining bytes of a buffer.
Parameters:
buffer - The input buffer.
Since:
1.5
MacSpi.java -- The MAC service provider interface. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About