com.veracode.apiwrapper

Class AbstractAPIWrapper

java.lang.Object

com.veracode.apiwrapper.AbstractAPIWrapper

Direct Known Subclasses:

AdminAPIWrapper, ArcherAPIWrapper, MitigationAPIWrapper, ResultsAPIWrapper, SandboxAPIWrapper, UploadAPIWrapper, VastAPIWrapper

public abstract class AbstractAPIWrapper
extends java.lang.Object

Abstract APIWrapper base class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_ADDRESS
static java.lang.String	ENV_ADDRESS

Method Summary

Modifier and Type	Method and Description
void	setOutputStream(java.io.PrintStream outputWriter)
void	setUpApiCredentials(Credentials credentials)
void	setUpApiCredentials(java.lang.String profile) Setup the API credentials by referencing a profile in the credentials file
void	setUpApiCredentials(java.lang.String apiID, java.lang.String apiKey) Deprecated. This method is deprecated. Please use setUpApiCredentials(Credentials credentials) or setUpApiCredentials(String profile) instead.
void	setUpCredentials(java.lang.String username, java.lang.String password) Deprecated. This method is deprecated. Use ID/KEY based authentication instead.
void	setupMaxRetryCount(int count)
void	setUpProxy(java.net.Proxy proxy) Set up a connection using a proxy represented by an instance of the java.net.Proxy class.
void	setUpProxy(java.lang.String host, java.lang.String port) Set up a connection using a proxy that requires no authentication.
void	setUpProxy(java.lang.String host, java.lang.String port, java.lang.String username, java.lang.String password) Set up a connection using a proxy that requires authentication.
void	setupTransactionId(java.util.UUID id)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_ADDRESS

public static final java.lang.String BASE_ADDRESS

ENV_ADDRESS

public static final java.lang.String ENV_ADDRESS

Method Detail

setUpProxy

public void setUpProxy(java.net.Proxy proxy)

Set up a connection using a proxy represented by an instance of the java.net.Proxy class. This method must be called before calling the APIs.

setupTransactionId

public void setupTransactionId(java.util.UUID id)

setupMaxRetryCount

public void setupMaxRetryCount(int count)

setUpProxy

public void setUpProxy(java.lang.String host,
                       java.lang.String port)

Set up a connection using a proxy that requires no authentication. This method must be called before calling the APIs.

A proxy server is a computer that offers a computer network service to allow clients to make indirect network connections to other network services.

Parameters:

host - The proxy IP address.

port - The proxy port. (A String that represents an integer value.)

setUpProxy

public void setUpProxy(java.lang.String host,
                       java.lang.String port,
                       java.lang.String username,
                       java.lang.String password)

Set up a connection using a proxy that requires authentication. This method must be called before calling the APIs.

A proxy server is a computer that offers a computer network service to allow clients to make indirect network connections to other network services. Some proxy servers require a username and password to access their services.

Parameters:

host - The proxy IP address.

port - The proxy port. (A String that represents an integer value.)

username - The proxy username.

password - The proxy password.

setUpCredentials

@Deprecated
public void setUpCredentials(java.lang.String username,
                                         java.lang.String password)

Deprecated. This method is deprecated. Use ID/KEY based authentication instead.

Set up the Veracode login credentials. This method is deprecated. Use ID/KEY based authentication instead.

Parameters:

username - The Veracode username.

password - The Veracode password.

setUpApiCredentials

public void setUpApiCredentials(java.lang.String profile)

Setup the API credentials by referencing a profile in the credentials file

Parameters:

profile - - name of the profile. Pass null or empty for using the default profile

setUpApiCredentials

public void setUpApiCredentials(Credentials credentials)

setUpApiCredentials

@Deprecated
public void setUpApiCredentials(java.lang.String apiID,
                                            java.lang.String apiKey)

Deprecated. This method is deprecated. Please use setUpApiCredentials(Credentials credentials) or setUpApiCredentials(String profile) instead.

Set up the Veracode API credentials. This method must be called before calling the APIs.

Parameters:

apiID - The Veracode API ID.

apiKey - The Veracode API key.

Throws:

InvalidArgumentException - If the specified API ID or API key is null or invalid.

setOutputStream

public void setOutputStream(java.io.PrintStream outputWriter)