SpawnError (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- java.lang.Enum<SpawnError>
- - com.goldencode.p2j.main.SpawnError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SpawnError>
```
public enum SpawnError
extends java.lang.Enum<SpawnError>
```
Class to collect all spawn error codes, that don't clash with spawn.c and winspawn.c exit codes. The enum constructor takes pairs of error codes and error messages. The messages are displayed to the web users with handling POST requests, processed by WebDriverHandler.handleStartClientRequest(org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, boolean, com.goldencode.p2j.main.WebDriverType).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CAN_NOT_SPAWN_REMOTE_ERR_CODE`
`DEFAULT_SPAWN_ERR`
`GENERIC`
`NO_AVAILABLE_PORTS_ERR_CODE`
`UNIX_INVALID_CRED_1`
`UNIX_INVALID_CRED_2`
`UNIX_PAM_FAILED`
`UNIX_ROOT_NOT_ALLOWED`
`UNIX_SPAWNER_NO_PERM`
`WIN_CANT_CREATE_ENV`
`WIN_CANT_CREATE_PROC`
`WIN_CANT_GET_PROFILE`
`WIN_CANT_LOAD_LIBS`
`WIN_CANT_SET_DIR`
`WIN_INVALID_CRED`

Field Summary

Fields
Modifier and Type Field and Description

private int code
Error message code.

private java.lang.String msg
Error message.

Fields
Modifier and Type	Field and Description
`private int`	`code` Error message code.
`private java.lang.String`	`msg` Error message.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Optional<SpawnError>`	`get(int code)` Returns the error matching the provided code.
`int`	`getCode()` Getter for `code`.
`java.lang.String`	`getMsg()` Getter for `msg`.
`static java.lang.String`	`getSpawnMsgOrDefault(int code)` Returns the error message corresponding to the provided code or the default spawn error message.
`boolean`	`isInvalidOsCredentials()` Returns if the exit code implies invalid OS credentials.
`java.lang.String`	`toString()` Returns the string representation of the error.
`static SpawnError`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static SpawnError[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - UNIX_INVALID_CRED_1
```
public static final SpawnError UNIX_INVALID_CRED_1
```
  - UNIX_INVALID_CRED_2
```
public static final SpawnError UNIX_INVALID_CRED_2
```
  - UNIX_ROOT_NOT_ALLOWED
```
public static final SpawnError UNIX_ROOT_NOT_ALLOWED
```
  - UNIX_PAM_FAILED
```
public static final SpawnError UNIX_PAM_FAILED
```
  - UNIX_SPAWNER_NO_PERM
```
public static final SpawnError UNIX_SPAWNER_NO_PERM
```
  - WIN_INVALID_CRED
```
public static final SpawnError WIN_INVALID_CRED
```
  - WIN_CANT_CREATE_ENV
```
public static final SpawnError WIN_CANT_CREATE_ENV
```
  - WIN_CANT_GET_PROFILE
```
public static final SpawnError WIN_CANT_GET_PROFILE
```
  - WIN_CANT_SET_DIR
```
public static final SpawnError WIN_CANT_SET_DIR
```
  - WIN_CANT_CREATE_PROC
```
public static final SpawnError WIN_CANT_CREATE_PROC
```
  - WIN_CANT_LOAD_LIBS
```
public static final SpawnError WIN_CANT_LOAD_LIBS
```
  - DEFAULT_SPAWN_ERR
```
public static final SpawnError DEFAULT_SPAWN_ERR
```
  - NO_AVAILABLE_PORTS_ERR_CODE
```
public static final SpawnError NO_AVAILABLE_PORTS_ERR_CODE
```
  - CAN_NOT_SPAWN_REMOTE_ERR_CODE
```
public static final SpawnError CAN_NOT_SPAWN_REMOTE_ERR_CODE
```
  - GENERIC
```
public static final SpawnError GENERIC
```
- Field Detail
  - code
```
private int code
```
    Error message code.
  - msg
```
private java.lang.String msg
```
    Error message.
- Method Detail
  - values
```
public static SpawnError[] 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 (SpawnError c : SpawnError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SpawnError valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getCode
```
public int getCode()
```
    Getter for code.
    
    Returns:
    
    See above.
  - getMsg
```
public java.lang.String getMsg()
```
    Getter for msg.
    
    Returns:
    
    See above.
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of the error.
    
    Overrides:
    
    toString in class java.lang.Enum<SpawnError>
    
    Returns:
    
    See above.
  - get
```
public static java.util.Optional<SpawnError> get(int code)
```
    Returns the error matching the provided code. If none, the optional is empty
    
    Parameters:
    
    code - The code to look for.
    
    Returns:
    
    See above.
  - isInvalidOsCredentials
```
public boolean isInvalidOsCredentials()
```
    Returns if the exit code implies invalid OS credentials. Applicable only when no SSO enabled. Otherwise the actual credentials entered by the end-user are not OS user / pass and the error code is a misconfiguration on the admin side. The message should not be shown to the end-user.
    
    Returns:
    
    true if the exit code implies invalid credentials, false otherwise.
  - getSpawnMsgOrDefault
```
public static java.lang.String getSpawnMsgOrDefault(int code)
```
    Returns the error message corresponding to the provided code or the default spawn error message.
    
    Parameters:
    
    code - Exit code.
    
    Returns:
    
    See above.

Enum SpawnError

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNIX_INVALID_CRED_1

UNIX_INVALID_CRED_2

UNIX_ROOT_NOT_ALLOWED

UNIX_PAM_FAILED

UNIX_SPAWNER_NO_PERM

WIN_INVALID_CRED

WIN_CANT_CREATE_ENV

WIN_CANT_GET_PROFILE

WIN_CANT_SET_DIR

WIN_CANT_CREATE_PROC

WIN_CANT_LOAD_LIBS

DEFAULT_SPAWN_ERR

NO_AVAILABLE_PORTS_ERR_CODE

CAN_NOT_SPAWN_REMOTE_ERR_CODE

GENERIC

Field Detail

code

msg

Method Detail

values

valueOf

getCode

getMsg

toString

get

isInvalidOsCredentials

getSpawnMsgOrDefault