LogException (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.iplanet.log.LogException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConnectionException, DriverLoadException, FormatterInitException, NullLocationException
```
public class LogException
extends Exception
```
The applications may encounter errors when they are denied for a log access because they don't have the access privileges or when they do not have a valid session. The applications may also encounter errors when the logging server is not able response to the applications' request or for some other reasons. This LogException class provides the method for detecting such errors.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALREADY_EXISTS` Log already exists.
`static int`	`CONNECTION_FALIED` Log JDBC driver connection failed.
`static int`	`CREATE_ACCESS_DENIED` Log creation privilege is denied.
`static int`	`DELETE_ACCESS_DENIED` Log deletion privilege is denied.
`static int`	`DELETE_ERROR` Log deletion error.
`static int`	`FATAL_ERROR` Log SQL error / static public final int SQL_ERROR = 523; /** Other unknown fatal error.
`static int`	`INACTIVE` Log is in inactive state, preventing log submission.
`static int`	`INVALID_LOG_NAME` Log name is in valid.
`static int`	`INVALID_SESSION` Invalid session.
`static int`	`LIST_ACCESS_DENIED` Log listing privilege is denied.
`static int`	`LIST_NOT_EXISTS` Log list does not exist.
`static int`	`LOG_HANDLER_ERROR` Log handler error.
`static int`	`LOG_NOT_FOUND` No such log exists.
`static int`	`NO_SUCH_SEGMENT_EXISTS` No such log segment exists.
`static int`	`NULL_LOCATION` Log JDBC driver loading failed.
`static int`	`NULL_POINTER` Log JDBC null pointer.
`static int`	`PROFILE_ERROR` Log profile error.
`static int`	`READ_ACCESS_DENIED` Log retrieval privilege is denied.
`static int`	`READ_ERROR` Log Retrieval error.
`static int`	`READ_EXCEEDS_MAX` Log retrieval size (in bytes) exceeds the maximum allowed.
`static int`	`TYPE_ERROR` Log type error.
`static int`	`WRITE_ACCESS_DENIED` Log submition privilege is denied.
`static int`	`WRITE_ERROR` Log submission error.

Constructor Summary

Constructors
Constructor and Description
`LogException()` Constructs a log exception.
`LogException(String msg)` Constructs a log exception.
`LogException(String msg, int type)` Constructs a log exception.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

int getType()
Returns log exception type.
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getType()` Returns log exception type.

- Field Detail
  - INVALID_SESSION
```
public static final int INVALID_SESSION
```
    Invalid session.
    
    See Also:
    
    Constant Field Values
  - ALREADY_EXISTS
```
public static final int ALREADY_EXISTS
```
    Log already exists.
    
    See Also:
    
    Constant Field Values
  - INACTIVE
```
public static final int INACTIVE
```
    Log is in inactive state, preventing log submission.
    
    See Also:
    
    Constant Field Values
  - LOG_HANDLER_ERROR
```
public static final int LOG_HANDLER_ERROR
```
    Log handler error.
    
    See Also:
    
    Constant Field Values
  - WRITE_ERROR
```
public static final int WRITE_ERROR
```
    Log submission error.
    
    See Also:
    
    Constant Field Values
  - READ_ERROR
```
public static final int READ_ERROR
```
    Log Retrieval error.
    
    See Also:
    
    Constant Field Values
  - DELETE_ERROR
```
public static final int DELETE_ERROR
```
    Log deletion error.
    
    See Also:
    
    Constant Field Values
  - LIST_NOT_EXISTS
```
public static final int LIST_NOT_EXISTS
```
    Log list does not exist.
    
    See Also:
    
    Constant Field Values
  - TYPE_ERROR
```
public static final int TYPE_ERROR
```
    Log type error.
    
    See Also:
    
    Constant Field Values
  - CREATE_ACCESS_DENIED
```
public static final int CREATE_ACCESS_DENIED
```
    Log creation privilege is denied.
    
    See Also:
    
    Constant Field Values
  - WRITE_ACCESS_DENIED
```
public static final int WRITE_ACCESS_DENIED
```
    Log submition privilege is denied.
    
    See Also:
    
    Constant Field Values
  - READ_ACCESS_DENIED
```
public static final int READ_ACCESS_DENIED
```
    Log retrieval privilege is denied.
    
    See Also:
    
    Constant Field Values
  - LIST_ACCESS_DENIED
```
public static final int LIST_ACCESS_DENIED
```
    Log listing privilege is denied.
    
    See Also:
    
    Constant Field Values
  - PROFILE_ERROR
```
public static final int PROFILE_ERROR
```
    Log profile error.
    
    See Also:
    
    Constant Field Values
  - LOG_NOT_FOUND
```
public static final int LOG_NOT_FOUND
```
    No such log exists.
    
    See Also:
    
    Constant Field Values
  - NO_SUCH_SEGMENT_EXISTS
```
public static final int NO_SUCH_SEGMENT_EXISTS
```
    No such log segment exists.
    
    See Also:
    
    Constant Field Values
  - DELETE_ACCESS_DENIED
```
public static final int DELETE_ACCESS_DENIED
```
    Log deletion privilege is denied.
    
    See Also:
    
    Constant Field Values
  - INVALID_LOG_NAME
```
public static final int INVALID_LOG_NAME
```
    Log name is in valid.
    
    See Also:
    
    Constant Field Values
  - READ_EXCEEDS_MAX
```
public static final int READ_EXCEEDS_MAX
```
    Log retrieval size (in bytes) exceeds the maximum allowed.
    
    See Also:
    
    Constant Field Values
  - NULL_LOCATION
```
public static final int NULL_LOCATION
```
    Log JDBC driver loading failed. static public final int DRIVER_LOAD_FAILED = 519; /** Log JDBC driver null location.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_FALIED
```
public static final int CONNECTION_FALIED
```
    Log JDBC driver connection failed.
    
    See Also:
    
    Constant Field Values
  - NULL_POINTER
```
public static final int NULL_POINTER
```
    Log JDBC null pointer.
    
    See Also:
    
    Constant Field Values
  - FATAL_ERROR
```
public static final int FATAL_ERROR
```
    Log SQL error / static public final int SQL_ERROR = 523; /** Other unknown fatal error.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogException
```
public LogException()
```
    Constructs a log exception.
  - LogException
```
public LogException(String msg)
```
    Constructs a log exception.
    
    Parameters:
    
    msg - Log exception message.
  - LogException
```
public LogException(String msg,
                    int type)
```
    Constructs a log exception.
    
    Parameters:
    
    msg - Exception message.
    
    type - Log exception type.
- Method Detail
  - getType
```
public int getType()
```
    Returns log exception type.
    
    Returns:
    
    Log exception type.

Class LogException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

INVALID_SESSION

ALREADY_EXISTS

INACTIVE

LOG_HANDLER_ERROR

WRITE_ERROR

READ_ERROR

DELETE_ERROR

LIST_NOT_EXISTS

TYPE_ERROR

CREATE_ACCESS_DENIED

WRITE_ACCESS_DENIED

READ_ACCESS_DENIED

LIST_ACCESS_DENIED

PROFILE_ERROR

LOG_NOT_FOUND

NO_SUCH_SEGMENT_EXISTS

DELETE_ACCESS_DENIED

INVALID_LOG_NAME

READ_EXCEEDS_MAX

NULL_LOCATION

CONNECTION_FALIED

NULL_POINTER

FATAL_ERROR

Constructor Detail

LogException

LogException

LogException

Method Detail

getType