A C E F G H I L M N P R S T U V

A

AbstractRemoteResource - Class in net.ossindex.common.resource

Provides common code for OSS Index API access.

AbstractRemoteResource(long) - Constructor for class net.ossindex.common.resource.AbstractRemoteResource

Create a new resource

affects(String, String) - Method in class net.ossindex.common.resource.VulnerabilityResource

Return true if this vulnerability affects anything within the provided range

appliesTo(String) - Method in class net.ossindex.common.resource.VulnerabilityResource

Return true if this vulnerability applies to the specified version.

ArtifactResource - Class in net.ossindex.common.resource

Representation of the FileResource, backed by the OSS Index REST API

ArtifactResource(long) - Constructor for class net.ossindex.common.resource.ArtifactResource

Create a new artifact

C

cache(String, String) - Method in class net.ossindex.common.cache.MapDbCache

cache(String, String) - Method in class net.ossindex.common.cache.MemoryCache

cache(String, String) - Method in interface net.ossindex.common.IOssIndexCache

Cache the specified query

cacheResources(T[]) - Method in class net.ossindex.common.ResourceFactory

Preemptively cache the individual queries for these resources.

close() - Method in class net.ossindex.common.cache.MapDbCache

close() - Method in class net.ossindex.common.cache.MemoryCache

close() - Method in interface net.ossindex.common.IOssIndexCache

Ensure that the cache persists if required

closeCache() - Method in class net.ossindex.common.ResourceFactory

Close the cache

commit() - Method in class net.ossindex.common.cache.MapDbCache

commit() - Method in class net.ossindex.common.cache.MemoryCache

commit() - Method in interface net.ossindex.common.IOssIndexCache

Commit any recent changes into the cache

compareTo(ArtifactResource) - Method in class net.ossindex.common.resource.ArtifactResource

compareTo(PackageResource) - Method in class net.ossindex.common.resource.PackageResource

createResource(Class<T>, long) - Method in class net.ossindex.common.ResourceFactory

Get a single instance of a resource.

E

equals(Object) - Method in class net.ossindex.common.utils.PackageDependency

exists() - Method in class net.ossindex.common.resource.AbstractRemoteResource

Returns true if the resource exists at OSS Index

F

FilePosition - Class in net.ossindex.common.utils

Track the position of text in a file

FilePosition(int, int, int) - Constructor for class net.ossindex.common.utils.FilePosition

Create a file position

FileResource - Class in net.ossindex.common.resource

Representation of the FileResource, backed by the OSS Index REST API

FileResource(long) - Constructor for class net.ossindex.common.resource.FileResource

Create a new file resource

findArtifactResource(PackageDependency) - Method in class net.ossindex.common.ResourceFactory

Find the ArtifactResource matching the specified package dependency

findArtifactResources(PackageDependency[]) - Method in class net.ossindex.common.ResourceFactory

Get multiple matching resources for the specified files.

findFileResource(File) - Method in class net.ossindex.common.ResourceFactory

Find an applicable resource, otherwise return null.

findFileResources(File[]) - Method in class net.ossindex.common.ResourceFactory

Get multiple matching resources for the specified files.

findScmResources(long[]) - Method in class net.ossindex.common.ResourceFactory

Get an SCM resource list matching the supplied scm IDs.

G

get(String) - Method in class net.ossindex.common.cache.MapDbCache

get(String, long) - Method in class net.ossindex.common.cache.MapDbCache

get(String) - Method in class net.ossindex.common.cache.MemoryCache

get(String, long) - Method in class net.ossindex.common.cache.MemoryCache

It is anticipated that this implementation will never be up long enough for the delay to matter.

get(String) - Method in interface net.ossindex.common.IOssIndexCache

Get cached results, if they are available

get(String, long) - Method in interface net.ossindex.common.IOssIndexCache

Return the cached value if the elapsed time is not passed.

getArtifact() - Method in class net.ossindex.common.utils.PackageDependency

Get the artifact for this dependency

getArtifacts() - Method in class net.ossindex.common.resource.PackageResource

Get all of the artifacts owned by the package

getBaseUrl() - Static method in class net.ossindex.common.ResourceFactory

Get the base URL for REST requests.

getCache() - Method in class net.ossindex.common.ResourceFactory

Get the current cache implementation

getCreationDate() - Method in class net.ossindex.common.resource.PackageResource

Date the package was created, if known

getDependencyGraph() - Method in class net.ossindex.common.resource.ArtifactResource

Get the dependency graph for the artifact

getDescription() - Method in class net.ossindex.common.resource.ArtifactResource

Get the artifact description

getDescription() - Method in class net.ossindex.common.resource.PackageResource

Get the artifact description

getDescription() - Method in class net.ossindex.common.resource.ScmResource

Get the artifact description

getDescription() - Method in class net.ossindex.common.resource.VulnerabilityResource

Get a reasonable description of the vulnerability

getDescription() - Method in class net.ossindex.common.utils.PackageDependency

Get a description of the dependency

getFirst(String) - Method in class net.ossindex.common.utils.LineIndexer

Get first line where the specified text is matched

getGroupId() - Method in class net.ossindex.common.utils.PackageDependency

Get the group id/name

getId() - Method in class net.ossindex.common.resource.AbstractRemoteResource

Get the OSS Index ID.

getId() - Method in class net.ossindex.common.utils.PackageDependency

Get the simple fully descriptive ID for the package

getLength() - Method in class net.ossindex.common.utils.FilePosition

Get the selection length

getLength() - Method in class net.ossindex.common.utils.PackageDependency

Length of the selection

getLine() - Method in class net.ossindex.common.utils.FilePosition

Get the line number

getLine() - Method in class net.ossindex.common.utils.PackageDependency

Get the line number of the dependency owner file that defines this dependency

getName() - Method in class net.ossindex.common.resource.ArtifactResource

Get the name of the resource

getName() - Method in class net.ossindex.common.resource.FileResource

Get the name of the resource

getName() - Method in class net.ossindex.common.resource.PackageResource

Get the name of the resource

getName() - Method in class net.ossindex.common.resource.ScmResource

Get the SCM name

getName() - Method in class net.ossindex.common.utils.PackageDependency

Get the artifact id/name

getOffset() - Method in class net.ossindex.common.utils.FilePosition

Get the character offset

getOffset() - Method in class net.ossindex.common.utils.PackageDependency

Get the character offset

getOptional() - Method in class net.ossindex.common.utils.PackageDependency

Is this an optional dependency?

getPackage() - Method in class net.ossindex.common.resource.ArtifactResource

Get the package the artifact belongs to

getPackageManager() - Method in class net.ossindex.common.resource.ArtifactResource

Get the name of the package manager that owns the artifact

getPackageManager() - Method in class net.ossindex.common.utils.PackageDependency

Get the package manager name

getPackageName() - Method in class net.ossindex.common.resource.ArtifactResource

Get the package name

getPackageName() - Method in class net.ossindex.common.resource.PackageResource

Get the package name

getResourceFactory() - Static method in class net.ossindex.common.ResourceFactory

Get the resource factory instance.

getResources(TypeToken<?>, String) - Method in class net.ossindex.common.ResourceFactory

Build resources out of the results of the specified query.

getResourceType() - Method in class net.ossindex.common.resource.AbstractRemoteResource

Get the OSS Index resource type.

getResourceType() - Method in class net.ossindex.common.resource.ArtifactResource

getResourceType() - Method in class net.ossindex.common.resource.FileResource

getResourceType() - Method in class net.ossindex.common.resource.PackageResource

getResourceType() - Method in class net.ossindex.common.resource.ScmResource

getResourceType() - Method in class net.ossindex.common.resource.UpdateInformation

getResourceType() - Method in class net.ossindex.common.resource.VulnerabilityResource

getScm() - Method in class net.ossindex.common.utils.PackageDependency

Get the SCM resource that is deemed to be the dependency source

getScmId() - Method in class net.ossindex.common.resource.ArtifactResource

Get the ID of the SCM related to the artifact

getSearch() - Method in class net.ossindex.common.resource.ArtifactResource

When the resource is retrieved in a search, this returns the search strings that were used.

getTitle() - Method in class net.ossindex.common.resource.VulnerabilityResource

Get a reasonable title of the vulnerability

getUpdateDate() - Method in class net.ossindex.common.resource.PackageResource

Date the package was last updated, if known

getUpdates() - Static method in class net.ossindex.common.resource.UpdateInformation

Get current and available update information.

getUri() - Method in class net.ossindex.common.resource.VulnerabilityResource

Get the unique URI for a vulnerability

getVersion() - Method in class net.ossindex.common.resource.ArtifactResource

Get the semantic version for the resource.

getVersion() - Method in class net.ossindex.common.utils.PackageDependency

Get the package version

getVersions() - Method in class net.ossindex.common.resource.VulnerabilityResource

Get the product version ranges affected by this vulnerability.

getVersionString() - Method in class net.ossindex.common.resource.ArtifactResource

Get the version string

getVulnerabilities() - Method in class net.ossindex.common.resource.ScmResource

Get a list of all vulnerabilities affecting this resource.

getVulnerabilities() - Method in class net.ossindex.common.utils.PackageDependency

Get the vulnerabilities that apply to the package

H

hashCode() - Method in class net.ossindex.common.utils.PackageDependency

I

IOssIndexCache - Interface in net.ossindex.common

Load on the server is reduced by caching data wherever possible.

isCve() - Method in class net.ossindex.common.resource.VulnerabilityResource

Return true if this vulnerability represents a known CVE.

isRoot() - Method in class net.ossindex.common.utils.PackageDependency

Is this a root package, which means it is directly referenced (as opposed to transitively).

L

LineIndexer - Class in net.ossindex.common.utils

Given a simple list of text rows, provide mechanisms for finding out what row provides the best match for specified text.

LineIndexer(String) - Constructor for class net.ossindex.common.utils.LineIndexer

Index the specified file

LsOss - Class in net.ossindex.examples

LsOss lists all of the open source files within a given list of files.

LsOss(String[]) - Constructor for class net.ossindex.examples.LsOss

Very simple argument parsing.

M

main(String[]) - Static method in class net.ossindex.examples.LsOss

Program main

MapDbCache - Class in net.ossindex.common.cache

An implementation of IOssIndexCache that uses MapDb as a back end.

MapDbCache(File) - Constructor for class net.ossindex.common.cache.MapDbCache

Create a cache at the specified location

MemoryCache - Class in net.ossindex.common.cache

Memory only cache

MemoryCache() - Constructor for class net.ossindex.common.cache.MemoryCache

Create a cache at the specified location

N

net.ossindex.common - package net.ossindex.common

net.ossindex.common.cache - package net.ossindex.common.cache

net.ossindex.common.resource - package net.ossindex.common.resource

net.ossindex.common.utils - package net.ossindex.common.utils

net.ossindex.examples - package net.ossindex.examples

P

PackageDependency - Class in net.ossindex.common.utils

Define a dependency from an artifact to a package/version.

PackageDependency(FilePosition, String, String, String) - Constructor for class net.ossindex.common.utils.PackageDependency

Create a package dependency

PackageDependency(FilePosition, String, String, String, String) - Constructor for class net.ossindex.common.utils.PackageDependency

PackageDependency(String, String, String) - Constructor for class net.ossindex.common.utils.PackageDependency

Create a package dependency

PackageDependency(String, String, String, String) - Constructor for class net.ossindex.common.utils.PackageDependency

Create a package dependency

PackageResource - Class in net.ossindex.common.resource

Representation of the FileResource, backed by the OSS Index REST API

PackageResource(long) - Constructor for class net.ossindex.common.resource.PackageResource

Create a new package

R

ResourceFactory - Class in net.ossindex.common

S

ScmResource - Class in net.ossindex.common.resource

Representation of the FileResource, backed by the OSS Index REST API

ScmResource() - Constructor for class net.ossindex.common.resource.ScmResource

setArtifact(ArtifactResource) - Method in class net.ossindex.common.utils.PackageDependency

Set the artifact that is deemed to be the best match.

setCache(IOssIndexCache) - Method in class net.ossindex.common.ResourceFactory

Set the cache implementation

setDebug(boolean) - Static method in class net.ossindex.common.ResourceFactory

Use the debug server

setIsRoot(boolean) - Method in class net.ossindex.common.utils.PackageDependency

Is this a root package, which means it is directly referenced (as opposed to transitively).

setName(String) - Method in class net.ossindex.common.resource.FileResource

Override the name provided by OSS Index.

setOptional(Boolean) - Method in class net.ossindex.common.utils.PackageDependency

Indicates that this is an "optional" package

setScm(ScmResource) - Method in class net.ossindex.common.utils.PackageDependency

Set the SCM resource that is deemed to be the dependency source

T

toString() - Method in class net.ossindex.common.resource.ScmResource

toString() - Method in class net.ossindex.common.utils.PackageDependency

U

UpdateInformation - Class in net.ossindex.common.resource

Provide information about available version of API and associated libraries.

UpdateInformation() - Constructor for class net.ossindex.common.resource.UpdateInformation

V

VulnerabilityResource - Class in net.ossindex.common.resource

Representation of a Vulnerability, backed by the OSS Index REST API.

VulnerabilityResource() - Constructor for class net.ossindex.common.resource.VulnerabilityResource

A C E F G H I L M N P R S T U V