Package org.springframework.web.context.request

Class SessionScope

    • Method Detail

      • getConversationId

        public String getConversationId()
        Description copied from interface: Scope
        Return the conversation ID for the current underlying scope, if any.

        The exact meaning of the conversation ID depends on the underlying storage mechanism. In the case of session-scoped objects, the conversation ID would typically be equal to (or derived from) the session ID; in the case of a custom conversation that sits within the overall session, the specific ID for the current conversation would be appropriate.

        Note: This is an optional operation. It is perfectly valid to return null in an implementation of this method if the underlying storage mechanism has no obvious candidate for such an ID.

        Returns:
        the conversation ID, or null if there is no conversation ID for the current scope

      • get

        public Object get​(String name,
                  ObjectFactory<?> objectFactory)
        Description copied from interface: Scope
        Return the object with the given name from the underlying scope, creating it if not found in the underlying storage mechanism.

        This is the central operation of a Scope, and the only operation that is absolutely required.

        Specified by:
        get in interface Scope
        Overrides:
        get in class AbstractRequestAttributesScope
        Parameters:
        name - the name of the object to retrieve
        objectFactory - the ObjectFactory to use to create the scoped object if it is not present in the underlying storage mechanism
        Returns:
        the desired object (never null)

      • remove

        @Nullable
public Object remove​(String name)
        Description copied from interface: Scope
        Remove the object with the given name from the underlying scope.

        Returns null if no object was found; otherwise returns the removed Object.

        Note that an implementation should also remove a registered destruction callback for the specified object, if any. It does, however, not need to execute a registered destruction callback in this case, since the object will be destroyed by the caller (if appropriate).

        Note: This is an optional operation. Implementations may throw UnsupportedOperationException if they do not support explicitly removing an object.

        Specified by:
        remove in interface Scope
        Overrides:
        remove in class AbstractRequestAttributesScope
        Parameters:
        name - the name of the object to remove
        Returns:
        the removed object, or null if no object was present
        See Also:
        Scope.registerDestructionCallback(java.lang.String, java.lang.Runnable)