Package com.google.appengine.api.taskqueue.dev

Class LocalTaskQueue

java.lang.Object

com.google.appengine.tools.development.AbstractLocalRpcService

com.google.appengine.api.taskqueue.dev.LocalTaskQueue

All Implemented Interfaces:

LocalRpcService

@AutoService(LocalRpcService.class)
public final class LocalTaskQueue
extends AbstractLocalRpcService

A local implementation of the Task Queue service interface backed by Quartz (http://www.opensymphony.com/quartz). This class is responsible for managing the lifecycle of the Quartz Scheduler but otherwise delegates to DevQueue for all the scheduling intelligence.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.appengine.tools.development.LocalRpcService

LocalRpcService.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CALLBACK_CLASS_PROP	Overrides the LocalTaskQueueCallback class that is used to service async task execution.
static final String	DISABLE_AUTO_TASK_EXEC_PROP	The name of a property that disables automatic task execution.
static final String	PACKAGE	The package name for this service.
static final String	QUEUE_XML_PATH_PROP	Overrides the path of queue.xml.
static final String	QUEUE_YAML_PATH_PROP	Overrides the path of queue.yaml.

Constructor Summary

Constructors

Constructor	Description
LocalTaskQueue()

Method Summary

Modifier and Type	Method	Description
TaskQueuePb.TaskQueueAddResponse	add(LocalRpcService.Status status, TaskQueuePb.TaskQueueAddRequest addRequest)
TaskQueuePb.TaskQueueBulkAddResponse	bulkAdd(LocalRpcService.Status status, TaskQueuePb.TaskQueueBulkAddRequest bulkAddRequest)	BulkAdd RPC implementation.
TaskQueuePb.TaskQueueDeleteResponse	delete(LocalRpcService.Status status, TaskQueuePb.TaskQueueDeleteRequest request)	Delete RPC implementation.
boolean	deleteTask(String queueName, String taskName)	Delete a task by name.
TaskQueuePb.TaskQueueFetchQueueStatsResponse	fetchQueueStats(LocalRpcService.Status status, TaskQueuePb.TaskQueueFetchQueueStatsRequest fetchQueueStatsRequest)	FetchQueueStats RPC implementation.
void	flushQueue(String queueName)	Remove all entries from a queue.
Double	getMaximumDeadline(boolean isOfflineRequest)	Return the maximum number of seconds that is allowed as a deadline for each API call.
String	getPackage()	Returns the package for the service, for example, "datastore_v3".
Map<String,QueueStateInfo>	getQueueStateInfo()	Returns a map of QueueStateInfo objects keyed by queue name.
void	init(LocalServiceContext context, Map<String,String> properties)	Initializes the service with a set of configuration properties.
TaskQueuePb.TaskQueueModifyTaskLeaseResponse	modifyTaskLease(LocalRpcService.Status status, TaskQueuePb.TaskQueueModifyTaskLeaseRequest request)
TaskQueuePb.TaskQueuePurgeQueueResponse	purgeQueue(LocalRpcService.Status status, TaskQueuePb.TaskQueuePurgeQueueRequest purgeQueueRequest)	PurgeQueue RPC implementation.
TaskQueuePb.TaskQueueQueryAndOwnTasksResponse	queryAndOwnTasks(LocalRpcService.Status status, TaskQueuePb.TaskQueueQueryAndOwnTasksRequest request)
boolean	runTask(String queueName, String taskName)	Run a task by name.
void	start()	Puts a new service into "serving" mode.
void	stop()	Stops the service, releasing all of its resources.

Methods inherited from class com.google.appengine.tools.development.AbstractLocalRpcService

getDefaultDeadline, getMaxApiRequestSize

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PACKAGE

public static final String PACKAGE

The package name for this service.

See Also:

• Constant Field Values

DISABLE_AUTO_TASK_EXEC_PROP

public static final String DISABLE_AUTO_TASK_EXEC_PROP

The name of a property that disables automatic task execution. If this property exists and is set to true in the properties argument to init(com.google.appengine.tools.development.LocalServiceContext, java.util.Map<java.lang.String, java.lang.String>) then the schedule will not automatically run any tasks. Manual task execution will still work as normal.

See Also:

• Constant Field Values

QUEUE_XML_PATH_PROP

public static final String QUEUE_XML_PATH_PROP

Overrides the path of queue.xml. Must be a full path, e.g. /usr/local/dev/myapp/tests/queue.xml

See Also:

• Constant Field Values

QUEUE_YAML_PATH_PROP

public static final String QUEUE_YAML_PATH_PROP

Overrides the path of queue.yaml. Must be a full path, e.g. /usr/local/dev/myapp/tests/queue.yaml

See Also:

• Constant Field Values

CALLBACK_CLASS_PROP

public static final String CALLBACK_CLASS_PROP

Overrides the LocalTaskQueueCallback class that is used to service async task execution. The value of this property must be the fully-qualified name of a class with a public, no-arg constructor that implements the LocalTaskQueueCallback interface.

See Also:

• Constant Field Values

Constructor Details

LocalTaskQueue

public LocalTaskQueue()

Method Details

init

public void init(LocalServiceContext context,
 Map<String,String> properties)

Description copied from interface: LocalRpcService

Initializes the service with a set of configuration properties. Must be called before a service is started.

Specified by:

init in interface LocalRpcService

Overrides:

init in class AbstractLocalRpcService

Parameters:

context - A context object for the application

properties - A read-only Map of properties.

start

public void start()

Description copied from interface: LocalRpcService

Puts a new service into "serving" mode. Aside from setting properties, the service is not functional until after having been started.

Specified by:

start in interface LocalRpcService

Overrides:

start in class AbstractLocalRpcService

stop

public void stop()

Description copied from interface: LocalRpcService

Stops the service, releasing all of its resources.

Specified by:

stop in interface LocalRpcService

Overrides:

stop in class AbstractLocalRpcService

getPackage

public String getPackage()

Description copied from interface: LocalRpcService

Returns the package for the service, for example, "datastore_v3".

Returns:

a not null package name.

add

public TaskQueuePb.TaskQueueAddResponse add(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueAddRequest addRequest)

fetchQueueStats

public TaskQueuePb.TaskQueueFetchQueueStatsResponse fetchQueueStats(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueFetchQueueStatsRequest fetchQueueStatsRequest)

FetchQueueStats RPC implementation.

purgeQueue

public TaskQueuePb.TaskQueuePurgeQueueResponse purgeQueue(LocalRpcService.Status status,
 TaskQueuePb.TaskQueuePurgeQueueRequest purgeQueueRequest)

PurgeQueue RPC implementation.

bulkAdd

public TaskQueuePb.TaskQueueBulkAddResponse bulkAdd(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueBulkAddRequest bulkAddRequest)

BulkAdd RPC implementation.

delete

public TaskQueuePb.TaskQueueDeleteResponse delete(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueDeleteRequest request)

Delete RPC implementation.

queryAndOwnTasks

public TaskQueuePb.TaskQueueQueryAndOwnTasksResponse queryAndOwnTasks(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueQueryAndOwnTasksRequest request)

modifyTaskLease

public TaskQueuePb.TaskQueueModifyTaskLeaseResponse modifyTaskLease(LocalRpcService.Status status,
 TaskQueuePb.TaskQueueModifyTaskLeaseRequest request)

getQueueStateInfo

public Map<String,QueueStateInfo> getQueueStateInfo()

Returns a map of QueueStateInfo objects keyed by queue name.

This is not part of the public interface. It is used by the dev server admin console Task Queue Viewer function.

flushQueue

public void flushQueue(String queueName)

Remove all entries from a queue.

deleteTask

public boolean deleteTask(String queueName,
 String taskName)

Delete a task by name.

Returns:

False if the task name was not found.

runTask

public boolean runTask(String queueName,
 String taskName)

Run a task by name.

Returns:

False if the task name was not found.

getMaximumDeadline

public Double getMaximumDeadline(boolean isOfflineRequest)

Description copied from interface: LocalRpcService

Return the maximum number of seconds that is allowed as a deadline for each API call. The user cannot request a deadline higher than this value. This method may return null if the service has no opinion about the maximum deadline, in which case a global maximum deadline will be used instead.

Specified by:

getMaximumDeadline in interface LocalRpcService

Overrides:

getMaximumDeadline in class AbstractLocalRpcService