Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> miamm >> [ soapmmil overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.miamm.soapmmil
Class SoapmmilMessage  

java.lang.Object
  org.miamm.soapmmil.SoapmmilMessage

---

public class SoapmmilMessage

extends java.lang.Object

A container for the parts of a SOAP message that are useful in Soapmmil. FIXME: these messages are disposable... once you close the reader, you can't reopen it TODO: this will later be used to push us into using more generic metadata such as FIPA

Version:

$Revision: 1.4 $
$Date: 2003/05/04 21:00:42 $

---

Field Summary
(package private)  soapical.util.MultiReader	_contents
(package private) static org.apache.log4j.Logger	_logger
(package private)  org.miamm.castor.headerblock.MiammSoapHeaderBlock	_misoh
(package private) static java.lang.String	UCLASSNAME

 

Constructor Summary

SoapmmilMessage(org.miamm.castor.headerblock.MiammSoapHeaderBlock misoh, java.io.Reader contents)

SoapmmilMessage(org.miamm.castor.headerblock.types.MsgContentType msgContent, java.io.Reader reader)           Creates a SoapmmilMessage with the role of inform.

SoapmmilMessage(org.miamm.castor.headerblock.types.MsgRoleType msgType, org.miamm.castor.headerblock.types.MsgContentType msgContent, java.io.Reader reader)

SoapmmilMessage(SoapmmilMessage msgRef, org.miamm.castor.headerblock.types.MsgContentType msgContent, java.io.Reader reader)           Produces a Soapmmil message which is a response to another message

 

Method Summary
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
java.io.Reader	getContents()           Returns the contents of this message.
org.miamm.castor.headerblock.MiammSoapHeaderBlock	getMisoh()
java.lang.String	getMsgId()
org.miamm.castor.headerblock.types.MsgContentType	getMsgType()
java.lang.String	getSender()
void	setMsgId(java.lang.String msgId)
void	setSender(java.lang.String sender)
javax.xml.soap.SOAPMessage	toSOAPMessage(java.lang.String sender)           Serialises this SoapmmilMessage to a SOAPMessage.

 

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

_logger

static org.apache.log4j.Logger _logger

---

UCLASSNAME

static final java.lang.String UCLASSNAME

See Also:

Constant Field Values

---

_misoh

org.miamm.castor.headerblock.MiammSoapHeaderBlock _misoh

---

_contents

soapical.util.MultiReader _contents

Constructor Detail

SoapmmilMessage

public SoapmmilMessage(org.miamm.castor.headerblock.types.MsgContentType msgContent,
                       java.io.Reader reader)

Creates a SoapmmilMessage with the role of inform.

---

SoapmmilMessage

public SoapmmilMessage(org.miamm.castor.headerblock.types.MsgRoleType msgType,
                       org.miamm.castor.headerblock.types.MsgContentType msgContent,
                       java.io.Reader reader)

---

SoapmmilMessage

public SoapmmilMessage(SoapmmilMessage msgRef,
                       org.miamm.castor.headerblock.types.MsgContentType msgContent,
                       java.io.Reader reader)

Produces a Soapmmil message which is a response to another message

---

SoapmmilMessage

public SoapmmilMessage(org.miamm.castor.headerblock.MiammSoapHeaderBlock misoh,
                       java.io.Reader contents)

Method Detail

clone

public java.lang.Object clone()

Description copied from class: java.lang.Object

This method may be called to create a new copy of the Object. The typical behavior is as follows:

• o == o.clone() is false
• o.getClass() == o.clone().getClass() is true
• o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

---

getMisoh

public org.miamm.castor.headerblock.MiammSoapHeaderBlock getMisoh()

---

getContents

public java.io.Reader getContents()

Returns the contents of this message. Note: this returns a MultiReader, which is just like a Reader, except that it can be reused.

---

getMsgId

public java.lang.String getMsgId()

---

getMsgType

public org.miamm.castor.headerblock.types.MsgContentType getMsgType()

---

setMsgId

public void setMsgId(java.lang.String msgId)

---

setSender

public void setSender(java.lang.String sender)

---

getSender

public java.lang.String getSender()

---

toSOAPMessage

public javax.xml.soap.SOAPMessage toSOAPMessage(java.lang.String sender)
                                         throws SoapmmilMessageContentException,
                                                java.lang.Exception

Serialises this SoapmmilMessage to a SOAPMessage. We silently copy the reader so that you can call this as often as you like. FIXME: Unfortunately, this has also the uncomfortable side-effect of modifying the message header.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> miamm >> [ soapmmil overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---