|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.net.SocketClient org.apache.commons.net.pop3.POP3 org.apache.commons.net.pop3.POP3Client org.apache.commons.net.pop3.POP3SClient
public class POP3SClient
POP3 over SSL processing. Copied from FTPSClient.java and modified to suit POP3. If implicit mode is selected (NOT the default), SSL/TLS negotiation starts right after the connection has been established. In explicit mode (the default), SSL/TLS negotiation starts when the user calls execTLS() and the server accepts the command. Implicit usage: POP3SClient c = new POP3SClient(true); c.connect("127.0.0.1", 995); Explicit usage: POP3SClient c = new POP3SClient(); c.connect("127.0.0.1", 110); if (c.execTLS()) { /rest of the commands here/ }
Field Summary |
---|
Fields inherited from class org.apache.commons.net.pop3.POP3 |
---|
_commandSupport_, AUTHORIZATION_STATE, DEFAULT_PORT, DISCONNECTED_STATE, TRANSACTION_STATE, UPDATE_STATE |
Fields inherited from class org.apache.commons.net.SocketClient |
---|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL |
Constructor Summary | |
---|---|
POP3SClient()
Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. |
|
POP3SClient(boolean implicit)
Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. |
|
POP3SClient(boolean implicit,
SSLContext ctx)
Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. |
|
POP3SClient(SSLContext context)
Constructor for POP3SClient, using DEFAULT_PROTOCOL - TLS - and isImplicit = false |
|
POP3SClient(String proto)
Constructor for POP3SClient. |
|
POP3SClient(String proto,
boolean implicit)
Constructor for POP3SClient. |
|
POP3SClient(String proto,
boolean implicit,
SSLContext ctx)
Constructor for POP3SClient. |
Method Summary | |
---|---|
protected void |
_connectAction_()
Because there are so many connect() methods, the _connectAction_() method is provided as a means of performing some action immediately after establishing a connection, rather than reimplementing all of the connect() methods. |
boolean |
execTLS()
The TLS command execution. |
String[] |
getEnabledCipherSuites()
Returns the names of the cipher suites which could be enabled for use on this connection. |
String[] |
getEnabledProtocols()
Returns the names of the protocol versions which are currently enabled for use on this connection. |
TrustManager |
getTrustManager()
Get the currently configured TrustManager . |
void |
setEnabledCipherSuites(String[] cipherSuites)
Controls which particular cipher suites are enabled for use on this connection. |
void |
setEnabledProtocols(String[] protocolVersions)
Controls which particular protocol versions are enabled for use on this connection. |
void |
setKeyManager(KeyManager newKeyManager)
Set a KeyManager to use. |
void |
setTrustManager(TrustManager newTrustManager)
Override the default TrustManager to use. |
Methods inherited from class org.apache.commons.net.pop3.POP3Client |
---|
capa, deleteMessage, listMessage, listMessages, listUniqueIdentifier, listUniqueIdentifiers, login, login, logout, noop, reset, retrieveMessage, retrieveMessageTop, status |
Methods inherited from class org.apache.commons.net.pop3.POP3 |
---|
disconnect, getAdditionalReply, getCommandSupport, getReplyString, getReplyStrings, getState, removeProtocolCommandistener, sendCommand, sendCommand, sendCommand, sendCommand, setState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public POP3SClient()
DEFAULT_PROTOCOL
i.e. TLS
Sets security mode to explicit.
public POP3SClient(boolean implicit)
DEFAULT_PROTOCOL
i.e. TLS
implicit
- The security mode, true
for implicit, false
for explicitpublic POP3SClient(String proto)
proto
- the protocol.public POP3SClient(String proto, boolean implicit)
proto
- the protocol.implicit
- The security mode, true
for implicit, false
for explicitpublic POP3SClient(String proto, boolean implicit, SSLContext ctx)
DEFAULT_POP3S_PORT
- 995 - if using implicit mode
proto
- the protocol.implicit
- The security mode, true
for implicit, false
for explicitctx
- the context to be usedpublic POP3SClient(boolean implicit, SSLContext ctx)
DEFAULT_PROTOCOL
i.e. TLS
implicit
- The security mode, true
for implicit, false
for explicitctx
- A pre-configured SSL Context.public POP3SClient(SSLContext context)
DEFAULT_PROTOCOL
- TLS - and isImplicit = false
context
- A pre-configured SSL Context.POP3SClient(boolean, SSLContext)
Method Detail |
---|
protected void _connectAction_() throws IOException
_connectAction_
in class POP3
IOException
- If it is thrown by _connectAction_().SocketClient._connectAction_()
public void setKeyManager(KeyManager newKeyManager)
KeyManager
to use.
newKeyManager
- The KeyManager implementation to set.KeyManagerUtils
public void setEnabledCipherSuites(String[] cipherSuites)
cipherSuites
- The cipher suites.public String[] getEnabledCipherSuites()
Socket
is not an SSLSocket
instance, returns null.
null
.public void setEnabledProtocols(String[] protocolVersions)
protocolVersions
- The protocol versions.public String[] getEnabledProtocols()
Socket
is not an SSLSocket
instance, returns null.
null
.public boolean execTLS() throws SSLException, IOException
SSLException
- If the server reply code is not positive.
IOException
- If an I/O error occurs while sending
the command or performing the negotiation.public TrustManager getTrustManager()
TrustManager
.
public void setTrustManager(TrustManager newTrustManager)
TrustManager
to use.
newTrustManager
- The TrustManager implementation to set.TrustManagerUtils
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |