Java Doc for Message.java in » Net » Coadunation_1.0.1 » com » rift » coad » daemon » messageservice » 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 » Net » Coadunation_1.0.1 » com.rift.coad.daemon.messageservice

Source Cross Reference

Class Diagram

Java Document (Java Doc)

com.rift.coad.daemon.messageservice .Message

All known Subclasses:   com.rift.coad.daemon.messageservice.message .MessageImpl,
Message
public interface Message extends Serializable(Code)
The definition of the message object.
author:
   Brett Chaldecott

Field Summary
final public static int CRITICAL
     A critical error.
final public static int DELIVERED
     The message has been delivered to its destination.
final public static int ERROR
     An error.
final public static int POINT_TO_MULTI_SERVICE
     A message will get delivered to all services within a coadunation cluster that match the service name.
final public static int POINT_TO_POINT
     A message will get delivered to a point defined by a JNDI URL.
final public static int POINT_TO_SERVICE
     A message will get delivered to the first available service with a matching service name.
final public static int UNDELIVERABLE
     The message could not be delivered to its destination.
final public static int UNDELIVERED
     This state flag indicates that a message is undelivered.
final public static int WARN


Method Summary
public void acknowledge()
     This method acknowledges that this message has been successfully processed by a target.
public void addError(int level, String msg)
     This method adds an error to the list of errors for this message.
public void clearBody()
     This clears the body of the message.
public void clearProperties()
     This method clears the properties assigned to this message.
public boolean containsProperty(String name)
     This method returns true if the property is found.
public boolean getBooleanProperty(String name)
     This method returns the boolean property value for the requested name.
public byte getByteProperty(String name)
     This method returns the byte property value for the requested name.
public String getCorrelationId()
     The external correlation id for this message.
public Date getCreated()
     This method returns the date this message was created.
public double getDoubleProperty(String name)
     This method returns the double property value for the requested name.
public List getErrors()

public float getFloatProperty(String name)
     This method returns the float property value for the requested name.
public String getFrom()
     This method returns the from URL of a message.
public int getIntProperty(String name)
     This method returns the int property value for the requested name.
public long getLongProperty(String name)
     This method returns the long property value for the requested name.
public String getMessageCreater()
     This method returns the creator of this message.
public String getMessageId()
     This method returns the id of this message object.
public List getMessagePrincipals()
     This method returns the list of user principals assigned to this message.
public int getMessageType()
     This method returns the type of message that this object represents.
public Object getObjectProperty(String name)
     This method returns the object property value for the requested name.
public int getPriority()
     This message returns the priority of this message.
public Date getProcessedDate()
     This method will return the last processed date.
public Enumeration getPropertyNames()
     This method returns the string property value for the requested name.
public Object getPropertyValue(String name)
     This method returns the value of the property.
public boolean getReply()
     This method returns the value of the reply flag.
public String getReplyNamedQueue()
     This will only be set if the reply service is not a daemon, but an external process.
public String getReplyTo()
     This method returns the reply to URL, it can be different from the from URL.
public int getRetries()
     This is the number of retries this message has had.
public String[] getServices()
     This method returns the list of services.
public String getSessionId()
     This method returns the ID of the session that created this message.
public int getState()
     This method returns the current state of this message.
public String getStringProperty(String name)
     This method returns the string property value for the requested name.
public String getTarget()
     This method will return the URL string for this message if this is a point to point message.
public String getTargetNamedQueue()
     This method gets the target named queue.
public void incrementRetries()
     This method increments the retry count on this object.
public boolean isAcknowledged()
     This method returns the value of the acknowledged flag for this message.
public boolean propertyExists(String name)
     This method returns true if the specified property exits.
public void setBooleanProperty(String name, boolean value)
     This method sets the boolean property value for the name.
public void setByteProperty(String name, byte value)
     This method sets the byte property value for the name.
public void setCorrelationId(String id)
     This method sets the correlation id for this message.
public void setDoubleProperty(String name, double value)
     This method sets the double property value for the name.
public void setFloatProperty(String name, float value)
     This method sets the float property value for the name.
public void setFrom(String from)
     This method returns the from address of the message.
public void setIntProperty(String name, int value)
     This method set the int property value for the name.
public void setLongProperty(String name, long value)
     This method sets the long property value for the name.
Parameters:
  name - The name of the property.
public void setMessageType(int messageType)
     This method sets the type of message that this object represents.
public void setObjectProperty(String name, Object value)
     This method returns the object property value for the name.
public void setPriority(int priority)
     This method sets the priority of the message.
public void setProcessedDate(Date processedDate)
     This method sets the processed date.
public void setPropertyValue(String name, Object value)
     This method sets the value of the property.
public void setReply(boolean value)
     This method sets the reply flag.
public void setReplyNamedQueue(String name)
     This will only be set if the reply service is not a daemon, but an external process.
public void setReplyTo(String replyTo)
     This method returns the reply to URL, it can be different from the from URL.
public void setServices(String[] services)
     This method returns the list of services this message targeted at.
public void setStringProperty(String name, String value)
     This method sets the string property value for the name.
Parameters:
  name - The name of the property.
public void setTarget(String target)
     This method sets the target of the message.
public void setTargetNamedQueue(String name)
     This method sets the target named queue.

Field Detail
CRITICAL
final public static int CRITICAL(Code)
A critical error.

DELIVERED
final public static int DELIVERED(Code)
The message has been delivered to its destination.

ERROR
final public static int ERROR(Code)
An error.

POINT_TO_MULTI_SERVICE
final public static int POINT_TO_MULTI_SERVICE(Code)
A message will get delivered to all services within a coadunation cluster that match the service name.

POINT_TO_POINT
final public static int POINT_TO_POINT(Code)
A message will get delivered to a point defined by a JNDI URL.

POINT_TO_SERVICE
final public static int POINT_TO_SERVICE(Code)
A message will get delivered to the first available service with a matching service name.

UNDELIVERABLE
final public static int UNDELIVERABLE(Code)
The message could not be delivered to its destination.

UNDELIVERED
final public static int UNDELIVERED(Code)
This state flag indicates that a message is undelivered.

WARN
final public static int WARN(Code)
A warning

Method Detail
acknowledge
public void acknowledge() throws MessageServiceException(Code)
This method acknowledges that this message has been successfully processed by a target.
exception:
  MessageServiceException -

addError
public void addError(int level, String msg) throws MessageServiceException(Code)
This method adds an error to the list of errors for this message.
Parameters:
  level - The level of the error.
Parameters:
  msg - The message associated with the error.

clearBody
public void clearBody() throws MessageServiceException(Code)
This clears the body of the message.
exception:
  MessageServiceException -

clearProperties
public void clearProperties() throws MessageServiceException(Code)
This method clears the properties assigned to this message.
exception:
  MessageServiceException -

containsProperty
public boolean containsProperty(String name) throws MessageServiceException(Code)
This method returns true if the property is found. TRUE if the property is found, FALSE if not.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -

getBooleanProperty
public boolean getBooleanProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the boolean property value for the requested name. The value of the boolean property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getByteProperty
public byte getByteProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the byte property value for the requested name. The value of the byte property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getCorrelationId
public String getCorrelationId() throws MessageServiceException(Code)
The external correlation id for this message. The string containing the correllation ID.
exception:
  MessageServiceException -

getCreated
public Date getCreated()(Code)
This method returns the date this message was created. The date message was created.

getDoubleProperty
public double getDoubleProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the double property value for the requested name. The value of the byte property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getErrors
public List getErrors() throws MessageServiceException(Code)
This method returns list of errors

getFloatProperty
public float getFloatProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the float property value for the requested name. The value of the float property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getFrom
public String getFrom() throws MessageServiceException(Code)
This method returns the from URL of a message. The string containing the from URL.
exception:
  MessageServiceException -

getIntProperty
public int getIntProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the int property value for the requested name. The value of the int property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getLongProperty
public long getLongProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the long property value for the requested name. The value of the long property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getMessageCreater
public String getMessageCreater()(Code)
This method returns the creator of this message.

getMessageId
public String getMessageId()(Code)
This method returns the id of this message object. The id of the message object.

getMessagePrincipals
public List getMessagePrincipals()(Code)
This method returns the list of user principals assigned to this message. The list of user principals assigned to this message.

getMessageType
public int getMessageType()(Code)
This method returns the type of message that this object represents. The type of object being wrapped.

getObjectProperty
public Object getObjectProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the object property value for the requested name. The value of the object property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getPriority
public int getPriority()(Code)
This message returns the priority of this message. The int indicating the priority of this message.
exception:
  MessageServiceException -

getProcessedDate
public Date getProcessedDate()(Code)
This method will return the last processed date.

getPropertyNames
public Enumeration getPropertyNames() throws MessageServiceException(Code)
This method returns the string property value for the requested name. The list of property names
exception:
  MessageServiceException -

getPropertyValue
public Object getPropertyValue(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the value of the property. The value of the property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getReply
public boolean getReply() throws MessageServiceException(Code)
This method returns the value of the reply flag. TRUE if it should reply FALSE if it should not. TRUE if this message must reply, FALSE if not.
exception:
  MessageServiceException -

getReplyNamedQueue
public String getReplyNamedQueue() throws MessageServiceException(Code)
This will only be set if the reply service is not a daemon, but an external process. The string containing the Queue name.
exception:
  MessageServiceException -

getReplyTo
public String getReplyTo() throws MessageServiceException(Code)
This method returns the reply to URL, it can be different from the from URL. The string containing the from URL.
exception:
  MessageServiceException -

getRetries
public int getRetries()(Code)
This is the number of retries this message has had. The number of retries performed by this message.

getServices
public String[] getServices() throws MessageServiceException, InvalidMessageType(Code)
This method returns the list of services. The string array list of services.
exception:
  MessageServiceException -
exception:
  InvalidMessageType -

getSessionId
public String getSessionId()(Code)
This method returns the ID of the session that created this message. The string containing the id of the session that created thismessage.

getState
public int getState() throws MessageServiceException(Code)
This method returns the current state of this message. The current state of this message.
exception:
  MessageServiceException -

getStringProperty
public String getStringProperty(String name) throws MessageServiceException, InvalidProperty(Code)
This method returns the string property value for the requested name. The value of the string property.
Parameters:
  name - The name of the property.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

getTarget
public String getTarget() throws MessageServiceException, InvalidMessageType(Code)
This method will return the URL string for this message if this is a point to point message. The string containing the Target URL.
exception:
  MessageServiceException -
exception:
  InvalidMessageType -

getTargetNamedQueue
public String getTargetNamedQueue() throws MessageServiceException(Code)
This method gets the target named queue. The string containing the Queue name.
exception:
  MessageServiceException -

incrementRetries
public void incrementRetries()(Code)
This method increments the retry count on this object.

isAcknowledged
public boolean isAcknowledged() throws MessageServiceException(Code)
This method returns the value of the acknowledged flag for this message. TRUE if acknowleded, FALSE if not.
exception:
  MessageServiceException -

propertyExists
public boolean propertyExists(String name) throws MessageServiceException(Code)
This method returns true if the specified property exits. TRUE if the property exists, FALSE if not.
Parameters:
  name - The name of the property to look for.
exception:
  MessageServiceException -

setBooleanProperty
public void setBooleanProperty(String name, boolean value) throws MessageServiceException(Code)
This method sets the boolean property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The value of the boolean property.
exception:
  MessageServiceException -

setByteProperty
public void setByteProperty(String name, byte value) throws MessageServiceException(Code)
This method sets the byte property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The value of the byte property.
exception:
  MessageServiceException -

setCorrelationId
public void setCorrelationId(String id) throws MessageServiceException(Code)
This method sets the correlation id for this message. It is the external identifier for this message.
Parameters:
  id - The id that will be used as the correlation id.
exception:
  MessageServiceException -

setDoubleProperty
public void setDoubleProperty(String name, double value) throws MessageServiceException(Code)
This method sets the double property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The value of the double property.
exception:
  MessageServiceException -

setFloatProperty
public void setFloatProperty(String name, float value) throws MessageServiceException(Code)
This method sets the float property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The value of the float property.
exception:
  MessageServiceException -

setFrom
public void setFrom(String from) throws MessageServiceException(Code)
This method returns the from address of the message. The from address of the message.
exception:
  MessageServiceException -

setIntProperty
public void setIntProperty(String name, int value) throws MessageServiceException(Code)
This method set the int property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The value of the int property.
exception:
  MessageServiceException -

setLongProperty
public void setLongProperty(String name, long value) throws MessageServiceException(Code)
This method sets the long property value for the name.
Parameters:
  name - The name of the property. value The new long value.
exception:
  MessageServiceException -

setMessageType
public void setMessageType(int messageType)(Code)
This method sets the type of message that this object represents.
Parameters:
  messageType - The type of object being wrapped.

setObjectProperty
public void setObjectProperty(String name, Object value) throws MessageServiceException(Code)
This method returns the object property value for the name.
Parameters:
  name - The name of the property.
Parameters:
  value - The new object value to set.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

setPriority
public void setPriority(int priority) throws MessageServiceException(Code)
This method sets the priority of the message.
Parameters:
  priority - The priority of the message.
exception:
  MessageServiceException -

setProcessedDate
public void setProcessedDate(Date processedDate)(Code)
This method sets the processed date.
Parameters:
  processedDate - The processed date of the message.

setPropertyValue
public void setPropertyValue(String name, Object value) throws MessageServiceException, InvalidProperty(Code)
This method sets the value of the property.
Parameters:
  name - The name of the property.
Parameters:
  value - The property value.
exception:
  MessageServiceException -
exception:
  InvalidProperty -

setReply
public void setReply(boolean value) throws MessageServiceException(Code)
This method sets the reply flag.
Parameters:
  value - TRUE if a reply is required, FALSE if not.
exception:
  MessageServiceException -

setReplyNamedQueue
public void setReplyNamedQueue(String name) throws MessageServiceException(Code)
This will only be set if the reply service is not a daemon, but an external process.
Parameters:
  name - The string containing the Queue name.
exception:
  MessageServiceException -

setReplyTo
public void setReplyTo(String replyTo) throws MessageServiceException(Code)
This method returns the reply to URL, it can be different from the from URL. The string containing the from URL.
exception:
  MessageServiceException -

setServices
public void setServices(String[] services) throws MessageServiceException, InvalidMessageType(Code)
This method returns the list of services this message targeted at.
Parameters:
  services - The list of services.
exception:
  MessageServiceException -
exception:
  InvalidMessageType -

setStringProperty
public void setStringProperty(String name, String value) throws MessageServiceException(Code)
This method sets the string property value for the name.
Parameters:
  name - The name of the property. value The new string value to set.
exception:
  MessageServiceException -

setTarget
public void setTarget(String target) throws MessageServiceException, InvalidMessageType(Code)
This method sets the target of the message.
Parameters:
  target - The string containing the Target URL.
exception:
  MessageServiceException -
exception:
  InvalidMessageType -

setTargetNamedQueue
public void setTargetNamedQueue(String name) throws MessageServiceException(Code)
This method sets the target named queue.
Parameters:
  name - The string containing the Queue name.
exception:
  MessageServiceException -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.