com.vordel.api.configuration.model

Class DeploymentResult

java.lang.Object

com.vordel.api.configuration.model.DeploymentResult

public class DeploymentResult
extends java.lang.Object

A DeploymentResult is returned as the result of an API Server loading a new configuration via the Configuration REST API at deployment time.

Constructor Summary

Constructors

Constructor and Description
DeploymentResult() Default constructor.
DeploymentResult(int errorCount, java.lang.String failureReason, boolean status, TraceData traceData, java.lang.String archiveId) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArchiveId() Get the id of the Deployment Archive that the API Server loaded/attempted to load.
int	getErrorCount() Get the number of errors that the API Server reported at configuration load time.
java.lang.String	getFailureReason() Get the deployment failure reason.
boolean	getStatus() Get the deployment status.
TraceData	getTraceData() Get the deployment trace data.
void	setArchiveId(java.lang.String archiveId) Set the id of the Deployment Archive that the API Server loaded/attempted to load.
void	setErrorCount(int errorCount) Get the error count
void	setFailureReason(java.lang.String failureReason) Set the deployment failure reason.
void	setStatus(boolean status) Set the deployment status
void	setTraceData(TraceData traceData) Set the trace data.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentResult

public DeploymentResult()

Default constructor.

DeploymentResult

public DeploymentResult(int errorCount,
                        java.lang.String failureReason,
                        boolean status,
                        TraceData traceData,
                        java.lang.String archiveId)

Constructor.

Parameters:

errorCount - The error count

failureReason - The reason for deployment failure

status - The deployment status, true if deployed successfully without having to rollback

traceData - Trace data from the API Server at configuration load time.

archiveId - The id of the Deployment Archive that the API Server loaded/attempted to load.

Method Detail

getErrorCount

public int getErrorCount()

Get the number of errors that the API Server reported at configuration load time. Note it is possible that a deployment will succeed even though the error count > 0.

Returns:

Error count

setErrorCount

public void setErrorCount(int errorCount)

Get the error count

Parameters:

errorCount - The error count

getFailureReason

public java.lang.String getFailureReason()

Get the deployment failure reason.

Returns:

Failure reason

setFailureReason

public void setFailureReason(java.lang.String failureReason)

Set the deployment failure reason.

Parameters:

failureReason - Failure reason

getStatus

public boolean getStatus()

Get the deployment status. True if the API Server loaded the configuration without errors that cause a rollback.

Returns:

status

setStatus

public void setStatus(boolean status)

Set the deployment status

Parameters:

status - The deployment status.

getTraceData

public TraceData getTraceData()

Get the deployment trace data. This is the trace data from the API Server at configuration load time.

Returns:

trace data

setTraceData

public void setTraceData(TraceData traceData)

Set the trace data.

Parameters:

traceData - The trace data

getArchiveId

public java.lang.String getArchiveId()

Get the id of the Deployment Archive that the API Server loaded/attempted to load.

Returns:

Id

setArchiveId

public void setArchiveId(java.lang.String archiveId)

Set the id of the Deployment Archive that the API Server loaded/attempted to load.

Parameters:

archiveId - The id