com.aoindustries.lang

Class SysExits

java.lang.Object

com.aoindustries.lang.SysExits

public final class SysExits
extends Object

POSIX-compatible process exit values. From /usr/include/sysexits.h:

  SYSEXITS.H -- Exit status codes for system programs.

        This include file attempts to categorize possible error
        exit statuses for system programs, notably delivermail
        and the Berkeley network.

        Error numbers begin at EX__BASE to reduce the possibility of
        clashing with other exit statuses that random programs may
        already return.  The meaning of the codes is approximately
        as follows:

        EX_USAGE -- The command was used incorrectly, e.g., with
                the wrong number of arguments, a bad flag, a bad
                syntax in a parameter, or whatever.
        EX_DATAERR -- The input data was incorrect in some way.
                This should only be used for user's data & not
                system files.
        EX_NOINPUT -- An input file (not a system file) did not
                exist or was not readable.  This could also include
                errors like "No message" to a mailer (if it cared
                to catch it).
        EX_NOUSER -- The user specified did not exist.  This might
                be used for mail addresses or remote logins.
        EX_NOHOST -- The host specified did not exist.  This is used
                in mail addresses or network requests.
        EX_UNAVAILABLE -- A service is unavailable.  This can occur
                if a support program or file does not exist.  This
                can also be used as a catchall message when something
                you wanted to do doesn't work, but you don't know
                why.
        EX_SOFTWARE -- An internal software error has been detected.
                This should be limited to non-operating system related
                errors as possible.
        EX_OSERR -- An operating system error has been detected.
                This is intended to be used for such things as "cannot
                fork", "cannot create pipe", or the like.  It includes
                things like getuid returning a user that does not
                exist in the passwd file.
        EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
                etc.) does not exist, cannot be opened, or has some
                sort of error (e.g., syntax error).
        EX_CANTCREAT -- A (user specified) output file cannot be
                created.
        EX_IOERR -- An error occurred while doing I/O on some file.
        EX_TEMPFAIL -- temporary failure, indicating something that
                is not really an error.  In sendmail, this means
                that a mailer (e.g.) could not create a connection,
                and the request should be reattempted later.
        EX_PROTOCOL -- the remote system returned something that
                was "not possible" during a protocol exchange.
        EX_NOPERM -- You did not have sufficient permission to
                perform the operation.  This is not intended for
                file system problems, which should use NOINPUT or
                CANTCREAT, but rather for higher level permissions.
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	EX__BASE base value for error messages
static int	EX__MAX
static int	EX_CANTCREAT can't create (user) output file
static int	EX_CONFIG configuration error
static int	EX_DATAERR data format error
static int	EX_IOERR input/output error
static int	EX_NOHOST host name unknown
static int	EX_NOINPUT cannot open input
static int	EX_NOPERM permission denied
static int	EX_NOUSER addressee unknown
static int	EX_OK successful termination
static int	EX_OSERR system error (e.g., can't fork)
static int	EX_OSFILE critical OS file missing
static int	EX_PROTOCOL remote error in protocol
static int	EX_SOFTWARE internal software error
static int	EX_TEMPFAIL temp failure; user is invited to retry
static int	EX_UNAVAILABLE service unavailable
static int	EX_USAGE command line usage error

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

EX_OK

public static final int EX_OK

successful termination

See Also:

Constant Field Values

EX__BASE

public static final int EX__BASE

base value for error messages

See Also:

Constant Field Values

EX_USAGE

public static final int EX_USAGE

command line usage error

See Also:

Constant Field Values

EX_DATAERR

public static final int EX_DATAERR

data format error

See Also:

Constant Field Values

EX_NOINPUT

public static final int EX_NOINPUT

cannot open input

See Also:

Constant Field Values

EX_NOUSER

public static final int EX_NOUSER

addressee unknown

See Also:

Constant Field Values

EX_NOHOST

public static final int EX_NOHOST

host name unknown

See Also:

Constant Field Values

EX_UNAVAILABLE

public static final int EX_UNAVAILABLE

service unavailable

See Also:

Constant Field Values

EX_SOFTWARE

public static final int EX_SOFTWARE

internal software error

See Also:

Constant Field Values

EX_OSERR

public static final int EX_OSERR

system error (e.g., can't fork)

See Also:

Constant Field Values

EX_OSFILE

public static final int EX_OSFILE

critical OS file missing

See Also:

Constant Field Values

EX_CANTCREAT

public static final int EX_CANTCREAT

can't create (user) output file

See Also:

Constant Field Values

EX_IOERR

public static final int EX_IOERR

input/output error

See Also:

Constant Field Values

EX_TEMPFAIL

public static final int EX_TEMPFAIL

temp failure; user is invited to retry

See Also:

Constant Field Values

EX_PROTOCOL

public static final int EX_PROTOCOL

remote error in protocol

See Also:

Constant Field Values

EX_NOPERM

public static final int EX_NOPERM

permission denied

See Also:

Constant Field Values

EX_CONFIG

public static final int EX_CONFIG

configuration error

See Also:

Constant Field Values

EX__MAX

public static final int EX__MAX

See Also:

Constant Field Values