oracle.search.sdk.crawler
Class PluginException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.search.sdk.crawler.PluginException

All Implemented Interfaces:

java.io.Serializable

public class PluginException

extends java.lang.Exception

This encapsulates information about a data source plugin-specific error.

See Also:

Serialized Form

Field Summary

static int	FATAL
protected int	m_errorCode
protected java.lang.Exception	m_errorException
protected java.lang.String	m_errorString
static int	UNDEFINED
static int	WARNING

Constructor Summary

PluginException(java.lang.Exception errorException)
Constructs an PluginExcception from an exception.

PluginException(int severity, java.lang.String message)
Constructs an PluginException from an error code.

PluginException(java.lang.String message)
Constructs an PluginException from a string

Method Summary

java.lang.String	getErrorString() returns the error message
protected java.lang.String	getErrorString(int errorCode, java.lang.String arg1) returns the error message based on the error code
boolean	isFatalException() Checks if the exception is a fatal exception
java.lang.String	toString() returns the error message
java.lang.String	toString(java.lang.String arg1)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

FATAL

public static final int FATAL

WARNING

public static final int WARNING

m_errorCode

protected int m_errorCode

m_errorString

protected java.lang.String m_errorString

m_errorException

protected java.lang.Exception m_errorException

Constructor Detail

PluginException

public PluginException(java.lang.String message)

Constructs an PluginException from a string

Parameters:

message - is the exception message

PluginException

public PluginException(int severity,
                       java.lang.String message)

Constructs an PluginException from an error code.

Parameters:

severity - severity of the exception: FATAL or WARNING

message - the exception message

PluginException

public PluginException(java.lang.Exception errorException)

Constructs an PluginExcception from an exception. This is useful when an plugin needs to return error/failure information that is a direct result of an exception.

Parameters:

errorException - the cause of the plugin exception

Method Detail

getErrorString

public java.lang.String getErrorString()

returns the error message

Returns:

textual description of error

toString

public java.lang.String toString()

returns the error message

Returns:

textual description of error

toString

public java.lang.String toString(java.lang.String arg1)

isFatalException

public boolean isFatalException()

Checks if the exception is a fatal exception

Returns:

true if the exception is fatal, false otherwise.

getErrorString

protected java.lang.String getErrorString(int errorCode,
                                          java.lang.String arg1)

returns the error message based on the error code

Parameters:

errorCode - the crawler error code

arg1 - argument of the message

Returns:

textual description of error