org.qbroker.net

Class NNTPConnector

java.lang.Object

org.qbroker.net.NNTPConnector

All Implemented Interfaces:

Connector

Direct Known Subclasses:

NNTPMessenger

public class NNTPConnector
extends java.lang.Object
implements Connector

NNTPConnector connects to a NNTP server and provides the following methods for news group operations: nntpGet(), nntpPost(), nntpListArticles(), and nntpListGroups().

This is NOT MT-Safe. Therefore, you need to use multiple instances to achieve your MT-Safty goal.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARTICLE_ALL
static int	ARTICLE_BODY
static int	ARTICLE_HEADER
protected java.lang.String	hostname
protected boolean	isConnected
protected int	maxArticle
protected java.lang.String	password
protected int	port
protected int	timeout
protected java.lang.String	uri
protected java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
NNTPConnector(java.util.Map props) Creates new NNTPConnector

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	connect()
protected org.apache.commons.net.nntp.Article	getArticleInfo(int anumber) It returns the article info for the given article number in the current newsgroup or null for failure.
protected org.apache.commons.net.nntp.Article[]	getArticleInfo(int lowNumber, int highNumber) It returns an array of article info for the given range of articles in the current newsgroup.
org.apache.commons.net.nntp.Article[]	getArticleInfo(java.lang.String gname, int anumber, long tm) It returns an array of article info for new articles in the specified newsgroup since the give timestamp.
java.util.Date	getDate(org.apache.commons.net.nntp.Article article) It parses the date field of an article and returns Date object or null upon failure.
org.apache.commons.net.nntp.NNTPClient	getNNTPClient()
java.lang.String	getReplyString()
java.lang.String	getURI()
boolean	isAllowedToPost()
boolean	isConnected()
static void	main(java.lang.String[] args)
java.lang.String	nntpGet(java.lang.StringBuffer strBuf, java.lang.String aid) It retrieves the entire article of the specific article id from the current newsgroup.
java.lang.String	nntpGet(java.lang.StringBuffer strBuf, java.lang.String aid, int contentType) It retrieves the content of the article of the specific article id from the current newsgroup.
java.lang.String[]	nntpListArticles(java.lang.String groupName, long tm) It returns an array of article IDs for requested articles in the specified news group.
org.apache.commons.net.nntp.NewsgroupInfo[]	nntpListGroups(java.lang.String distName, long tm) It returns a list of news groups on the NNTP server.
java.lang.String	nntpPost(java.lang.String header, java.lang.String body) It posts the article with the header and the body to the current newsgroup.
java.lang.String	nntpPost(java.lang.String subject, java.lang.String story, java.lang.String groupName) It posts the article with the subject and the story to the current newsgroup.
java.lang.String	reconnect() It reconnects and returns null or error message upon failure
java.lang.String	setNewsgroup(java.lang.String groupName) It sets the current newsgroup and returns null upon success or the error text otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

hostname

protected java.lang.String hostname

uri

protected java.lang.String uri

username

protected java.lang.String username

password

protected java.lang.String password

port

protected int port

timeout

protected int timeout

maxArticle

protected int maxArticle

isConnected

protected boolean isConnected

ARTICLE_ALL

public static final int ARTICLE_ALL

See Also:

Constant Field Values

ARTICLE_HEADER

public static final int ARTICLE_HEADER

See Also:

Constant Field Values

ARTICLE_BODY

public static final int ARTICLE_BODY

See Also:

Constant Field Values

Constructor Detail

NNTPConnector

public NNTPConnector(java.util.Map props)
              throws java.io.IOException

Creates new NNTPConnector

Throws:

java.io.IOException

Method Detail

connect

protected void connect()
                throws java.io.IOException

Throws:

java.io.IOException

getURI

public java.lang.String getURI()

Specified by:

getURI in interface Connector

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Connector

reconnect

public java.lang.String reconnect()

It reconnects and returns null or error message upon failure

Specified by:

reconnect in interface Connector

close

public void close()

Specified by:

close in interface Connector

isAllowedToPost

public boolean isAllowedToPost()

nntpGet

public java.lang.String nntpGet(java.lang.StringBuffer strBuf,
                                java.lang.String aid)
                         throws java.io.IOException

It retrieves the entire article of the specific article id from the current newsgroup. The content is stored in the provided StringBuffer. It returns null upon succes or the error message otherwise.

Throws:

java.io.IOException

nntpGet

public java.lang.String nntpGet(java.lang.StringBuffer strBuf,
                                java.lang.String aid,
                                int contentType)
                         throws java.io.IOException

It retrieves the content of the article of the specific article id from the current newsgroup. The content is stored in the provided StringBuffer. It returns null upon succes or the error message otherwise.

Throws:

java.io.IOException

nntpPost

public java.lang.String nntpPost(java.lang.String header,
                                 java.lang.String body)
                          throws java.io.IOException

It posts the article with the header and the body to the current newsgroup. It returns null upon succes or the error message otherwise.

Throws:

java.io.IOException

nntpPost

public java.lang.String nntpPost(java.lang.String subject,
                                 java.lang.String story,
                                 java.lang.String groupName)
                          throws java.io.IOException

It posts the article with the subject and the story to the current newsgroup. It returns null upon succes or the error message otherwise.

Throws:

java.io.IOException

nntpListGroups

public org.apache.commons.net.nntp.NewsgroupInfo[] nntpListGroups(java.lang.String distName,
                                                                  long tm)
                                                           throws java.io.IOException

It returns a list of news groups on the NNTP server. If distName is null, it returns all available news groups. Otherwise, distName can be a pattern as the wildmat or the name of a specific news group. If timestamp is positive, it will return all new groups added since the timestamp.

Throws:

java.io.IOException

nntpListArticles

public java.lang.String[] nntpListArticles(java.lang.String groupName,
                                           long tm)
                                    throws java.io.IOException

It returns an array of article IDs for requested articles in the specified news group. If the timestamp is positive, the returned list only contains the articles added since the give timestamp. In case of failure, it returns null.

Throws:

java.io.IOException

getArticleInfo

protected org.apache.commons.net.nntp.Article[] getArticleInfo(int lowNumber,
                                                               int highNumber)
                                                        throws java.io.IOException

It returns an array of article info for the given range of articles in the current newsgroup.

Throws:

java.io.IOException

getArticleInfo

protected org.apache.commons.net.nntp.Article getArticleInfo(int anumber)
                                                      throws java.io.IOException

It returns the article info for the given article number in the current newsgroup or null for failure.

Throws:

java.io.IOException

getArticleInfo

public org.apache.commons.net.nntp.Article[] getArticleInfo(java.lang.String gname,
                                                            int anumber,
                                                            long tm)
                                                     throws java.io.IOException

It returns an array of article info for new articles in the specified newsgroup since the give timestamp. If the timestamp is positive, the returned list only contains the new articles since the given timestamp. In case of failure, it returns null.

Throws:

java.io.IOException

getDate

public java.util.Date getDate(org.apache.commons.net.nntp.Article article)

It parses the date field of an article and returns Date object or null upon failure.

getReplyString

public java.lang.String getReplyString()

setNewsgroup

public java.lang.String setNewsgroup(java.lang.String groupName)

It sets the current newsgroup and returns null upon success or the error text otherwise.

getNNTPClient

public org.apache.commons.net.nntp.NNTPClient getNNTPClient()

main

public static void main(java.lang.String[] args)