Package com.amazon.corretto.crypto.provider

Class InputBuffer<T,S,X extends java.lang.Throwable>

java.lang.Object

com.amazon.corretto.crypto.provider.InputBuffer<T,S,X>

Type Parameters:

T - result type

S - state type

X - exception which can be thrown upon completion

All Implemented Interfaces:

java.lang.Cloneable

public class InputBuffer<T,S,X extends java.lang.Throwable>
extends java.lang.Object
implements java.lang.Cloneable

Class to handle buffering data prior to passing it through to the native code. It buffers it up into fewer (larger) chunks to avoid incurring marshalling overhead. The first time a handler is called it will be an InitialUpdate handler (if present). All subsequent calls are guaranteed to go to standard Update handlers. If all of the data can be buffered prior to calling doFinal(), then this class will attempt to use the SinglePass handler if available.

The following handlers must be set.

• withUpdater(ArrayStateConsumer)
• withDoFinal(FinalHandlerFunction)

All ByteBuffer handlers default to calling their InputBuffer.ArrayStateConsumer equivalents. All InitialUpdate handlers default to calling their Update equivalents. withSinglePass(ArrayFunction) defaults to calling the update and doFinal steps.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputBuffer.ArrayFunction<T,X extends java.lang.Throwable>
static interface	InputBuffer.ArrayStateConsumer<S>
static interface	InputBuffer.ByteBufferBiConsumer<S>
static interface	InputBuffer.ByteBufferFunction<S>
static interface	InputBuffer.FinalHandlerFunction<T,R,X extends java.lang.Throwable>
static interface	InputBuffer.StateSupplier<S>

Method Summary

Modifier and Type	Method	Description
protected InputBuffer<T,S,X>	clone()	WARNING! This only does a shallow copy of the handlers, so any which refer to external state (so, any values not passed in as arguments) may be incorrect and need to be fixed prior to use.
T	doFinal()
void	reset()
int	size()
void	update(byte val)
void	update(byte[] src, int offset, int length)
void	update(java.nio.ByteBuffer src)
InputBuffer<T,S,X>	withDoFinal(InputBuffer.FinalHandlerFunction<S,T,X> handler)
InputBuffer<T,S,X>	withInitialStateSupplier(InputBuffer.StateSupplier<S> supplier)
InputBuffer<T,S,X>	withInitialUpdater(InputBuffer.ArrayFunction<S,java.lang.RuntimeException> handler)
InputBuffer<T,S,X>	withInitialUpdater(InputBuffer.ByteBufferFunction<S> handler)
InputBuffer<T,S,X>	withSinglePass(InputBuffer.ArrayFunction<T,X> handler)
InputBuffer<T,S,X>	withStateCloner(java.util.function.Function<S,S> cloner)
InputBuffer<T,S,X>	withUpdater(InputBuffer.ArrayStateConsumer<S> handler)
InputBuffer<T,S,X>	withUpdater(InputBuffer.ByteBufferBiConsumer<S> handler)

Methods inherited from class java.lang.Object

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

Method Detail

reset

public void reset()

size

public int size()

withInitialUpdater

public InputBuffer<T,S,X> withInitialUpdater(InputBuffer.ArrayFunction<S,java.lang.RuntimeException> handler)

withUpdater

public InputBuffer<T,S,X> withUpdater(InputBuffer.ArrayStateConsumer<S> handler)

withInitialUpdater

public InputBuffer<T,S,X> withInitialUpdater(InputBuffer.ByteBufferFunction<S> handler)

withUpdater

public InputBuffer<T,S,X> withUpdater(InputBuffer.ByteBufferBiConsumer<S> handler)

withDoFinal

public InputBuffer<T,S,X> withDoFinal(InputBuffer.FinalHandlerFunction<S,T,X> handler)

withSinglePass

public InputBuffer<T,S,X> withSinglePass(InputBuffer.ArrayFunction<T,X> handler)

withStateCloner

public InputBuffer<T,S,X> withStateCloner(java.util.function.Function<S,S> cloner)

withInitialStateSupplier

public InputBuffer<T,S,X> withInitialStateSupplier(InputBuffer.StateSupplier<S> supplier)

update

public void update(java.nio.ByteBuffer src)

update

public void update(byte[] src,
                   int offset,
                   int length)

update

public void update(byte val)

doFinal

public T doFinal()
          throws X extends java.lang.Throwable

Throws:

X extends java.lang.Throwable

clone

protected InputBuffer<T,S,X> clone()
                                        throws java.lang.CloneNotSupportedException

WARNING! This only does a shallow copy of the handlers, so any which refer to external state (so, any values not passed in as arguments) may be incorrect and need to be fixed prior to use.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException