|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.net.SocketClient
org.apache.commons.net.ftp.FTP
org.apache.commons.net.ftp.FTPClient
org.apache.commons.net.ftp.FTPSClient
public class FTPSClient
FTP over SSL processing. If desired, the JVM property -Djavax.net.debug=all can be used to see wire-level SSL details.
Field Summary | |
---|---|
static java.lang.String |
KEYSTORE_ALGORITHM
Deprecated. - not used - will be removed in next major release |
static java.lang.String |
PROVIDER
Deprecated. - not used - will be removed in next major release |
static java.lang.String |
STORE_TYPE
Deprecated. - not used - will be removed in next major release |
static java.lang.String |
TRUSTSTORE_ALGORITHM
Deprecated. - not used - will be removed in next major release |
Fields inherited from class org.apache.commons.net.ftp.FTPClient |
---|
ACTIVE_LOCAL_DATA_CONNECTION_MODE, ACTIVE_REMOTE_DATA_CONNECTION_MODE, PASSIVE_LOCAL_DATA_CONNECTION_MODE, PASSIVE_REMOTE_DATA_CONNECTION_MODE |
Fields inherited from class org.apache.commons.net.SocketClient |
---|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL |
Constructor Summary | |
---|---|
FTPSClient()
Constructor for FTPSClient. |
|
FTPSClient(boolean isImplicit)
Constructor for FTPSClient. |
|
FTPSClient(boolean isImplicit,
javax.net.ssl.SSLContext context)
Constructor for FTPSClient. |
|
FTPSClient(javax.net.ssl.SSLContext context)
Constructor for FTPSClient. |
|
FTPSClient(java.lang.String protocol)
Constructor for FTPSClient. |
|
FTPSClient(java.lang.String protocol,
boolean isImplicit)
Constructor for FTPSClient. |
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. |
protected java.net.Socket |
_openDataConnection_(int command,
java.lang.String arg)
Returns a socket of the data connection. |
void |
execPBSZ(long pbsz)
PBSZ command. |
void |
execPROT(java.lang.String prot)
PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private |
java.lang.String |
getAuthValue()
Return AUTH command use value. |
java.lang.String[] |
getEnabledCipherSuites()
Returns the names of the cipher suites which could be enabled for use on this connection. |
java.lang.String[] |
getEnabledProtocols()
Returns the names of the protocol versions which are currently enabled for use on this connection. |
boolean |
getEnableSessionCreation()
Returns true if new SSL sessions may be established by this socket. |
boolean |
getNeedClientAuth()
Returns true if the socket will require client authentication. |
javax.net.ssl.TrustManager |
getTrustManager()
Get the currently configured TrustManager . |
boolean |
getUseClientMode()
Returns true if the socket is set to use client mode in its first handshake. |
boolean |
getWantClientAuth()
Returns true if the socket will request client authentication. |
int |
sendCommand(java.lang.String command,
java.lang.String args)
Send an FTP command. |
void |
setAuthValue(java.lang.String auth)
Set AUTH command use value. |
void |
setEnabledCipherSuites(java.lang.String[] cipherSuites)
Controls which particular cipher suites are enabled for use on this connection. |
void |
setEnabledProtocols(java.lang.String[] protocolVersions)
Controls which particular protocol versions are enabled for use on this connection. |
void |
setEnabledSessionCreation(boolean isCreation)
Controls whether new a SSL session may be established by this socket. |
void |
setKeyManager(javax.net.ssl.KeyManager keyManager)
Set a KeyManager to use |
void |
setNeedClientAuth(boolean isNeedClientAuth)
Configures the socket to require client authentication. |
void |
setTrustManager(javax.net.ssl.TrustManager trustManager)
Override the default TrustManager to use. |
void |
setUseClientMode(boolean isClientMode)
Configures the socket to use client (or server) mode in its first handshake. |
void |
setWantClientAuth(boolean isWantClientAuth)
Configures the socket to request client authentication, but only if such a request is appropriate to the cipher suite negotiated. |
Methods inherited from class org.apache.commons.net.ftp.FTP |
---|
abor, acct, addProtocolCommandListener, allo, allo, appe, cdup, cwd, dele, eprt, epsv, feat, getControlEncoding, getReply, getReplyCode, getReplyString, getReplyStrings, help, help, isStrictMultilineParsing, list, list, mdtm, mfmt, mkd, mode, nlst, nlst, noop, pass, pasv, port, pwd, quit, rein, removeProtocolCommandListener, rest, retr, rmd, rnfr, rnto, sendCommand, sendCommand, sendCommand, setControlEncoding, setStrictMultilineParsing, site, smnt, stat, stat, stor, stou, stou, stru, syst, type, type, user |
Methods inherited from class org.apache.commons.net.SocketClient |
---|
connect, connect, connect, connect, connect, connect, getConnectTimeout, getDefaultPort, getDefaultTimeout, getKeepAlive, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getServerSocketFactory, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setConnectTimeout, setDefaultPort, setDefaultTimeout, setKeepAlive, setReceiveBufferSize, setSendBufferSize, setServerSocketFactory, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
@Deprecated public static java.lang.String KEYSTORE_ALGORITHM
@Deprecated public static java.lang.String TRUSTSTORE_ALGORITHM
@Deprecated public static java.lang.String PROVIDER
@Deprecated public static java.lang.String STORE_TYPE
Constructor Detail |
---|
public FTPSClient() throws java.security.NoSuchAlgorithmException
java.security.NoSuchAlgorithmException
- A requested cryptographic algorithm
is not available in the environment.public FTPSClient(boolean isImplicit) throws java.security.NoSuchAlgorithmException
isImplicit
- The security mode (Implicit/Explicit).
java.security.NoSuchAlgorithmException
- A requested cryptographic algorithm
is not available in the environment.public FTPSClient(java.lang.String protocol) throws java.security.NoSuchAlgorithmException
protocol
- the protocol
java.security.NoSuchAlgorithmException
- A requested cryptographic algorithm
is not available in the environment.public FTPSClient(java.lang.String protocol, boolean isImplicit) throws java.security.NoSuchAlgorithmException
protocol
- the protocolisImplicit
- The security mode(Implicit/Explicit).
java.security.NoSuchAlgorithmException
- A requested cryptographic algorithm
is not available in the environment.public FTPSClient(boolean isImplicit, javax.net.ssl.SSLContext context)
isImplicit
- The security mode(Implicit/Explicit).context
- A pre-configured SSL Contextpublic FTPSClient(javax.net.ssl.SSLContext context)
context
- A pre-configured SSL ContextMethod Detail |
---|
public void setAuthValue(java.lang.String auth)
auth
- AUTH command use value.public java.lang.String getAuthValue()
protected void _connectAction_() throws java.io.IOException
_connectAction_
in class FTPClient
java.io.IOException
- If it throw by _connectAction_.SocketClient._connectAction_()
public void setKeyManager(javax.net.ssl.KeyManager keyManager)
KeyManager
to use
keyManager
- The KeyManager implementation to set.public void setEnabledSessionCreation(boolean isCreation)
isCreation
- The established socket flag.public boolean getEnableSessionCreation()
Socket
instance is not SSL-enabled (i.e. an
instance of SSLSocket
with SSLSocket
getEnableSessionCreation()
) enabled,
this returns False.
public void setNeedClientAuth(boolean isNeedClientAuth)
isNeedClientAuth
- The need client auth flag.public boolean getNeedClientAuth()
Socket
is not an SSLSocket
instance, returns false.
public void setWantClientAuth(boolean isWantClientAuth)
isWantClientAuth
- The want client auth flag.public boolean getWantClientAuth()
Socket
is not an SSLSocket
instance, returns false.
public void setUseClientMode(boolean isClientMode)
isClientMode
- The use client mode flag.public boolean getUseClientMode()
Socket
is not an SSLSocket
instance, returns false.
public void setEnabledCipherSuites(java.lang.String[] cipherSuites)
cipherSuites
- The cipher suites.public java.lang.String[] getEnabledCipherSuites()
Socket
is not an SSLSocket
instance, returns null.
null
public void setEnabledProtocols(java.lang.String[] protocolVersions)
protocolVersions
- The protocol versions.public java.lang.String[] getEnabledProtocols()
Socket
is not an SSLSocket
instance, returns null.
null
public void execPBSZ(long pbsz) throws javax.net.ssl.SSLException, java.io.IOException
pbsz
- Protection Buffer Size.
javax.net.ssl.SSLException
- If the server reply code does not equal "200".
java.io.IOException
- If an I/O error occurs while sending
the command.public void execPROT(java.lang.String prot) throws javax.net.ssl.SSLException, java.io.IOException
prot
- Data Channel Protection Level.
javax.net.ssl.SSLException
- If the server reply code does not equal "200".
java.io.IOException
- If an I/O error occurs while sending
the command.public int sendCommand(java.lang.String command, java.lang.String args) throws java.io.IOException
SSLSocket
instance to be assigned
to a plain Socket
instances
sendCommand
in class FTP
command
- The FTP command.args
- The arguments to the FTP command. If this parameter is
set to null, then the command is sent with no argument.
java.io.IOException
- If an I/O error occurs while sending
the command.FTP.sendCommand(java.lang.String)
protected java.net.Socket _openDataConnection_(int command, java.lang.String arg) throws java.io.IOException
SSLSocket
, which carries out handshake processing.
_openDataConnection_
in class FTPClient
command
- The textual representation of the FTP command to send.arg
- The arguments to the FTP command.
If this parameter is set to null, then the command is sent with
no arguments.
java.io.IOException
- If there is any problem with the connection.FTPClient._openDataConnection_(int, String)
public javax.net.ssl.TrustManager getTrustManager()
TrustManager
.
public void setTrustManager(javax.net.ssl.TrustManager trustManager)
TrustManager
to use.
trustManager
- The TrustManager implementation to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |