com.lf.commons.docking.crypto

Class CryptoResult

java.lang.Object

com.lf.commons.docking.crypto.CryptoResult

public class CryptoResult
extends java.lang.Object

Simple data holding class documenting the processed files used for encryption/decryption.

It is used for both ebcryption and decryption so that the global fields are named in a more generic manner (source file, target file etc.).

Since:

1.6

Version:

$Revision: 1.9 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_ERROR Status for the result, finished with errors.
static int	STATUS_IGNORED Status for the result, file was ignored.
static int	STATUS_OK Status for the result, finished with success.
static int	STATUS_UNKNOWN Status for the initial object.
static int	STATUS_WARNING Status for the result, finished with warnings.

Constructor Summary

Constructors

Constructor and Description
CryptoResult() Constructor method for i18n purposes only.
CryptoResult(java.io.File source, java.io.File target, int format) Constructor settings the initial values.

Method Summary

Methods

Modifier and Type	Method and Description
void	displayFields() Print some info about this object for debugging purposes.
boolean	equals(CryptoResult tocheck) Checks wether a given CryptoResult instance is equal to this.
java.lang.String	getComment() Getter for the optional comment like error messages.
com.didisoft.pgp.KeyPairInformation[]	getCryptKeys() Getter for the key(s) used for encryption/decryption.
int	getDuration() Getter for the time in milliseconds the operation took.
int	getFormat() Getter for the target file format.
java.io.File	getSourceFile() Getter for the source file.
int	getStatus() Getter for the operational status.
java.io.File	getTargetFile() Getter for the target file.
static java.lang.String	mapFromStatus(int status) Maps the given numerical status constant to the corresponding text representation.
void	setComment(java.lang.String comment) Setter for the optional comment like error messages.
void	setCryptKeys(com.didisoft.pgp.KeyPairInformation[] keys) Setter for the key(s) used for encryption/decryption.
void	setDuration(int duration) Setter for the time in milliseconds the operation took.
void	setStatus(int status) Setter for the operational status.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_UNKNOWN

public static final int STATUS_UNKNOWN

Status for the initial object.

See Also:

Constant Field Values

STATUS_OK

public static final int STATUS_OK

Status for the result, finished with success.

See Also:

Constant Field Values

STATUS_WARNING

public static final int STATUS_WARNING

Status for the result, finished with warnings.

See Also:

Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

Status for the result, finished with errors.

See Also:

Constant Field Values

STATUS_IGNORED

public static final int STATUS_IGNORED

Status for the result, file was ignored.

See Also:

Constant Field Values

Constructor Detail

CryptoResult

public CryptoResult()
             throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

CryptoResult

public CryptoResult(java.io.File source,
            java.io.File target,
            int format)

Constructor settings the initial values.

Parameters:

source - The source file (required)

target - The target file

format - CryptoConstants.ENCRYPTION_FORMAT_PGP|...

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If at least one of the parameters is invalid

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The identifer for the represented object or empty string

Since:

1.6

equals

public boolean equals(CryptoResult tocheck)

Checks wether a given CryptoResult instance is equal to this.

Parameters:

tocheck - The instance to be compared

Returns:

The CryptoResult instance to check for equality

Since:

1.6

getSourceFile

public java.io.File getSourceFile()

Getter for the source file.

Returns:

The source file

Since:

1.6

getTargetFile

public java.io.File getTargetFile()

Getter for the target file.

Returns:

The target file

Since:

1.6

getFormat

public int getFormat()

Getter for the target file format.

Returns:

The format

Since:

1.6

getDuration

public int getDuration()

Getter for the time in milliseconds the operation took.

Returns:

The time in milliseconds

Since:

1.6

getStatus

public int getStatus()

Getter for the operational status.

Returns:

The status

Since:

1.6

getComment

public java.lang.String getComment()

Getter for the optional comment like error messages.

Returns:

The comment

Since:

1.6

getCryptKeys

public com.didisoft.pgp.KeyPairInformation[] getCryptKeys()

Getter for the key(s) used for encryption/decryption.

Returns:

The crypt keys

Since:

1.6

setDuration

public void setDuration(int duration)

Setter for the time in milliseconds the operation took.

Parameters:

duration - The time in milliseconds, -1 unsets

Since:

1.6

setStatus

public void setStatus(int status)

Setter for the operational status.

Parameters:

status - The status

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

setComment

public void setComment(java.lang.String comment)

Setter for the optional comment like error messages.

Parameters:

comment - The comment

Since:

1.6

setCryptKeys

public void setCryptKeys(com.didisoft.pgp.KeyPairInformation[] keys)

Setter for the key(s) used for encryption/decryption.

Parameters:

keys - The crypt keys

Since:

1.6

displayFields

public void displayFields()

Print some info about this object for debugging purposes.

Since:

1.6

mapFromStatus

public static java.lang.String mapFromStatus(int status)

Maps the given numerical status constant to the corresponding text representation.

Parameters:

status - The status constant

Returns:

The status text, null if not a valid status

Since:

1.6