KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mule > umo > provider > UMOSessionHandler


1 /*
2  * $Id: UMOSessionHandler.java 3798 2006-11-04 04:07:14Z aperepel $
3  * --------------------------------------------------------------------------------------
4  * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
5  *
6  * The software in this package is published under the terms of the MuleSource MPL
7  * license, a copy of which has been included with this distribution in the
8  * LICENSE.txt file.
9  */
10
11 package org.mule.umo.provider;
12
13 import org.mule.umo.UMOException;
14 import org.mule.umo.UMOMessage;
15 import org.mule.umo.UMOSession;
16
17 /**
18  * An interface used for reading and writing session information to and from the
19  * current message.
20  *
21  * @author <a HREF="mailto:ross.mason@symphonysoft.com">Ross Mason</a>
22  * @version $Revision: 3798 $
23  */
24 public interface UMOSessionHandler
25 {
26
27     public void storeSessionInfoToMessage(UMOSession session, UMOMessage message) throws UMOException;
28
29     public void retrieveSessionInfoFromMessage(UMOMessage message, UMOSession session) throws UMOException;
30
31     /**
32      * The property name of the session id to use when creating the Mule session. by
33      * default the property name "ID" will be used. If no property was set on the
34      * session called "ID" a session id will be automatically generated
35      *
36      * @return the property name of the session id that is set on the session
37      */
38     public String JavaDoc getSessionIDKey();
39 }
40
Popular Tags