com.neuvector.model

Class NVScanner

java.lang.Object

com.neuvector.model.NVScanner

public class NVScanner
extends Object

Constructor Summary

Constructors

Constructor and Description
NVScanner()
NVScanner(String nvScannerImage, String nvRegistryURL, String nvRegistryUser, String nvRegistryPassword)
NVScanner(String nvScannerImage, String nvRegistryURL, String nvRegistryUser, String nvRegistryPassword, String nvMountPath)

Method Summary

Modifier and Type	Method and Description
String	getNvMountPath()
String	getNvRegistryPassword()
String	getNvRegistryURL()
String	getNvRegistryUser()
String	getNvScannerImage()
void	setNvMountPath(String nvMountPath)
void	setNvRegistryPassword(String nvRegistryPassword)
void	setNvRegistryURL(String nvRegistryURL)
void	setNvRegistryUser(String nvRegistryUser)
void	setNvScannerImage(String nvScannerImage)

Methods inherited from class java.lang.Object

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

Constructor Detail

NVScanner

public NVScanner()

NVScanner

public NVScanner(String nvScannerImage,
                 String nvRegistryURL,
                 String nvRegistryUser,
                 String nvRegistryPassword)

Parameters:

nvScannerImage - The name of the NeuVector Scanner image. For example, "neuvector/scanner:latest"

nvRegistryURL - The registry from which to pull the NeuVector Scanner image. If it is empty, the API will skip the action to pull the NeuVector Scanner image.

nvRegistryUser - The user name to login the registry. If the user name and the password are empty, the API will skip the docker login action.

nvRegistryPassword - The password to login the registry.

NVScanner

public NVScanner(String nvScannerImage,
                 String nvRegistryURL,
                 String nvRegistryUser,
                 String nvRegistryPassword,
                 String nvMountPath)

Parameters:

nvScannerImage - The name of the NeuVector Scanner image. For example, "neuvector/scanner:latest"

nvRegistryURL - The registry from which to pull the NeuVector Scanner image. If it is empty, the API will skip the action to pull the NeuVector Scanner image.

nvRegistryUser - The user name to login the registry. If the user name and the password are empty, the API will skip the docker login action.

nvRegistryPassword - The password to login the registry.

nvMountPath - The mount path mapping to the path inside the NeuVector Scanner container. It is the path to store the scan result. It is optional. If you don't pass in nvMountPath, it will use the default path "/var/neuvector"

Method Detail

getNvScannerImage

public String getNvScannerImage()

Returns:

String

setNvScannerImage

public void setNvScannerImage(String nvScannerImage)

Parameters:

nvScannerImage - The name of the NeuVector Scanner Image

getNvRegistryURL

public String getNvRegistryURL()

Returns:

String

setNvRegistryURL

public void setNvRegistryURL(String nvRegistryURL)

Parameters:

nvRegistryURL - The registry url from which to pull NeuVector Scanner image

getNvRegistryUser

public String getNvRegistryUser()

Returns:

String

setNvRegistryUser

public void setNvRegistryUser(String nvRegistryUser)

Parameters:

nvRegistryUser - The login user of the registry url

getNvRegistryPassword

public String getNvRegistryPassword()

Returns:

String

setNvRegistryPassword

public void setNvRegistryPassword(String nvRegistryPassword)

Parameters:

nvRegistryPassword - The login password of the registry url

getNvMountPath

public String getNvMountPath()

Returns:

String

setNvMountPath

public void setNvMountPath(String nvMountPath)

Parameters:

nvMountPath - The file path to save the scan report.