Package com.isode.som.pumice.objects

Class SomPumiceMailbox

java.lang.Object

com.isode.som.pumice.objects.SomPumiceObject

com.isode.som.pumice.objects.SomPumiceMailbox

All Implemented Interfaces:

SomPumiceHandler, SomHandler

public class SomPumiceMailbox
extends SomPumiceObject
implements SomPumiceHandler

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

Author:

tc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SomPumiceMailbox.EntryClass
static enum	SomPumiceMailbox.EntryState

Field Summary

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

errortext, somSession

Constructor Summary

Constructors

Constructor	Description
SomPumiceMailbox(SomPumiceSession session, String mName)	Create a new mailbox object, with the specified name
SomPumiceMailbox(SomPumiceSession session, String[] pairs)	Create a new mailbox object and populate from type/value pairs
SomPumiceMailbox(SomPumiceSession session, String m, String[] pairs)	Create a new mailbox object, with the specified name and populate from type/value pairs

Method Summary

Modifier and Type	Method	Description
String	ageoldest()
com.isode.asn.modules.MS.AutoActionRegistrations	autoActions()
String	autoActionsString()
void	backup(SomCommandListener listener, String dest)
String	buildInfoString()
void	deregisterAutoAction(SomCommandListener listener, com.isode.asn.modules.MS.AutoActionRegistration reg)
Integer	errorCount()
SomPumiceMessage[]	getMessages()
void	handleBindResponse(int status, String detail)	Handle the response to a Bind operation
void	handleResponse(SomCommand command, int status, SomPumiceConnection object)
void	handleResponse(SomCommand command, int status, SomPumiceMailbox object)
void	handleResponse(SomCommand obj, int status, SomPumiceMessage msg)
void	handleResponse(SomCommand command, int status, SomPumiceMessageStore object)
void	handleResponse(SomCommand command, int status, String detail)	Generic command response handler
void	handleResponse(SomCommand command, int status, String[] pairs)
String	lastBindTime()
String	lastOpTime()
String	lastOpType()
void	listMessages(SomCommandListener listener)
String	mailboxName()
String	mailboxPath()
Integer	numMessages()
Integer	numP3Associations()
Integer	numP7Associations()
Integer	numReports()
Integer	numSubmittedMessages()
Integer	numUnreadHighPriority()
Integer	numUnreadLowPriority()
Integer	numUnreadMediumPriority()
String	orAddress()
void	paste(SomCommandListener listener, String sourceMailbox, Integer sourceMessage)
void	rebuildStatistics(SomCommandListener listener)
void	refresh(SomCommandListener listener)
void	registerAutoAction(SomCommandListener listener, com.isode.asn.modules.MS.AutoActionRegistration reg)
void	removeFromArray(ArrayList<SomPumiceMailbox> mailboxes)
void	tidy(SomCommandListener listener, SomUtcTime since, SomPumiceMailbox.EntryState entryState, SomPumiceMailbox.EntryClass entryClass)
Integer	volMessages()
Integer	volSubmittedMessages()

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 Details

SomPumiceMailbox

public SomPumiceMailbox(SomPumiceSession session,
 String mName)

Create a new mailbox object, with the specified name

Parameters:

session - Session within which mailbox exists

mName - name of mailbox (string encoded ORAddress)

SomPumiceMailbox

public SomPumiceMailbox(SomPumiceSession session,
 String m,
 String[] pairs)

Create a new mailbox object, with the specified name and populate from type/value pairs

Parameters:

session - Session within which mailbox exists

m - name of mailbox (string encoded ORAddress)

pairs - type/value data pairs

SomPumiceMailbox

public SomPumiceMailbox(SomPumiceSession session,
 String[] pairs)

Create a new mailbox object and populate from type/value pairs

Parameters:

session - Session within which mailbox exists

pairs - type/value data pairs

Method Details

mailboxName

public String mailboxName()

removeFromArray

public void removeFromArray(ArrayList<SomPumiceMailbox> mailboxes)

getMessages

public SomPumiceMessage[] getMessages()

handleResponse

public void handleResponse(SomCommand command,
 int status,
 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 command,
 int status,
 SomPumiceConnection object)

Specified by:

handleResponse in interface SomPumiceHandler

handleResponse

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

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,
 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,
 String[] pairs)

Specified by:

handleResponse in interface SomPumiceHandler

refresh

public void refresh(SomCommandListener listener)
             throws SomException

Throws:

SomException

listMessages

public void listMessages(SomCommandListener listener)
                  throws SomException

Throws:

SomException

rebuildStatistics

public void rebuildStatistics(SomCommandListener listener)
                       throws SomException

Throws:

SomException

backup

public void backup(SomCommandListener listener,
 String dest)
            throws SomException

Throws:

SomException

paste

public void paste(SomCommandListener listener,
 String sourceMailbox,
 Integer sourceMessage)
           throws SomException

Throws:

SomException

tidy

public void tidy(SomCommandListener listener,
 SomUtcTime since,
 SomPumiceMailbox.EntryState entryState,
 SomPumiceMailbox.EntryClass entryClass)
          throws SomException

Throws:

SomException

buildInfoString

public String buildInfoString()

mailboxPath

public String mailboxPath()
                   throws SomException

Throws:

SomException

orAddress

public String orAddress()
                 throws SomException

Throws:

SomException

autoActionsString

public String autoActionsString()
                         throws Exception

Throws:

Exception

autoActions

public com.isode.asn.modules.MS.AutoActionRegistrations autoActions()
                                                             throws Exception

Throws:

Exception

registerAutoAction

public void registerAutoAction(SomCommandListener listener,
 com.isode.asn.modules.MS.AutoActionRegistration reg)
                        throws Exception

Throws:

Exception

deregisterAutoAction

public void deregisterAutoAction(SomCommandListener listener,
 com.isode.asn.modules.MS.AutoActionRegistration reg)
                          throws Exception

Throws:

Exception

numMessages

public Integer numMessages()
                    throws SomException

Throws:

SomException

numSubmittedMessages

public Integer numSubmittedMessages()
                             throws SomException

Throws:

SomException

numReports

public Integer numReports()
                   throws SomException

Throws:

SomException

volMessages

public Integer volMessages()
                    throws SomException

Throws:

SomException

volSubmittedMessages

public Integer volSubmittedMessages()
                             throws SomException

Throws:

SomException

numP7Associations

public Integer numP7Associations()
                          throws SomException

Throws:

SomException

numP3Associations

public Integer numP3Associations()
                          throws SomException

Throws:

SomException

numUnreadLowPriority

public Integer numUnreadLowPriority()
                             throws SomException

Throws:

SomException

numUnreadMediumPriority

public Integer numUnreadMediumPriority()
                                throws SomException

Throws:

SomException

numUnreadHighPriority

public Integer numUnreadHighPriority()
                              throws SomException

Throws:

SomException

errorCount

public Integer errorCount()
                   throws SomException

Throws:

SomException

lastBindTime

public String lastBindTime()
                    throws SomException

Throws:

SomException

lastOpType

public String lastOpType()
                  throws SomException

Throws:

SomException

lastOpTime

public String lastOpTime()
                  throws SomException

Throws:

SomException

ageoldest

public String ageoldest()
                 throws SomException

Throws:

SomException