Java Doc for ConnectionContext.java in  » Net » edtftpj » com » enterprisedt » net » ftp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » edtftpj » com.enterprisedt.net.ftp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.enterprisedt.net.ftp.ConnectionContext

ConnectionContext
public class ConnectionContext implements Cloneable(Code)
Holds various parameters pertaining to the context of the connection. Used internally.
author:
   Bruce Blackshaw
version:
   $Revision: 1.2 $


Field Summary
protected  inttransferBufferSize
    

Constructor Summary
public  ConnectionContext()
    

Method Summary
public  Objectclone()
    
public synchronized  intgetActiveHighPort()
     Get the upper limit of the port range for active mode.
public synchronized  StringgetActiveIPAddress()
    
public synchronized  intgetActiveLowPort()
     Get the lower limit of the port range for active mode.
public synchronized  FTPConnectModegetConnectMode()
    
public synchronized  FTPTransferTypegetContentType()
    
public synchronized  StringgetControlEncoding()
    
public synchronized  booleangetDetectContentType()
    
public synchronized  DirectoryEmptyStringsgetDirectoryEmptyMessages()
     Get class that holds fragments of server messages that indicate a directory is empty.
public synchronized  FileNotFoundStringsgetFileNotFoundMessages()
     Get class that holds fragments of server messages that indicate a file was not found.
public synchronized  booleangetListenOnAllInterfaces()
    
public synchronized  Locale[]getParserLocales()
    
public synchronized  StringgetPassword()
    
public synchronized  StringgetRemoteHost()
    
public synchronized  intgetRemotePort()
    
public synchronized  intgetTimeout()
    
public  intgetTransferBufferSize()
    
public synchronized  TransferCompleteStringsgetTransferCompleteMessages()
     Get class that holds fragments of server messages that indicate a transfer completed.
public synchronized  intgetTransferNotifyInterval()
     Get the interval used for progress notification of transfers.
public synchronized  StringgetUserName()
    
public  booleanisAutoLogin()
    
public synchronized  booleanisAutoPassiveIPSubstitution()
    
public synchronized  booleanisDeleteOnFailure()
    
public synchronized  booleanisStrictReturnCodes()
     Determine if strict checking of return codes is switched on.
public synchronized  voidsetActiveIPAddress(String activeIP)
     We can force PORT to send a fixed IP address, which can be useful with certain NAT configurations.
public synchronized  voidsetActivePortRange(int lowest, int highest)
     Force a certain range of ports to be used in active mode.
public  voidsetAutoLogin(boolean autoLogin)
    
public synchronized  voidsetAutoPassiveIPSubstitution(boolean autoPassiveIPSubstitution)
    
public synchronized  voidsetConnectMode(FTPConnectMode connectMode)
    
public synchronized  voidsetContentType(FTPTransferType transferType)
    
public synchronized  voidsetControlEncoding(String controlEncoding)
    
public synchronized  voidsetDeleteOnFailure(boolean deleteOnFailure)
    
public synchronized  voidsetDetectContentType(boolean detectContentType)
     Set autodetect of filetypes on or off.
public synchronized  voidsetListenOnAllInterfaces(boolean listenOnAll)
     Listen on all interfaces for active mode transfers (the default).
public synchronized  voidsetParserLocales(Locale[] locales)
    
public synchronized  voidsetPassword(String password)
    
public synchronized  voidsetRemoteHost(String remoteHost)
    
public synchronized  voidsetRemotePort(int remotePort)
    
public synchronized  voidsetStrictReturnCodes(boolean strict)
     Set strict checking of FTP return codes.
public synchronized  voidsetTimeout(int timeout)
    
public  voidsetTransferBufferSize(int size)
    
public synchronized  voidsetTransferNotifyInterval(int notifyInterval)
     Set the interval used for progress notification of transfers.
public synchronized  voidsetUserName(String username)
    

Field Detail
transferBufferSize
protected int transferBufferSize(Code)
Size of transfer buffers




Constructor Detail
ConnectionContext
public ConnectionContext()(Code)




Method Detail
clone
public Object clone()(Code)



getActiveHighPort
public synchronized int getActiveHighPort()(Code)
Get the upper limit of the port range for active mode. upper limit, or -1 if not set



getActiveIPAddress
public synchronized String getActiveIPAddress()(Code)
The active IP address being used, or null if not used IP address as a string or null



getActiveLowPort
public synchronized int getActiveLowPort()(Code)
Get the lower limit of the port range for active mode. lower limit, or -1 if not set



getConnectMode
public synchronized FTPConnectMode getConnectMode()(Code)



getContentType
public synchronized FTPTransferType getContentType()(Code)



getControlEncoding
public synchronized String getControlEncoding()(Code)
Get the encoding used for the control connection Returns the current controlEncoding.



getDetectContentType
public synchronized boolean getDetectContentType()(Code)
Get the detect content type flag true if we are detecting binary and ASCII transfers from the file type



getDirectoryEmptyMessages
public synchronized DirectoryEmptyStrings getDirectoryEmptyMessages()(Code)
Get class that holds fragments of server messages that indicate a directory is empty. New messages can be added.

The fragments are used when it is necessary to examine the message returned by a server to see if it is saying a directory is empty. If an FTP server is returning a different message that still clearly indicates a directory is empty, use this property to add a new server fragment to the repository via the add method. It would be helpful to email support at enterprisedt dot com to inform us of the message so it can be added to the next build. messages class




getFileNotFoundMessages
public synchronized FileNotFoundStrings getFileNotFoundMessages()(Code)
Get class that holds fragments of server messages that indicate a file was not found. New messages can be added.

The fragments are used when it is necessary to examine the message returned by a server to see if it is saying a file was not found. If an FTP server is returning a different message that still clearly indicates a file was not found, use this property to add a new server fragment to the repository via the add method. It would be helpful to email support at enterprisedt dot com to inform us of the message so it can be added to the next build. messages class




getListenOnAllInterfaces
public synchronized boolean getListenOnAllInterfaces()(Code)
Are we listening on all interfaces in active mode, which is the default? true if listening on all interfaces, false if listening just on the control interface



getParserLocales
public synchronized Locale[] getParserLocales()(Code)



getPassword
public synchronized String getPassword()(Code)



getRemoteHost
public synchronized String getRemoteHost()(Code)



getRemotePort
public synchronized int getRemotePort()(Code)



getTimeout
public synchronized int getTimeout()(Code)



getTransferBufferSize
public int getTransferBufferSize()(Code)
Get the size of the buffers used in writing to and reading from the data sockets transfer buffer size



getTransferCompleteMessages
public synchronized TransferCompleteStrings getTransferCompleteMessages()(Code)
Get class that holds fragments of server messages that indicate a transfer completed. New messages can be added.

The fragments are used when it is necessary to examine the message returned by a server to see if it is saying a transfer completed. If an FTP server is returning a different message that still clearly indicates a transfer failed, use this property to add a new server fragment to the repository via the add method. It would be helpful to email support at enterprisedt dot com to inform us of the message so it can be added to the next build. messages class




getTransferNotifyInterval
public synchronized int getTransferNotifyInterval()(Code)
Get the interval used for progress notification of transfers. number of bytes between each notification.



getUserName
public synchronized String getUserName()(Code)



isAutoLogin
public boolean isAutoLogin()(Code)
Determine if auto login is switched on true if auto login



isAutoPassiveIPSubstitution
public synchronized boolean isAutoPassiveIPSubstitution()(Code)
Is automatic substitution of the remote host IP set to be on for passive mode connections? true if set on, false otherwise



isDeleteOnFailure
public synchronized boolean isDeleteOnFailure()(Code)
If true, delete partially written files when exceptions are thrown during a download true if delete local file on error



isStrictReturnCodes
public synchronized boolean isStrictReturnCodes()(Code)
Determine if strict checking of return codes is switched on. If it is (the default), all return codes must exactly match the expected code. If strict checking is off, only the first digit must match. true if strict return code checking, false if non-strict.



setActiveIPAddress
public synchronized void setActiveIPAddress(String activeIP)(Code)
We can force PORT to send a fixed IP address, which can be useful with certain NAT configurations.
Parameters:
  activeIP - IP address to force, in 192.168.1.0 form or in IPV6 form, e.g.1080::8:800:200C:417A



setActivePortRange
public synchronized void setActivePortRange(int lowest, int highest)(Code)
Force a certain range of ports to be used in active mode. This is generally so that a port range can be configured in a firewall. Note that if lowest == highest, a single port will be used. This works well for uploads, but downloads generally require multiple ports, as most servers fail to create a connection repeatedly for the same port.
Parameters:
  lowest - Lower limit of range.
Parameters:
  highest - Upper limit of range.



setAutoLogin
public void setAutoLogin(boolean autoLogin)(Code)
Set the autoLogin flag
Parameters:
  autoLogin - true if logging in automatically



setAutoPassiveIPSubstitution
public synchronized void setAutoPassiveIPSubstitution(boolean autoPassiveIPSubstitution)(Code)
Set automatic substitution of the remote host IP on if in passive mode
Parameters:
  autoPassiveIPSubstitution - true if set to on, false otherwise



setConnectMode
public synchronized void setConnectMode(FTPConnectMode connectMode)(Code)



setContentType
public synchronized void setContentType(FTPTransferType transferType)(Code)



setControlEncoding
public synchronized void setControlEncoding(String controlEncoding)(Code)
Set the encoding used for control channel messages
Parameters:
  controlEncoding - The controlEncoding to set, which is the name of a Charset



setDeleteOnFailure
public synchronized void setDeleteOnFailure(boolean deleteOnFailure)(Code)
Switch on or off the automatic deletion of partially written files that are left when an exception is thrown during a download
Parameters:
  deleteOnFailure - true if delete when a failure occurs



setDetectContentType
public synchronized void setDetectContentType(boolean detectContentType)(Code)
Set autodetect of filetypes on or off. If on, the transfer mode is switched from ASCII to binary and vice versa depending on the extension of the file. After the transfer, the mode is always returned to what it was before the transfer was performed. The default is off. If the filetype is unknown, the transfer mode is unchanged
Parameters:
  detectContentType - true if detecting transfer mode, false if not



setListenOnAllInterfaces
public synchronized void setListenOnAllInterfaces(boolean listenOnAll)(Code)
Listen on all interfaces for active mode transfers (the default).
Parameters:
  listenOnAll - true if listen on all interfaces, false to listen on the control interface



setParserLocales
public synchronized void setParserLocales(Locale[] locales)(Code)
Set the list of locales to be tried for date parsing of dir listings
Parameters:
  locales - locales to use



setPassword
public synchronized void setPassword(String password)(Code)



setRemoteHost
public synchronized void setRemoteHost(String remoteHost)(Code)



setRemotePort
public synchronized void setRemotePort(int remotePort)(Code)



setStrictReturnCodes
public synchronized void setStrictReturnCodes(boolean strict)(Code)
Set strict checking of FTP return codes. If strict checking is on (the default) code must exactly match the expected code. If strict checking is off, only the first digit must match.
Parameters:
  strict - true for strict checking, false for loose checking



setTimeout
public synchronized void setTimeout(int timeout)(Code)



setTransferBufferSize
public void setTransferBufferSize(int size)(Code)
Set the size of the buffers used in writing to and reading from the data sockets
Parameters:
  size - new size of buffer in bytes



setTransferNotifyInterval
public synchronized void setTransferNotifyInterval(int notifyInterval)(Code)
Set the interval used for progress notification of transfers.
Parameters:
  notifyInterval - number of bytes between each notification



setUserName
public synchronized void setUserName(String username)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.