Java Doc for MessageExchange.java in » ESB » open-esb » javax » jbi » messaging » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » open esb » javax.jbi.messaging

Source Cross Reference

Class Diagram

Java Document (Java Doc)

javax.jbi.messaging .MessageExchange

All known Subclasses:   com.sun.jbi.messaging .MessageExchangeImpl,
MessageExchange
public interface MessageExchange (Code)
MessageExchange represents a container for normalized messages which are described by an exchange pattern. The exchange pattern defines the names, sequence, and cardinality of messages in an exchange.
author:
   JSR208 Expert Group

Inner Class :final public static class Role

Field Summary
String JTA_TRANSACTION_PROPERTY_NAME
     JTA transaction context property name.

Method Summary
Fault createFault()
     Generic factory method for Fault objects.
NormalizedMessage createMessage()
     Creates a normalized message based on the specified message reference.
ServiceEndpoint getEndpoint()
     Retrieves the endpoint used by this exchange.
Exception getError()
     Retrieves the Exception describing the exchanges error status.
String getExchangeId()
     Returns the unique identifier assigned by the NMS for this exchange.
Fault getFault()
     Retrieves the fault message for this exchange, if one exists.
QName getInterfaceName()
     Retrieves the interface name used by this exchange.
NormalizedMessage getMessage(String name)
     Retrieves a normalized message based on the specified message reference.
QName getOperation()
     Retrieves the operation used by this exchange.
URI getPattern()
     Returns the URI of the pattern for this exchange.
Object getProperty(String name)
     Retrieves the specified property from the exchange.
java.util.Set getPropertyNames()
     Returns the name of all properties for this exchange.
Role getRole()
     Queries the role that the caller plays in the exchange.
QName getService()
     Retrieves the service used by this exchange.
ExchangeStatus getStatus()
     Returns the processing status of the exchange.
boolean isTransacted()
     Queries the existence of a transaction context.
void setEndpoint(ServiceEndpoint endpoint)
     Specifies the endpoint used by this exchange.
void setError(Exception error)
     Used to specify the source of a failure status.
void setFault(Fault fault)
     Specifies the fault message for this exchange, if one exists.
void setInterfaceName(QName interfaceName)
     Specifies the interface name used by this exchange.
void setMessage(NormalizedMessage msg, String name)
     Sets a normalized message with the specified message reference.
void setOperation(QName name)
     Specifies the operation used by this exchange.
void setProperty(String name, Object obj)
     Specifies a property for the exchange.
void setService(QName service)
     Specifies the service used by this exchange.
void setStatus(ExchangeStatus status)
     Sets the processing status of the exchange.

Field Detail
JTA_TRANSACTION_PROPERTY_NAME
String JTA_TRANSACTION_PROPERTY_NAME(Code)
JTA transaction context property name.

Method Detail
createFault
Fault createFault() throws MessagingException(Code)
Generic factory method for Fault objects. a new fault
throws:
  MessagingException - failed to create fault

createMessage
NormalizedMessage createMessage() throws MessagingException(Code)
Creates a normalized message based on the specified message reference. The pattern governing this exchange must contain a definition for the reference name supplied. a new normalized message
throws:
  MessagingException - failed to create message

getEndpoint
ServiceEndpoint getEndpoint()(Code)
Retrieves the endpoint used by this exchange. endpoint address for this message exchange

getError
Exception getError()(Code)
Retrieves the Exception describing the exchanges error status. exception associated with this exchange

getExchangeId
String getExchangeId()(Code)
Returns the unique identifier assigned by the NMS for this exchange. unique id for this exchange

getFault
Fault getFault()(Code)
Retrieves the fault message for this exchange, if one exists. A fault/message reference is unnecessary, since an exchange can carry at most one fault, and it is always the final message in an exchange. fault associated with the exchange, or null if not present

getInterfaceName
QName getInterfaceName()(Code)
Retrieves the interface name used by this exchange. interface used for this message exchange

getMessage
NormalizedMessage getMessage(String name)(Code)
Retrieves a normalized message based on the specified message reference.
Parameters:
  name - message reference message with the specified reference name

getOperation
QName getOperation()(Code)
Retrieves the operation used by this exchange. operation name for this message exchange

getPattern
URI getPattern()(Code)
Returns the URI of the pattern for this exchange. pattern URI for this exchange

getProperty
Object getProperty(String name)(Code)
Retrieves the specified property from the exchange.
Parameters:
  name - property name property value

getPropertyNames
java.util.Set getPropertyNames()(Code)
Returns the name of all properties for this exchange. a set of all the property names, as Strings.

getRole
Role getRole()(Code)
Queries the role that the caller plays in the exchange. Role expected of caller.

getService
QName getService()(Code)
Retrieves the service used by this exchange. service address for this message exchange

getStatus
ExchangeStatus getStatus()(Code)
Returns the processing status of the exchange. status of the exchange

isTransacted
boolean isTransacted()(Code)
Queries the existence of a transaction context. boolean transactional state of the exchange

setEndpoint
void setEndpoint(ServiceEndpoint endpoint)(Code)
Specifies the endpoint used by this exchange.
Parameters:
  endpoint - endpoint address

setError
void setError(Exception error)(Code)
Used to specify the source of a failure status. Invoking this method automatically adjusts the status of the ME to ExchangeStatus.ERROR.
Parameters:
  error - error cause

setFault
void setFault(Fault fault) throws MessagingException(Code)
Specifies the fault message for this exchange, if one exists. A fault/message reference is unnecessary, since an exchange can carry at most one fault, and it is always the final message in an exchange.
Parameters:
  fault - fault
throws:
  MessagingException - operation not permitted in the current exchange state

setInterfaceName
void setInterfaceName(QName interfaceName)(Code)
Specifies the interface name used by this exchange.
Parameters:
  interfaceName - interface name

setMessage
void setMessage(NormalizedMessage msg, String name) throws MessagingException(Code)
Sets a normalized message with the specified message reference. The pattern governing this exchange must contain a definition for the reference name supplied.
Parameters:
  msg - normalized message
Parameters:
  name - message reference
throws:
  MessagingException - operation not permitted in the current exchange state

setOperation
void setOperation(QName name)(Code)
Specifies the operation used by this exchange.
Parameters:
  name - operation name

setProperty
void setProperty(String name, Object obj)(Code)
Specifies a property for the exchange.
Parameters:
  name - property name
Parameters:
  obj - property value

setService
void setService(QName service)(Code)
Specifies the service used by this exchange.
Parameters:
  service - service address

setStatus
void setStatus(ExchangeStatus status) throws MessagingException(Code)
Sets the processing status of the exchange.
Parameters:
  status - exchange status
throws:
  MessagingException - failed to set status, possibly due to an invalid state transition.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.