Package com.isode.som.pumice.objects

Class SomPumiceMessage

java.lang.Object

com.isode.som.pumice.objects.SomPumiceObject

com.isode.som.pumice.objects.SomPumiceMessage

All Implemented Interfaces:

SomPumiceHandler, SomHandler

public class SomPumiceMessage
extends SomPumiceObject
implements SomPumiceHandler

Class which models a message in a Message Store mailbox The SomPumiceSubordinates command generates a list of objects of this type when it is invoked to list messages

Author:

tc

Field Summary

Fields inherited from class com.isode.som.pumice.objects.SomPumiceObject

errortext, somSession

Constructor Summary

Constructors

Constructor	Description
SomPumiceMessage(SomPumiceSession session, java.lang.String[] pairs)	Create a new SomPumiceMessage object, populating it with data
SomPumiceMessage(SomPumiceSession session, java.lang.String mbx, java.lang.Integer s)	Create a new SomPumiceMessage object
SomPumiceMessage(SomPumiceSession session, java.lang.String mbx, java.lang.Integer s, java.lang.String[] pairs)	Create a new SomPumiceMessage object, populating it with data

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	age()
java.lang.String	buildInfoString()
void	delete(SomCommandListener listener)
void	forward(SomCommandListener listener, java.lang.String recip, java.lang.String coverNote)
void	handleBindResponse(int status, java.lang.String detail)	Handle the response to a Bind operation
void	handleResponse(SomCommand obj, int status, SomMessage msg)
void	handleResponse(SomCommand command, int status, SomPumiceConnection object)
void	handleResponse(SomCommand command, int status, SomPumiceMailbox object)
void	handleResponse(SomCommand command, int status, SomPumiceMessage object)
void	handleResponse(SomCommand command, int status, SomPumiceMessageStore object)
void	handleResponse(SomCommand command, int status, java.lang.String detail)	Generic command response handler
void	handleResponse(SomCommand command, int status, java.lang.String[] pairs)
java.lang.String	ipmType()
java.lang.String	mailboxPath()
void	move(SomCommandListener listener, java.lang.String destMailbox)
java.lang.String	mtsIdentifier()
java.lang.String	originator()
java.lang.String	priority()
void	refresh(SomCommandListener listener)
void	removeFromArray(java.util.ArrayList<SomPumiceMessage> messages)
java.lang.Integer	sequenceNumber()
void	setState(SomCommandListener listener, java.lang.String newState)
java.lang.Integer	size()
java.lang.String	state()
java.lang.String	subject()
java.lang.String	type()
java.lang.String	uniqueId()

Methods inherited from class com.isode.som.pumice.objects.SomPumiceObject

addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, notifyListeners, notifyListeners, parsePairs, print, removeBindListener, setSkipNotifications

Methods inherited from class java.lang.Object

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

Constructor Detail

SomPumiceMessage

public SomPumiceMessage(SomPumiceSession session,
                        java.lang.String mbx,
                        java.lang.Integer s)

Create a new SomPumiceMessage object

Parameters:

session - Session within which to create message

mbx - Name of mailbox containing message

s - Sequence number of message

SomPumiceMessage

public SomPumiceMessage(SomPumiceSession session,
                        java.lang.String mbx,
                        java.lang.Integer s,
                        java.lang.String[] pairs)

Create a new SomPumiceMessage object, populating it with data

Parameters:

session - Session within which to create message

mbx - Name of mailbox containing message

s - Sequence number of message

pairs - Data type/value pairs

SomPumiceMessage

public SomPumiceMessage(SomPumiceSession session,
                        java.lang.String[] pairs)

Create a new SomPumiceMessage object, populating it with data

Parameters:

session - Session within which to create message

pairs - Data type/value pairs

Method Detail

removeFromArray

public void removeFromArray(java.util.ArrayList<SomPumiceMessage> messages)

uniqueId

public java.lang.String uniqueId()

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           java.lang.String detail)

Description copied from interface: SomHandler

Generic command response handler

Specified by:

handleResponse in interface SomHandler

Specified by:

handleResponse in interface SomPumiceHandler

Parameters:

command - the command to which the response applies

status - status from command

detail - error detail

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           SomPumiceMessageStore object)

handleResponse

public void handleResponse(SomCommand obj,
                           int status,
                           SomMessage msg)

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           SomPumiceMessage object)

Specified by:

handleResponse in interface SomPumiceHandler

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           SomPumiceConnection object)

Specified by:

handleResponse in interface SomPumiceHandler

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           SomPumiceMailbox object)

Specified by:

handleResponse in interface SomPumiceHandler

handleBindResponse

public void handleBindResponse(int status,
                               java.lang.String detail)

Description copied from interface: SomHandler

Handle the response to a Bind operation

Specified by:

handleBindResponse in interface SomHandler

Parameters:

status - operation status

detail - error detail on failure

handleResponse

public void handleResponse(SomCommand command,
                           int status,
                           java.lang.String[] pairs)

Specified by:

handleResponse in interface SomPumiceHandler

refresh

public void refresh(SomCommandListener listener)
             throws SomException

Throws:

SomException

delete

public void delete(SomCommandListener listener)
            throws SomException

Throws:

SomException

move

public void move(SomCommandListener listener,
                 java.lang.String destMailbox)
          throws SomException

Throws:

SomException

setState

public void setState(SomCommandListener listener,
                     java.lang.String newState)
              throws SomException

Throws:

SomException

forward

public void forward(SomCommandListener listener,
                    java.lang.String recip,
                    java.lang.String coverNote)
             throws SomException

Throws:

SomException

buildInfoString

public java.lang.String buildInfoString()

mailboxPath

public java.lang.String mailboxPath()
                             throws SomException

Throws:

SomException

sequenceNumber

public java.lang.Integer sequenceNumber()
                                 throws SomException

Throws:

SomException

size

public java.lang.Integer size()
                       throws SomException

Throws:

SomException

age

public java.lang.Integer age()
                      throws SomException

Throws:

SomException

type

public java.lang.String type()
                      throws SomException

Throws:

SomException

ipmType

public java.lang.String ipmType()
                         throws SomException

Throws:

SomException

priority

public java.lang.String priority()
                          throws SomException

Throws:

SomException

state

public java.lang.String state()
                       throws SomException

Throws:

SomException

originator

public java.lang.String originator()
                            throws SomException

Throws:

SomException

subject

public java.lang.String subject()
                         throws SomException

Throws:

SomException

mtsIdentifier

public java.lang.String mtsIdentifier()
                               throws SomException

Throws:

SomException