ipworksssl
Class Nntps

java.lang.Object
  ipworksssl.Nntps

public class Nntps
extends java.lang.Object

The NNTPS Bean is used to read, search, and post articles on Usenet news servers.

The NNTPS Bean is the SSL-enabled equivalent of the IP*Works! NNTP Bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The ipworksssl.Nntps#config and {@link ipworksssl.Nntps#config configuration settings determine which protocols are enabled and at what security level. The {@link ipworksssl.Nntps#getSSLCert SSLCert} property is used to select a client certificate if the server is requesting client authentication. The {@link ipworksssl.Nntps#config configuration setting, together with the {@link ipworksssl.NntpsSSLServerAuthenticationEvent SSLServerAuthentication} event allow you to check the server identity and other security attributes. Finally, the {@link ipworksssl.NntpsSSLStatusEvent SSLStatus} event provides information about the SSL handshake.

The NNTPS Bean implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and read and post articles.

The {@link ipworksssl.Nntps#getCurrentGroup CurrentGroup} property sets the current newsgroup. From then on, news articles from that group can be read by setting the article number in {@link ipworksssl.Nntps#getCurrentArticle CurrentArticle} and then calling the appropriate method. Properties such as {@link ipworksssl.Nntps#getArticleCount ArticleCount} , {@link ipworksssl.Nntps#getFirstArticle FirstArticle} , {@link ipworksssl.Nntps#getLastArticle LastArticle} provide information about the current state.

The headers and text of the articles are received respectively through the {@link ipworksssl.NntpsHeaderEvent Header} and {@link ipworksssl.NntpsTransferEvent Transfer} events. Additionally, up to {@link ipworksssl.Nntps#getMaxLines MaxLines} from the article body are provided in the {@link ipworksssl.Nntps#getArticleText ArticleText} property. The {@link ipworksssl.NntpsGroupOverviewEvent GroupOverview} event returns information about a range of articles ( {@link ipworksssl.Nntps#getOverviewRange OverviewRange} ) in {@link ipworksssl.Nntps#getCurrentGroup CurrentGroup} , and the {@link ipworksssl.NntpsGroupListEvent GroupList} event is used when listing newsgroup names. The {@link ipworksssl.NntpsPITrailEvent PITrail} event provides a trace of the interaction with the server.

The bean supports posting of articles through the {@link ipworksssl.Nntps#getArticleText ArticleText} and {@link ipworksssl.Nntps#getAttachedFile AttachedFile} properties. The article text is specified in one or both of the above, and then the {@link ipworksssl.Nntps#postArticle PostArticle} method is called. Article headers are given in a series of properties like {@link ipworksssl.Nntps#getArticleFrom ArticleFrom} , {@link ipworksssl.Nntps#getArticleSubject ArticleSubject} , {@link ipworksssl.Nntps#getOrganization Organization} , etc. that map directly to the USENET article header with the same name.

Field Summary

static int	sslAutomatic
static int	sslExplicit
static int	sslImplicit
static int	sslNone

Constructor Summary

Nntps()
Creates an instance of Nntps Bean.

Nntps(java.lang.String runtimeLicense)
Creates an instance of Nntps Bean with specified run-time license.

Method Summary

void	addNntpsEventListener(NntpsEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a {@link ipworksssl.Nntps#config configuration setting.
void	connect() Connects to the news server.
void	disconnect() Disconnects from the news server.
void	doEvents() Processes events from the internal message queue.
void	fetchArticle() Get the headers and body of an article specified in CurrentArticle .
void	fetchArticleBody() Gets only the body of an article specified in CurrentArticle .
void	fetchArticleHeaders() Gets only the headers of an article specified in CurrentArticle .
int	getArticleCount() The estimated number of articles in CurrentGroup .
java.lang.String	getArticleDate() The date of the current article.
java.lang.String	getArticleFrom() The email address of the author (for posting articles).
java.lang.String	getArticleHeaders() The full headers of the article as retrieved from the server.
java.lang.String	getArticleId() The message identifier of the current article.
ArticleInfoList	getArticleList() Collection of articles collected through GroupOverview or GroupSearch .
java.lang.String	getArticleReferences() Articles to which the posted article follows up.
java.lang.String	getArticleReplyTo() The address to reply to (for posting articles).
java.lang.String	getArticleSubject() The article subject (for posted articles).
java.lang.String	getArticleText() The full text of the article (without the headers).
java.lang.String	getAttachedFile() A file name which the contents of will be appended to the ArticleText when posting articles.
java.lang.String	getCheckDate() The date (format YYMMDD HHMMSS) to check for creation of new groups.
java.lang.String	getCurrentArticle() The number or message identifier of the current article.
java.lang.String	getCurrentGroup() The name of the current group.
Firewall	getFirewall() A set of properties related to firewall access.
int	getFirstArticle() The number of the first article in CurrentGroup .
GroupInfoList	getGroupList() Collection of newsgroups listed by ListGroups or ListNewGroups .
int	getLastArticle() The number of the last article in CurrentGroup .
java.lang.String	getLastReply() The last reply from the server.
java.lang.String	getLocalFile() The path to a local file for downloading the article body.
java.lang.String	getLocalHost() The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
int	getMaxLines() The maximum number of message lines aside from headers to retrieve.
java.lang.String	getNewsgroups() A comma separated list of newsgroups in which to post the article.
int	getNewsPort() The server port for secure NNTP (default 563).
java.lang.String	getNewsServer() The name or address of a news server.
java.lang.String	getOrganization() The organization of the author (for posting articles).
java.lang.String	getOtherHeaders() An RFC850 compliant string consisting of extra headers (for posting articles).
java.lang.String	getOverviewRange() A range for the GroupOverview method (first-last).
HeaderList	getParsedHeaders() A collection of headers returned from the last article retrieval.
java.lang.String	getPassword() A logon password for the NewsServer .
java.lang.String	getSearchHeader() A header for the GroupSearch method.
java.lang.String	getSearchPattern() A search pattern for the GroupSearch method.
java.lang.String	getSearchRange() A range for the GroupSearch method (first-last).
Certificate	getSSLAcceptServerCert() Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
Certificate	getSSLCert() The certificate to be used during SSL negotiation.
Certificate	getSSLServerCert() The server certificate for the last established connection.
int	getSSLStartMode() Determines how the bean starts the SSL negotiation.
int	getTimeout() A timeout for the bean.
java.lang.String	getUser() A user identifier to login as in the NewsServer .
void	groupOverview() Receives an overview for the articles in range OverviewRange in the CurrentGroup .
void	groupSearch() Receives an overview for the articles in range SearchRange in the CurrentGroup .
void	interrupt() Interrupt the current method.
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
void	listGroups() Lists all groups on the server.
void	listNewGroups() Lists all new groups on the server.
java.lang.String	localizeDate(java.lang.String dateTime) Converts a valid RFC 822 message date to local date and time.
void	postArticle() Posts the current article and attached file.
void	removeNntpsEventListener(NntpsEventListener l)
void	resetHeaders() Resets all of the article headers.
void	setArticleFrom(java.lang.String articleFrom) The email address of the author (for posting articles).
void	setArticleReferences(java.lang.String articleReferences) Articles to which the posted article follows up.
void	setArticleReplyTo(java.lang.String articleReplyTo) The address to reply to (for posting articles).
void	setArticleStream(java.io.OutputStream articleStream) Sets the stream to which the article downloaded from the server will be written.
void	setArticleSubject(java.lang.String articleSubject) The article subject (for posted articles).
void	setArticleText(java.lang.String articleText) The full text of the article (without the headers).
void	setAttachedFile(java.lang.String attachedFile) A file name which the contents of will be appended to the ArticleText when posting articles.
void	setCheckDate(java.lang.String checkDate) The date (format YYMMDD HHMMSS) to check for creation of new groups.
void	setCommand(java.lang.String command) Used to send additional commands directly to the server.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setCurrentArticle(java.lang.String currentArticle) The number or message identifier of the current article.
void	setCurrentGroup(java.lang.String currentGroup) The name of the current group.
void	setFirewall(Firewall firewall) A set of properties related to firewall access.
void	setLocalFile(java.lang.String localFile) The path to a local file for downloading the article body.
void	setLocalHost(java.lang.String localHost) The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
void	setMaxLines(int maxLines) The maximum number of message lines aside from headers to retrieve.
void	setNewsgroups(java.lang.String newsgroups) A comma separated list of newsgroups in which to post the article.
void	setNewsPort(int newsPort) The server port for secure NNTP (default 563).
void	setNewsServer(java.lang.String newsServer) The name or address of a news server.
void	setOrganization(java.lang.String organization) The organization of the author (for posting articles).
void	setOtherHeaders(java.lang.String otherHeaders) An RFC850 compliant string consisting of extra headers (for posting articles).
void	setOverviewRange(java.lang.String overviewRange) A range for the GroupOverview method (first-last).
void	setPassword(java.lang.String password) A logon password for the NewsServer .
void	setSearchHeader(java.lang.String searchHeader) A header for the GroupSearch method.
void	setSearchPattern(java.lang.String searchPattern) A search pattern for the GroupSearch method.
void	setSearchRange(java.lang.String searchRange) A range for the GroupSearch method (first-last).
void	setSSLAcceptServerCert(Certificate SSLAcceptServerCert) Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
void	setSSLCert(Certificate SSLCert) The certificate to be used during SSL negotiation.
void	setSSLStartMode(int SSLStartMode) Determines how the bean starts the SSL negotiation.
void	setTimeout(int timeout) A timeout for the bean.
void	setUser(java.lang.String user) A user identifier to login as in the NewsServer .

Methods inherited from class java.lang.Object

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

Field Detail

sslAutomatic

public static final int sslAutomatic

See Also:

Constant Field Values

sslImplicit

public static final int sslImplicit

See Also:

Constant Field Values

sslExplicit

public static final int sslExplicit

See Also:

Constant Field Values

sslNone

public static final int sslNone

See Also:

Constant Field Values

Constructor Detail

Nntps

public Nntps()

Creates an instance of Nntps Bean.

Nntps

public Nntps(java.lang.String runtimeLicense)

Creates an instance of Nntps Bean with specified run-time license.

Method Detail

getArticleCount

public int getArticleCount()

The estimated number of articles in CurrentGroup .

This property contains the estimated number of articles in CurrentGroup The value of this property is 0 if there is no current group ( CurrentGroup is ""). Otherwise, when CurrentGroup is set it is the number of articles in the group as shown by the news server. For most news servers, this is an estimated value of the number of the articles, rather than the exact value.

getArticleDate

public java.lang.String getArticleDate()

The date of the current article.

This property contains the date of the current article. If the bean is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the date of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the bean returns a cached value.

getArticleFrom

public java.lang.String getArticleFrom()

The email address of the author (for posting articles).

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setArticleFrom

public void setArticleFrom(java.lang.String articleFrom)
                    throws IPWorksSSLException

The email address of the author (for posting articles).

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getArticleHeaders

public java.lang.String getArticleHeaders()

The full headers of the article as retrieved from the server.

This property contains the full headers of the article as retrieved from the server. If the bean is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full headers of the article as reported by the server.

The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the bean returns a cached value.

getArticleId

public java.lang.String getArticleId()

The message identifier of the current article.

This property contains the message identifier of the current article. If the bean is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the message identifier of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If the CurrentArticle has not changed, the bean returns a cached value.

getArticleList

public ArticleInfoList getArticleList()

Collection of articles collected through GroupOverview or GroupSearch .

This property contains a collection of articles collected through GroupOverview or GroupSearch . This collection consists of a list of articleinfo objects. The returned list contains information about each article in the OverviewRange or SearchRange when either GroupOverview or GroupSearch is called.

{@link ipworksssl.Nntps#config can be used to control the number of articles saved.

This collection is indexed from 0 to size - 1.

getArticleReferences

public java.lang.String getArticleReferences()

Articles to which the posted article follows up.

This property contains articles to which the posted article follows up. If this property contains a non-empty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setArticleReferences

public void setArticleReferences(java.lang.String articleReferences)
                          throws IPWorksSSLException

Articles to which the posted article follows up.

This property contains articles to which the posted article follows up. If this property contains a non-empty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getArticleReplyTo

public java.lang.String getArticleReplyTo()

The address to reply to (for posting articles).

This property contains the address to reply to (for posting articles). If this property contains a non-empty string, a Reply-To article header is created for the article. This header shows the address to use for replies (useful if this address is different from the one in ArticleFrom ).

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setArticleReplyTo

public void setArticleReplyTo(java.lang.String articleReplyTo)
                       throws IPWorksSSLException

The address to reply to (for posting articles).

This property contains the address to reply to (for posting articles). If this property contains a non-empty string, a Reply-To article header is created for the article. This header shows the address to use for replies (useful if this address is different from the one in ArticleFrom ).

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getArticleSubject

public java.lang.String getArticleSubject()

The article subject (for posted articles).

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setArticleSubject

public void setArticleSubject(java.lang.String articleSubject)
                       throws IPWorksSSLException

The article subject (for posted articles).

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getArticleText

public java.lang.String getArticleText()

The full text of the article (without the headers).

This property contains the full text of the article (without the headers). If the bean is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The NewsServer is asked about the text of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the bean returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The bean automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

setArticleText

public void setArticleText(java.lang.String articleText)
                    throws IPWorksSSLException

The full text of the article (without the headers).

This property contains the full text of the article (without the headers). If the bean is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The NewsServer is asked about the text of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the bean returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The bean automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

Throws:

IPWorksSSLException

getAttachedFile

public java.lang.String getAttachedFile()

A file name which the contents of will be appended to the ArticleText when posting articles.

The content of this property is appended to the text in ArticleText (if any) and sent to the news server. This property is useful for posting arbitrarily large articles and/or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the message lines must contain only 7-bit characters so that the message may be successfully sent through the various Usenet news servers on the Internet.

The bean automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

setAttachedFile

public void setAttachedFile(java.lang.String attachedFile)
                     throws IPWorksSSLException

A file name which the contents of will be appended to the ArticleText when posting articles.

The content of this property is appended to the text in ArticleText (if any) and sent to the news server. This property is useful for posting arbitrarily large articles and/or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the message lines must contain only 7-bit characters so that the message may be successfully sent through the various Usenet news servers on the Internet.

The bean automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

Throws:

IPWorksSSLException

getCheckDate

public java.lang.String getCheckDate()

The date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.

This property contains the date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the ListNewGroups method.

setCheckDate

public void setCheckDate(java.lang.String checkDate)
                  throws IPWorksSSLException

The date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.

This property contains the date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the ListNewGroups method.

Throws:

IPWorksSSLException

setCommand

public void setCommand(java.lang.String command)
                throws IPWorksSSLException

Used to send additional commands directly to the server.

This property can be used to send additional commands directly to the server. Check the LastReply property and/or trap the PITrail events coming from the server to get the response.

Throws:

IPWorksSSLException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksSSLException

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

Throws:

IPWorksSSLException

getCurrentArticle

public java.lang.String getCurrentArticle()

The number or message identifier of the current article.

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as FetchArticle .

setCurrentArticle

public void setCurrentArticle(java.lang.String currentArticle)
                       throws IPWorksSSLException

The number or message identifier of the current article.

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as FetchArticle .

Throws:

IPWorksSSLException

getCurrentGroup

public java.lang.String getCurrentGroup()

The name of the current group.

This property contains the name of the current group. When this property is set to a valid group name, the bean sends an NNTP GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle , LastArticle , and ArticleCount are set to the reported values for the group. This property is then used for all references to articles (until changed to another group).

setCurrentGroup

public void setCurrentGroup(java.lang.String currentGroup)
                     throws IPWorksSSLException

The name of the current group.

This property contains the name of the current group. When this property is set to a valid group name, the bean sends an NNTP GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle , LastArticle , and ArticleCount are set to the reported values for the group. This property is then used for all references to articles (until changed to another group).

Throws:

IPWorksSSLException

getFirewall

public Firewall getFirewall()

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksSSLException

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:

IPWorksSSLException

getFirstArticle

public int getFirstArticle()

The number of the first article in CurrentGroup .

This property contains the number of the first article in CurrentGroup . The value of this property is 0 if there is no current group ( CurrentGroup is "").

getGroupList

public GroupInfoList getGroupList()

Collection of newsgroups listed by ListGroups or ListNewGroups .

This property contains a collection of newsgroups listed by ListGroups or ListNewGroups . This collection consists of a list of groupinfo objects. These objects contain information about each group such as the name, first and last article, and whether or not you can post to the group.

{@link ipworksssl.Nntps#config can be used to control the number of groups saved.

This collection is indexed from 0 to size - 1.

isIdle

public boolean isIdle()

The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

getLastArticle

public int getLastArticle()

The number of the last article in CurrentGroup .

This property contains the number of the last article in CurrentGroup . The value of this property is 0 if there is no current group ( CurrentGroup is "").

getLastReply

public java.lang.String getLastReply()

The last reply from the server.

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

getLocalFile

public java.lang.String getLocalFile()

The path to a local file for downloading the article body. If the file exists, it is overwritten (optional).

This property is used when retrieving an article. If this property is empty then the received data is provided through the parameters of the Transfer event

setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksSSLException

The path to a local file for downloading the article body. If the file exists, it is overwritten (optional).

This property is used when retrieving an article. If this property is empty then the received data is provided through the parameters of the Transfer event

Throws:

IPWorksSSLException

getLocalHost

public java.lang.String getLocalHost()

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksSSLException

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Throws:

IPWorksSSLException

getMaxLines

public int getMaxLines()

The maximum number of message lines aside from headers to retrieve.

This property is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property. Please note that due to NNTP protocol limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText .

The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.

setMaxLines

public void setMaxLines(int maxLines)
                 throws IPWorksSSLException

The maximum number of message lines aside from headers to retrieve.

This property is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property. Please note that due to NNTP protocol limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText .

The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.

Throws:

IPWorksSSLException

getNewsgroups

public java.lang.String getNewsgroups()

A comma separated list of newsgroups in which to post the article.

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the CurrentGroup property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setNewsgroups

public void setNewsgroups(java.lang.String newsgroups)
                   throws IPWorksSSLException

A comma separated list of newsgroups in which to post the article.

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the CurrentGroup property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getNewsPort

public int getNewsPort()

The server port for secure NNTP (default 563).

This property contains the server port for NNTP (default 119). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

setNewsPort

public void setNewsPort(int newsPort)
                 throws IPWorksSSLException

The server port for secure NNTP (default 563).

This property contains the server port for NNTP (default 119). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Throws:

IPWorksSSLException

getNewsServer

public java.lang.String getNewsServer()

The name or address of a news server.

This property specifies the IP address (IP number in dotted internet format) or the Domain Name for the news server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

setNewsServer

public void setNewsServer(java.lang.String newsServer)
                   throws IPWorksSSLException

The name or address of a news server.

This property specifies the IP address (IP number in dotted internet format) or the Domain Name for the news server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Throws:

IPWorksSSLException

getOrganization

public java.lang.String getOrganization()

The organization of the author (for posting articles).

This property contains the organization of the article's author. If this property contains a non-empty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

setOrganization

public void setOrganization(java.lang.String organization)
                     throws IPWorksSSLException

The organization of the author (for posting articles).

This property contains the organization of the article's author. If this property contains a non-empty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than {@link ipworksssl.Nntps#config , then it is folded according to RFC 850 specifications.

Throws:

IPWorksSSLException

getOtherHeaders

public java.lang.String getOtherHeaders()

An RFC850 compliant string consisting of extra headers (for posting articles).

This property contains a string of headers to be appended to the message headers created from other properties like From , Subject , etc.

The headers must be of the format "header: value" as specified in RFC 850. [Header lines should be separated by CRLF ("\r\ n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the bean. A good example is posting of MIME attachments.

SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed article headers.

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksSSLException

An RFC850 compliant string consisting of extra headers (for posting articles).

This property contains a string of headers to be appended to the message headers created from other properties like From , Subject , etc.

The headers must be of the format "header: value" as specified in RFC 850. [Header lines should be separated by CRLF ("\r\ n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the bean. A good example is posting of MIME attachments.

SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed article headers.

Throws:

IPWorksSSLException

getOverviewRange

public java.lang.String getOverviewRange()

A range for the GroupOverview method (first-last).

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end .

The default value of this property is '-', meaning 'all articles in the group' .

setOverviewRange

public void setOverviewRange(java.lang.String overviewRange)
                      throws IPWorksSSLException

A range for the GroupOverview method (first-last).

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end .

The default value of this property is '-', meaning 'all articles in the group' .

Throws:

IPWorksSSLException

getParsedHeaders

public HeaderList getParsedHeaders()

A collection of headers returned from the last article retrieval.

This property contains a collection of headers returned from the last article retrieval. This property is populated when either FetchArticle or FetchArticleHeaders is called, and contains a list of all of the headers from the article fetched.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

{@link ipworksssl.Nntps#config can be used to control the number of headers saved.

This collection is indexed from 0 to size - 1.

getPassword

public java.lang.String getPassword()

A logon password for the NewsServer .

This property contains a logon password for the NewsServer . If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent in order to provide authentication information for the user. This command is not part of the NNTP protocol, but it is widely used by popular news servers.

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksSSLException

A logon password for the NewsServer .

This property contains a logon password for the NewsServer . If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent in order to provide authentication information for the user. This command is not part of the NNTP protocol, but it is widely used by popular news servers.

Throws:

IPWorksSSLException

getSearchHeader

public java.lang.String getSearchHeader()

A header for the GroupSearch method.

This property specifies the header to search for SearchPattern (e.g. "Subject").

setSearchHeader

public void setSearchHeader(java.lang.String searchHeader)
                     throws IPWorksSSLException

A header for the GroupSearch method.

This property specifies the header to search for SearchPattern (e.g. "Subject").

Throws:

IPWorksSSLException

getSearchPattern

public java.lang.String getSearchPattern()

A search pattern for the GroupSearch method.

This property contains a search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX 'find' command.

As an example, "* new *" will match all headers that contain the word "new".

setSearchPattern

public void setSearchPattern(java.lang.String searchPattern)
                      throws IPWorksSSLException

A search pattern for the GroupSearch method.

This property contains a search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX 'find' command.

As an example, "* new *" will match all headers that contain the word "new".

Throws:

IPWorksSSLException

getSearchRange

public java.lang.String getSearchRange()

A range for the GroupSearch method (first-last).

This property specifies a range of articles for which to do a search on the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end .

The default value of the property is '-', meaning 'search all articles in the group' .

setSearchRange

public void setSearchRange(java.lang.String searchRange)
                    throws IPWorksSSLException

A range for the GroupSearch method (first-last).

This property specifies a range of articles for which to do a search on the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end .

The default value of the property is '-', meaning 'search all articles in the group' .

Throws:

IPWorksSSLException

getSSLAcceptServerCert

public Certificate getSSLAcceptServerCert()

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert)
                            throws IPWorksSSLException

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Throws:

IPWorksSSLException

getSSLCert

public Certificate getSSLCert()

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

setSSLCert

public void setSSLCert(Certificate SSLCert)
                throws IPWorksSSLException

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Throws:

IPWorksSSLException

getSSLServerCert

public Certificate getSSLServerCert()

The server certificate for the last established connection.

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

getSSLStartMode

public int getSSLStartMode()

Determines how the bean starts the SSL negotiation.

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)

If the remote port is set to the standard plaintext port of the protocol (where applicable), the bean will behave the same as if SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit ( sslImplicit ).

1 (sslImplicit)

The SSL negotiation will start immediately after the connection is established.

2 (sslExplicit)

The bean will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.

3 (sslNone)

No SSL negotiation, no SSL security. All communication will be in plaintext mode.

setSSLStartMode

public void setSSLStartMode(int SSLStartMode)
                     throws IPWorksSSLException

Determines how the bean starts the SSL negotiation.

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)

If the remote port is set to the standard plaintext port of the protocol (where applicable), the bean will behave the same as if SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit ( sslImplicit ).

1 (sslImplicit)

The SSL negotiation will start immediately after the connection is established.

2 (sslExplicit)

The bean will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.

3 (sslNone)

No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Throws:

IPWorksSSLException

getTimeout

public int getTimeout()

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Nntps#config configuration setting.

The default value for the {@link ipworksssl.Nntps#getTimeout Timeout} property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksSSLException

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Nntps#config configuration setting.

The default value for the {@link ipworksssl.Nntps#getTimeout Timeout} property is 60 (seconds).

Throws:

IPWorksSSLException

getUser

public java.lang.String getUser()

A user identifier to login as in the NewsServer .

This property contains a user identifier to login as in the NewsServer . If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO USER command is sent in order to provide authentication information for the user. Although this command is not part of the NNTP protocol, it is widely used by news servers for authentication purposes.

setUser

public void setUser(java.lang.String user)
             throws IPWorksSSLException

A user identifier to login as in the NewsServer .

This property contains a user identifier to login as in the NewsServer . If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO USER command is sent in order to provide authentication information for the user. Although this command is not part of the NNTP protocol, it is widely used by news servers for authentication purposes.

Throws:

IPWorksSSLException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksSSLException

Sets or retrieves a ipworksssl.Nntps#config configuration setting.

{@link ipworksssl.Nntps#config Config} is a generic method available in every bean. It is used to set and retrieve {@link ipworksssl.Nntps#config configuration settingsfor the bean.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Nntps#config Config} method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a {@link ipworksssl.Nntps#config configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Nntps#config Config} method.

NNTP Configuration Settings

ArticleInfoLimit

Instructs bean to save the amount of articles specified that are returned by the server when a GroupOverview event is fired

This config should be set when the {@link ipworksssl.Nntps#getArticleList ArticleList} collection will be populated after a call to either {@link ipworksssl.Nntps#groupOverview GroupOverview} or {@link ipworksssl.Nntps#groupSearch GroupSearch} . This value represents the number of articles that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

GroupInfoLimit

Instructs bean to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made

This config should be set when the {@link ipworksssl.Nntps#getGroupList GroupList} collection will be populated after a call to {@link ipworksssl.Nntps#listGroups ListGroups} . This value represents the number of group info objects that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

HeaderLimit

Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired

This config should be set when the {@link ipworksssl.Nntps#getParsedHeaders ParsedHeaders} collection will be populated when a {@link ipworksssl.NntpsHeaderEvent Header} event has been fired. This value represents the number of headers that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is 0, so no items will be included in the collection .

MaxHeaderLength

Maximum length for headers to avoid line folding (default 80)

The MaxHeaderLength specifies the maximum line length supported by the news delivery system. Any headers longer than MaxHeaderLength are folded as specified in RFC 850.It is generally a good idea to use a MaxHeaderLength of less than 100 bytes, although different news servers have different requirements for header lengths.

IPPort Configuration Settings

ConnectionTimeout

Sets a separate timeout value for establishing a connection

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the bean will use {@link ipworksssl.Nntps#getTimeout Timeout} for establishing a connection and transmitting/receiving data.

FirewallAutoDetect

Tells the bean whether or not to automatically detect and use firewall system settings, if available

This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallHost

Name or IP address of firewall (optional)

If a {@link ipworksssl.Nntps#config is given, requested connections will be authenticated through the specified firewall when connecting.If the {@link ipworksssl.Nntps#config setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the {@link ipworksssl.Nntps#config setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener

If true, the component binds to a SOCKS firewall as a server (IPPort only)

This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. {@link ipworksssl.Nntps#getRemoteHost RemoteHost} and {@link ipworksssl.Nntps#getRemotePort RemotePort} are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore {@link ipworksssl.Nntps#getRemoteHost RemoteHost} , and it is recommended that {@link ipworksssl.Nntps#getRemoteHost RemoteHost} be set to empty string in this case.

{@link ipworksssl.Nntps#getRemotePort RemotePort} is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the {@link ipworksssl.NntpsConnectionStatusEvent ConnectionStatus} event.

The connection to the firewall is made by calling the {@link ipworksssl.Nntps#connect Connect} method.

FirewallPassword

Password to be used if authentication is to be used when connecting through the firewall

If {@link ipworksssl.Nntps#config is specified, the {@link ipworksssl.Nntps#config and {@link ipworksssl.Nntps#config settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort

The TCP port for the FirewallHost;

Note that the {@link ipworksssl.Nntps#config is set automatically when {@link ipworksssl.Nntps#config is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType

Determines the type of firewall to connect through

The appropriate values are as follows:

0

No firewall (default setting).

1

Connect through a tunneling proxy. {@link ipworksssl.Nntps#config is set to 80.

2

Connect through a SOCKS4 Proxy. {@link ipworksssl.Nntps#config is set to 1080.

3

Connect through a SOCKS5 Proxy. {@link ipworksssl.Nntps#config is set to 1080.

NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser

A user name if authentication is to be used connecting through a firewall

If the {@link ipworksssl.Nntps#config is specified, the {@link ipworksssl.Nntps#config and {@link ipworksssl.Nntps#config settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime

The inactivity time in milliseconds before a TCP keep-alive packet is sent

When set, {@link ipworksssl.Nntps#config will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval

The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received

When set, {@link ipworksssl.Nntps#config will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by {@link ipworksssl.Nntps#config . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger

When set to True, connections are terminated gracefully

This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if {@link ipworksssl.Nntps#config is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, {@link ipworksssl.Nntps#config is a positive value, the system will attempt to send pending data until the specified {@link ipworksssl.Nntps#config is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime

Time in seconds to have the connection linger

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost

The name of the local host through which connections are initiated or accepted

The {@link ipworksssl.Nntps#getLocalHost LocalHost} setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the {@link ipworksssl.Nntps#getLocalHost LocalHost} setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort

The TCP port in the local host where the bean binds

This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by {@link ipworksssl.Nntps#getLocalPort LocalPort} after the connection is established.

{@link ipworksssl.Nntps#getLocalPort LocalPort} cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength

The maximum amount of data to accumulate when no EOL is found

{@link ipworksssl.Nntps#config is the size of an internal buffer, which holds received data while waiting for an {@link ipworksssl.Nntps#getEOL EOL} string.If an {@link ipworksssl.Nntps#getEOL EOL} string is found in the input stream before {@link ipworksssl.Nntps#config bytes are received, the {@link ipworksssl.NntpsDataInEvent DataIn} event is fired with the EOL parameter set to True, and the buffer is reset.

If no {@link ipworksssl.Nntps#getEOL EOL} is found, and {@link ipworksssl.Nntps#config bytes are accumulated in the buffer, the {@link ipworksssl.NntpsDataInEvent DataIn} event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for {@link ipworksssl.Nntps#config is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate

The transfer rate limit in bytes per second

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

TCPKeepAlive

Determines whether or not the keep alive socket option is enabled

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set {@link ipworksssl.Nntps#config and {@link ipworksssl.Nntps#config to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6

Whether or not to use IPv6

By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.

CloseStreamAfterTransfer

If true, the component will close the upload or download stream after the transfer

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

TcpNoDelay

Whether or not to delay when sending packets

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

SSL Configuration Settings

ReuseSSLSession

Determines if the SSL session is reused

If set to true, the component will reuse the context if and only if the following criteria are met:

• The target host name is the same.
• The system cache entry has not expired (default timeout is 10 hours).
• The application process that calls the function is the same.
• The logon session is the same.
• The instance of the component is the same.

SSLCipherStrength

The minimum cipher strength used for bulk encryption

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the {@link ipworksssl.NntpsSSLStatusEvent SSLStatus} event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Nntps#config config setting.

SSLEnabledProtocols

Used to enable/disable the supported security protocols

Used to enable/disable the supported security protocols.Not all supported protocols are enabled by default (the value of this setting is 192). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.2

3072 (Hex C00)

TLS1.1

768 (Hex 300)

TLS1

192 (Hex C0) (Default)

SSL3

48 (Hex 30)

SSL2

12 (Hex 0C)

Please note that although a number of sites still support SSL2, it is usually a good idea to disable it because of potential security vulnerabilities.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Nntps#config config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

SSLProvider

The name of the security provider to use

Change this setting to use security providers other than the system default.Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

SSLSecurityFlags

Flags that control certificate verification

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001

Ignore time validity status of certificate.

0x00000002

Ignore time validity status of CTL.

0x00000004

Ignore non-nested certificate times.

0x00000010

Allow unknown Certificate Authority.

0x00000020

Ignore wrong certificate usage.

0x00000100

Ignore unknown certificate revocation status.

0x00000200

Ignore unknown CTL signer revocation status.

0x00000400

Ignore unknown Certificate Authority revocation status.

0x00000800

Ignore unknown Root revocation status.

0x00008000

Allow test Root certificate.

0x00004000

Trust test Root certificate.

0x80000000

Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLContextProtocol

The protocol used when getting an SSLContext instance

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLTrustManagerFactoryAlgorithm

The algorithm to be used to create a TrustManager through TrustManagerFactory

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

SSLEnabledCipherSuites

The cipher suite to be used in an SSL negotiation

The enabled cipher suites to be used in SSL negotiation.By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values:

 obj.config("SSLEnabledCipherSuites=*");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); 

Possible values include:

• SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_RC4_128_SHA
• SSL_RSA_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_WITH_DES_CBC_SHA
• SSL_RSA_WITH_NULL_MD5
• SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
• SSL_DHE_RSA_WITH_DES_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
• SSL_RSA_WITH_NULL_SHA
• SSL_DH_anon_WITH_RC4_128_MD5
• SSL_RSA_WITH_RC4_128_MD5
• SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_ECDSA_WITH_NULL_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA256
• TLS_ECDH_anon_WITH_RC4_128_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_EXPORT_WITH_RC4_40_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_RC4_128_SHA
• TLS_ECDH_ECDSA_WITH_RC4_128_SHA
• TLS_ECDH_anon_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• TLS_RSA_WITH_NULL_SHA256
• TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
• TLS_KRB5_WITH_RC4_128_MD5
• TLS_ECDHE_ECDSA_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_RC4_128_SHA
• TLS_EMPTY_RENEGOTIATION_INFO_SCSV
• TLS_KRB5_WITH_3DES_EDE_CBC_MD5
• TLS_KRB5_WITH_RC4_128_SHA
• TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_NULL_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_DES_CBC_MD5
• TLS_KRB5_EXPORT_WITH_RC4_40_MD5
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
• TLS_ECDH_anon_WITH_AES_128_CBC_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_WITH_DES_CBC_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_NULL_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA

SSLEnabledCipherSuites is used together with SSLCipherStrength .

Note: This configuration setting is available only in .NET and Java.

SSLAlgorithmList

A string that controls the cipher algorithms to be used by SSL

This configuration option takes a semicolon (;) delimited list of cipher algorithms to specify what algorithms may be used by SSL. This option can be used in conjunction with SSLEnabledProtocols to control which ciphers are used.For example:

 obj.Config("SSLEnabledProtocols=3072"); // TLS1.2  (supports SHA_256)
   obj.Config("SSLAlgorithmList=CALG_SHA_256;CALG_MD5"); 

Possible values include:

• CALG_3DES
• CALG_3DES_112
• CALG_AES
• CALG_AES_128
• CALG_AES_192
• CALG_AES_256
• CALG_AGREEDKEY_ANY
• CALG_CYLINK_MEK
• CALG_DES
• CALG_DESX
• CALG_DH_EPHEM
• CALG_DH_SF
• CALG_DSS_SIGN
• CALG_ECDH
• CALG_ECDSA
• CALG_ECMQV
• CALG_HASH_REPLACE_OWF
• CALG_HUGHES_MD5
• CALG_HMAC
• CALG_KEA_KEYX
• CALG_MAC
• CALG_MD2
• CALG_MD4
• CALG_MD5
• CALG_NO_SIGN
• CALG_OID_INFO_CNG_ONLY
• CALG_OID_INFO_PARAMETERS
• CALG_PCT1_MASTER
• CALG_RC2
• CALG_RC4
• CALG_RC5
• CALG_RSA_KEYX
• CALG_RSA_SIGN
• CALG_SCHANNEL_ENC_KEY
• CALG_SCHANNEL_MAC_KEY
• CALG_SCHANNEL_MASTER_HASH
• CALG_SEAL
• CALG_SHA
• CALG_SHA1
• CALG_SHA_256
• CALG_SHA_384
• CALG_SHA_512
• CALG_SKIPJACK
• CALG_SSL2_MASTER
• CALG_SSL3_MASTER
• CALG_SSL3_SHAMD5
• CALG_TEK
• CALG_TLS1_MASTER
• CALG_TLS1PRF

This option is only valid in Windows.

Socket Configuration Settings

AbsoluteTimeout

Determines whether timeouts are inactivity timeouts or absolute timeouts

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.Note: This option is not valid for UDP ports.

FirewallData

Used to send extra data to the firewall

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize

The size in bytes of the incoming queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize

The size in bytes of the outgoing queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable

Tells the bean whether or not a message loop is available for processing events

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

UseDaemonThreads

Whether threads created by the bean are daemon threads

If set to True, when the bean creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the bean will not set the Daemon property on the created thread.

Throws:

IPWorksSSLException

connect

public void connect()
             throws IPWorksSSLException

Connects to the news server.

This method is used to connect to the news server. If the User and/or Password are set, then corresponding AUTHINFO commands are sent to the NewsServer as well.

Throws:

IPWorksSSLException

disconnect

public void disconnect()
                throws IPWorksSSLException

Disconnects from the news server.

This method is used to disconnect from the NewsServer . First the bean attempts to send a QUIT command, and if that fails, the connection is broken.

Throws:

IPWorksSSLException

doEvents

public void doEvents()
              throws IPWorksSSLException

Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:

IPWorksSSLException

fetchArticle

public void fetchArticle()
                  throws IPWorksSSLException

Get the headers and body of an article specified in CurrentArticle .

This method gets the headers and body of the article specified in CurrentArticle . The headers are delivered via the Header event, and the article body via the Transfer event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

fetchArticleBody

public void fetchArticleBody()
                      throws IPWorksSSLException

Gets only the body of an article specified in CurrentArticle .

This method gets only the body of the article specified in CurrentArticle . The body via the Transfer event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

fetchArticleHeaders

public void fetchArticleHeaders()
                         throws IPWorksSSLException

Gets only the headers of an article specified in CurrentArticle .

This method gets only the headers of the article specified in CurrentArticle . The headers are delivered via the Header event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

groupOverview

public void groupOverview()
                   throws IPWorksSSLException

Receives an overview for the articles in range OverviewRange in the CurrentGroup .

This method receives an overview for the articles in range OverviewRange in the CurrentGroup . The overview data is delivered via the GroupOverview event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

groupSearch

public void groupSearch()
                 throws IPWorksSSLException

Receives an overview for the articles in range SearchRange in the CurrentGroup .

This method searches the current newsgroup for articles in range SearchRange in the CurrentGroup , where SearchHeader matches SearchPattern . The results are delivered via the GroupSearch event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

interrupt

public void interrupt()
               throws IPWorksSSLException

Interrupt the current method.

If there is no method in progress, Interrupt simply returns, doing nothing.

Throws:

IPWorksSSLException

listGroups

public void listGroups()
                throws IPWorksSSLException

Lists all groups on the server.

This method asks the server to list all its newsgroups. Use this method with caution as listing groups may take quite a long over slow links. The group names and other information are returned via the GroupList event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

listNewGroups

public void listNewGroups()
                   throws IPWorksSSLException

Lists all new groups on the server.

This method asks the server to list all the newsgroups created since CheckDate . The group names (if any) and other information are returned via the GroupList event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

localizeDate

public java.lang.String localizeDate(java.lang.String dateTime)
                              throws IPWorksSSLException

Converts a valid RFC 822 message date to local date and time.

This method can be used to convert an RFC 822 date/time string to the corresponding local date and time.

Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

Throws:

IPWorksSSLException

postArticle

public void postArticle()
                 throws IPWorksSSLException

Posts the current article and attached file.

This method posts the current article and attached file (if any). If a connection to the NewsServer doesn't already exist, a new one is created.

Throws:

IPWorksSSLException

resetHeaders

public void resetHeaders()
                  throws IPWorksSSLException

Resets all of the article headers.

This method resets all the article headers to "" (empty string). Use this method before posting a new article, so that headers from the previous article are not carried over to the next one.

Throws:

IPWorksSSLException

setArticleStream

public void setArticleStream(java.io.OutputStream articleStream)
                      throws IPWorksSSLException

Sets the stream to which the article downloaded from the server will be written.

This method sets the stream to which the article downloaded from the server will be written. If a download stream is set before the FetchArticle or FetchArticleBody methods are called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The bean will automatically close this stream if ipworksssl.Nntps#config is set to true (default). If the stream is closed, you will need to call {@link ipworksssl.Nntps#setArticleStream SetArticleStream} again before calling {@link ipworksssl.Nntps#fetchArticle FetchArticle} or {@link ipworksssl.Nntps#fetchArticleBody FetchArticleBody} again. The downloaded content will be written starting at the current position in the stream.

Note: {@link ipworksssl.Nntps#setArticleStream SetArticleStream} and {@link ipworksssl.Nntps#getLocalFile LocalFile} will reset the other.

Throws:

IPWorksSSLException

addNntpsEventListener

public void addNntpsEventListener(NntpsEventListener l)
                           throws java.util.TooManyListenersException

Throws:

java.util.TooManyListenersException

removeNntpsEventListener

public void removeNntpsEventListener(NntpsEventListener l)