loginaction.html

关于asterisk的java包

<A NAME="LoginAction()"><!-- --></A><H3>
LoginAction</H3>
<PRE>
public <B>LoginAction</B>()</PRE>
<DL>
<DD>Creates a new empty LoginAction.
<P>
</DL>
<HR>

<A NAME="LoginAction(java.lang.String, java.lang.String)"><!-- --></A><H3>
LoginAction</H3>
<PRE>
public <B>LoginAction</B>(java.lang.String&nbsp;username,
                   java.lang.String&nbsp;secret)</PRE>
<DL>
<DD>Creates a new LoginAction that performs a cleartext login.<p>
 You should not use cleartext login if you are concerned about security,
 using <A HREF="../../../../org/asteriskjava/manager/action/ChallengeAction.html" title="class in org.asteriskjava.manager.action"><CODE>ChallengeAction</CODE></A> and login with a password hash instead.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username as configured in Asterisk's
            <code>manager.conf</code><DD><CODE>secret</CODE> - the user's password as configured in Asterisk's
            <code>manager.conf</code><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DL>
<HR>

<A NAME="LoginAction(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
LoginAction</H3>
<PRE>
public <B>LoginAction</B>(java.lang.String&nbsp;username,
                   java.lang.String&nbsp;authType,
                   java.lang.String&nbsp;key)</PRE>
<DL>
<DD>Creates a new LoginAction that performs a login via challenge/response.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username as configured in Asterisk's
            <code>manager.conf</code><DD><CODE>authType</CODE> - the digest alogrithm, must match the digest algorithm
            that was used with the corresponding ChallengeAction.<DD><CODE>key</CODE> - the hash of the user's password and the challenge<DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DL>
<HR>

<A NAME="LoginAction(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
LoginAction</H3>
<PRE>
public <B>LoginAction</B>(java.lang.String&nbsp;username,
                   java.lang.String&nbsp;authType,
                   java.lang.String&nbsp;key,
                   java.lang.String&nbsp;events)</PRE>
<DL>
<DD>Creates a new LoginAction that performs a login via challenge/response.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username as configured in Asterisk's
            <code>manager.conf</code><DD><CODE>authType</CODE> - the digest alogrithm, must match the digest algorithm
            that was used with the corresponding ChallengeAction.<DD><CODE>key</CODE> - the hash of the user's password and the challenge<DD><CODE>events</CODE> - the event mask. Set to "on" if all events should be send,
            "off" if not events should be sent or a combination of
            "system", "call" and "log" (separated by ',') to specify what
            kind of events should be sent.<DT><B>Since:</B></DT>
  <DD>0.2</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="getAction()"><!-- --></A><H3>
getAction</H3>
<PRE>
public java.lang.String <B>getAction</B>()</PRE>
<DL>
<DD>Returns the name of this action, i.e. "Login".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/manager/action/ManagerAction.html#getAction()">getAction</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html#getAction()">getAction</A></CODE> in class <CODE><A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html" title="class in org.asteriskjava.manager.action">AbstractManagerAction</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getUsername()"><!-- --></A><H3>
getUsername</H3>
<PRE>
public java.lang.String <B>getUsername</B>()</PRE>
<DL>
<DD>Returns the username.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setUsername(java.lang.String)"><!-- --></A><H3>
setUsername</H3>
<PRE>
public void <B>setUsername</B>(java.lang.String&nbsp;username)</PRE>
<DL>
<DD>Sets the username as configured in asterik's <code>manager.conf</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSecret()"><!-- --></A><H3>
getSecret</H3>
<PRE>
public java.lang.String <B>getSecret</B>()</PRE>
<DL>
<DD>Returns the secret.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setSecret(java.lang.String)"><!-- --></A><H3>
setSecret</H3>
<PRE>
public void <B>setSecret</B>(java.lang.String&nbsp;secret)</PRE>
<DL>
<DD>Sets the secret to use when using cleartext login.<p>
 The secret contains the user's password as configured in Asterisk's
 <code>manager.conf</code>.<p>
 The secret and key properties are mutually exclusive.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthType()"><!-- --></A><H3>
getAuthType</H3>
<PRE>
public java.lang.String <B>getAuthType</B>()</PRE>
<DL>
<DD>Returns the digest alogrithm when using challenge/response.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setAuthType(java.lang.String)"><!-- --></A><H3>
setAuthType</H3>
<PRE>
public void <B>setAuthType</B>(java.lang.String&nbsp;authType)</PRE>
<DL>
<DD>Sets the digest alogrithm when using challenge/response.<p>
 The digest algorithm is used to create the key based on the challenge and
 the user's password.<p>
 Currently Asterisk supports only "MD5".
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getKey()"><!-- --></A><H3>
getKey</H3>
<PRE>
public java.lang.String <B>getKey</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the key.</DL>
</DD>
</DL>
<HR>

<A NAME="setKey(java.lang.String)"><!-- --></A><H3>
setKey</H3>
<PRE>
public void <B>setKey</B>(java.lang.String&nbsp;key)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to set.</DL>
</DD>
</DL>
<HR>

<A NAME="getEvents()"><!-- --></A><H3>
getEvents</H3>
<PRE>
public java.lang.String <B>getEvents</B>()</PRE>
<DL>
<DD>Returns the event mask.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the event mask.</DL>
</DD>
</DL>
<HR>

<A NAME="setEvents(java.lang.String)"><!-- --></A><H3>
setEvents</H3>
<PRE>
public void <B>setEvents</B>(java.lang.String&nbsp;events)</PRE>
<DL>
<DD>Sets the event mask.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>events</CODE> - the event mask. Set to "on" if all events should be send,
            "off" if not events should be sent or a combination of
            "system", "call" and "log" (separated by ',') to specify what
            kind of events should be sent.</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LoginAction.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>
Asterisk-Java</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/asteriskjava/manager/action/ListCommandsAction.html" title="class in org.asteriskjava.manager.action"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/asteriskjava/manager/action/LogoffAction.html" title="class in org.asteriskjava.manager.action"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/asteriskjava/manager/action/LoginAction.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="LoginAction.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 2004-2007 Stefan Reuter. All Rights Reserved.
</BODY>
</HTML>