Interface WebSubjectContext

All Superinterfaces:

Map<String,Object>, RequestPairSource, org.apache.shiro.subject.SubjectContext

All Known Implementing Classes:

DefaultWebSubjectContext

public interface WebSubjectContext
extends org.apache.shiro.subject.SubjectContext, RequestPairSource

A WebSubjectContext is a SubjectContext that additionally provides for type-safe methods to set and retrieve a ServletRequest and ServletResponse.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
javax.servlet.ServletRequest	getServletRequest()	Returns the ServletRequest received by the servlet container triggering the creation of the Subject instance.
javax.servlet.ServletResponse	getServletResponse()	The paired ServletResponse corresponding to the associated servletRequest.
javax.servlet.ServletRequest	resolveServletRequest()
javax.servlet.ServletResponse	resolveServletResponse()
void	setServletRequest(javax.servlet.ServletRequest request)	Sets the ServletRequest received by the servlet container triggering the creation of the Subject instance.
void	setServletResponse(javax.servlet.ServletResponse response)	Sets the paired ServletResponse corresponding to the associated servletRequest.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.apache.shiro.subject.SubjectContext

getAuthenticationInfo, getAuthenticationToken, getHost, getPrincipals, getSecurityManager, getSession, getSessionId, getSubject, isAuthenticated, isSessionCreationEnabled, resolveAuthenticated, resolveHost, resolvePrincipals, resolveSecurityManager, resolveSession, setAuthenticated, setAuthenticationInfo, setAuthenticationToken, setHost, setPrincipals, setSecurityManager, setSession, setSessionCreationEnabled, setSessionId, setSubject

Method Details

getServletRequest

javax.servlet.ServletRequest getServletRequest()

Returns the ServletRequest received by the servlet container triggering the creation of the Subject instance.

Specified by:

getServletRequest in interface RequestPairSource

Returns:

the ServletRequest received by the servlet container triggering the creation of the Subject instance.

setServletRequest

void setServletRequest(javax.servlet.ServletRequest request)

Sets the ServletRequest received by the servlet container triggering the creation of the Subject instance.

Parameters:

request - the ServletRequest received by the servlet container triggering the creation of the Subject instance.

resolveServletRequest

javax.servlet.ServletRequest resolveServletRequest()

getServletResponse

javax.servlet.ServletResponse getServletResponse()

The paired ServletResponse corresponding to the associated servletRequest.

Specified by:

getServletResponse in interface RequestPairSource

Returns:

the paired ServletResponse corresponding to the associated servletRequest.

setServletResponse

void setServletResponse(javax.servlet.ServletResponse response)

Sets the paired ServletResponse corresponding to the associated servletRequest.

Parameters:

response - The paired ServletResponse corresponding to the associated servletRequest.

resolveServletResponse

javax.servlet.ServletResponse resolveServletResponse()