net.ossindex.common

Class ResourceFactory

java.lang.Object

net.ossindex.common.ResourceFactory

public class ResourceFactory
extends Object

Author:

Ken Duck

Method Summary

Modifier and Type	Method and Description
<T extends AbstractRemoteResource> void	cacheResources(T[] resources) Preemptively cache the individual queries for these resources.
void	closeCache() Close the cache
<T extends AbstractRemoteResource> T	createResource(Class<T> cls, long id) Get a single instance of a resource.
ArtifactResource	findArtifactResource(PackageDependency dep) Find the ArtifactResource matching the specified package dependency
ArtifactResource[]	findArtifactResources(PackageDependency[] pkgDeps) Get multiple matching resources for the specified files.
FileResource	findFileResource(File file) Find an applicable resource, otherwise return null.
FileResource[]	findFileResources(File[] files) Get multiple matching resources for the specified files.
ScmResource[]	findScmResources(long[] scmIds) Get an SCM resource list matching the supplied scm IDs.
protected static String	getBaseUrl() Get the base URL for REST requests.
IOssIndexCache	getCache() Get the current cache implementation
static ResourceFactory	getResourceFactory() Get the resource factory instance.
<T extends AbstractRemoteResource> List<T>	getResources(com.google.gson.reflect.TypeToken<?> type, String query) Build resources out of the results of the specified query.
void	setCache(IOssIndexCache cache) Set the cache implementation
static void	setDebug(boolean b) Use the debug server

Methods inherited from class java.lang.Object

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

Method Detail

getResourceFactory

public static ResourceFactory getResourceFactory()

Get the resource factory instance.

Returns:

ResourceFactory instance

setCache

public void setCache(IOssIndexCache cache)

Set the cache implementation

Parameters:

cache - Cache implementation

getCache

public IOssIndexCache getCache()

Get the current cache implementation

Returns:

Cache implementation

getBaseUrl

protected static String getBaseUrl()

Get the base URL for REST requests.

Returns:

Request URL

setDebug

public static void setDebug(boolean b)

Use the debug server

Parameters:

b - Set to true to enable debug server access

findArtifactResource

public ArtifactResource findArtifactResource(PackageDependency dep)
                                      throws IOException

Find the ArtifactResource matching the specified package dependency

Parameters:

dep - Package dependency

Returns:

Matching artifact resource (only returns one match)

Throws:

IOException - On error

findArtifactResources

public ArtifactResource[] findArtifactResources(PackageDependency[] pkgDeps)
                                         throws IOException

Get multiple matching resources for the specified files. If a file does not have a match then a null will be placed in the results array. This is done so the user knows which result belongs with which input file.

Parameters:

pkgDeps - Array of package dependencies to find matching artifacts for

Returns:

Array of matching artifacts

Throws:

IOException - On error

findFileResource

public FileResource findFileResource(File file)
                              throws IOException

Find an applicable resource, otherwise return null. Use a combination of HttpClient and GSON to handle the request and response.

Parameters:

file - File to retrieve a file resource for

Returns:

The matching file resource

Throws:

IOException - On error

findFileResources

public FileResource[] findFileResources(File[] files)
                                 throws IOException

Get multiple matching resources for the specified files. If a file does not have a match then a null will be placed in the results array. This is done so the user knows which result belongs with which input file.

Parameters:

files - Files to find matching file resources for

Returns:

Matching file resources

Throws:

IOException - On error

findScmResources

public ScmResource[] findScmResources(long[] scmIds)
                               throws IOException

Get an SCM resource list matching the supplied scm IDs.

Parameters:

scmIds - SCM resource IDs

Returns:

Array of SCM resources

Throws:

IOException - On error

getResources

public <T extends AbstractRemoteResource> List<T> getResources(com.google.gson.reflect.TypeToken<?> type,
                                                               String query)
                                                        throws IOException

Build resources out of the results of the specified query.

Type Parameters:

T - Type of resource being returned

Parameters:

type - Array type for results

query - OSS Index REST query

Returns:

Results matching the query with the specified type

Throws:

IOException - On error

createResource

public <T extends AbstractRemoteResource> T createResource(Class<T> cls,
                                                           long id)
                                                    throws IOException

Get a single instance of a resource. This is relatively slow. You should instead batch these queries if possible (see the 'find*' methods.)

Type Parameters:

T - Type of resource being returned

Parameters:

cls - Class (type) of the expected resource

id - Resource ID to retrieve

Returns:

Resource matching the specified ID

Throws:

ConnectException - On server connection issues

IOException

cacheResources

public <T extends AbstractRemoteResource> void cacheResources(T[] resources)

Preemptively cache the individual queries for these resources.

Type Parameters:

T - Type of resource being returned

Parameters:

resources - Individual resources to cache

closeCache

public void closeCache()

Close the cache