Java Doc for FtpConnector.java in  » ESB » mule » org » mule » transport » 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 » ESB » mule » org.mule.transport.ftp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.mule.transport.AbstractConnector
      org.mule.transport.ftp.FtpConnector

FtpConnector
public class FtpConnector extends AbstractConnector (Code)


Field Summary
final public static  StringDEFAULT_FTP_CONNECTION_FACTORY_CLASS
     TODO it makes sense to have a type-safe adapter for FTP specifically, but without Java 5's covariant return types the benefits are diminished.
final public static  intDEFAULT_POLLING_FREQUENCY
    
final public static  StringFTP
    
final public static  StringPROPERTY_BINARY_TRANSFER
    
final public static  StringPROPERTY_FILENAME
    
final public static  StringPROPERTY_OUTPUT_PATTERN
    
final public static  StringPROPERTY_PASSIVE_MODE
    
final public static  StringPROPERTY_POLLING_FREQUENCY
    


Method Summary
protected  FTPClientcreateFtpClient(ImmutableEndpoint endpoint)
     Creates a new FTPClient that logs in and changes the working directory using the data provided in endpoint.
public  MessageReceivercreateReceiver(Service service, InboundEndpoint endpoint)
    
public  voiddestroyFtp(EndpointURI uri, FTPClient client)
    
protected  voiddoConnect()
    
protected  voiddoDisconnect()
    
protected  voiddoDispose()
    
protected  voiddoInitialise()
    
protected  voiddoStart()
    
protected  voiddoStop()
    
public  voidenterActiveOrPassiveMode(FTPClient client, ImmutableEndpoint endpoint)
     Passive mode is OFF by default.
public  StringgetConnectionFactoryClass()
     Getter for property 'connectionFactoryClass'.
public  FilenameParsergetFilenameParser()
    
public  FTPClientgetFtp(EndpointURI uri)
    
protected synchronized  ObjectPoolgetFtpPool(EndpointURI uri)
    
public  StringgetOutputPattern()
    
public  OutputStreamgetOutputStream(ImmutableEndpoint endpoint, MuleMessage message)
     Well get the output stream (if any) for this type of transport.
public  longgetPollingFrequency()
    
public  StringgetProtocol()
    
public  booleanisBinary()
     Getter for FTP transfer type.
public  booleanisPassive()
     Getter for FTP passive mode.
public  booleanisValidateConnections()
     Whether to test FTP connection on each take from pool.
public  voidreleaseFtp(EndpointURI uri, FTPClient client)
    
public  voidsetBinary(boolean binary)
     Setter for FTP transfer type.
public  voidsetConnectionFactoryClass(String connectionFactoryClass)
     Setter for property 'connectionFactoryClass'.
public  voidsetFilenameParser(FilenameParser filenameParser)
    
public  voidsetOutputPattern(String outputPattern)
    
public  voidsetPassive(boolean passive)
     Setter for FTP passive mode.
public  voidsetPollingFrequency(long pollingFrequency)
    
public  voidsetValidateConnections(boolean validateConnections)
     Whether to test FTP connection on each take from pool.
public  voidsetupFileType(FTPClient client, ImmutableEndpoint endpoint)
     Transfer type is BINARY by default.

Field Detail
DEFAULT_FTP_CONNECTION_FACTORY_CLASS
final public static String DEFAULT_FTP_CONNECTION_FACTORY_CLASS(Code)
TODO it makes sense to have a type-safe adapter for FTP specifically, but without Java 5's covariant return types the benefits are diminished. Keeping it simple for now.



DEFAULT_POLLING_FREQUENCY
final public static int DEFAULT_POLLING_FREQUENCY(Code)



FTP
final public static String FTP(Code)



PROPERTY_BINARY_TRANSFER
final public static String PROPERTY_BINARY_TRANSFER(Code)



PROPERTY_FILENAME
final public static String PROPERTY_FILENAME(Code)



PROPERTY_OUTPUT_PATTERN
final public static String PROPERTY_OUTPUT_PATTERN(Code)



PROPERTY_PASSIVE_MODE
final public static String PROPERTY_PASSIVE_MODE(Code)



PROPERTY_POLLING_FREQUENCY
final public static String PROPERTY_POLLING_FREQUENCY(Code)





Method Detail
createFtpClient
protected FTPClient createFtpClient(ImmutableEndpoint endpoint) throws Exception(Code)
Creates a new FTPClient that logs in and changes the working directory using the data provided in endpoint.



createReceiver
public MessageReceiver createReceiver(Service service, InboundEndpoint endpoint) throws Exception(Code)



destroyFtp
public void destroyFtp(EndpointURI uri, FTPClient client) throws Exception(Code)



doConnect
protected void doConnect() throws Exception(Code)



doDisconnect
protected void doDisconnect() throws Exception(Code)



doDispose
protected void doDispose()(Code)



doInitialise
protected void doInitialise() throws InitialisationException(Code)



doStart
protected void doStart() throws MuleException(Code)



doStop
protected void doStop() throws MuleException(Code)



enterActiveOrPassiveMode
public void enterActiveOrPassiveMode(FTPClient client, ImmutableEndpoint endpoint)(Code)
Passive mode is OFF by default. The value is taken from the connector settings. In case there are any overriding properties set on the endpoint, those will be used.
See Also:   FtpConnector.setPassive(boolean)



getConnectionFactoryClass
public String getConnectionFactoryClass()(Code)
Getter for property 'connectionFactoryClass'. Value for property 'connectionFactoryClass'.



getFilenameParser
public FilenameParser getFilenameParser()(Code)
Returns the filenameParser.



getFtp
public FTPClient getFtp(EndpointURI uri) throws Exception(Code)



getFtpPool
protected synchronized ObjectPool getFtpPool(EndpointURI uri)(Code)



getOutputPattern
public String getOutputPattern()(Code)
Returns the outputPattern.



getOutputStream
public OutputStream getOutputStream(ImmutableEndpoint endpoint, MuleMessage message) throws MuleException(Code)
Well get the output stream (if any) for this type of transport. Typically this will be called only when Streaming is being used on an outbound endpoint
Parameters:
  endpoint - the endpoint that releates to this Dispatcher
Parameters:
  message - the current message being processed the output stream to use for this request or null if the transportdoes not support streaming
throws:
  org.mule.api.MuleException -



getPollingFrequency
public long getPollingFrequency()(Code)
Returns the pollingFrequency.



getProtocol
public String getProtocol()(Code)



isBinary
public boolean isBinary()(Code)
Getter for FTP transfer type. true if using FTP binary type



isPassive
public boolean isPassive()(Code)
Getter for FTP passive mode. true if using FTP passive mode



isValidateConnections
public boolean isValidateConnections()(Code)
Whether to test FTP connection on each take from pool.



releaseFtp
public void releaseFtp(EndpointURI uri, FTPClient client) throws Exception(Code)



setBinary
public void setBinary(boolean binary)(Code)
Setter for FTP transfer type.
Parameters:
  binary - binary type flag



setConnectionFactoryClass
public void setConnectionFactoryClass(String connectionFactoryClass)(Code)
Setter for property 'connectionFactoryClass'. Should be an instance of FtpConnectionFactory .
Parameters:
  connectionFactoryClass - Value to set for property 'connectionFactoryClass'.



setFilenameParser
public void setFilenameParser(FilenameParser filenameParser)(Code)

Parameters:
  filenameParser - The filenameParser to set.



setOutputPattern
public void setOutputPattern(String outputPattern)(Code)

Parameters:
  outputPattern - The outputPattern to set.



setPassive
public void setPassive(boolean passive)(Code)
Setter for FTP passive mode.
Parameters:
  passive - passive mode flag



setPollingFrequency
public void setPollingFrequency(long pollingFrequency)(Code)

Parameters:
  pollingFrequency - The pollingFrequency to set.



setValidateConnections
public void setValidateConnections(boolean validateConnections)(Code)
Whether to test FTP connection on each take from pool. This takes care of a failed (or restarted) FTP server at the expense of an additional NOOP command packet being sent, but increases overall availability.

Disable to gain slight performance gain or if you are absolutely sure of the FTP server availability.

The default value is true




setupFileType
public void setupFileType(FTPClient client, ImmutableEndpoint endpoint) throws Exception(Code)
Transfer type is BINARY by default. The value is taken from the connector settings. In case there are any overriding properties set on the endpoint, those will be used.

The alternative type is ASCII.


See Also:   FtpConnector.setBinary(boolean)




Fields inherited from org.mule.transport.AbstractConnector
final public static int DEFAULT_NUM_CONCURRENT_TX_RECEIVERS(Code)(Java Doc)
final protected WaitableBoolean connected(Code)(Java Doc)
final protected WaitableBoolean connecting(Code)(Java Doc)
protected volatile ConnectionStrategy connectionStrategy(Code)(Java Doc)
protected volatile boolean createMultipleTransactedReceivers(Code)(Java Doc)
protected volatile MessageDispatcherFactory dispatcherFactory(Code)(Java Doc)
final protected GenericKeyedObjectPool dispatchers(Code)(Java Doc)
final protected AtomicBoolean disposed(Code)(Java Doc)
final protected AtomicBoolean disposing(Code)(Java Doc)
protected volatile ExceptionListener exceptionListener(Code)(Java Doc)
final protected AtomicBoolean initialised(Code)(Java Doc)
final protected Log logger(Code)(Java Doc)
protected MuleContext muleContext(Code)(Java Doc)
protected volatile String name(Code)(Java Doc)
protected volatile int numberOfConcurrentTransactedReceivers(Code)(Java Doc)
final protected ConcurrentMap receivers(Code)(Java Doc)
protected volatile MessageRequesterFactory requesterFactory(Code)(Java Doc)
final protected GenericKeyedObjectPool requesters(Code)(Java Doc)
protected volatile TransportServiceDescriptor serviceDescriptor(Code)(Java Doc)
protected volatile Properties serviceOverrides(Code)(Java Doc)
protected volatile SessionHandler sessionHandler(Code)(Java Doc)
final protected WaitableBoolean startOnConnect(Code)(Java Doc)
final protected AtomicBoolean started(Code)(Java Doc)

Methods inherited from org.mule.transport.AbstractConnector
protected void checkDisposed() throws DisposeException(Code)(Java Doc)
public void connect() throws Exception(Code)(Java Doc)
protected MessageReceiver createReceiver(Service service, InboundEndpoint endpoint) throws Exception(Code)(Java Doc)
public void destroyReceiver(MessageReceiver receiver, InboundEndpoint endpoint) throws Exception(Code)(Java Doc)
public void disconnect() throws Exception(Code)(Java Doc)
public void dispatch(OutboundEndpoint endpoint, MuleEvent event) throws DispatchException(Code)(Java Doc)
final public synchronized void dispose()(Code)(Java Doc)
protected void disposeDispatchers()(Code)(Java Doc)
protected void disposeReceivers()(Code)(Java Doc)
protected void disposeRequesters()(Code)(Java Doc)
protected void disposeWorkManagers()(Code)(Java Doc)
abstract protected void doConnect() throws Exception(Code)(Java Doc)
abstract protected void doDisconnect() throws Exception(Code)(Java Doc)
abstract protected void doDispose()(Code)(Java Doc)
abstract protected void doInitialise() throws InitialisationException(Code)(Java Doc)
abstract protected void doStart() throws MuleException(Code)(Java Doc)
abstract protected void doStop() throws MuleException(Code)(Java Doc)
public void exceptionThrown(Exception e)(Code)(Java Doc)
public void fireNotification(ServerNotification notification)(Code)(Java Doc)
protected String getConnectEventId()(Code)(Java Doc)
public String getConnectionDescription()(Code)(Java Doc)
public ConnectionStrategy getConnectionStrategy()(Code)(Java Doc)
public List getDefaultInboundTransformers()(Code)(Java Doc)
public List getDefaultOutboundTransformers()(Code)(Java Doc)
public List getDefaultResponseTransformers()(Code)(Java Doc)
public MessageDispatcherFactory getDispatcherFactory()(Code)(Java Doc)
public ThreadingProfile getDispatcherThreadingProfile()(Code)(Java Doc)
protected WorkManager getDispatcherWorkManager() throws MuleException(Code)(Java Doc)
public ExceptionListener getExceptionListener()(Code)(Java Doc)
public int getMaxDispatchersActive()(Code)(Java Doc)
public int getMaxRequestersActive()(Code)(Java Doc)
public MessageAdapter getMessageAdapter(Object message) throws MessagingException(Code)(Java Doc)
public MuleContext getMuleContext()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public int getNumberOfConcurrentTransactedReceivers()(Code)(Java Doc)
public OutputStream getOutputStream(OutboundEndpoint endpoint, MuleMessage message) throws MuleException(Code)(Java Doc)
public MessageReceiver getReceiver(Service service, InboundEndpoint endpoint)(Code)(Java Doc)
protected Object getReceiverKey(Service service, InboundEndpoint endpoint)(Code)(Java Doc)
public ThreadingProfile getReceiverThreadingProfile()(Code)(Java Doc)
protected WorkManager getReceiverWorkManager(String receiverName) throws MuleException(Code)(Java Doc)
public Map getReceivers()(Code)(Java Doc)
public MessageReceiver[] getReceivers(String wildcardExpression)(Code)(Java Doc)
public ReplyToHandler getReplyToHandler()(Code)(Java Doc)
public MessageRequesterFactory getRequesterFactory()(Code)(Java Doc)
public ThreadingProfile getRequesterThreadingProfile()(Code)(Java Doc)
protected WorkManager getRequesterWorkManager() throws MuleException(Code)(Java Doc)
public ScheduledExecutorService getScheduler()(Code)(Java Doc)
protected TransportServiceDescriptor getServiceDescriptor()(Code)(Java Doc)
public Map getServiceOverrides()(Code)(Java Doc)
public SessionHandler getSessionHandler()(Code)(Java Doc)
public List getSupportedProtocols()(Code)(Java Doc)
public void handleException(Exception exception)(Code)(Java Doc)
protected void handleWorkException(WorkEvent event, String type)(Code)(Java Doc)
protected synchronized void initFromServiceDescriptor() throws InitialisationException(Code)(Java Doc)
protected void initWorkManagers() throws MuleException(Code)(Java Doc)
final public synchronized LifecycleTransitionResult initialise() throws InitialisationException(Code)(Java Doc)
public void initialiseFromUrl(EndpointURI endpointUri) throws InitialisationException(Code)(Java Doc)
final public boolean isConnected()(Code)(Java Doc)
public boolean isCreateMultipleTransactedReceivers()(Code)(Java Doc)
public boolean isDisposed()(Code)(Java Doc)
public boolean isDisposing()(Code)(Java Doc)
public boolean isEnableMessageEvents()(Code)(Java Doc)
public boolean isRemoteSyncEnabled()(Code)(Java Doc)
public boolean isStarted()(Code)(Java Doc)
public boolean isSyncEnabled(String protocol)(Code)(Java Doc)
public MessageReceiver lookupReceiver(String key)(Code)(Java Doc)
public MessageReceiver registerListener(Service service, InboundEndpoint endpoint) throws Exception(Code)(Java Doc)
public void registerSupportedProtocol(String protocol)(Code)(Java Doc)
protected void registerSupportedProtocolWithoutPrefix(String protocol)(Code)(Java Doc)
public MuleMessage request(String uri, long timeout) throws Exception(Code)(Java Doc)
public MuleMessage request(InboundEndpoint endpoint, long timeout) throws Exception(Code)(Java Doc)
public MuleMessage send(OutboundEndpoint endpoint, MuleEvent event) throws DispatchException(Code)(Java Doc)
public void setConnectionStrategy(ConnectionStrategy connectionStrategy)(Code)(Java Doc)
public void setCreateMultipleTransactedReceivers(boolean createMultipleTransactedReceivers)(Code)(Java Doc)
public void setDispatcherFactory(MessageDispatcherFactory dispatcherFactory)(Code)(Java Doc)
public void setDispatcherThreadingProfile(ThreadingProfile dispatcherThreadingProfile)(Code)(Java Doc)
public void setDynamicNotification(boolean dynamic)(Code)(Java Doc)
public void setExceptionListener(ExceptionListener listener)(Code)(Java Doc)
public void setMaxDispatchersActive(int maxActive)(Code)(Java Doc)
public void setMaxRequestersActive(int maxActive)(Code)(Java Doc)
public void setMuleContext(MuleContext context)(Code)(Java Doc)
public void setName(String newName)(Code)(Java Doc)
public void setNumberOfConcurrentTransactedReceivers(int count)(Code)(Java Doc)
public void setReceiverThreadingProfile(ThreadingProfile receiverThreadingProfile)(Code)(Java Doc)
public void setRequesterFactory(MessageRequesterFactory requesterFactory)(Code)(Java Doc)
public void setRequesterThreadingProfile(ThreadingProfile requesterThreadingProfile)(Code)(Java Doc)
public void setServiceOverrides(Map serviceOverrides)(Code)(Java Doc)
public void setSessionHandler(SessionHandler sessionHandler)(Code)(Java Doc)
public void setSupportedProtocols(List supportedProtocols)(Code)(Java Doc)
protected void setupDispatchReturn(OutboundEndpoint endpoint, MessageDispatcher dispatcher, MuleMessage result)(Code)(Java Doc)
protected void setupRequestReturn(InboundEndpoint endpoint, MessageRequester requester, MuleMessage result)(Code)(Java Doc)
final public synchronized LifecycleTransitionResult start() throws MuleException(Code)(Java Doc)
final public synchronized LifecycleTransitionResult stop() throws MuleException(Code)(Java Doc)
public boolean supportsProtocol(String protocol)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void unregisterListener(Service service, InboundEndpoint endpoint) throws Exception(Code)(Java Doc)
public void unregisterSupportedProtocol(String protocol)(Code)(Java Doc)
protected void updateCachedNotificationHandler()(Code)(Java Doc)
public void workAccepted(WorkEvent event)(Code)(Java Doc)
public void workCompleted(WorkEvent event)(Code)(Java Doc)
public void workRejected(WorkEvent event)(Code)(Java Doc)
public void workStarted(WorkEvent event)(Code)(Java Doc)

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.