Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.nntp
Class XHDRResponse

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

public class XHDRResponse
extends NNTPResponseBuffer

Obtains a list of articles and returns the requested header info for each article. The XHDR response is defined in RFC-2980, and the valid headers in RFC-1036. The required header lines are "From", "Date", "Newsgroups", "Subject", "Message-ID", and "Path". The optional header lines are "Followup-To", "Expires", "Reply-To", "Sender", "References", "Control", "Distribution", "Keywords", "Summary", "Approved", "Lines", "Xref", and "Organization".


Field Summary
 
Fields inherited from interface com.jivesoftware.forum.nntp.NNTPResponse
DOT_TERMINATOR, ENDLINE
 
Method Summary
static NNTPResponse getXHDR(Connection connection, java.lang.String header, ArticlePointer pointer, ArticleFilter filter)
          Create a new XHDR response given a requested header, article pointer, and filter restricting results.
 
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

getXHDR

public static NNTPResponse getXHDR(Connection connection,
                                   java.lang.String header,
                                   ArticlePointer pointer,
                                   ArticleFilter filter)
                            throws ArticleNotFoundException,
                                   ArticleNotSelectedException,
                                   NoPermissionException,
                                   java.io.IOException,
                                   NoGroupSelectedException
Create a new XHDR response given a requested header, article pointer, and filter restricting results.

Parameters:
connection - the connection to send the response to.
header - the header to retrieve (e.g. subject, from, body, etc).
pointer - the current session article pointer.
filter - the filter restricting results.
Throws:
NoGroupSelectedException - If no group was selected
ArticleNotFoundException - If no article matching the filter was found
ArticleNotSelectedException - If no article was selected and the filter required one
NoPermissionException - If the caller lacked sufficient permission to get the XHDR response
java.io.IOException - if there was a problem sending the response over the connection.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.