Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.nntp
Class XOverResponse

java.lang.Object
  extended by com.jivesoftware.forum.nntp.NNTPResponseBuffer
      extended by com.jivesoftware.forum.nntp.XOverResponse
All Implemented Interfaces:
NNTPResponse

public class XOverResponse
extends NNTPResponseBuffer

Implements the proper XOVER response according to RFC-2980.


Field Summary
 
Fields inherited from interface com.jivesoftware.forum.nntp.NNTPResponse
DOT_TERMINATOR, ENDLINE
 
Method Summary
static NNTPResponse sendXOver(ArticlePointer pointer, ArticleFilter filter, Connection connection)
          Produce a new XOver response using the given pointer and obeying the given filter.
 
Methods inherited from class com.jivesoftware.forum.nntp.NNTPResponseBuffer
append, appendBulkText, appendLine, appendParameter, appendXParameter, close, endLine, flush, getValue, send
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

sendXOver

public static NNTPResponse sendXOver(ArticlePointer pointer,
                                     ArticleFilter filter,
                                     Connection connection)
                              throws NoGroupSelectedException,
                                     ArticleNotSelectedException,
                                     NoPermissionException,
                                     ArticleNotFoundException,
                                     java.io.IOException
Produce a new XOver response using the given pointer and obeying the given filter.

Parameters:
pointer - the pointer to articles to produce the overview.
filter - The filter to restrict articles in the overview.
connection - The connection to send the response to.
Throws:
NoGroupSelectedException - if no groups were selected and the filter requires a group (number or range selection).
ArticleNotSelectedException - if no article is selected and the filter requires a current article.
NoPermissionException - if the caller does not have permission to get an XOver response.
ArticleNotFoundException - if the indicated article could not be found.
java.io.IOException - if there was a problem sending the response over the connection.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.