Interface WebSubject

All Superinterfaces:
RequestPairSource, org.apache.shiro.subject.Subject
All Known Implementing Classes:
WebDelegatingSubject

public interface WebSubject extends org.apache.shiro.subject.Subject, RequestPairSource
A WebSubject represents a Subject instance that was acquired as a result of an incoming ServletRequest.
Since:
1.0
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    A WebSubject.Builder performs the same function as a Subject.Builder, but additionally ensures that the Servlet request/response pair that is triggering the Subject instance's creation is retained for use by internal Shiro components as necessary.
  • Method Summary

    Modifier and Type
    Method
    Description
    javax.servlet.ServletRequest
    Returns the ServletRequest accessible when the Subject instance was created.
    javax.servlet.ServletResponse
    Returns the ServletResponse accessible when the Subject instance was created.

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

    associateWith, associateWith, checkPermission, checkPermission, checkPermissions, checkPermissions, checkRole, checkRoles, checkRoles, execute, execute, getPreviousPrincipals, getPrincipal, getPrincipals, getSession, getSession, hasAllRoles, hasRole, hasRoles, isAuthenticated, isPermitted, isPermitted, isPermitted, isPermitted, isPermittedAll, isPermittedAll, isRemembered, isRunAs, login, logout, releaseRunAs, runAs
  • Method Details

    • getServletRequest

      javax.servlet.ServletRequest getServletRequest()
      Returns the ServletRequest accessible when the Subject instance was created.
      Specified by:
      getServletRequest in interface RequestPairSource
      Returns:
      the ServletRequest accessible when the Subject instance was created.
    • getServletResponse

      javax.servlet.ServletResponse getServletResponse()
      Returns the ServletResponse accessible when the Subject instance was created.
      Specified by:
      getServletResponse in interface RequestPairSource
      Returns:
      the ServletResponse accessible when the Subject instance was created.