net.ossindex.common

Interface IPackageRequest

All Known Implementing Classes:

PackageRequestService

public interface IPackageRequest

Interface to be implemented for the package request API.

Author:

Ken Duck

Method Summary

Modifier and Type	Method and Description
OssiPackage	add(List<PackageCoordinate> path) Add a new package/version (with dependency information) to search for.
OssiPackage	add(String pm, String groupId, String artifactId, String version) Add a new artifact to search for.
void	addVulnerabilityFilter(IVulnerabilityFilter filter) Filter the request results using the specified filter(s)
Collection<OssiPackage>	run() Execute the request.
void	setCacheFile(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(String user, String token) Set the credentials to be used in the OSS Index query
void	setMaximumPackagesPerRequest(int count)

Method Detail

add

OssiPackage add(String pm,
                String groupId,
                String artifactId,
                String version)

Add a new artifact to search for.

Parameters:

pm - Name of the package manager

groupId - Group ID for the package

artifactId - Artifact ID for the package

version - Version number for request

Returns:

A package descriptor containing the information

add

OssiPackage add(List<PackageCoordinate> path)

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

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

addVulnerabilityFilter

void addVulnerabilityFilter(IVulnerabilityFilter filter)

Filter the request results using the specified filter(s)

run

Collection<OssiPackage> run()
                     throws IOException

Execute the request.

Throws:

IOException

setCacheFile

void setCacheFile(String path)

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

setCredentials

void setCredentials(String user,
                    String token)

Set the credentials to be used in the OSS Index query

setMaximumPackagesPerRequest

void setMaximumPackagesPerRequest(int count)

setCacheTimeout

void setCacheTimeout(int hours)

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