Package com.levigo.jadice.web.transport.server

Class TransportInvocationContext

java.lang.Object

com.levigo.jadice.web.server.internal.AbstractInvocationContext

com.levigo.jadice.web.transport.server.TransportInvocationContext

All Implemented Interfaces:

InvocationContext, ServletInvocationContext

public class TransportInvocationContext
extends com.levigo.jadice.web.server.internal.AbstractInvocationContext
implements ServletInvocationContext

This is the invocation context of the adaptive transport layer utilizing implementations to obtain the HttpSession and optionally the HttpServletRequest.

Constructor Summary

Constructors

Constructor	Description
TransportInvocationContext(jakarta.servlet.http.HttpSession httpSession, Principal userPrincipal, com.levigo.jadice.web.transport.server.session.internal.MessageClient client)	Creates a TransportInvocationContext containing the HttpSession and the HttpServletRequest.

Method Summary

Modifier and Type	Method	Description
String	getClientId()
String	getQueryString()
jakarta.servlet.http.HttpSession	getSession()	Returns the associated HttpSession if available.
String	getSessionId()	Returns a session-id if the Context contains session information.
Principal	getUserPrincipal()	Returns the Principal identifying the user sending the message.

Methods inherited from class com.levigo.jadice.web.server.internal.AbstractInvocationContext

create, ensureValid, isValid, setValid

Methods inherited from class java.lang.Object

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

Constructor Details

TransportInvocationContext

public TransportInvocationContext(jakarta.servlet.http.HttpSession httpSession,
 Principal userPrincipal,
 com.levigo.jadice.web.transport.server.session.internal.MessageClient client)

Creates a TransportInvocationContext containing the HttpSession and the HttpServletRequest.

Parameters:

httpSession - The HTTP-session of the invocation.

client -

Method Details

getSession

public jakarta.servlet.http.HttpSession getSession()
                                            throws IllegalStateException

Description copied from interface: ServletInvocationContext

Returns the associated HttpSession if available.

This method must be called within the ContextualFactory.create(com.levigo.jadice.web.server.InvocationContext) method. Later calls result in an IllegalStateException.

Specified by:

getSession in interface ServletInvocationContext

Returns:

the associated HttpSession for the current request.

Throws:

IllegalStateException

getUserPrincipal

public Principal getUserPrincipal()

Description copied from interface: ServletInvocationContext

Returns the Principal identifying the user sending the message.

Specified by:

getUserPrincipal in interface ServletInvocationContext

Returns:

the user Principal

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface ServletInvocationContext

getClientId

public String getClientId()

Specified by:

getClientId in interface InvocationContext

getSessionId

public String getSessionId()

Description copied from class: com.levigo.jadice.web.server.internal.AbstractInvocationContext

Returns a session-id if the Context contains session information.

Overrides:

getSessionId in class com.levigo.jadice.web.server.internal.AbstractInvocationContext

Returns:

session id or null if no session is available