org.dvb.internet

Interface UsenetClientService

All Superinterfaces:

InternetClientService, Service

public interface UsenetClientService
extends InternetClientService

Service representing the resident usenet news client

Method Summary

Methods

Modifier and Type	Method and Description
void	setInitialGroup(URL group) Set the initial group to be displayed when the news client starts.
void	setInitialMessage(URL message) Set the initial message to be used when the news client starts.
void	subscribe(String newsgroup) Add a newsgroup to the list currently subscribed newsgroups.

Methods inherited from interface org.dvb.internet.InternetClientService

canRunApplication, getName, getServiceType, getSupportedClientServices, hasMultipleInstances, retrieveDetails

Methods inherited from interface javax.tv.service.Service

equals, getLocator, hashCode

Method Detail

subscribe

void subscribe(String newsgroup)
               throws IOException

Add a newsgroup to the list currently subscribed newsgroups. If the newsgroup is already in the list, then this method has no effect. As a side-effect a newsgroup previously subscribed to by this method may be unsubscribed. Implementations may restrict the number of newsgroups a single MHP application or source of applications may subscribe to.

Parameters:

newsgroup - the name of the newsgroup that should be subscribed to

Throws:

IOException - if no more newsgroups can be added due to a lack of storage space

setInitialMessage

void setInitialMessage(URL message)

Set the initial message to be used when the news client starts. This URL is specific to this instance of UsenetClientService and will not impact any other instance and is only valid for the lifetime of this instance. Calling this method and then selecting the UsenetClientService instance is equivalent to selecting the UsenetClientService instance, obtaining the UsenetClient and then calling the selectMessage method there. If the application calling this method is still running when the message is sent (or fails) and has registered an InternetClientListener then the appropriate InternetClientEvent shall be sent corresponding to the success or failure of the operation to send the message. Calls to setInitialGroup shall cancel previous calls to setInitialMessage and vice-versa on the same UsenetClientService instance.

Parameters:

message - the URL of the message. This may or may not include the address of a news server

Throws:

IllegalArgumentException - if the specified URL does not include a Usenet news message ID or does not correspond to the Usenet news URL format specified in RFC 1738

setInitialGroup

void setInitialGroup(URL group)

Set the initial group to be displayed when the news client starts. This URL is specific to this instance of UsenetClientService and will not impact any other instance and is only valid for the lifetime of this instance. Calling this method and then selecting the UsenetClientService instance is equivalent to selecting the UsenetClientService instance, obtaining the UsenetClient and then calling the selectMessage method there. If the application calling this method is still running when the message is sent (or fails) and has registered an InternetClientListener then the appropriate InternetClientEvent shall be sent corresponding to the success or failure of the operation to send the message. Calls to setInitialGroup shall cancel previous calls to setInitialMessage and vice-versa on the same UsenetClientService instance.

Parameters:

group - the URL of the message. This may or may not include the address of a news server

Throws:

IllegalArgumentException - if the specified URL does not correspond to the Usenet news URL format specified in RFC 1738