generatenonce.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes the command with the specified session data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.Action.html" title="enum in org.jivesoftware.openfire.commands">AdHocCommand.Action</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#getActions(org.jivesoftware.openfire.commands.SessionData)">getActions</A></B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection with the allowed actions based on the current stage as defined
 in the SessionData.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/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/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#getCode()">getCode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the unique identifier for this command for the containing JID.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/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/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#getDefaultLabel()">getDefaultLabel</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the default label used for describing this commmand.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.Action.html" title="enum in org.jivesoftware.openfire.commands">AdHocCommand.Action</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#getExecuteAction(org.jivesoftware.openfire.commands.SessionData)">getExecuteAction</A></B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns which of the actions available for the current stage is considered the equivalent
 to "execute".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#getMaxStages(org.jivesoftware.openfire.commands.SessionData)">getMaxStages</A></B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the max number of stages for this command.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/jivesoftware/openfire/commands/clearspace/GenerateNonce.html#hasPermission(org.xmpp.packet.JID)">hasPermission</A></B>(<A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;requester)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the requester is allowed to execute this command.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.commands.AdHocCommand"><!-- --></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.jivesoftware.openfire.commands.<A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addNextStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">addNextStageInformation</A>, <A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addPreviousStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">addPreviousStageInformation</A>, <A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addStageActions(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">addStageActions</A>, <A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#get(java.util.Map, java.lang.String, int)">get</A>, <A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getLabel()">getLabel</A>, <A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#setLabel(java.lang.String)">setLabel</A></CODE></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.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" 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/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="GenerateNonce()"><!-- --></A><H3>
GenerateNonce</H3>
<PRE>
public <B>GenerateNonce</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="addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)"><!-- --></A><H3>
addStageInformation</H3>
<PRE>
protected void <B>addStageInformation</B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data,
                                   org.dom4j.Element&nbsp;command)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">AdHocCommand</A></CODE></B></DD>
<DD>Adds to the command element the data form or notes required by the current stage. The
 current stage is specified in the SessionData. This method will never be invoked for
 commands that have no stages.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">addStageInformation</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.<DD><CODE>command</CODE> - the command element to be sent to the command requester.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data,
                    org.dom4j.Element&nbsp;command)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">AdHocCommand</A></CODE></B></DD>
<DD>Executes the command with the specified session data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">execute</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages.<DD><CODE>command</CODE> - the command element to be sent to the command requester with a reported
        data result or note element with the answer of the execution.</DL>
</DD>
</DL>
<HR>

<A NAME="getActions(org.jivesoftware.openfire.commands.SessionData)"><!-- --></A><H3>
getActions</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.Action.html" title="enum in org.jivesoftware.openfire.commands">AdHocCommand.Action</A>&gt; <B>getActions</B>(<A HREF="../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getActions(org.jivesoftware.openfire.commands.SessionData)">AdHocCommand</A></CODE></B></DD>
<DD>Returns a collection with the allowed actions based on the current stage as defined
 in the SessionData. Possible actions are: <tt>prev</tt>, <tt>next</tt> and <tt>complete</tt>.
 This method will never be invoked for commands that have no stages.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getActions(org.jivesoftware.openfire.commands.SessionData)">getActions</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.
<DT><B>Returns:</B><DD>a collection with the allowed actions based on the current stage as defined
         in the SessionData.</DL>
</DD>
</DL>
<HR>

<A NAME="getCode()"><!-- --></A><H3>