org.jboss.weld.context.bound.BoundRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weld-api Show documentation

Weld specifc extensions to the CDI API

The newest version!

package org.jboss.weld.context.bound;

import java.util.Map;

/**
 * 
 * A conversation is used to span multiple requests, however is shorter than a session. The {@link BoundConversationContext}
 * uses one Map to represent a request, and a second to represent the session, which are encapsulated in a {@link BoundRequest}.
 * 
 *
 * @author Pete Muir
 *
 */
public interface BoundRequest {

    /**
     * Get the current request map.
     *
     * @return the request map.
     */
    Map getRequestMap();

    /**
     * 
     * Get the current session map.
     * 
     *
     * 
     * A {@link BoundRequest} may be backed by a data store that only creates sessions on demand. It is recommended that if the
     * session is not created on demand, or that the session has already been created (but is not required by this access) that
     * the session is returned as it allows the conversation context to work more efficiently.
     * 
     *
     * @param create if true, then a session must be created
     * @return the session map; null may be returned if create is false
     */
    Map getSessionMap(boolean create);

}