defaultmanagerconnection.html

关于asterisk的java包

<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.
<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="logoff()"><!-- --></A><H3>
logoff</H3>
<PRE>
public void <B>logoff</B>()
            throws java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#logoff()">ManagerConnection</A></CODE></B></DD>
<DD>Sends a LogoffAction to the Asterisk server and disconnects.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#logoff()">logoff</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 not in state CONNECTED or RECONNECTING.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/LogoffAction.html" title="class in org.asteriskjava.manager.action"><CODE>LogoffAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction)"><!-- --></A><H3>
sendAction</H3>
<PRE>
public <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A> <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action)
                           throws java.io.IOException,
                                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A>,
                                  java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction)">ManagerConnection</A></CODE></B></DD>
<DD>Sends a ManagerAction to the Asterisk server and waits for the
 corresponding ManagerResponse.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction)">sendAction</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>action</CODE> - the action to send to the Asterisk server
<DT><B>Returns:</B><DD>the corresponding response received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if no response is received within the default
             timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, long)"><CODE>ManagerConnection.sendAction(ManagerAction, long)</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><CODE>ManagerConnection.sendAction(ManagerAction, SendActionCallback)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction, long)"><!-- --></A><H3>
sendAction</H3>
<PRE>
public <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A> <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action,
                                  long&nbsp;timeout)
                           throws java.io.IOException,
                                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A>,
                                  java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, long)">ManagerConnection</A></CODE></B></DD>
<DD>Sends a ManagerAction to the Asterisk server and waits for the
 corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, long)">sendAction</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>action</CODE> - the action to send to the Asterisk server<DD><CODE>timeout</CODE> - milliseconds to wait for the response before throwing a
            TimeoutException
<DT><B>Returns:</B><DD>the corresponding response received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if no response is received within the given
             timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><CODE>ManagerConnection.sendAction(ManagerAction, SendActionCallback)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><!-- --></A><H3>
sendAction</H3>
<PRE>
public void <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action,
                       <A HREF="../../../org/asteriskjava/manager/SendActionCallback.html" title="interface in org.asteriskjava.manager">SendActionCallback</A>&nbsp;callbackHandler)
                throws java.io.IOException,
                       java.lang.IllegalArgumentException,
                       java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)">ManagerConnection</A></CODE></B></DD>
<DD>Sends a ManagerAction to the Asterisk server and registers a callback
 handler to be called when the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> is
 received. Be very careful that your callbackHandler terminates very
 quickly and does not do any fancy processing because it is called from
 the reader thread which is blocked for the time it takes to execute your
 callbackHandler.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)">sendAction</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>action</CODE> - the action to send to the Asterisk server<DD><CODE>callbackHandler</CODE> - the callback handler to call when the response is
            received or <code>null</code> if you are not interested in
            the response
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to the Asterisk
             server.</DL>
</DD>
</DL>
<HR>

<A NAME="sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction)"><!-- --></A><H3>
sendEventGeneratingAction</H3>
<PRE>
public <A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A> <B>sendEventGeneratingAction</B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action)
                                         throws java.io.IOException,
                                                <A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A>,
                                                java.lang.IllegalArgumentException,
                                                java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction)">ManagerConnection</A></CODE></B></DD>
<DD>Sends an <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A> to the Asterisk server and waits
 for the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> and the
 <A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A>s
 <p>
 EventGeneratingActions are <A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action"><CODE>ManagerAction</CODE></A>s that don't return
 their response in the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> but send a
 series of events that contain the payload.
 <p>
 This method will block until the correpsonding action complete event has
 been received. The action complete event is determined by
 <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html#getActionCompleteEventClass()"><CODE>EventGeneratingAction.getActionCompleteEventClass()</CODE></A>.
 <p>
 Examples for EventGeneratingActions are
 <A HREF="../../../org/asteriskjava/manager/action/StatusAction.html" title="class in org.asteriskjava.manager.action"><CODE>StatusAction</CODE></A>,
 <CODE>org.asteriskjava.manager.action.QueueAction</CODE> or
 <A HREF="../../../org/asteriskjava/manager/action/AgentsAction.html" title="class in org.asteriskjava.manager.action"><CODE>AgentsAction</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction)">sendEventGeneratingAction</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>action</CODE> - the action to send to the Asterisk server
<DT><B>Returns:</B><DD>a ResponseEvents that contains the corresponding response and
         response events received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A></CODE> - if no response or not all response events
             are received within the given timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>,
             the actionCompleteEventClass property of the action is
             <code>null</code> or if actionCompleteEventClass is not a
             ResponseEvent.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, long)"><!-- --></A><H3>
sendEventGeneratingAction</H3>
<PRE>
public <A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A> <B>sendEventGeneratingAction</B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action,
                                                long&nbsp;timeout)
                                         throws java.io.IOException,
                                                <A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A>,
                                                java.lang.IllegalArgumentException,
                                                java.lang.IllegalStateException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, long)">ManagerConnection</A></CODE></B></DD>
<DD>Sends an <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A> to the Asterisk server and waits
 for the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> and the
 <A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A>s
 <p>
 EventGeneratingActions are <A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action"><CODE>ManagerAction</CODE></A>s that don't return
 their response in the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> but send a
 series of events that contain the payload.
 <p>
 This method will block until the correpsonding action complete event has
 been received but no longer that timeout seconds. The action complete
 event is determined by
 <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html#getActionCompleteEventClass()"><CODE>EventGeneratingAction.getActionCompleteEventClass()</CODE></A>.
 <p>
 Examples for EventGeneratingActions are the
 <A HREF="../../../org/asteriskjava/manager/action/StatusAction.html" title="class in org.asteriskjava.manager.action"><CODE>StatusAction</CODE></A>, the
 <CODE>org.asteriskjava.manager.action.QueueAction</CODE> or the
 <A HREF="../../../org/asteriskjava/manager/action/AgentsAction.html" title="class in org.asteriskjava.manager.action"><CODE>AgentsAction</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, long)">sendEventGeneratingAction</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>action</CODE> - the action to send to the Asterisk server<DD><CODE>timeout</CODE> - milliseconds to wait for the response and the action
            complete event before throwing a TimeoutException
<DT><B>Returns:</B><DD>a ResponseEvents that contains the corresponding response and
         response events received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A></CODE> - if no response or not all response events
             are received within the given timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>,
             the actionCompleteEventClass property of the action is
             <code>null</code> or if actionCompleteEventClass is not a
             ResponseEvent.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interf