Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.3 / apidocs / org / apache / shiro / authz / aop / package-summary.html
blob: cbe393698a3808807a2110f47653f163ff9a1a0c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:15:54 EST 2014 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.apache.shiro.authz.aop (Apache Shiro 1.2.3 API)
</TITLE>
<META NAME="date" CONTENT="2014-02-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.shiro.authz.aop (Apache Shiro 1.2.3 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/shiro/authz/annotation/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/shiro/authz/permission/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/shiro/authz/aop/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.apache.shiro.authz.aop
</H2>
Contains AOP implementation support classes specifically used for authorization operations, particularly supporting
AOP Method Interceptors and JSR-175 metadata Annotations.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AnnotationsAuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AnnotationsAuthorizingMethodInterceptor</A></B></TD>
<TD>An <tt>AnnotationsAuthorizingMethodInterceptor</tt> is a MethodInterceptor that asserts a given method is authorized
to execute based on one or more configured <tt>AuthorizingAnnotationMethodInterceptor</tt>s.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AuthenticatedAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">AuthenticatedAnnotationHandler</A></B></TD>
<TD>Handles <A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresAuthentication.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresAuthentication</CODE></A> annotations and ensures the calling subject is
authenticated before allowing access.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AuthenticatedAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthenticatedAnnotationMethodInterceptor</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresAuthentication.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresAuthenticated</CODE></A> annotation
is declared, and if so, ensures the calling
<code>Subject</code>.<A HREF="../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated()"><CODE>isAuthenticated()</CODE></A> before invoking
the method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationHandler</A></B></TD>
<TD>An AnnotationHandler that executes authorization (access control) behavior based on directive(s) found in a
JSR-175 Annotation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationMethodInterceptor</A></B></TD>
<TD>An <tt>AnnotationMethodInterceptor</tt> that asserts the calling code is authorized to execute the method
before allowing the invocation to continue by inspecting code annotations to perform an access control check.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/AuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingMethodInterceptor</A></B></TD>
<TD>Basic abstract class to support intercepting methods that perform authorization (access control) checks.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/GuestAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">GuestAnnotationHandler</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresGuest.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresGuest</CODE></A> annotation
is declared, and if so, ensures the calling <code>Subject</code> does <em>not</em>
have an <A HREF="../../../../../org/apache/shiro/subject/Subject.html#getPrincipal()"><CODE>identity</CODE></A> before invoking the method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/GuestAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">GuestAnnotationMethodInterceptor</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresGuest.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresGuest</CODE></A> annotation
is declared, and if so, ensures the calling <code>Subject</code> does <em>not</em>
have an <A HREF="../../../../../org/apache/shiro/subject/Subject.html#getPrincipal()"><CODE>identity</CODE></A> before invoking the method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">PermissionAnnotationHandler</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresPermissions.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresPermissions</CODE></A> annotation is
declared, and if so, performs a permission check to see if the calling <code>Subject</code> is allowed continued
access.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">PermissionAnnotationMethodInterceptor</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresPermissions.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresPermissions</CODE></A> annotation is declared, and if so, performs
a permission check to see if the calling <code>Subject</code> is allowed to call the method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/RoleAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">RoleAnnotationHandler</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresRoles.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresRoles</CODE></A> annotation is declared, and if so, performs
a role check to see if the calling <code>Subject</code> is allowed to proceed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/RoleAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">RoleAnnotationMethodInterceptor</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresRoles.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresRoles</CODE></A> annotation is declared, and if so, performs
a role check to see if the calling <code>Subject</code> is allowed to invoke the method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/UserAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">UserAnnotationHandler</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresUser.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresUser</CODE></A> annotation
is declared, and if so, ensures the calling <code>Subject</code> is <em>either</em>
<A HREF="../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated()"><CODE>authenticated</CODE></A> <b><em>or</em></b> remembered via remember
me services before allowing access.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/shiro/authz/aop/UserAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">UserAnnotationMethodInterceptor</A></B></TD>
<TD>Checks to see if a @<A HREF="../../../../../org/apache/shiro/authz/annotation/RequiresUser.html" title="annotation in org.apache.shiro.authz.annotation"><CODE>RequiresUser</CODE></A> annotation
is declared, and if so, ensures the calling <code>Subject</code> is <em>either</em>
<A HREF="../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated()"><CODE>authenticated</CODE></A> <b><em>or</em></b> remembered via remember
me services before invoking the method.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.apache.shiro.authz.aop Description
</H2>
<P>
Contains AOP implementation support classes specifically used for authorization operations, particularly supporting
AOP Method Interceptors and JSR-175 metadata Annotations.
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/shiro/authz/annotation/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/shiro/authz/permission/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/shiro/authz/aop/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>