org.apache.karaf.cave.server.api

Interface CaveRepositoryService

@Path(value="/")
public interface CaveRepositoryService

Service to manipulate a Cave repository.

Method Summary

Methods

Modifier and Type	Method and Description
CaveRepository	create(String name, boolean scan) Create a Cave repository.
CaveRepository	create(String name, String location, boolean scan) Create a Cave repository.
void	destroy(String name) Destroy a Cave repository, including the storage.
CaveRepository[]	getRepositories() Get the list of all Cave repositories.
CaveRepository	getRepository(String name) Get a Cave repository identified by the given name.
void	install(String name) Install a Cave repository into the OBR service.
void	remove(String name) Remove a Cave repository from the repositories registry.
void	uninstall(String name) Uninstall a Cave repository from the OBR service.

Method Detail

create

CaveRepository create(String name,
                    boolean scan)
                      throws Exception

Create a Cave repository.

Parameters:

name - the name of the repository

scan - if true, the repository is scanned at creation time, and the OBR metadata are created.

Returns:

the Cave repository.

Throws:

Exception - in case of creation failure.

create

CaveRepository create(String name,
                    String location,
                    boolean scan)
                      throws Exception

Create a Cave repository.

Parameters:

name - the name of the repository.

location - the storage location of the repository.

scan - if true, the repository is scanned at creation time, and the OBR metadata are created.

Returns:

the Cave repository.

Throws:

Exception - in case of creation failure.

uninstall

void uninstall(String name)
               throws Exception

Uninstall a Cave repository from the OBR service.

Parameters:

name - the name of the repository.

Throws:

Exception - in case of uninstall failure.

remove

void remove(String name)
            throws Exception

Remove a Cave repository from the repositories registry.

Parameters:

name - the name of the repository.

Throws:

Exception - in case of remove failure.

destroy

void destroy(String name)
             throws Exception

Destroy a Cave repository, including the storage.

Parameters:

name - the name of the repository.

Throws:

Exception - incase of remove failure.

install

void install(String name)
             throws Exception

Install a Cave repository into the OBR service.

Parameters:

name - the name of the Cave repository.

Throws:

Exception - in case of registration failure.

getRepositories

@Path(value="/repositories")
CaveRepository[] getRepositories()

Get the list of all Cave repositories.

Returns:

the Cave repositories.

getRepository

@Path(value="/repositories/{name}")
CaveRepository getRepository(String name)

Get a Cave repository identified by the given name.

Parameters:

name - the name of the Cave repository.

Returns:

the Cave repository