| <!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:44 EST 2014 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| AnnotationMethodInterceptor (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="AnnotationMethodInterceptor (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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnnotationMethodInterceptor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/aop/AnnotationMethodInterceptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AnnotationMethodInterceptor.html" target="_top"><B>NO FRAMES</B></A> |
| <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> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.aop</FONT> |
| <BR> |
| Class AnnotationMethodInterceptor</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/shiro/aop/MethodInterceptorSupport.html" title="class in org.apache.shiro.aop">org.apache.shiro.aop.MethodInterceptorSupport</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.aop.AnnotationMethodInterceptor</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/shiro/aop/MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationMethodInterceptor</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.33"><B>AnnotationMethodInterceptor</B></A><DT>extends <A HREF="../../../../org/apache/shiro/aop/MethodInterceptorSupport.html" title="class in org.apache.shiro.aop">MethodInterceptorSupport</A></DL> |
| </PRE> |
| |
| <P> |
| MethodInterceptor that inspects a specific annotation on the method invocation before continuing |
| its execution. |
| </p> |
| The annotation is acquired from the <A HREF="../../../../org/apache/shiro/aop/MethodInvocation.html" title="interface in org.apache.shiro.aop"><CODE>MethodInvocation</CODE></A> via a |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop"><CODE>AnnotationResolver</CODE></A> instance that may be configured. Unless |
| overridden, the default <code>AnnotationResolver</code> is a |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#AnnotationMethodInterceptor(org.apache.shiro.aop.AnnotationHandler)">AnnotationMethodInterceptor</A></B>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler)</CODE> |
| |
| <BR> |
| Constructs an <code>AnnotationMethodInterceptor</code> with the |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><CODE>AnnotationHandler</CODE></A> that will be used to process annotations of a |
| corresponding type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#AnnotationMethodInterceptor(org.apache.shiro.aop.AnnotationHandler, org.apache.shiro.aop.AnnotationResolver)">AnnotationMethodInterceptor</A></B>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler, |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A> resolver)</CODE> |
| |
| <BR> |
| Constructs an <code>AnnotationMethodInterceptor</code> with the |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><CODE>AnnotationHandler</CODE></A> that will be used to process annotations of a |
| corresponding type, using the specified <code>AnnotationResolver</code> to acquire annotations |
| at runtime.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getAnnotation(org.apache.shiro.aop.MethodInvocation)">getAnnotation</A></B>(<A HREF="../../../../org/apache/shiro/aop/MethodInvocation.html" title="interface in org.apache.shiro.aop">MethodInvocation</A> mi)</CODE> |
| |
| <BR> |
| Returns the Annotation that this interceptor will process for the specified method invocation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getHandler()">getHandler</A></B>()</CODE> |
| |
| <BR> |
| Returns the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getResolver()">getResolver</A></B>()</CODE> |
| |
| <BR> |
| Returns the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#setHandler(org.apache.shiro.aop.AnnotationHandler)">setHandler</A></B>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler)</CODE> |
| |
| <BR> |
| Sets the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#setResolver(org.apache.shiro.aop.AnnotationResolver)">setResolver</A></B>(<A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A> resolver)</CODE> |
| |
| <BR> |
| Returns the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#supports(org.apache.shiro.aop.MethodInvocation)">supports</A></B>(<A HREF="../../../../org/apache/shiro/aop/MethodInvocation.html" title="interface in org.apache.shiro.aop">MethodInvocation</A> mi)</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this interceptor supports, that is, should inspect, the specified |
| <code>MethodInvocation</code>, <code>false</code> otherwise.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.aop.MethodInterceptorSupport"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.aop.<A HREF="../../../../org/apache/shiro/aop/MethodInterceptorSupport.html" title="class in org.apache.shiro.aop">MethodInterceptorSupport</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/shiro/aop/MethodInterceptorSupport.html#getSubject()">getSubject</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.aop.MethodInterceptor"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.shiro.aop.<A HREF="../../../../org/apache/shiro/aop/MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/shiro/aop/MethodInterceptor.html#invoke(org.apache.shiro.aop.MethodInvocation)">invoke</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AnnotationMethodInterceptor(org.apache.shiro.aop.AnnotationHandler)"><!-- --></A><H3> |
| AnnotationMethodInterceptor</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.51"><B>AnnotationMethodInterceptor</B></A>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler)</PRE> |
| <DL> |
| <DD>Constructs an <code>AnnotationMethodInterceptor</code> with the |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><CODE>AnnotationHandler</CODE></A> that will be used to process annotations of a |
| corresponding type. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>handler</CODE> - the handler to delegate to for processing the annotation.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="AnnotationMethodInterceptor(org.apache.shiro.aop.AnnotationHandler, org.apache.shiro.aop.AnnotationResolver)"><!-- --></A><H3> |
| AnnotationMethodInterceptor</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.65"><B>AnnotationMethodInterceptor</B></A>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler, |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A> resolver)</PRE> |
| <DL> |
| <DD>Constructs an <code>AnnotationMethodInterceptor</code> with the |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><CODE>AnnotationHandler</CODE></A> that will be used to process annotations of a |
| corresponding type, using the specified <code>AnnotationResolver</code> to acquire annotations |
| at runtime. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>handler</CODE> - the handler to use to process any discovered annotation<DD><CODE>resolver</CODE> - the resolver to use to locate/acquire the annotation<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getHandler()"><!-- --></A><H3> |
| getHandler</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.80"><B>getHandler</B></A>()</PRE> |
| <DL> |
| <DD>Returns the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHandler(org.apache.shiro.aop.AnnotationHandler)"><!-- --></A><H3> |
| setHandler</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.91"><B>setHandler</B></A>(<A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop">AnnotationHandler</A> handler)</PRE> |
| <DL> |
| <DD>Sets the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>handler</CODE> - the <code>AnnotationHandler</code> used to perform authorization behavior based on |
| an annotation discovered at runtime.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResolver()"><!-- --></A><H3> |
| getResolver</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A> <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.104"><B>getResolver</B></A>()</PRE> |
| <DL> |
| <DD>Returns the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime. The annotation is then used by the <A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getHandler()"><CODE>handler</CODE></A> to |
| perform authorization logic. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime.<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResolver(org.apache.shiro.aop.AnnotationResolver)"><!-- --></A><H3> |
| setResolver</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.117"><B>setResolver</B></A>(<A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop">AnnotationResolver</A> resolver)</PRE> |
| <DL> |
| <DD>Returns the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime. The annotation is then used by the <A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getHandler()"><CODE>handler</CODE></A> to |
| perform authorization logic. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>resolver</CODE> - the <code>AnnotationResolver</code> to use to acquire annotations from intercepted |
| methods at runtime.<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supports(org.apache.shiro.aop.MethodInvocation)"><!-- --></A><H3> |
| supports</H3> |
| <PRE> |
| public boolean <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.133"><B>supports</B></A>(<A HREF="../../../../org/apache/shiro/aop/MethodInvocation.html" title="interface in org.apache.shiro.aop">MethodInvocation</A> mi)</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this interceptor supports, that is, should inspect, the specified |
| <code>MethodInvocation</code>, <code>false</code> otherwise. |
| <p/> |
| The default implementation simply does the following: |
| <p/> |
| <code>return <A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getAnnotation(org.apache.shiro.aop.MethodInvocation)"><CODE>getAnnotation(mi)</CODE></A> != null</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mi</CODE> - the <code>MethodInvocation</code> for the method being invoked. |
| <DT><B>Returns:</B><DD><code>true</code> if this interceptor supports, that is, should inspect, the specified |
| <code>MethodInvocation</code>, <code>false</code> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAnnotation(org.apache.shiro.aop.MethodInvocation)"><!-- --></A><H3> |
| getAnnotation</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</A> <A HREF="../../../../src-html/org/apache/shiro/aop/AnnotationMethodInterceptor.html#line.147"><B>getAnnotation</B></A>(<A HREF="../../../../org/apache/shiro/aop/MethodInvocation.html" title="interface in org.apache.shiro.aop">MethodInvocation</A> mi)</PRE> |
| <DL> |
| <DD>Returns the Annotation that this interceptor will process for the specified method invocation. |
| <p/> |
| The default implementation acquires the annotation using an annotation |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getResolver()"><CODE>resolver</CODE></A> using the internal annotation <A HREF="../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html#getHandler()"><CODE>handler</CODE></A>'s |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html#getAnnotationClass()"><CODE>annotationClass</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mi</CODE> - the MethodInvocation wrapping the Method from which the Annotation will be acquired. |
| <DT><B>Returns:</B><DD>the Annotation that this interceptor will process for the specified method invocation.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnnotationMethodInterceptor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationHandler.html" title="class in org.apache.shiro.aop"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/shiro/aop/AnnotationResolver.html" title="interface in org.apache.shiro.aop"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/aop/AnnotationMethodInterceptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AnnotationMethodInterceptor.html" target="_top"><B>NO FRAMES</B></A> |
| <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> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
