net.ossindex.common.request

Class PackageRequestService

java.lang.Object

net.ossindex.common.request.PackageRequestService

All Implemented Interfaces:

IPackageRequest

public class PackageRequestService
extends java.lang.Object
implements IPackageRequest

Perform a package request.

Constructor Summary

Constructors

Constructor and Description
PackageRequestService(OssIndexHttpClient client)

Method Summary

Modifier and Type	Method and Description
OssiPackage	add(java.util.List<PackageCoordinate> path) Add a new package/version (with dependency information) to search for.
OssiPackage	add(java.lang.String type, java.lang.String namespace, java.lang.String artifactId, java.lang.String version) Add a new artifact to search for.
void	addVulnerabilityFilter(IVulnerabilityFilter filter) Filter the request results using the specified filter(s)
boolean	isDebug()
java.util.Collection<OssiPackage>	run() Execute the request.
void	setCacheFile(java.lang.String path) Set the file path to be used by the cache.
void	setCacheTimeout(int hours) Number of hours till the cache expires.
void	setCredentials(java.lang.String user, java.lang.String token) Set the credentials to be used in the OSS Index query
void	setDebug(boolean debug)
void	setMaximumPackagesPerRequest(int count)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageRequestService

public PackageRequestService(OssIndexHttpClient client)

Method Detail

addVulnerabilityFilter

public void addVulnerabilityFilter(IVulnerabilityFilter filter)

Description copied from interface: IPackageRequest

Filter the request results using the specified filter(s)

Specified by:

addVulnerabilityFilter in interface IPackageRequest

setCacheFile

public void setCacheFile(java.lang.String path)

Description copied from interface: IPackageRequest

Set the file path to be used by the cache. Set to null to disable the cache.

Specified by:

setCacheFile in interface IPackageRequest

setCredentials

public void setCredentials(java.lang.String user,
                           java.lang.String token)

Description copied from interface: IPackageRequest

Set the credentials to be used in the OSS Index query

Specified by:

setCredentials in interface IPackageRequest

setMaximumPackagesPerRequest

public void setMaximumPackagesPerRequest(int count)

Specified by:

setMaximumPackagesPerRequest in interface IPackageRequest

setCacheTimeout

public void setCacheTimeout(int hours)

Description copied from interface: IPackageRequest

Number of hours till the cache expires. Only affects new items in the cache.

Specified by:

setCacheTimeout in interface IPackageRequest

add

public OssiPackage add(java.lang.String type,
                       java.lang.String namespace,
                       java.lang.String artifactId,
                       java.lang.String version)

Description copied from interface: IPackageRequest

Add a new artifact to search for.

Specified by:

add in interface IPackageRequest

Parameters:

type - Name of the package manager

namespace - Group ID for the package

artifactId - Artifact ID for the package

version - Version number for request

Returns:

A package descriptor containing the information

add

public OssiPackage add(java.util.List<PackageCoordinate> path)

Description copied from interface: IPackageRequest

Add a new package/version (with dependency information) to search for. This is useful for advanced filtering.

Specified by:

add in interface IPackageRequest

Parameters:

path - A path from the root (including) package to the dependency package. The packager being checked is the last one placed on the list (max index).

Returns:

A package descriptor containing the information

run

public java.util.Collection<OssiPackage> run()
                                      throws java.io.IOException

Description copied from interface: IPackageRequest

Execute the request.

Specified by:

run in interface IPackageRequest

Throws:

java.io.IOException

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)