Package com.io7m.brooklime.api

Interface BLNexusClientType

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BLNexusClient

public interface BLNexusClientType
extends java.io.Closeable

A Nexus client.

Method Summary

Modifier and Type	Method	Description
BLStagingRepositoryUpload	createUploadRequest(BLStagingRepositoryUploadRequestParameters request)	Create a staging repository upload request.
java.util.List<BLStagingProfileRepository>	stagingRepositories()	List the available staging repositories.
void	stagingRepositoryClose(BLStagingRepositoryClose close)	Close one or more staging repositories.
java.lang.String	stagingRepositoryCreate(BLStagingRepositoryCreate create)	Create a staging repository.
void	stagingRepositoryDrop(BLStagingRepositoryDrop drop)	Drop one or more staging repositories.
java.util.Optional<BLStagingProfileRepository>	stagingRepositoryGet(java.lang.String id)	Retrieve an existing staging repository.
void	stagingRepositoryRelease(BLStagingRepositoryRelease release)	Release one or more staging repositories.
void	upload(BLStagingRepositoryUpload upload, BLProgressReceiverType receiver)	Execute an upload request.

Methods inherited from interface java.io.Closeable

close

Method Detail

upload

void upload(BLStagingRepositoryUpload upload,
            BLProgressReceiverType receiver)
     throws BLException

Execute an upload request. Progress updates will be delivered to the given receiver.

Parameters:

upload - The set of files to be uploaded

receiver - The progress receiver

Throws:

BLException - On errors

createUploadRequest

BLStagingRepositoryUpload createUploadRequest(BLStagingRepositoryUploadRequestParameters request)
                                       throws BLException

Create a staging repository upload request.

Parameters:

request - The upload request parameters

Returns:

A new request

Throws:

BLException - On errors

stagingRepositories

java.util.List<BLStagingProfileRepository> stagingRepositories()
                                                        throws BLException

List the available staging repositories.

Returns:

The list of repositories

Throws:

BLException - On errors

stagingRepositoryGet

java.util.Optional<BLStagingProfileRepository> stagingRepositoryGet(java.lang.String id)
                                                             throws BLException

Retrieve an existing staging repository.

Parameters:

id - The ID of the repository

Returns:

The repository, or nothing if the repository does not exist

Throws:

BLException - On errors

stagingRepositoryCreate

java.lang.String stagingRepositoryCreate(BLStagingRepositoryCreate create)
                                  throws BLException

Create a staging repository.

Parameters:

create - The creation parameters

Returns:

The ID of the created repository

Throws:

BLException - On errors

stagingRepositoryDrop

void stagingRepositoryDrop(BLStagingRepositoryDrop drop)
                    throws BLException

Drop one or more staging repositories.

Parameters:

drop - The repository parameters

Throws:

BLException - On errors

stagingRepositoryClose

void stagingRepositoryClose(BLStagingRepositoryClose close)
                     throws BLException

Close one or more staging repositories.

Parameters:

close - The repository parameters

Throws:

BLException - On errors

stagingRepositoryRelease

void stagingRepositoryRelease(BLStagingRepositoryRelease release)
                       throws BLException

Release one or more staging repositories.

Parameters:

release - The repository parameters

Throws:

BLException - On errors