facebooksignatureutil.html

A Facebook API client implemented in Java, derived from the poorly-maintained official Facebook clie

</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#extractFacebookParamsFromStandardsCompliantArray(java.util.Map)">extractFacebookParamsFromStandardsCompliantArray</A></B>(java.util.Map&lt;java.lang.String,java.lang.String[]&gt;&nbsp;reqParams)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Out of the passed in <code>reqParams</code>, extracts the parameters that are in the FacebookParam namespace and returns them.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#generateSignature(java.util.List, java.lang.String)">generateSignature</A></B>(java.util.List&lt;java.lang.String&gt;&nbsp;params,
                  java.lang.String&nbsp;secret)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculates the signature for the given set of params using the supplied secret</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#pulloutFbSigParams(java.util.Map)">pulloutFbSigParams</A></B>(java.util.Map&lt;java.lang.String,java.lang.String[]&gt;&nbsp;reqParams)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#toString(java.lang.CharSequence)">toString</A></B>(java.lang.CharSequence&nbsp;cs)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#verifySignature(java.util.EnumMap, java.lang.String)">verifySignature</A></B>(java.util.EnumMap&lt;<A HREF="../../../../com/google/code/facebookapi/FacebookParam.html" title="enum in com.google.code.facebookapi">FacebookParam</A>,java.lang.String&gt;&nbsp;params,
                java.lang.String&nbsp;secret)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that a signature received matches the expected value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#verifySignature(java.util.EnumMap, java.lang.String, java.lang.String)">verifySignature</A></B>(java.util.EnumMap&lt;<A HREF="../../../../com/google/code/facebookapi/FacebookParam.html" title="enum in com.google.code.facebookapi">FacebookParam</A>,java.lang.String&gt;&nbsp;params,
                java.lang.String&nbsp;secret,
                java.lang.String&nbsp;expected)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that a signature received matches the expected value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#verifySignature(java.util.Map, java.lang.String)">verifySignature</A></B>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
                java.lang.String&nbsp;secret)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that a signature received matches the expected value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html#verifySignature(java.util.Map, java.lang.String, java.lang.String)">verifySignature</A></B>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
                java.lang.String&nbsp;secret,
                java.lang.String&nbsp;expected)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that a signature received matches the expected value.</TD>
</TR>
</TABLE>
&nbsp;<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.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="log"><!-- --></A><H3>
log</H3>
<PRE>
protected static org.apache.commons.logging.Log <B>log</B></PRE>
<DL>
<DL>
</DL>
</DL>

<!-- ========= 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="FacebookSignatureUtil()"><!-- --></A><H3>
FacebookSignatureUtil</H3>
<PRE>
public <B>FacebookSignatureUtil</B>()</PRE>
<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="pulloutFbSigParams(java.util.Map)"><!-- --></A><H3>
pulloutFbSigParams</H3>
<PRE>
public static java.util.Map&lt;java.lang.String,java.lang.String&gt; <B>pulloutFbSigParams</B>(java.util.Map&lt;java.lang.String,java.lang.String[]&gt;&nbsp;reqParams)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="extractFacebookParamsFromArray(java.util.Map)"><!-- --></A><H3>
extractFacebookParamsFromArray</H3>
<PRE>
public static java.util.Map&lt;java.lang.String,java.lang.String&gt; <B>extractFacebookParamsFromArray</B>(java.util.Map&lt;java.lang.CharSequence,java.lang.CharSequence[]&gt;&nbsp;reqParams)</PRE>
<DL>
<DD>Out of the passed in <code>reqParams</code>, extracts the parameters that are in the FacebookParam namespace and returns them.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reqParams</CODE> - A map of request parameters to their values. Values are arrays of strings, as returned by ServletRequest.getParameterMap(). Only the first element in a
            given array is significant.
<DT><B>Returns:</B><DD>a boolean indicating whether the calculated signature matched the expected signature</DL>
</DD>
</DL>
<HR>

<A NAME="toString(java.lang.CharSequence)"><!-- --></A><H3>
toString</H3>
<PRE>
public static java.lang.String <B>toString</B>(java.lang.CharSequence&nbsp;cs)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="extractFacebookParamsFromStandardsCompliantArray(java.util.Map)"><!-- --></A><H3>
extractFacebookParamsFromStandardsCompliantArray</H3>
<PRE>
public static java.util.Map&lt;java.lang.String,java.lang.String&gt; <B>extractFacebookParamsFromStandardsCompliantArray</B>(java.util.Map&lt;java.lang.String,java.lang.String[]&gt;&nbsp;reqParams)</PRE>
<DL>
<DD>Out of the passed in <code>reqParams</code>, extracts the parameters that are in the FacebookParam namespace and returns them.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reqParams</CODE> - A map of request parameters to their values. Values are arrays of strings, as returned by ServletRequest.getParameterMap(). Only the first element in a
            given array is significant.
<DT><B>Returns:</B><DD>a boolean indicating whether the calculated signature matched the expected signature</DL>
</DD>
</DL>
<HR>

<A NAME="extractFacebookNamespaceParams(java.util.Map)"><!-- --></A><H3>
extractFacebookNamespaceParams</H3>
<PRE>
public static java.util.Map&lt;java.lang.String,java.lang.CharSequence&gt; <B>extractFacebookNamespaceParams</B>(java.util.Map&lt;java.lang.CharSequence,java.lang.CharSequence&gt;&nbsp;reqParams)</PRE>
<DL>
<DD>Out of the passed in <code>reqParams</code>, extracts the parameters that are in the FacebookParam namespace and returns them.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reqParams</CODE> - a map of request parameters to their values
<DT><B>Returns:</B><DD>a boolean indicating whether the calculated signature matched the expected signature</DL>
</DD>
</DL>
<HR>

<A NAME="extractFacebookParams(java.util.Map)"><!-- --></A><H3>
extractFacebookParams</H3>
<PRE>
public static java.util.EnumMap&lt;<A HREF="../../../../com/google/code/facebookapi/FacebookParam.html" title="enum in com.google.code.facebookapi">FacebookParam</A>,java.lang.CharSequence&gt; <B>extractFacebookParams</B>(java.util.Map&lt;java.lang.CharSequence,java.lang.CharSequence&gt;&nbsp;reqParams)</PRE>
<DL>
<DD>Out of the passed in <code>reqParams</code>, extracts the parameters that are known FacebookParams and returns them.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reqParams</CODE> - a map of request parameters to their values
<DT><B>Returns:</B><DD>a map suitable for being passed to verify signature</DL>