org.apache.shiro.web.subject
Interface WebSubjectContext

All Superinterfaces:
Map<String,Object>, RequestPairSource, SubjectContext
All Known Implementing Classes:
DefaultWebSubjectContext

public interface WebSubjectContext
extends 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
 ServletRequest getServletRequest()
          Returns the ServletRequest received by the servlet container triggering the creation of the Subject instance.
 ServletResponse getServletResponse()
          The paired ServletResponse corresponding to the associated servletRequest.
 ServletRequest resolveServletRequest()
           
 ServletResponse resolveServletResponse()
           
 void setServletRequest(ServletRequest request)
          Sets the ServletRequest received by the servlet container triggering the creation of the Subject instance.
 void setServletResponse(ServletResponse response)
          Sets the paired ServletResponse corresponding to the associated servletRequest.
 
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
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

getServletRequest

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(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

ServletRequest resolveServletRequest()

getServletResponse

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(ServletResponse response)
Sets the paired ServletResponse corresponding to the associated servletRequest.

Parameters:
response - The paired ServletResponse corresponding to the associated servletRequest.

resolveServletResponse

ServletResponse resolveServletResponse()


Copyright © 2004-2014 The Apache Software Foundation. All Rights Reserved.