1 /* 2 * $Id: SessionHandler.java 10489 2008-01-23 17:53:38Z dfeist $ 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 CPAL v1.0 7 * license, a copy of which has been included with this distribution in the 8 * LICENSE.txt file. 9 */ 10 11 package org.mule.api.transport; 12 13 import org.mule.api.MuleException; 14 import org.mule.api.MuleMessage; 15 import org.mule.api.MuleSession; 16 17 /** 18 * An interface used for reading and writing session information to and from the 19 * current message. 20 */ 21 public interface SessionHandler 22 { 23 24 void storeSessionInfoToMessage(MuleSession session, MuleMessage message) throws MuleException; 25 26 void retrieveSessionInfoFromMessage(MuleMessage message, MuleSession session) throws MuleException; 27 28 /** 29 * The property name of the session id to use when creating the Mule session. by 30 * default the property name "ID" will be used. If no property was set on the 31 * session called "ID" a session id will be automatically generated 32 * 33 * @return the property name of the session id that is set on the session 34 */ 35 String getSessionIDKey(); 36 }