defaultmanagerconnection.html

关于asterisk的java包

 Default is <code>true</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getHostname()"><!-- --></A><H3>
getHostname</H3>
<PRE>
public java.lang.String <B>getHostname</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getHostname()">ManagerConnection</A></CODE></B></DD>
<DD>Returns the hostname of the connected Asterisk server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getHostname()">getHostname</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the hostname of the connected Asterisk server.</DL>
</DD>
</DL>
<HR>

<A NAME="getPort()"><!-- --></A><H3>
getPort</H3>
<PRE>
public int <B>getPort</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getPort()">ManagerConnection</A></CODE></B></DD>
<DD>Returns the Manager API port of the connected Asterisk server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getPort()">getPort</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Manager API port of the connected Asterisk server.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsername()"><!-- --></A><H3>
getUsername</H3>
<PRE>
public java.lang.String <B>getUsername</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getUsername()">ManagerConnection</A></CODE></B></DD>
<DD>Returns the username to use to connect to the Asterisk server. This is
 the username specified in Asterisk's <code>manager.conf</code> file.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getUsername()">getUsername</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the username to use for login</DL>
</DD>
</DL>
<HR>

<A NAME="getPassword()"><!-- --></A><H3>
getPassword</H3>
<PRE>
public java.lang.String <B>getPassword</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getPassword()">ManagerConnection</A></CODE></B></DD>
<DD>Returns the password to use to connect to the Asterisk server. This is
 the username specified in Asterisk's <code>manager.conf</code> file.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#getPassword()">getPassword</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the password to use for login</DL>
</DD>
</DL>
<HR>

<A NAME="isSsl()"><!-- --></A><H3>
isSsl</H3>
<PRE>
public boolean <B>isSsl</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#isSsl()">ManagerConnection</A></CODE></B></DD>
<DD>Returns whether to use SSL.
 <p>
 Default is false.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#isSsl()">isSsl</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if SSL is used for the connection,
         <code>false</code> for a plain text connection.</DL>
</DD>
</DL>
<HR>

<A NAME="registerUserEventClass(java.lang.Class)"><!-- --></A><H3>
registerUserEventClass</H3>
<PRE>
public void <B>registerUserEventClass</B>(java.lang.Class&nbsp;userEventClass)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#registerUserEventClass(java.lang.Class)">ManagerConnection</A></CODE></B></DD>
<DD>Registers a new user event type.
 <p>
 Asterisk allows you to send custom events via the UserEvent application.
 If you choose to send such events you can extend the abstract class
 UserEvent provide a name for your new event and optionally add your own
 attributes. After registering a user event type Asterisk-Java will handle
 such events the same way it handles the internal events and inform your
 registered event handlers.
 <p>
 Note: If you write your own Asterisk applications that use Asterisk's
 <code>manager_event()</code> function directly and don't use the
 channel and uniqueid attributes provided by UserEvent you can also
 register events that directly subclass <A HREF="../../../org/asteriskjava/manager/event/ManagerEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ManagerEvent</CODE></A>.
 <p>
 The event class must be a concrete class with a default constructor (one
 that takes no arguments).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#registerUserEventClass(java.lang.Class)">registerUserEventClass</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>userEventClass</CODE> - the class representing the user event to register.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/event/UserEvent.html" title="class in org.asteriskjava.manager.event"><CODE>UserEvent</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/event/ManagerEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ManagerEvent</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setSocketTimeout(int)"><!-- --></A><H3>
setSocketTimeout</H3>
<PRE>
public void <B>setSocketTimeout</B>(int&nbsp;socketTimeout)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketTimeout(int)">ManagerConnection</A></CODE></B></DD>
<DD>The timeout to use when connecting the the Asterisk server.
 <p>
 Default is 0, that is using Java's built-in default.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketTimeout(int)">setSocketTimeout</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>socketTimeout</CODE> - the timeout value to be used in milliseconds.<DT><B>See Also:</B><DD><CODE>Socket.connect(java.net.SocketAddress, int)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setSocketReadTimeout(int)"><!-- --></A><H3>
setSocketReadTimeout</H3>
<PRE>
public void <B>setSocketReadTimeout</B>(int&nbsp;socketReadTimeout)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketReadTimeout(int)">ManagerConnection</A></CODE></B></DD>
<DD>Connection is dropped (and restarted) if it stales on read longer than
 the timeout.
 <p>
 If you set this property to a non zero value be sure to also use a
 <A HREF="../../../org/asteriskjava/manager/PingThread.html" title="class in org.asteriskjava.manager"><CODE>PingThread</CODE></A> or somthing similar to make sure there is some network
 traffic, otherwise you will encounter lots of unexpected reconnects. The
 read timeout should be at least twice the interval set for the
 PingThread.
 <p>
 Default is 0, that is no read timeout.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketReadTimeout(int)">setSocketReadTimeout</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>socketReadTimeout</CODE> - the read timeout value to be used in
            milliseconds.<DT><B>See Also:</B><DD><CODE>Socket.setSoTimeout(int)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="login()"><!-- --></A><H3>
login</H3>
<PRE>
public void <B>login</B>()
           throws java.lang.IllegalStateException,
                  java.io.IOException,
                  <A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A>,
                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#login()">ManagerConnection</A></CODE></B></DD>
<DD>Logs in to the Asterisk server with the username and password specified
 when this connection was created.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#login()">login</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if connection is not in state INITIAL or
             DISCONNECTED.
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A></CODE> - if the username and/or password are
             incorrect or the ChallengeResponse could not be built.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if a timeout occurs while waiting for the
             protocol identifier. The connection is closed in this case.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/LoginAction.html" title="class in org.asteriskjava.manager.action"><CODE>LoginAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/action/ChallengeAction.html" title="class in org.asteriskjava.manager.action"><CODE>ChallengeAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="login(java.lang.String)"><!-- --></A><H3>
login</H3>
<PRE>
public void <B>login</B>(java.lang.String&nbsp;events)
           throws java.lang.IllegalStateException,
                  java.io.IOException,
                  <A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A>,
                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#login(java.lang.String)">ManagerConnection</A></CODE></B></DD>
<DD>Logs in to the Asterisk server with the username and password specified
 when this connection was created and a given event mask.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#login(java.lang.String)">login</A></CODE> in interface <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager">ManagerConnection</A></CODE></DL>
</DD>
<DD><DL>