Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.java.security.prng
Interface IRandom  view IRandom download IRandom.java

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
BasePRNG

public interface IRandom
extends java.lang.Cloneable

The basic visible methods of any pseudo-random number generator.

The [HAC] defines a PRNG (as implemented in this library) as follows:

IMPLEMENTATION NOTE: Although all the concrete classes in this package implement the java.lang.Cloneable interface, it is important to note here that such an operation, for those algorithms that use an underlting symmetric key block cipher, DOES NOT clone any session key material that may have been used in initialising the source PRNG (the instance to be cloned). Instead a clone of an already initialised PRNG, that uses and underlying symmetric key block cipher, is another instance with a clone of the same cipher that operates with the same block size but without any knowledge of neither key material nor key size.

References:

  1. [HAC]: Handbook of Applied Cryptography.
    CRC Press, Inc. ISBN 0-8493-8523-7, 1997
    Menezes, A., van Oorschot, P. and S. Vanstone.


Method Summary
 void addRandomByte(byte b)
          Supplement, or possibly replace, the random state of this PRNG with a random byte.
 void addRandomBytes(byte[] in)
          Supplement, or possibly replace, the random state of this PRNG with a sequence of new random bytes.
 void addRandomBytes(byte[] in, int offset, int length)
          Supplement, or possibly replace, the random state of this PRNG with a sequence of new random bytes.
 java.lang.Object clone()
          Returns a clone copy of this instance.
 void init(java.util.Map attributes)
          Initialises the pseudo-random number generator scheme with the appropriate attributes.
 java.lang.String name()
          Returns the canonical name of this instance.
 byte nextByte()
          Returns the next 8 bits of random data generated from this instance.
 void nextBytes(byte[] out, int offset, int length)
          Fills the designated byte array, starting from byte at index offset, for a maximum of length bytes with the output of this generator instance.
 

Method Detail

name

public java.lang.String name()

Returns the canonical name of this instance.


init

public void init(java.util.Map attributes)

Initialises the pseudo-random number generator scheme with the appropriate attributes.


nextByte

public byte nextByte()
              throws java.lang.IllegalStateException,
                     LimitReachedException

Returns the next 8 bits of random data generated from this instance.


nextBytes

public void nextBytes(byte[] out,
                      int offset,
                      int length)
               throws java.lang.IllegalStateException,
                      LimitReachedException

Fills the designated byte array, starting from byte at index offset, for a maximum of length bytes with the output of this generator instance.


addRandomByte

public void addRandomByte(byte b)

Supplement, or possibly replace, the random state of this PRNG with a random byte.

Implementations are not required to implement this method in any meaningful way; this may be a no-operation, and implementations may throw an java.lang.UnsupportedOperationException.


addRandomBytes

public void addRandomBytes(byte[] in)

Supplement, or possibly replace, the random state of this PRNG with a sequence of new random bytes.

Implementations are not required to implement this method in any meaningful way; this may be a no-operation, and implementations may throw an java.lang.UnsupportedOperationException.


addRandomBytes

public void addRandomBytes(byte[] in,
                           int offset,
                           int length)

Supplement, or possibly replace, the random state of this PRNG with a sequence of new random bytes.

Implementations are not required to implement this method in any meaningful way; this may be a no-operation, and implementations may throw an java.lang.UnsupportedOperationException.


clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone copy of this instance.