com.veracode.apiwrapper.wrappers

Class SandboxAPIWrapper

java.lang.Object

com.veracode.apiwrapper.AbstractAPIWrapper

com.veracode.apiwrapper.wrappers.SandboxAPIWrapper

public final class SandboxAPIWrapper
extends AbstractAPIWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREATE_SANDBOX_URI
static java.lang.String	DELETE_SANDBOX_URI
static java.lang.String	GET_SANDBOX_LIST_URI
static java.lang.String	PROMOTE_SANDBOX_URI
static java.lang.String	UPDATE_SANDBOX_URI

Fields inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

BASE_ADDRESS, ENV_ADDRESS

Constructor Summary

Constructors

Constructor and Description
SandboxAPIWrapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createSandbox(java.lang.String app_id, java.lang.String sandbox_name) Creates a sandbox for the specified application.
java.lang.String	createSandbox(java.lang.String appId, java.lang.String sandboxName, java.lang.Boolean autoRecreate) Recreate a sandbox for the specified application.
java.lang.String	deleteSandbox(java.lang.String sandboxId) Delete sandbox based on the provided sandbox_id
java.lang.String	getSandboxList(java.lang.String app_id) Returns a list of all the sandboxes associated with the specified application.
java.lang.String	promoteSandbox(java.lang.String build_id) Promotes a sandbox scan to a policy scan for the specified build ID.
java.lang.String	updateSandbox(java.lang.String sandbox_id, java.lang.String custom_field_name, java.lang.String custom_field_value) Enables you to amend an existing sandbox in the application profile.
java.lang.String	updateSandbox(java.lang.String sandboxId, java.lang.String customFieldName, java.lang.String customFieldValue, java.lang.Boolean autoRecreate) Enables you to amend an existing sandbox in the application profile.

Methods inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

setOutputStream, setUpApiCredentials, setUpApiCredentials, setUpApiCredentials, setUpCredentials, setupMaxRetryCount, setUpProxy, setUpProxy, setUpProxy, setupTransactionId

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_SANDBOX_URI

public static final java.lang.String CREATE_SANDBOX_URI

See Also:

Constant Field Values

GET_SANDBOX_LIST_URI

public static final java.lang.String GET_SANDBOX_LIST_URI

See Also:

Constant Field Values

PROMOTE_SANDBOX_URI

public static final java.lang.String PROMOTE_SANDBOX_URI

See Also:

Constant Field Values

UPDATE_SANDBOX_URI

public static final java.lang.String UPDATE_SANDBOX_URI

See Also:

Constant Field Values

DELETE_SANDBOX_URI

public static final java.lang.String DELETE_SANDBOX_URI

See Also:

Constant Field Values

Constructor Detail

SandboxAPIWrapper

public SandboxAPIWrapper()

Method Detail

createSandbox

public java.lang.String createSandbox(java.lang.String app_id,
                                      java.lang.String sandbox_name)
                               throws java.io.IOException

Creates a sandbox for the specified application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createsandbox.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_name - Required. The name of the sandbox.

Returns:

A String that represents the sandboxinfo XML document, which references the sandboxinfo.xsd schema.

Throws:

java.io.IOException

createSandbox

public java.lang.String createSandbox(java.lang.String appId,
                                      java.lang.String sandboxName,
                                      java.lang.Boolean autoRecreate)
                               throws java.io.IOException

Recreate a sandbox for the specified application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createsandbox.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxinfo.xsd

Parameters:

appId - Required. A String that represents an Integer value.

sandboxName - Required. The name of the sandbox.

autoRecreate - Optional. flag to recreate sandbox.

Returns:

A String that represents the sandboxinfo XML document, which references the sandboxinfo.xsd schema.

Throws:

java.io.IOException

getSandboxList

public java.lang.String getSandboxList(java.lang.String app_id)
                                throws java.io.IOException

Returns a list of all the sandboxes associated with the specified application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getsandboxlist.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the sandboxlist XML document, which references the sandboxlist.xsd schema.

Throws:

java.io.IOException

promoteSandbox

public java.lang.String promoteSandbox(java.lang.String build_id)
                                throws java.io.IOException

Promotes a sandbox scan to a policy scan for the specified build ID.

Parameters:

build_id - Required. Integer values of the build.

Returns:

A String that represents the sandboxlist XML document, which references the sandboxlist.xsd schema.

Throws:

java.io.IOException

updateSandbox

public java.lang.String updateSandbox(java.lang.String sandbox_id,
                                      java.lang.String custom_field_name,
                                      java.lang.String custom_field_value)
                               throws java.io.IOException

Enables you to amend an existing sandbox in the application profile.

Parameters:

sandbox_id - Required. Integer value of the sandbox to update.

custom_field_name - Required. Specifies the custom field that the custom_field_value changes.

custom_field_value - Required. The value of the custom field that the custom_field_name specifies.

Returns:

A String that represents the sandboxlist XML document, which references the sandboxlist.xsd schema.

Throws:

java.io.IOException

updateSandbox

public java.lang.String updateSandbox(java.lang.String sandboxId,
                                      java.lang.String customFieldName,
                                      java.lang.String customFieldValue,
                                      java.lang.Boolean autoRecreate)
                               throws java.io.IOException

Enables you to amend an existing sandbox in the application profile.

Parameters:

sandboxId - Required. Integer value of the sandbox to update.

customFieldName - Required. Specifies the custom field that the custom_field_value changes.

customFieldValue - Required. The value of the custom field that the custom_field_name specifies.

autoRecreate - Optional. The value of the flag used to creates a new sandbox with the same name when the current sandbox expires.

Returns:

A String that represents the sandboxlist XML document, which references the sandboxlist.xsd schema.

Throws:

java.io.IOException

deleteSandbox

public java.lang.String deleteSandbox(java.lang.String sandboxId)
                               throws java.io.IOException

Delete sandbox based on the provided sandbox_id

Parameters:

sandboxId - Required. Integer value of the sandbox to delete.

Returns:

A String that represents the deletesandboxresult XML document, which references the deletesandboxresult.xsd schema.

Throws:

java.io.IOException