SessionHandler (Mule ESB 2.2.1 API)
Keywords: org.mule.api.transport.SessionHandler interface

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.mule.api.transport
Interface SessionHandler

All Known Implementing Classes:
  HttpSessionHandler, MuleSessionHandler, NullSessionHandler

    public interface SessionHandler

An interface used for reading and writing session information to and from the current message.

Method Summary
`String` | `getSessionIDKey()` The property name of the session id to use when creating the Mule session.
`void` | `retrieveSessionInfoFromMessage(MuleMessage message, MuleSession session)`
`void` | `storeSessionInfoToMessage(MuleSession session, MuleMessage message)`

Method Detail

### storeSessionInfoToMessage

    void storeSessionInfoToMessage(MuleSession session,
                                   MuleMessage message)
                                   throws MuleException

  Throws:
    `MuleException`

### retrieveSessionInfoFromMessage

    void retrieveSessionInfoFromMessage(MuleMessage message,
                                        MuleSession session)
                                        throws MuleException

  Throws:
    `MuleException`

### getSessionIDKey

    String getSessionIDKey()

  The property name of the session id to use when creating the Mule session. by default the property name "ID" will be used. If no property was set on the session called "ID" a session id will be automatically generated

  Returns:
    the property name of the session id that is set on the session

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.