01: /*
02: * $Id: SessionHandler.java 10489 2008-01-23 17:53:38Z dfeist $
03: * --------------------------------------------------------------------------------------
04: * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
05: *
06: * The software in this package is published under the terms of the CPAL v1.0
07: * license, a copy of which has been included with this distribution in the
08: * LICENSE.txt file.
09: */
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: void storeSessionInfoToMessage(MuleSession session,
24: MuleMessage message) throws MuleException;
25:
26: void retrieveSessionInfoFromMessage(MuleMessage message,
27: MuleSession session) throws MuleException;
28:
29: /**
30: * The property name of the session id to use when creating the Mule session. by
31: * default the property name "ID" will be used. If no property was set on the
32: * session called "ID" a session id will be automatically generated
33: *
34: * @return the property name of the session id that is set on the session
35: */
36: String getSessionIDKey();
37: }
|