View Javadoc
1   /*
2    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
3    * The software in this package is published under the terms of the CPAL v1.0
4    * license, a copy of which has been included with this distribution in the
5    * LICENSE.txt file.
6    */
7   package org.mule.session;
8   
9   import org.mule.api.MuleException;
10  import org.mule.api.MuleMessage;
11  import org.mule.api.MuleSession;
12  import org.mule.api.transport.SessionHandler;
13  
14  /**
15   * A session handler that ignores any session information
16   */
17  public class NullSessionHandler implements SessionHandler
18  {
19      public MuleSession retrieveSessionInfoFromMessage(MuleMessage message) throws MuleException
20      {
21          return null;
22      }
23  
24      /**
25       * @deprecated Use retrieveSessionInfoFromMessage(MuleMessage message) instead
26       */
27      @Deprecated
28      public void retrieveSessionInfoFromMessage(MuleMessage message, MuleSession session) throws MuleException
29      {
30          retrieveSessionInfoFromMessage(message);
31      }
32  
33      public void storeSessionInfoToMessage(MuleSession session, MuleMessage message) throws MuleException
34      {
35          // noop
36      }
37  
38      /**
39       * The property name of the session id to use when creating the Mule session. by
40       * default the property name "ID" will be used. If no property was set on the
41       * session called "ID" a session id will be automatically generated
42       * 
43       * @return the property name of the session id that is set on the session
44       */
45      public String getSessionIDKey()
46      {
47          return "ID";
48      }
49  }