org.apache.airavata.wsmg.msgbox.Storage
Interface MsgBoxStorage

All Known Implementing Classes:
DatabaseStorageImpl, InMemoryImpl

public interface MsgBoxStorage

Message Box storage backend. This has implemented in two ways in-memory and database.


Method Summary
 String createMsgBox()
           
 void destroyMsgBox(String key)
           
 void dispose()
          Clean up method
 void putMessageIntoMsgBox(String msgBoxID, String messageID, String soapAction, org.apache.axiom.om.OMElement message)
           
 void removeAncientMessages()
          The ancientness is defined in the db.config file.
 List<String> takeMessagesFromMsgBox(String key)
          IMPORTANT::: List retrieved from this method is sorted by time in ascending order i.e the newest message will appear as the last item in the list.
 

Method Detail

createMsgBox

String createMsgBox()
                    throws Exception
Throws:
Exception

destroyMsgBox

void destroyMsgBox(String key)
                   throws Exception
Throws:
Exception

takeMessagesFromMsgBox

List<String> takeMessagesFromMsgBox(String key)
                                    throws Exception
IMPORTANT::: List retrieved from this method is sorted by time in ascending order i.e the newest message will appear as the last item in the list.

Parameters:
key -
Returns:
Throws:
Exception

putMessageIntoMsgBox

void putMessageIntoMsgBox(String msgBoxID,
                          String messageID,
                          String soapAction,
                          org.apache.axiom.om.OMElement message)
                          throws Exception
Throws:
Exception

removeAncientMessages

void removeAncientMessages()
                           throws Exception
The ancientness is defined in the db.config file.

Throws:
Exception

dispose

void dispose()
Clean up method



Copyright © 2011-2012 The Apache Software Foundation. All Rights Reserved.