org.myrobotlab.framework.repo

Class Repo

java.lang.Object

org.myrobotlab.framework.repo.Repo

All Implemented Interfaces:

java.io.Serializable

public class Repo
extends java.lang.Object
implements java.io.Serializable

This class is responsible for maintaining the "local" repo state for the MRL instance running. It could have "potentially" the knowledge of the gitHub repo using the github api. But at the moment, it maintains a local file specifying the state of the requested dependencies. For example. If the Arduino Service is requested, then an attempt is made to download the appropriate depenencies for the service. This would include some version of jssc. The attempt resolves & retrieves or doesn't - the requested dependency and its resultant state is written to the .myrobotlab repo.json file

Author:

GroG

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INSTALL_FINISHED
static java.lang.String	INSTALL_PROGRESS
static java.lang.String	INSTALL_START
static org.slf4j.Logger	log
static org.apache.ivy.util.filter.Filter	NO_FILTER
java.lang.String	REPO_DIR

Constructor Summary

Constructors

Constructor and Description
Repo()

Method Summary

Modifier and Type	Method and Description
void	addLibrary(java.lang.String org, java.lang.String version) adds a library initially as unresolved to the local repo information if the library becomes resolved - the state changes, and will be used to prevent fetch or resolving the library again
void	addStatusListener(RepoInstallListener listener)
void	clear()
void	clearErrors()
static Status	createFinishedStatus(java.lang.String format, java.lang.Object... args) creates a installation finished status this is primarily for calling services which want a status of repo starting finishing an install
static Status	createStartStatus(java.lang.String format, java.lang.Object... args) creates a installation start status this is primarily for calling services which want a status of repo starting an install
void	error(java.lang.String format, java.lang.Object... args) error callback
static java.util.Map<java.lang.String,Library>	generateLibrariesFromRepo(java.lang.String repoDir) generates instance of all dependencies from a repo directory would be useful for checking validity - not used during runtime libraries
java.util.List<Status>	getErrors()
static java.lang.String	getKey(java.lang.String org, java.lang.String version)
static Repo	getLocalInstance()
java.util.Set<Library>	getUnfulfilledDependencies(java.lang.String type)
boolean	hasErrors()
void	info(java.lang.String format, java.lang.Object... args) info call back
void	install() installs all currently defined service types and their dependencies
void	install(java.lang.String fullTypeName) Install the all dependencies for a service if it has any.
void	installProgress(Status status) call back for listeners
boolean	isInstalled(java.lang.String typeName)
boolean	isServiceTypeInstalled(java.lang.String fullTypeName) searches through dependencies directly defined by the service and all Peers - recursively searches for their dependencies if any are not found - returns false
static void	main(java.lang.String[] args)
org.apache.ivy.core.report.ResolveReport	resolveArtifacts(java.lang.String org, java.lang.String version, boolean retrieve) resolveArtifact does an Ivy resolve with a URLResolver to MRL's repo at github.
void	save() saves repo to file
void	setInstalled(java.lang.String key)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final transient org.slf4j.Logger log

NO_FILTER

public static final org.apache.ivy.util.filter.Filter NO_FILTER

INSTALL_START

public static final java.lang.String INSTALL_START

See Also:

Constant Field Values

INSTALL_PROGRESS

public static final java.lang.String INSTALL_PROGRESS

See Also:

Constant Field Values

INSTALL_FINISHED

public static final java.lang.String INSTALL_FINISHED

See Also:

Constant Field Values

REPO_DIR

public final java.lang.String REPO_DIR

See Also:

Constant Field Values

Constructor Detail

Repo

public Repo()

Method Detail

getLocalInstance

public static Repo getLocalInstance()

addStatusListener

public void addStatusListener(RepoInstallListener listener)

getErrors

public java.util.List<Status> getErrors()

hasErrors

public boolean hasErrors()

info

public void info(java.lang.String format,
                 java.lang.Object... args)

info call back

Parameters:

format - format

args - args

error

public void error(java.lang.String format,
                  java.lang.Object... args)

error callback

Parameters:

format - format

args - args

createStartStatus

public static Status createStartStatus(java.lang.String format,
                                       java.lang.Object... args)

creates a installation start status this is primarily for calling services which want a status of repo starting an install

Parameters:

format - format

args - args

Returns:

status

createFinishedStatus

public static Status createFinishedStatus(java.lang.String format,
                                          java.lang.Object... args)

creates a installation finished status this is primarily for calling services which want a status of repo starting finishing an install

Parameters:

format - format

args - args

Returns:

status

installProgress

public void installProgress(Status status)

call back for listeners

Parameters:

status - the status object?

install

public void install()
             throws java.text.ParseException,
                    java.io.IOException

installs all currently defined service types and their dependencies

Throws:

java.text.ParseException - e

java.io.IOException - e

clearErrors

public void clearErrors()

install

public void install(java.lang.String fullTypeName)
             throws java.text.ParseException,
                    java.io.IOException

Install the all dependencies for a service if it has any. This uses Ivy programmatically to resolve and retrieve all necessary dependencies for a service. Steps : 1. check if .myrobotlab/repo.json file loaded - if not create it repo.json represents current state of installed libraries (local repo) 2. get list of dependecies from service type (this comes from the serviceData.json / classMeta) these are what need to be resolved 3. retrieve - and update state in memory and repo.json

Parameters:

fullTypeName - f

Throws:

java.text.ParseException - e

java.io.IOException - e

isServiceTypeInstalled

public boolean isServiceTypeInstalled(java.lang.String fullTypeName)

searches through dependencies directly defined by the service and all Peers - recursively searches for their dependencies if any are not found - returns false

Parameters:

fullTypeName - f

Returns:

true/false

resolveArtifacts

public org.apache.ivy.core.report.ResolveReport resolveArtifacts(java.lang.String org,
                                                                 java.lang.String version,
                                                                 boolean retrieve)
                                                          throws java.text.ParseException,
                                                                 java.io.IOException

resolveArtifact does an Ivy resolve with a URLResolver to MRL's repo at github. The equivalent command line is -settings ivychain.xml -dependency "gnu.io.rxtx" "rxtx" "2.1-7r2" -confs "runtime,x86.64.windows"

Parameters:

org - org

version - version

retrieve - boolean

Returns:

the resolution report

Throws:

java.text.ParseException - e

java.io.IOException - e

save

public void save()

saves repo to file

addLibrary

public void addLibrary(java.lang.String org,
                       java.lang.String version)

adds a library initially as unresolved to the local repo information if the library becomes resolved - the state changes, and will be used to prevent fetch or resolving the library again

Parameters:

org - the org

version - the version of that lib

generateLibrariesFromRepo

public static java.util.Map<java.lang.String,Library> generateLibrariesFromRepo(java.lang.String repoDir)

generates instance of all dependencies from a repo directory would be useful for checking validity - not used during runtime libraries

Parameters:

repoDir - the directory to load from

Returns:

map

setInstalled

public void setInstalled(java.lang.String key)

getKey

public static java.lang.String getKey(java.lang.String org,
                                      java.lang.String version)

getUnfulfilledDependencies

public java.util.Set<Library> getUnfulfilledDependencies(java.lang.String type)

clear

public void clear()

isInstalled

public boolean isInstalled(java.lang.String typeName)

main

public static void main(java.lang.String[] args)