| java.lang.Object
 org.apache.geronimo.mail.ProtocolGBean
org.apache.geronimo.mail.NNTPTransportGBean
| NNTPTransportGBean | | public class NNTPTransportGBean extends ProtocolGBean implements NNTPGBeanConstants(Code) | | A GBean that provides for the configuration of a JavaMail NNTP transport
protocol.
NNTP transport properties that are common to all NNTP transports are
provided via member variables of this class. Values that are set in the
individual member variables will override any of the corresponding values
that have been set in the properties set.
version:
$Rev: 486195 $ $Date: 2006-12-12 07:42:02 -0800 (Tue, 12 Dec 2006) $
See Also: MailGBean |
| Field Summary | |
| final public static GBeanInfo | GBEAN_INFO
|
| Constructor Summary | |
| public | NNTPTransportGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, String from, Boolean auth, String saslRealm, Boolean quitWait, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)
Construct an instance of NNTPTransportGBean
Values that are set in the individual member variables will override any of
the corresponding values that have been set in the properties set. |
| Method Summary | |
| public void | addOverrides(Properties props)
Add the overrides from the member variables to the properties file. | | public void | doFail()
| | public void | doStart()
| | public void | doStop()
| | public Boolean | getAuth()
Returns whether an attempt will be made to authenticate the user
Defaults to false. | | public Integer | getConnectionTimeout()
Returns the socket connection timeout value in milliseconds. | | public String | getFrom()
Returns the email address to use for NNTP POST command. | | public static GBeanInfo | getGBeanInfo()
| | public Integer | getPort()
Returns the NNTP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public Boolean | getQuitWait()
Returns whether the transport will wait for the response to the QUIT command.
If set to true, causes the transport to wait for the response to the QUIT
command. | | public String | getSaslRealm()
Returns the realm to use with DIGEST-MD5 authentication. | | public String | getSocketFactoryClass()
Returns the class that will be used to create NNTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | public Boolean | getSocketFactoryFallback()
Returns whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. | | public Integer | getSocketFactoryPort()
Returns the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. | | public Integer | getTimeout()
Returns the socket I/O timeout value in milliseconds. | | public void | setAuth(Boolean auth)
Sets whether an attempt will be made to authenticate the user. | | public void | setConnectionTimeout(Integer connectionTimeout)
Sets the socket connection timeout value in milliseconds. | | public void | setFrom(String from)
Sets the email address to use for NNTP POST command
Email address to use for NNTP POST command. | | public void | setPort(Integer port)
Sets the NNTP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public void | setQuitWait(Boolean quitWait)
Sets whether the transport will wait for the response to the QUIT command
If set to true, causes the transport to wait for the response to the QUIT
command. | | public void | setSaslRealm(String saslRealm)
Sets the realm to use with DIGEST-MD5 authentication. | | public void | setSocketFactoryClass(String socketFactoryClass)
Sets the class that will be used to create NNTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | public void | setSocketFactoryFallback(Boolean socketFactoryFallback)
Sets whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. | | public void | setSocketFactoryPort(Integer socketFactoryPort)
Sets the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. | | public void | setTimeout(Integer timeout)
Sets the socket I/O timeout value in milliseconds. |
| GBEAN_INFO | | final public static GBeanInfo GBEAN_INFO(Code) | | |
| NNTPTransportGBean | | public NNTPTransportGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, String from, Boolean auth, String saslRealm, Boolean quitWait, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)(Code) | | Construct an instance of NNTPTransportGBean
Values that are set in the individual member variables will override any of
the corresponding values that have been set in the properties set.
Parameters:
objectName - the object name of the protocol
Parameters:
properties - the set of default properties for the protocol
Parameters:
host - the host the protocol connects to
Parameters:
user - the default name for the protocol
Parameters:
port - the NNTP server port
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds
Parameters:
timeout - the socket I/O timeout value in milliseconds
Parameters:
from - the email address to use for NNTP POST command
Parameters:
auth - whether an attempt will be made to authenticate the user
Parameters:
saslRealm - the realm to use with DIGEST-MD5 authentication
Parameters:
quitWait - whether the transport will wait for the response to the QUIT command
Parameters:
socketFactoryClass - the class that will be used to create NNTP sockets
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created
Parameters:
socketFactoryPort - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| addOverrides | | public void addOverrides(Properties props)(Code) | | Add the overrides from the member variables to the properties file.
|
| doFail | | public void doFail()(Code) | | |
| getAuth | | public Boolean getAuth()(Code) | | Returns whether an attempt will be made to authenticate the user
Defaults to false.
|
| getConnectionTimeout | | public Integer getConnectionTimeout()(Code) | | Returns the socket connection timeout value in milliseconds.
|
| getFrom | | public String getFrom()(Code) | | Returns the email address to use for NNTP POST command.
|
| getGBeanInfo | | public static GBeanInfo getGBeanInfo()(Code) | | |
| getPort | | public Integer getPort()(Code) | | Returns the NNTP server port to connect to, if the connect() method
doesn't explicitly specify one.
|
| getQuitWait | | public Boolean getQuitWait()(Code) | | Returns whether the transport will wait for the response to the QUIT command.
If set to true, causes the transport to wait for the response to the QUIT
command. If set to false (the default), the QUIT command is sent and the
connection is immediately closed.
|
| getSaslRealm | | public String getSaslRealm()(Code) | | Returns the realm to use with DIGEST-MD5 authentication.
|
| getSocketFactoryClass | | public String getSocketFactoryClass()(Code) | | Returns the class that will be used to create NNTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create NNTP
sockets.
|
| getSocketFactoryFallback | | public Boolean getSocketFactoryFallback()(Code) | | Returns whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. Defaults to true.
|
| getSocketFactoryPort | | public Integer getSocketFactoryPort()(Code) | | Returns the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. If not set, the default port will be used.
|
| getTimeout | | public Integer getTimeout()(Code) | | Returns the socket I/O timeout value in milliseconds.
|
| setAuth | | public void setAuth(Boolean auth)(Code) | | Sets whether an attempt will be made to authenticate the user.
Defaults to false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
auth - whether an attempt will be made to authenticate the user. |
| setConnectionTimeout | | public void setConnectionTimeout(Integer connectionTimeout)(Code) | | Sets the socket connection timeout value in milliseconds.
Default is infinite timeout.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds. |
| setFrom | | public void setFrom(String from)(Code) | | Sets the email address to use for NNTP POST command
Email address to use for NNTP POST command. This sets the envelope
return address. Defaults to msg.getFrom() or InternetAddress.getLocalAddress().
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
from - the email address to use for NNTP POST command |
| setPort | | public void setPort(Integer port)(Code) | | Sets the NNTP server port to connect to, if the connect() method
doesn't explicitly specify one.
Defaults to 25.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
port - the NNTP server port to connect to |
| setQuitWait | | public void setQuitWait(Boolean quitWait)(Code) | | Sets whether the transport will wait for the response to the QUIT command
If set to true, causes the transport to wait for the response to the QUIT
command. If set to false (the default), the QUIT command is sent and the
connection is immediately closed.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
quitWait - whether the transport will wait for the response to the QUIT command |
| setSaslRealm | | public void setSaslRealm(String saslRealm)(Code) | | Sets the realm to use with DIGEST-MD5 authentication.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
saslRealm - the realm to use with DIGEST-MD5 authentication |
| setSocketFactoryClass | | public void setSocketFactoryClass(String socketFactoryClass)(Code) | | Sets the class that will be used to create NNTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create NNTP
sockets.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryClass - the class that will be used to create NNTP sockets |
| setSocketFactoryFallback | | public void setSocketFactoryFallback(Boolean socketFactoryFallback)(Code) | | Sets whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. Defaults to true.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| setSocketFactoryPort | | public void setSocketFactoryPort(Integer socketFactoryPort)(Code) | | Sets the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. If not set, the default port will be used.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryPort - the port to connect to when using the specified socket factory |
| setTimeout | | public void setTimeout(Integer timeout)(Code) | | Sets the socket I/O timeout value in milliseconds.
Default is infinite timeout.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
timeout - the socket I/O timeout value in milliseconds |
|
|