Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.nntp
Class NNTPException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.jivesoftware.base.JiveException
              extended by com.jivesoftware.forum.nntp.NNTPException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ArticleNotFoundException, ArticleNotSelectedException, NewsGroupNotFoundException, NoGroupSelectedException, NoNextArticleException, NoPermissionException, NoPreviousArticleException, PostFailedException, PostNotAllowedException, PostRejectedException, SyntaxException

public class NNTPException
extends JiveException

Base NNTP exception. All NNTP exceptions allow the generation of a specific NNTP response that can be returned to clients.

See Also:
Serialized Form

Field Summary
protected  NNTPResponse response
          The static response that this exception will use.
 
Constructor Summary
NNTPException()
          Constructs a new exception with null as its detail message.
NNTPException(java.lang.String message)
          Constructs a new exception with the specified detail message.
NNTPException(java.lang.String message, java.lang.Throwable cause)
          Constructs a new exception with the specified detail message and cause.
NNTPException(java.lang.Throwable cause)
          Constructs a new exception with the specified cause and a detail message which contains the class and detail message of cause).
 
Method Summary
 NNTPResponse getErrorResponse()
          Returns the error response associated with this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

response

protected NNTPResponse response
The static response that this exception will use.

Constructor Detail

NNTPException

public NNTPException()
Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).


NNTPException

public NNTPException(java.lang.String message)
Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:
message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

NNTPException

public NNTPException(java.lang.Throwable cause)
Constructs a new exception with the specified cause and a detail message which contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables (for example, PrivilegedActionException).

Parameters:
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

NNTPException

public NNTPException(java.lang.String message,
                     java.lang.Throwable cause)
Constructs a new exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:
message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
Method Detail

getErrorResponse

public NNTPResponse getErrorResponse()
Returns the error response associated with this exception. The response basically transforms the Java exception into an NNTP protocol error message.

Returns:
the response that belongs to the given exception.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.