com.tailf.maapi

Class CommitQueueResult

Object

com.tailf.maapi.ApplyResult

com.tailf.maapi.CommitQueueResult

public class CommitQueueResult
extends ApplyResult

Represents a successful invocation of the Maapi#applyTransWithResult(int,boolean,int,String,int) method. The purpose of this class is to represent the result of a transaction where the configuration change for the participating devices has been placed in the commit queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommitQueueResult.Status

Field Summary

Fields

Modifier and Type	Field and Description
static int	NCS_COMMIT_QUEUE_ASYNC Deprecated. Use CommitQueueResult.Status.ASYNC instead.
static int	NCS_COMMIT_QUEUE_DELETED Deprecated. Use CommitQueueResult.Status.DELETED instead.
static int	NCS_COMMIT_QUEUE_FAILED Deprecated. Use CommitQueueResult.Status.FAILED instead.
static int	NCS_COMMIT_QUEUE_NONE Deprecated. Use CommitQueueResult.Status.NONE instead.
static int	NCS_COMMIT_QUEUE_SYNC Deprecated. Use CommitQueueResult.Status.COMPLETED instead.
static int	NCS_COMMIT_QUEUE_TIMEOUT Deprecated. Use CommitQueueResult.Status.TIMEOUT instead.
long	queue_id Deprecated. Use CommitQueueResult.getId() instead.
long	status Deprecated. Use CommitQueueResult.getStatus() instead.

Constructor Summary

Constructors

Constructor and Description
CommitQueueResult(ConfResponse result)
CommitQueueResult(long queue_id, long status) Deprecated. Use CommitQueueResult(ConfResponse) instead.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getFailedDevices() Return the error reason for each failed device.
long	getId() Return the commit queue id.
CommitQueueResult.Status	getStatus() Return the status of the commit queue item.
String	getStatusAsString() Return the status as a string.

Methods inherited from class Object

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

Field Detail

queue_id

public final long queue_id

Deprecated. Use CommitQueueResult.getId() instead.

status

public final long status

Deprecated. Use CommitQueueResult.getStatus() instead.

NCS_COMMIT_QUEUE_NONE

public static final int NCS_COMMIT_QUEUE_NONE

Deprecated. Use CommitQueueResult.Status.NONE instead.

See Also:

Constant Field Values

NCS_COMMIT_QUEUE_ASYNC

public static final int NCS_COMMIT_QUEUE_ASYNC

Deprecated. Use CommitQueueResult.Status.ASYNC instead.

See Also:

Constant Field Values

NCS_COMMIT_QUEUE_SYNC

public static final int NCS_COMMIT_QUEUE_SYNC

Deprecated. Use CommitQueueResult.Status.COMPLETED instead.

See Also:

Constant Field Values

NCS_COMMIT_QUEUE_TIMEOUT

public static final int NCS_COMMIT_QUEUE_TIMEOUT

Deprecated. Use CommitQueueResult.Status.TIMEOUT instead.

See Also:

Constant Field Values

NCS_COMMIT_QUEUE_DELETED

public static final int NCS_COMMIT_QUEUE_DELETED

Deprecated. Use CommitQueueResult.Status.DELETED instead.

See Also:

Constant Field Values

NCS_COMMIT_QUEUE_FAILED

public static final int NCS_COMMIT_QUEUE_FAILED

Deprecated. Use CommitQueueResult.Status.FAILED instead.

See Also:

Constant Field Values

Constructor Detail

CommitQueueResult

public CommitQueueResult(long queue_id,
                         long status)
                  throws MaapiException,
                         ConfException

Deprecated. Use CommitQueueResult(ConfResponse) instead.

Throws:

MaapiException

ConfException

CommitQueueResult

public CommitQueueResult(ConfResponse result)
                  throws MaapiException,
                         ConfException

Throws:

MaapiException

ConfException

Method Detail

getId

public long getId()

Return the commit queue id. If the status is CommitQueueResult.Status.NONE this method will return 0.

getStatus

public CommitQueueResult.Status getStatus()

Return the status of the commit queue item.

The status could be any of the following:

CommitQueueResult.Status.NONE means that no device was involved in the transaction.

CommitQueueResult.Status.ASYNC means that the transaction has successfully placed the configuration change for the participating devices in the commit queue.

CommitQueueResult.Status.COMPLETED means that the queue item was successfully completed.

CommitQueueResult.Status.TIMEOUT means that the timer expired before the queue item was completed.

CommitQueueResult.Status.DELETED means that queue item was deleted from the queue.

CommitQueueResult.Status.FAILED means that the queue item failed. The CommitQueueResult.getFailedDevices() method will provide the error reason for each failed device.

getStatusAsString

public String getStatusAsString()

Return the status as a string.

getFailedDevices

public Map<String,String> getFailedDevices()

Return the error reason for each failed device.