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


org.mule.api.transport.Connector

All known Subclasses:   org.mule.transport.AbstractConnector,
Connector
public interface Connector extends Lifecycle,MuleContextAware,NamedObject(Code)
Connector is the mechanism used to connect to external systems and protocols in order to send and receive data.


Field Summary
 intINT_VALUE_NOT_SET
    


Method Summary
 voiddispatch(OutboundEndpoint endpoint, MuleEvent event)
    
 MessageDispatcherFactorygetDispatcherFactory()
    
 ExceptionListenergetExceptionListener()
    
 MessageAdaptergetMessageAdapter(Object message)
    
 MuleContextgetMuleContext()
    
 OutputStreamgetOutputStream(OutboundEndpoint endpoint, MuleMessage message)
     Will get the output stream for this type of transport.
 StringgetProtocol()
    
 MessageRequesterFactorygetRequesterFactory()
    
 voidhandleException(Exception exception)
    
 booleanisDisposed()
    
 booleanisDisposing()
    
 booleanisRemoteSyncEnabled()
    
 booleanisStarted()
    
 booleanisSyncEnabled(String protocol)
     Used to define is this connectors endpoints' should be synchronous by default rather than using mule's instance wide default.
 MessageReceiverregisterListener(Service service, InboundEndpoint endpoint)
    
 MuleMessagerequest(String uri, long timeout)
     Make a specific request to the underlying transport
Parameters:
  uri - the endpoint uri to use when connecting to the resource
Parameters:
  timeout - the maximum time the operation should block before returning.The call should return immediately if there is data available.
 MuleMessagerequest(InboundEndpoint endpoint, long timeout)
     Make a specific request to the underlying transport
Parameters:
  endpoint - the endpoint to use when connecting to the resource
Parameters:
  timeout - the maximum time the operation should block before returning.The call should return immediately if there is data available.
 MuleMessagesend(OutboundEndpoint endpoint, MuleEvent event)
    
 voidsetDispatcherFactory(MessageDispatcherFactory factory)
    
 voidsetExceptionListener(ExceptionListener listener)
    
 voidsetRequesterFactory(MessageRequesterFactory factory)
    
 booleansupportsProtocol(String protocol)
    
 voidunregisterListener(Service service, InboundEndpoint endpoint)
    
Parameters:
  service - the listening service
Parameters:
  endpoint - the associated endpointDescriptor with the listener
throws:
  Exception - if the listener cannot be unregistered.

Field Detail
INT_VALUE_NOT_SET
int INT_VALUE_NOT_SET(Code)





Method Detail
dispatch
void dispatch(OutboundEndpoint endpoint, MuleEvent event) throws DispatchException(Code)
Dispatches an event from the endpoint to the external system
Parameters:
  event - The event to dispatch
throws:
  DispatchException - if the event fails to be dispatched



getDispatcherFactory
MessageDispatcherFactory getDispatcherFactory()(Code)
The dispatcher factory is used to create a message dispatcher of the current request the factory to use when a dispatcher request is madr



getExceptionListener
ExceptionListener getExceptionListener()(Code)
the Exception stategy used by the endpoint
See Also:   ExceptionListener



getMessageAdapter
MessageAdapter getMessageAdapter(Object message) throws MessagingException(Code)
Gets a MessageAdapter from the connector for the given message (data)
Parameters:
  message - the data with which to initialise the MessageAdapter the MessageAdapter for the endpoint
throws:
  MessagingException - if the message parameter is not supported
See Also:   MessageAdapter



getMuleContext
MuleContext getMuleContext()(Code)



getOutputStream
OutputStream getOutputStream(OutboundEndpoint endpoint, MuleMessage message) throws MuleException(Code)
Will get the output stream for this type of transport. Typically this will be called only when Streaming is being used on an outbound endpoint. If Streaming is not supported by this transport an UnsupportedOperationException is thrown. Note that the stream MUST release resources on close. For help doing so, see org.mule.model.streaming.CallbackOutputStream .
Parameters:
  endpoint - the endpoint that releates to this Dispatcher
Parameters:
  message - the current message being processed the output stream to use for this request
throws:
  MuleException -



getProtocol
String getProtocol()(Code)
the primary protocol name for endpoints of this connector



getRequesterFactory
MessageRequesterFactory getRequesterFactory()(Code)
The requester factory is used to create a message requester of the current request the factory to use when a request is made



handleException
void handleException(Exception exception)(Code)

Parameters:
  exception - the exception that was caught



isDisposed
boolean isDisposed()(Code)
false if the connector is alive and well or true if the connector isbeing destroyed



isDisposing
boolean isDisposing()(Code)
false if the connector is alive and well or true if the connector hasbeen told to dispose



isRemoteSyncEnabled
boolean isRemoteSyncEnabled()(Code)



isStarted
boolean isStarted()(Code)
true if the endpoint is started



isSyncEnabled
boolean isSyncEnabled(String protocol)(Code)
Used to define is this connectors endpoints' should be synchronous by default rather than using mule's instance wide default. The endpoint is passed through to this method so that transports like axis/xfire can determine if synchronous should be default depending on the endpoint transport e.g. http/vm/jms etc.
Parameters:
  endpoint -
See Also:   ImmutableEndpoint.isSynchronous



registerListener
MessageReceiver registerListener(Service service, InboundEndpoint endpoint) throws Exception(Code)
This creates a MessageReceiver associated with this endpoint and registers it with the connector
Parameters:
  service - the listening service
Parameters:
  endpoint - the endpoint contains the listener endpointUri on which tolisten on.
throws:
  Exception - if the MessageReceiver cannot be created or the Receivercannot be registered



request
MuleMessage request(String uri, long timeout) throws Exception(Code)
Make a specific request to the underlying transport
Parameters:
  uri - the endpoint uri to use when connecting to the resource
Parameters:
  timeout - the maximum time the operation should block before returning.The call should return immediately if there is data available. Ifno data becomes available before the timeout elapses, null will bereturned the result of the request wrapped in a MuleMessage object. Null will bereturned if no data was avaialable
throws:
  Exception - if the call to the underlying protocal cuases an exception



request
MuleMessage request(InboundEndpoint endpoint, long timeout) throws Exception(Code)
Make a specific request to the underlying transport
Parameters:
  endpoint - the endpoint to use when connecting to the resource
Parameters:
  timeout - the maximum time the operation should block before returning.The call should return immediately if there is data available. Ifno data becomes available before the timeout elapses, null will bereturned the result of the request wrapped in a MuleMessage object. Null will bereturned if no data was avaialable
throws:
  Exception - if the call to the underlying protocal cuases an exception



send
MuleMessage send(OutboundEndpoint endpoint, MuleEvent event) throws DispatchException(Code)
Sends an event from the endpoint to the external system
Parameters:
  event - The event to send event the response form the external system wrapped in a MuleEvent
throws:
  DispatchException - if the event fails to be dispatched



setDispatcherFactory
void setDispatcherFactory(MessageDispatcherFactory factory)(Code)
The dispatcher factory is used to create a message dispatcher of the current request
Parameters:
  factory - the factory to use when a dispatcher request is madr



setExceptionListener
void setExceptionListener(ExceptionListener listener)(Code)

Parameters:
  listener - the exception strategy to use with this endpoint
See Also:   ExceptionListener



setRequesterFactory
void setRequesterFactory(MessageRequesterFactory factory)(Code)
The requester factory is used to create a message requester of the current request
Parameters:
  factory - the factory to use when a request is made



supportsProtocol
boolean supportsProtocol(String protocol)(Code)
true if the protocol is supported by this connector.



unregisterListener
void unregisterListener(Service service, InboundEndpoint endpoint) throws Exception(Code)

Parameters:
  service - the listening service
Parameters:
  endpoint - the associated endpointDescriptor with the listener
throws:
  Exception - if the listener cannot be unregistered. If a listener is notassociated with the given endpoint this will not throw anexception



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