Package org.jivesoftware.openfire.streammanagement

Class Sasl2ResumeResult

java.lang.Object

org.jivesoftware.openfire.streammanagement.Sasl2ResumeResult

public final class Sasl2ResumeResult
extends Object

Outcome of StreamManager.processSasl2Resume(ResumeRequest): either the <resumed/> element (and the now-resumed session) to embed in a SASL2 <success/> response, or the <failed/> element to embed instead.

Method Summary

Modifier and Type	Method	Description
org.dom4j.Element	getResultElement()	Returns the element (<resumed/> on success, <failed/> otherwise) to embed in the SASL2 <success/> response.
LocalClientSession	getResumedSession()	Returns the session that was resumed.
boolean	isSuccess()	Returns whether the resume request was honored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isSuccess

public boolean isSuccess()

Returns whether the resume request was honored.

Returns:

true if the session was successfully resumed.

getResultElement

@Nonnull
public org.dom4j.Element getResultElement()

Returns the element (<resumed/> on success, <failed/> otherwise) to embed in the SASL2 <success/> response.

Returns:

the result element (never null).

getResumedSession

@Nullable
public LocalClientSession getResumedSession()

Returns the session that was resumed. Only set when isSuccess() returns true. Guaranteed to be non-null when isSuccess() returns true.

Returns:

the resumed session, or null on failure.