net.shibboleth.tool.xmlsectool

Enum ReturnCode

java.lang.Object

java.lang.Enum<ReturnCode>

net.shibboleth.tool.xmlsectool.ReturnCode

All Implemented Interfaces:

Serializable, Comparable<ReturnCode>

public enum ReturnCode
extends Enum<ReturnCode>

Return codes for the command-line application.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RC_INIT Return code indicating an initialization error, 1.
RC_INVALID_CRED Return code indicating an error reading the credentials, 6.
RC_INVALID_XML Return code indicating input XML was not valid, 4.
RC_INVALID_XS Return code indicating an error validating the XML, 5.
RC_IO Return code indicating an error reading files, 2.
RC_MALFORMED_XML Return code indicating the input XML was not well formed, 3.
RC_NOHOME Return code indicating that the JAVA_HOME variable is not set within the shell script, 8.
RC_NOJAVA Return code indicating that the "java" command is not executable within the shell script, 9.
RC_OK Return code indicating command completed successfully, 0.
RC_SIG Return code indicating indicating that signing or signature verification failed, 7.
RC_UNKNOWN Return code indicating an unknown error occurred, -1.

Field Summary

Fields

Modifier and Type	Field and Description
private int	code Return code value.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCode() Gets the return code value.
static ReturnCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReturnCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RC_OK

public static final ReturnCode RC_OK

Return code indicating command completed successfully, 0.

RC_INIT

public static final ReturnCode RC_INIT

Return code indicating an initialization error, 1.

RC_IO

public static final ReturnCode RC_IO

Return code indicating an error reading files, 2.

RC_MALFORMED_XML

public static final ReturnCode RC_MALFORMED_XML

Return code indicating the input XML was not well formed, 3.

RC_INVALID_XML

public static final ReturnCode RC_INVALID_XML

Return code indicating input XML was not valid, 4.

RC_INVALID_XS

public static final ReturnCode RC_INVALID_XS

Return code indicating an error validating the XML, 5.

RC_INVALID_CRED

public static final ReturnCode RC_INVALID_CRED

Return code indicating an error reading the credentials, 6.

RC_SIG

public static final ReturnCode RC_SIG

Return code indicating indicating that signing or signature verification failed, 7.

RC_NOHOME

public static final ReturnCode RC_NOHOME

Return code indicating that the JAVA_HOME variable is not set within the shell script, 8.

RC_NOJAVA

public static final ReturnCode RC_NOJAVA

Return code indicating that the "java" command is not executable within the shell script, 9.

RC_UNKNOWN

public static final ReturnCode RC_UNKNOWN

Return code indicating an unknown error occurred, -1.

Field Detail

code

private final int code

Return code value.

Method Detail

values

public static ReturnCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReturnCode c : ReturnCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReturnCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Gets the return code value.

Returns:

the return code value