org.asteriskjava.manager.action

Class DbGetAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.DbGetAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class DbGetAction
extends AbstractManagerAction
implements EventGeneratingAction

Retrieves an entry in the Asterisk database for a given family and key.

If an entry is found a DBGetResponseEvent is sent by Asterisk containing the value, otherwise a ManagerError indicates that no entry matches.

It is implemented in main/db.c.

Available since Asterisk 1.2

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

DbGetResponseEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DbGetAction() Creates a new empty DbGetAction.
DbGetAction(String family, String key) Creates a new DbGetAction that retrieves the value of the database entry with the given key in the given family.

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	getFamily() Returns the family of the key.
String	getKey() Returns the the key of the entry to retrieve.
void	setFamily(String family) Sets the family of the key.
void	setKey(String key) Sets the key of the entry to retrieve.

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

DbGetAction

public DbGetAction()

Creates a new empty DbGetAction.

DbGetAction

public DbGetAction(String family,
                   String key)

Creates a new DbGetAction that retrieves the value of the database entry with the given key in the given family.

Parameters:

family - the family of the key

key - the key of the entry to retrieve

Since:

0.2

Method Detail

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

getFamily

public String getFamily()

Returns the family of the key.

Returns:

the family of the key.

setFamily

public void setFamily(String family)

Sets the family of the key.

Parameters:

family - the family of the key.

getKey

public String getKey()

Returns the the key of the entry to retrieve.

Returns:

the key of the entry to retrieve.

setKey

public void setKey(String key)

Sets the key of the entry to retrieve.

Parameters:

key - the key of the entry to retrieve.

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