Package org.whitesource.agent.dependency.resolver.npm

Class NpmLsJsonDependencyCollector

java.lang.Object

org.whitesource.agent.dependency.resolver.DependencyCollector

org.whitesource.agent.dependency.resolver.npm.NpmLsJsonDependencyCollector

Direct Known Subclasses:

BowerLsJsonDependencyCollector, YarnDependencyCollector

public class NpmLsJsonDependencyCollector
extends DependencyCollector

Collect dependencies using 'npm ls' or bower command.

Author:

eugen.horovitz

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	ignoreNpmLsErrors
protected boolean	includeDevDependencies
static java.lang.String	LS_COMMAND
static java.lang.String	LS_PARAMETER_JSON
protected boolean	npmLsFailureStatus
protected long	npmTimeoutDependenciesCollector
static java.lang.String	PEER_MISSING

Fields inherited from class org.whitesource.agent.dependency.resolver.DependencyCollector

C_CHAR_WINDOWS

Constructor Summary

Constructors

Constructor	Description
NpmLsJsonDependencyCollector(boolean includeDevDependencies, long npmTimeoutDependenciesCollector, boolean ignoreNpmLsErrors, boolean ignoreScripts)

Method Summary

Modifier and Type	Method	Description
java.util.Collection<org.whitesource.agent.api.model.AgentProjectInfo>	collectDependencies(java.lang.String rootDirectory)
boolean	executePreparationStep(java.lang.String folder)
protected void	getDependencies(org.json.JSONObject jsonObject, java.lang.String rootDirectory, java.util.Collection<org.whitesource.agent.api.model.DependencyInfo> dependencies)
protected org.whitesource.agent.api.model.DependencyInfo	getDependency(java.lang.String dependencyAlias, org.json.JSONObject jsonObject)
protected java.lang.String[]	getInstallParams()
protected java.lang.String[]	getLsCommandParams()
protected java.lang.String[]	getLsCommandParamsJson()
boolean	getNpmLsFailureStatus()

Methods inherited from class org.whitesource.agent.dependency.resolver.DependencyCollector

getSingleProjectList, isWindows

Methods inherited from class java.lang.Object

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

Field Detail

LS_COMMAND

public static final java.lang.String LS_COMMAND

See Also:

Constant Field Values

LS_PARAMETER_JSON

public static final java.lang.String LS_PARAMETER_JSON

See Also:

Constant Field Values

PEER_MISSING

public static final java.lang.String PEER_MISSING

See Also:

Constant Field Values

includeDevDependencies

protected final boolean includeDevDependencies

ignoreNpmLsErrors

protected final boolean ignoreNpmLsErrors

npmLsFailureStatus

protected boolean npmLsFailureStatus

npmTimeoutDependenciesCollector

protected final long npmTimeoutDependenciesCollector

Constructor Detail

NpmLsJsonDependencyCollector

public NpmLsJsonDependencyCollector(boolean includeDevDependencies,
                                    long npmTimeoutDependenciesCollector,
                                    boolean ignoreNpmLsErrors,
                                    boolean ignoreScripts)

Method Detail

collectDependencies

public java.util.Collection<org.whitesource.agent.api.model.AgentProjectInfo> collectDependencies(java.lang.String rootDirectory)

Specified by:

collectDependencies in class DependencyCollector

executePreparationStep

public boolean executePreparationStep(java.lang.String folder)

getDependencies

protected void getDependencies(org.json.JSONObject jsonObject,
                               java.lang.String rootDirectory,
                               java.util.Collection<org.whitesource.agent.api.model.DependencyInfo> dependencies)

getInstallParams

protected java.lang.String[] getInstallParams()

getLsCommandParams

protected java.lang.String[] getLsCommandParams()

getLsCommandParamsJson

protected java.lang.String[] getLsCommandParamsJson()

getDependency

protected org.whitesource.agent.api.model.DependencyInfo getDependency(java.lang.String dependencyAlias,
                                                                       org.json.JSONObject jsonObject)

getNpmLsFailureStatus

public boolean getNpmLsFailureStatus()