org.apache.karaf.cave.server.api

Class CaveRepository

java.lang.Object

org.apache.karaf.cave.server.api.CaveRepository

public abstract class CaveRepository
extends Object

Cave repository is a storage area where to upload artifacts. It's already the basement of the OBR repository.xml metadata.

Constructor Summary

Constructors

Constructor and Description
CaveRepository()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	cleanup() Cleanup the repository storage.
String	getLocation() Get the location (filesystem) of this repository.
String	getName() Get the name of the repository.
abstract URL	getRepositoryXml() Return the repository URL of the OBR repository.xml.
abstract void	populate(URL url, boolean update) Populate from a remote URL (for instance a Maven repository), and eventually update the OBR information.
abstract void	populate(URL url, String filter, boolean update) Populate from a remote URL (for instance a Maven repository), eventually filtering artifacts, and eventually update the OBR information.
abstract void	proxy(URL url) Proxy an URL (for instance a Maven repository) and add OBR information.
abstract void	proxy(URL url, String filter) Proxy an URL (for instance a Maven repository), eventually filtering some artifacts, and add OBR information.
abstract void	scan() Scan the whole repository, reading bundle MANIFEST, etc to update or generate the OBR repository.xml.
void	setLocation(String location) Set the location (filesystem) of this repository.
void	setName(String name) Set the name of the repository.
abstract void	upload(URL url) Upload an artifact from the given URL into the repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaveRepository

public CaveRepository()

Method Detail

getName

public String getName()

Get the name of the repository.

Returns:

the name of the repository

setName

public void setName(String name)

Set the name of the repository.

Parameters:

name - the name of the repository

getLocation

public String getLocation()

Get the location (filesystem) of this repository.

Returns:

the location of this repository.

setLocation

public void setLocation(String location)

Set the location (filesystem) of this repository.

Parameters:

location - the location of this repository

upload

public abstract void upload(URL url)
                     throws Exception

Upload an artifact from the given URL into the repository.

Parameters:

url - the URL of the artifact.

Throws:

Exception - in case of upload failure.

scan

public abstract void scan()
                   throws Exception

Scan the whole repository, reading bundle MANIFEST, etc to update or generate the OBR repository.xml.

Throws:

Exception - in case of scan failure.

proxy

public abstract void proxy(URL url)
                    throws Exception

Proxy an URL (for instance a Maven repository) and add OBR information.

Parameters:

url - the URL to proxy.

Throws:

Exception

proxy

public abstract void proxy(URL url,
         String filter)
                    throws Exception

Proxy an URL (for instance a Maven repository), eventually filtering some artifacts, and add OBR information.

Parameters:

url - the URL to proxy.

filter - regex filter on the artifacts URL.

Throws:

Exception

populate

public abstract void populate(URL url,
            boolean update)
                       throws Exception

Populate from a remote URL (for instance a Maven repository), and eventually update the OBR information.

Parameters:

url - the URL to copy.

update - if true the OBR information is updated, false else.

Throws:

Exception - in case of copy failure.

populate

public abstract void populate(URL url,
            String filter,
            boolean update)
                       throws Exception

Populate from a remote URL (for instance a Maven repository), eventually filtering artifacts, and eventually update the OBR information.

Parameters:

url - the URL to copy.

filter - regex filter on the artifacts URL.

update - if true the OBR information is updated, false else.

Throws:

Exception

getRepositoryXml

public abstract URL getRepositoryXml()
                              throws Exception

Return the repository URL of the OBR repository.xml.

Returns:

the URL of the OBR repository.xml.

Throws:

Exception - in case of failure to get repository.xml URL.

cleanup

public abstract void cleanup()
                      throws Exception

Cleanup the repository storage.

Throws:

Exception - in case of cleanup failure.