| <!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.5.0_22) on Fri Jan 20 11:50:22 EST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| CrossOriginResourceSharing (Apache CXF Bundle Jar 2.5.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cxf.jaxrs.cors.CrossOriginResourceSharing class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="CrossOriginResourceSharing (Apache CXF Bundle Jar 2.5.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/CrossOriginResourceSharing.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> |
| Apache CXF API</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CorsHeaderConstants.html" title="class in org.apache.cxf.jaxrs.cors"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharingFilter.html" title="class in org.apache.cxf.jaxrs.cors"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CrossOriginResourceSharing.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</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.cxf.jaxrs.cors</FONT> |
| <BR> |
| Annotation Type CrossOriginResourceSharing</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html#value()" title="class or interface in java.lang.annotation">value</A>={<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation">TYPE</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation">METHOD</A>}) |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Inherited.html" title="class or interface in java.lang.annotation">@Inherited</A> |
| </FONT>public @interface <B>CrossOriginResourceSharing</B></DL> |
| </PRE> |
| |
| <P> |
| Attach <a href="http://www.w3.org/TR/cors/">CORS</a> information |
| to a resource. This annotation is read by <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharingFilter.html" title="class in org.apache.cxf.jaxrs.cors"><CODE>CrossOriginResourceSharingFilter</CODE></A>. |
| If this annotation is present on a method, or |
| on the method's class (or its superclasses), then it completely |
| overrides any parameters set in <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharingFilter.html" title="class in org.apache.cxf.jaxrs.cors"><CODE>CrossOriginResourceSharingFilter</CODE></A>. |
| If a particular parameter of this annotation is not specified, then the |
| default value is used, <em>not</em> the parameters of the filter. |
| |
| Note that the CORS specification censors the headers on a |
| preflight OPTIONS request. As a result, the filter cannot determine |
| exactly which method corresponds to the request, and so uses only |
| class-level annotations to set policies. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| |
| <A NAME="annotation_type_optional_element_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>Optional Element Summary</B></FONT></TH> |
| </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/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowAllOrigins()">allowAllOrigins</A></B></CODE> |
| |
| <BR> |
| If true, this resource will return</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/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowAnyHeaders()">allowAnyHeaders</A></B></CODE> |
| |
| <BR> |
| Act as if whatever headers are listed in the Access-Control-Request-Headers are |
| listed in allowHeaders.</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/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowCredentials()">allowCredentials</A></B></CODE> |
| |
| <BR> |
| If true, this resource will return</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowHeaders()">allowHeaders</A></B></CODE> |
| |
| <BR> |
| A list of headers that the client may include |
| in an actual request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowOrigins()">allowOrigins</A></B></CODE> |
| |
| <BR> |
| A list of permitted origins.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html#exposeHeaders()">exposeHeaders</A></B></CODE> |
| |
| <BR> |
| A list of headers to return in <tt> |
| Access-Control-Expose-Headers</tt>.</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/cxf/jaxrs/cors/CrossOriginResourceSharing.html#localPreflight()">localPreflight</A></B></CODE> |
| |
| <BR> |
| Controls the implementation of preflight processing |
| on an OPTIONS method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html#maxAge()">maxAge</A></B></CODE> |
| |
| <BR> |
| The value to return in <tt>Access-Control-Max-Age</tt>.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| <A NAME="allowAllOrigins()"><!-- --></A><H3> |
| allowAllOrigins</H3> |
| <PRE> |
| public abstract boolean <B>allowAllOrigins</B></PRE> |
| <DL> |
| <DD>If true, this resource will return |
| <pre>Access-Control-Allow-Origin: *</pre> |
| for a valid request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>false</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allowOrigins()"><!-- --></A><H3> |
| allowOrigins</H3> |
| <PRE> |
| public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>allowOrigins</B></PRE> |
| <DL> |
| <DD>A list of permitted origins. This is ignored |
| if <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html#allowAllOrigins()"><CODE>allowAllOrigins()</CODE></A> is true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allowHeaders()"><!-- --></A><H3> |
| allowHeaders</H3> |
| <PRE> |
| public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>allowHeaders</B></PRE> |
| <DL> |
| <DD>A list of headers that the client may include |
| in an actual request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allowAnyHeaders()"><!-- --></A><H3> |
| allowAnyHeaders</H3> |
| <PRE> |
| public abstract boolean <B>allowAnyHeaders</B></PRE> |
| <DL> |
| <DD>Act as if whatever headers are listed in the Access-Control-Request-Headers are |
| listed in allowHeaders. Convenient for dealing with Browser bugs. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>false</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allowCredentials()"><!-- --></A><H3> |
| allowCredentials</H3> |
| <PRE> |
| public abstract boolean <B>allowCredentials</B></PRE> |
| <DL> |
| <DD>If true, this resource will return |
| <pre>Access-Control-Allow-Credentials: true</pre> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>false</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="exposeHeaders()"><!-- --></A><H3> |
| exposeHeaders</H3> |
| <PRE> |
| public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>exposeHeaders</B></PRE> |
| <DL> |
| <DD>A list of headers to return in <tt> |
| Access-Control-Expose-Headers</tt>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="maxAge()"><!-- --></A><H3> |
| maxAge</H3> |
| <PRE> |
| public abstract int <B>maxAge</B></PRE> |
| <DL> |
| <DD>The value to return in <tt>Access-Control-Max-Age</tt>. |
| If this is negative, then no header is returned. The default |
| value is -1. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>-1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="localPreflight()"><!-- --></A><H3> |
| localPreflight</H3> |
| <PRE> |
| public abstract boolean <B>localPreflight</B></PRE> |
| <DL> |
| <DD>Controls the implementation of preflight processing |
| on an OPTIONS method. |
| If the current method is OPTIONS, and this method wants to |
| handle the preflight process for itself, set this value to |
| <tt>true</tt>. In the default, false, case, the filter |
| performs preflight processing. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>false</DD> |
| </DL> |
| </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/CrossOriginResourceSharing.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> |
| Apache CXF API</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CorsHeaderConstants.html" title="class in org.apache.cxf.jaxrs.cors"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/cxf/jaxrs/cors/CrossOriginResourceSharingFilter.html" title="class in org.apache.cxf.jaxrs.cors"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cxf/jaxrs/cors/CrossOriginResourceSharing.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CrossOriginResourceSharing.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Apache CXF |
| </BODY> |
| </HTML> |
