gnu.javax.crypto.assembly

Class Assembly


public class Assembly
extends Object

An Assembly is a construction consisting of a chain of Transformer elements; each wired in pre- or post- transformation mode. This chain is terminated by one LoopbackTransformer element.

Once constructed, and correctly initialised, the bulk of the methods available on the Assembly are delegated to the head of the Transformer chain of the Assembly.

See Also:
Transformer

Field Summary

static String
DIRECTION

Constructor Summary

Assembly()
Trivial constructor that sets the chain to a LoopbackTransformer.

Method Summary

void
addPostTransformer(Transformer t)
Adds the designated Transformer and signals that it should operate in post-processing mode; i.e. it should apply its internal transformation algorithm on the input data stream, after it passes that stream to the next element in the chain.
void
addPreTransformer(Transformer t)
Adds the designated Transformer and signals that it should operate in pre-processing mode; i.e. it should apply its internal transformation algorithm on the input data stream, before it passes that stream to the next element in the chain.
void
init(Map<K,V> attributes)
Initialises the Assembly for operation with specific characteristics.
byte[]
lastUpdate()
Convenience method that calls the method with same name and three arguments using a 0-long byte array.
byte[]
lastUpdate(byte b)
Convenience method that calls the method with same name and three arguments, using a byte array of length 1 whose contents are the designated byte.
byte[]
lastUpdate(byte[] in)
Convenience method that calls the method with same name and three arguments.
byte[]
lastUpdate(byte[] in, int offset, int length)
Processes a designated number of bytes from a given byte array and signals, at the same time, that this is the last push operation for this Assembly.
void
reset()
Resets the Assembly for re-initialisation and use with other characteristics.
byte[]
update(byte b)
Convenience method that calls the method with same name and three arguments, using a byte array of length 1 whose contents are the designated byte.
byte[]
update(byte[] in)
Convenience method that calls the method with same name and three arguments.
byte[]
update(byte[] in, int offset, int length)
Processes a designated number of bytes from a given byte array.

Methods inherited from class java.lang.Object

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

Field Details

DIRECTION

public static final String DIRECTION
Field Value:
"gnu.crypto.assembly.assembly.direction"

Constructor Details

Assembly

public Assembly()
Trivial constructor that sets the chain to a LoopbackTransformer.

Method Details

addPostTransformer

public void addPostTransformer(Transformer t)
Adds the designated Transformer and signals that it should operate in post-processing mode; i.e. it should apply its internal transformation algorithm on the input data stream, after it passes that stream to the next element in the chain.
Parameters:
t - the Transformer to add at the head of the current chain.
Throws:
IllegalArgumentException - if the designated Transformer has a non-null tail; i.e. it is already an element of a chain.

addPreTransformer

public void addPreTransformer(Transformer t)
Adds the designated Transformer and signals that it should operate in pre-processing mode; i.e. it should apply its internal transformation algorithm on the input data stream, before it passes that stream to the next element in the chain.
Parameters:
t - the Transformer to add at the head of the current chain.
Throws:
IllegalArgumentException - if the designated Transformer has a non-null tail; i.e. it is already an element of a chain.

init

public void init(Map<K,V> attributes)
            throws TransformerException
Initialises the Assembly for operation with specific characteristics.
Parameters:
attributes - a set of name-value pairs that describes the desired future behaviour of this instance.
Throws:
IllegalStateException - if the instance is already initialised.

lastUpdate

public byte[] lastUpdate()
            throws TransformerException
Convenience method that calls the method with same name and three arguments using a 0-long byte array.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

lastUpdate

public byte[] lastUpdate(byte b)
            throws TransformerException
Convenience method that calls the method with same name and three arguments, using a byte array of length 1 whose contents are the designated byte.
Parameters:
b - the byte to process.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

lastUpdate

public byte[] lastUpdate(byte[] in)
            throws TransformerException
Convenience method that calls the method with same name and three arguments. All bytes in in, starting from index position 0 are considered.
Parameters:
in - the input data bytes.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

lastUpdate

public byte[] lastUpdate(byte[] in,
                         int offset,
                         int length)
            throws TransformerException
Processes a designated number of bytes from a given byte array and signals, at the same time, that this is the last push operation for this Assembly.
Parameters:
in - the input data bytes.
offset - index of in from which to start considering data.
length - the count of bytes to process.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

reset

public void reset()
Resets the Assembly for re-initialisation and use with other characteristics. This method always succeeds.

update

public byte[] update(byte b)
            throws TransformerException
Convenience method that calls the method with same name and three arguments, using a byte array of length 1 whose contents are the designated byte.
Parameters:
b - the byte to process.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

update

public byte[] update(byte[] in)
            throws TransformerException
Convenience method that calls the method with same name and three arguments. All bytes in in, starting from index position 0 are considered.
Parameters:
in - the input data bytes.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

update

public byte[] update(byte[] in,
                     int offset,
                     int length)
            throws TransformerException
Processes a designated number of bytes from a given byte array.
Parameters:
in - the input data bytes.
offset - index of in from which to start considering data.
length - the count of bytes to process.
Returns:
the result of transformation.
Throws:
IllegalStateException - if the instance is not initialised.
TransformerException - if a transformation-related exception occurs during the operation.

Assembly.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a 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 of the License, 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; if not, write to the Free Software Foundation, Inc., 51 Franklin St, 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.