Top Description Fields Constructors Methods
org.apache.sshd.common.digest

public Class BaseDigest

extends Object
implements Digest
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.digest.Digest, java.lang.Comparable, org.apache.sshd.common.digest.DigestInformation, org.apache.sshd.common.AlgorithmNameProvider
Imports
java.security.MessageDigest, java.util.Objects, org.apache.sshd.common.util.GenericUtils, .NumberUtils, .ValidateUtils, org.apache.sshd.common.util.security.SecurityUtils

Base class for Digest algorithms based on the JCE provider.
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final String
private final int
private int
h

private MessageDigest
private String
s

Constructor Summary

AccessConstructor and Description
public
BaseDigest(String
the JCE algorithm to use for this digest
algorithm
,
int
the block size of this digest
bsize
)

Create a new digest using the given algorithm and block size.

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Digest
the object to be compared.
that
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public byte[]
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public final String
public int
protected MessageDigest

Returns:

The current MessageDigest - may be null if init() not called
getMessageDigest
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
public void
update(byte[] data, int start, int len)

Implements org.apache.sshd.common.digest.Digest.update.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

algorithmback to summary
private final String algorithm
bsizeback to summary
private final int bsize
hback to summary
private int h
mdback to summary
private MessageDigest md
sback to summary
private String s

Constructor Detail

BaseDigestback to summary
public BaseDigest(String algorithm, int bsize)

Create a new digest using the given algorithm and block size. The initialization and creation of the underlying MessageDigest object will be done in the init() method.

Parameters
algorithm:String

the JCE algorithm to use for this digest

bsize:int

the block size of this digest

Method Detail

compareToback to summary
public int compareTo(Digest that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
that:Digest

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
digestback to summary
public byte[] digest() throws Exception

Implements org.apache.sshd.common.digest.Digest.digest.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAlgorithmback to summary
public final String getAlgorithm()

Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.

Annotations
@Override
getBlockSizeback to summary
public int getBlockSize()

Implements org.apache.sshd.common.digest.DigestInformation.getBlockSize.

Returns:int

Doc from org.apache.sshd.common.digest.DigestInformation.getBlockSize.

The number of bytes in the digest's output

Annotations
@Override
getMessageDigestback to summary
protected MessageDigest getMessageDigest()
Returns:MessageDigest

The current MessageDigest - may be null if init() not called

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
initback to summary
public void init() throws Exception

Implements org.apache.sshd.common.digest.Digest.init.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
updateback to summary
public void update(byte[] data) throws Exception

Implements org.apache.sshd.common.digest.Digest.update.

Annotations
@Override
updateback to summary
public void update(byte[] data, int start, int len) throws Exception

Implements org.apache.sshd.common.digest.Digest.update.

Annotations
@Override