org.asteriskjava.manager.action

Class PJSipShowEndpointAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.PJSipShowEndpointAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class PJSipShowEndpointAction
extends AbstractManagerAction
implements EventGeneratingAction

Retrieves details about a given endpoint.

For the given endpoint, the call will return several events, including EndpointDetail, AorDetail, AuthDetail, TransportDetail, ContactStatusDetail,and IdentifyDetail.

Some events may appear multiple times.

When all events have been reported an EndpointDetailComplete is sent.

Available since Asterisk 12 Permission required: write=system

Since:

12

Version:

$Id$

Author:

Steve Sether

See Also:

ContactStatusDetail, AorDetail, EndpointDetail, TransportDetail, AuthDetail, EndpointDetailComplete, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PJSipShowEndpointAction() Creates a new SipPeersAction.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action for example "Hangup".
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
String	getEndpoint()
void	setEndpoint(String endpoint)

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

PJSipShowEndpointAction

public PJSipShowEndpointAction()

Creates a new SipPeersAction.

Method Detail

getEndpoint

public String getEndpoint()

setEndpoint

public void setEndpoint(String endpoint)

getAction

public String getAction()

Description copied from interface: ManagerAction

Returns the name of the action for example "Hangup".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getActionCompleteEventClass

public Class<? extends ResponseEvent> getActionCompleteEventClass()

Description copied from interface: EventGeneratingAction

Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:

getActionCompleteEventClass in interface EventGeneratingAction

Returns:

a Class that is an instance of ResponseEvent.

See Also:

ResponseEvent