|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.nntp.NNTPServerConfig
public class NNTPServerConfig
The configuration settings for server behavior when article reading (POST) and writing (ARTICLE).
Method Summary | |
---|---|
java.lang.String |
getAnonymousUsername()
Retrieves the author name for users without viewable user information. |
java.lang.String |
getDefaultSubject()
Returns the default subject, which is the subject that will be used if a user does not provide a subject when posting through NNTP. |
java.lang.String |
getEmptyListGroupName()
Obtain the name of the news group to return for 'empty' responses to the LIST command. |
java.lang.String |
getGlobalMessageFooter()
|
static NNTPServerConfig |
getInstance()
|
int |
getMaxHeaderLength()
Obtains the maximum lenght of a header line before it is folded. |
java.lang.String |
getMimeCharacterEncoding()
Obtain the MIME character encoding name that should be used when encoding outgoing message bodies. |
java.nio.charset.Charset |
getMimeCharset()
Obtain the MIME character encoder that should be used when encoding outgoing message bodies. |
java.lang.String |
getMimeIntro()
Retrieves the mime introductory text. |
java.lang.String |
getName()
Retrieves the name of the server. |
int |
getWriteBufferSize()
Obtains the size of the write buffer used for the server when generating articles to be posted. |
boolean |
isAttachmentsAllowed()
Returns true if attachments will be sent/received from clients. |
boolean |
isCrossPostingAllowed()
Returns true if cross-posting is allowed. |
boolean |
isEmptyList()
Obtain flag indicating if the LIST and NEWGROUPS command should return an empty response. |
boolean |
isEmptyNewNews()
Obtain a flag indicating if the NEWNEWS command should return an empty response. |
void |
setAnonymousUsername(java.lang.String username)
Sets the string to use when identifying an author that doesn't have any viewable user information. |
void |
setAttachmentsAllowed(boolean allowed)
Enables the server to send/receive attachments from clients. |
void |
setCrossPostingAllowed(boolean allowed)
Enables or disables cross-posting. |
void |
setDefaultSubject(java.lang.String subject)
Sets the default subject, which is the subject that will be used if a user does not provide a subject when posting through NNTP. |
void |
setEmptyList(boolean list)
Set the empty list configuration of this server. |
void |
setEmptyListGroupName(java.lang.String newName)
Sets the name of the group to return on empty LIST responses. |
void |
setEmptyNewNews(boolean newNews)
Set the empty newnews configuration for this server. |
void |
setGlobalMessageFooter(java.lang.String messageFooter)
|
void |
setMaxHeaderLength(int headerLength)
Sets the maximum length of a header line before it is folded. |
void |
setMimeIntro(java.lang.String intro)
Sets the introductory text that is placed above a MIME multi-part body. |
void |
setName(java.lang.String hostName)
Sets the name of the server. |
void |
setWriteBufferSize(int size)
Sets the size of the write buffer used for the server when generating articles to be posted. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static NNTPServerConfig getInstance()
public java.lang.String getName()
public void setName(java.lang.String hostName)
hostName
- the new host name to use for the NNTP serverpublic void setAnonymousUsername(java.lang.String username)
username
- the new RFC822 address for users without any infopublic java.lang.String getAnonymousUsername()
public void setMimeIntro(java.lang.String intro)
intro
- the introductory text to insertpublic java.lang.String getMimeIntro()
public void setWriteBufferSize(int size)
size
- the size of the write buffer in bytespublic int getWriteBufferSize()
public void setMaxHeaderLength(int headerLength)
headerLength
- the length of the longest allowed header line in bytes.public int getMaxHeaderLength()
public boolean isAttachmentsAllowed()
public void setAttachmentsAllowed(boolean allowed)
allowed
- true if attachments will be sent/received from clients.public boolean isCrossPostingAllowed()
public void setCrossPostingAllowed(boolean allowed)
allowed
- true if cross-posting should be enabled.public java.lang.String getMimeCharacterEncoding()
public java.nio.charset.Charset getMimeCharset()
public java.lang.String getDefaultSubject()
public void setDefaultSubject(java.lang.String subject)
subject
- the default subject.public java.lang.String getGlobalMessageFooter()
public void setGlobalMessageFooter(java.lang.String messageFooter)
public boolean isEmptyList()
If getEmptyListGroupName() returns a non-null value, and isEmptyList() is true, the response to LIST will contain that group. This is useful for returning a support or help group rather than no groups at all.
public void setEmptyList(boolean list)
list
- true if the LIST command should return an empty response.public boolean isEmptyNewNews()
public void setEmptyNewNews(boolean newNews)
newNews
- true if the NEWNEWS command should return an empty response.public java.lang.String getEmptyListGroupName()
public void setEmptyListGroupName(java.lang.String newName)
newName
- the name of the group to return on empty LIST responses
or an empty string for no group
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |