|
||||||||||
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.imap.IMAP org.apache.commons.net.imap.IMAPClient org.apache.commons.net.imap.IMAPSClient
public class IMAPSClient
The IMAPSClient class provides SSL/TLS connection encryption to IMAPClient. Copied from FTPSClient.java and modified to suit IMAP. 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: IMAPSClient c = new IMAPSClient(true); c.connect("127.0.0.1", 993); Explicit usage: IMAPSClient c = new IMAPSClient(); c.connect("127.0.0.1", 143); if (c.execTLS()) { /rest of the commands here/ }
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.commons.net.imap.IMAPClient |
---|
IMAPClient.FETCH_ITEM_NAMES, IMAPClient.SEARCH_CRITERIA, IMAPClient.STATUS_DATA_ITEMS |
Nested classes/interfaces inherited from class org.apache.commons.net.imap.IMAP |
---|
IMAP.IMAPState |
Field Summary | |
---|---|
static int |
DEFAULT_IMAPS_PORT
The default IMAP over SSL port. |
static String |
DEFAULT_PROTOCOL
Default secure socket protocol name. |
Fields inherited from class org.apache.commons.net.imap.IMAP |
---|
__DEFAULT_ENCODING, __writer, _reader, DEFAULT_PORT |
Fields inherited from class org.apache.commons.net.SocketClient |
---|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL |
Constructor Summary | |
---|---|
IMAPSClient()
Constructor for IMAPSClient. |
|
IMAPSClient(boolean implicit)
Constructor for IMAPSClient. |
|
IMAPSClient(boolean implicit,
SSLContext ctx)
Constructor for IMAPSClient. |
|
IMAPSClient(SSLContext context)
Constructor for IMAPSClient. |
|
IMAPSClient(String proto)
Constructor for IMAPSClient. |
|
IMAPSClient(String proto,
boolean implicit)
Constructor for IMAPSClient. |
|
IMAPSClient(String proto,
boolean implicit,
SSLContext ctx)
Constructor for IMAPSClient. |
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.imap.IMAPClient |
---|
append, append, capability, check, close, copy, create, delete, examine, expunge, fetch, list, login, logout, lsub, noop, rename, search, search, select, status, store, subscribe, uid, unsubscribe |
Methods inherited from class org.apache.commons.net.imap.IMAP |
---|
disconnect, doCommand, doCommand, generateCommandID, getReplyString, getReplyStrings, getState, sendCommand, sendCommand, sendCommand, sendCommand, sendData, setState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_IMAPS_PORT
public static final String DEFAULT_PROTOCOL
Constructor Detail |
---|
public IMAPSClient()
public IMAPSClient(boolean implicit)
implicit
- The security mode (Implicit/Explicit).public IMAPSClient(String proto)
proto
- the protocol.public IMAPSClient(String proto, boolean implicit)
proto
- the protocol.implicit
- The security mode(Implicit/Explicit).public IMAPSClient(String proto, boolean implicit, SSLContext ctx)
proto
- the protocol.implicit
- The security mode(Implicit/Explicit).public IMAPSClient(boolean implicit, SSLContext ctx)
implicit
- The security mode(Implicit/Explicit).ctx
- A pre-configured SSL Context.public IMAPSClient(SSLContext context)
context
- A pre-configured SSL Context.Method Detail |
---|
protected void _connectAction_() throws IOException
_connectAction_
in class IMAP
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 |