View Javadoc

1   /*
2    * $Id: SessionHandler.java 19191 2010-08-25 21:05:23Z tcarlson $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.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      /**
27       * @deprecated Use retrieveSessionInfoFromMessage(MuleMessage message) instead
28       */
29      @Deprecated
30      void retrieveSessionInfoFromMessage(MuleMessage message, MuleSession session) throws MuleException;
31  
32      MuleSession retrieveSessionInfoFromMessage(MuleMessage message) throws MuleException;
33  
34      /**
35       * The property name of the session id to use when creating the Mule session. by
36       * default the property name "ID" will be used. If no property was set on the
37       * session called "ID" a session id will be automatically generated
38       * 
39       * @return the property name of the session id that is set on the session
40       * @deprecated This method is no longer needed and will be removed in the next major release
41       */
42      @Deprecated
43      String getSessionIDKey();
44  }