Package ca.gc.cyber.ops.assemblyline.java.client.clients

Interface IAssemblylineClient

All Known Implementing Classes:

AssemblylineClient

public interface IAssemblylineClient

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URL
static String	FILE_DOWNLOAD_URL
static String	FILE_INFO_URL
static String	FILE_RESULT_FOR_SERVICE_URL
static String	FILE_RESULTS_URL
static String	HASH_SEARCH
static String	HASH_SEARCH_LIST_DATA_SOURCES
static String	INGEST_GET_MESSAGE_LIST_URL
static String	INGEST_URL
static String	LOGIN_URL
static String	RESULT_URL
static String	SUBMISSION_COMPLETE_URL
static String	SUBMISSION_FILE_RESULTS_URL
static String	SUBMISSION_FULL_URL
static String	SUBMISSION_TREE_URL
static String	SUBMISSION_URL
static String	SUBMIT_URL

Method Summary

Modifier and Type	Method	Description
InputStream	downloadFile(String sha256)
InputStream	downloadFile(String sha256, DownloadFileParams params)
reactor.core.publisher.Mono<FileInfo>	getFileInfo(String sha256)
reactor.core.publisher.Mono<FileResultForService>	getFileResultForService(String sha256, String serviceName)
reactor.core.publisher.Mono<FileResults>	getFileResults(String sha256)
reactor.core.publisher.Mono<List<String>>	getHashSearchDataSources()
reactor.core.publisher.Flux<IngestSubmissionResponse>	getIngestMessageList(String notification)
reactor.core.publisher.Mono<ResultBlock>	getResult(String cacheKey)
String	getSession()
reactor.core.publisher.Mono<Submission>	getSubmission(String sid)
reactor.core.publisher.Mono<SubmissionFileResults>	getSubmissionFileResults(String sid, String sha256)
reactor.core.publisher.Mono<SubmissionFull>	getSubmissionFull(String sid)
reactor.core.publisher.Mono<SubmissionTree>	getSubmissionTree(String sid)
reactor.core.publisher.Mono<Map<String,HashSearchResult>>	hashSearch(String fileHash)
reactor.core.publisher.Mono<Map<String,HashSearchResult>>	hashSearch(String fileHash, List<String> dataSources, Integer maxTimeout)
reactor.core.publisher.Mono<IngestResponse>	ingestBinary(BinaryFile<IngestBase> binaryIngest)
reactor.core.publisher.Mono<IngestResponse>	ingestUrlOrSha256(NonBinaryIngest ingest)
reactor.core.publisher.Mono<Boolean>	isSubmissionComplete(String sid)
reactor.core.publisher.Mono<LoginResponse>	login()
reactor.core.publisher.Mono<Submission>	submitBinary(BinaryFile<SubmitMetadata> binaryIngest)
reactor.core.publisher.Mono<Submission>	submitUrlOrSha256(NonBinarySubmit submit)
AssemblylineClient	withAuthBearerToken(String authBearerToken)

Field Detail

BASE_URL

static final String BASE_URL

See Also:

Constant Field Values

LOGIN_URL

static final String LOGIN_URL

See Also:

Constant Field Values

FILE_DOWNLOAD_URL

static final String FILE_DOWNLOAD_URL

See Also:

Constant Field Values

FILE_INFO_URL

static final String FILE_INFO_URL

See Also:

Constant Field Values

FILE_RESULTS_URL

static final String FILE_RESULTS_URL

See Also:

Constant Field Values

FILE_RESULT_FOR_SERVICE_URL

static final String FILE_RESULT_FOR_SERVICE_URL

See Also:

Constant Field Values

HASH_SEARCH

static final String HASH_SEARCH

See Also:

Constant Field Values

HASH_SEARCH_LIST_DATA_SOURCES

static final String HASH_SEARCH_LIST_DATA_SOURCES

See Also:

Constant Field Values

INGEST_URL

static final String INGEST_URL

See Also:

Constant Field Values

INGEST_GET_MESSAGE_LIST_URL

static final String INGEST_GET_MESSAGE_LIST_URL

See Also:

Constant Field Values

RESULT_URL

static final String RESULT_URL

See Also:

Constant Field Values

SUBMISSION_COMPLETE_URL

static final String SUBMISSION_COMPLETE_URL

See Also:

Constant Field Values

SUBMISSION_URL

static final String SUBMISSION_URL

See Also:

Constant Field Values

SUBMISSION_FILE_RESULTS_URL

static final String SUBMISSION_FILE_RESULTS_URL

See Also:

Constant Field Values

SUBMISSION_FULL_URL

static final String SUBMISSION_FULL_URL

See Also:

Constant Field Values

SUBMISSION_TREE_URL

static final String SUBMISSION_TREE_URL

See Also:

Constant Field Values

SUBMIT_URL

static final String SUBMIT_URL

See Also:

Constant Field Values

Method Detail

withAuthBearerToken

AssemblylineClient withAuthBearerToken(String authBearerToken)

login

reactor.core.publisher.Mono<LoginResponse> login()

isSubmissionComplete

reactor.core.publisher.Mono<Boolean> isSubmissionComplete(String sid)

getFileInfo

reactor.core.publisher.Mono<FileInfo> getFileInfo(String sha256)

getFileResults

reactor.core.publisher.Mono<FileResults> getFileResults(String sha256)

getFileResultForService

reactor.core.publisher.Mono<FileResultForService> getFileResultForService(String sha256,
                                                                          String serviceName)

getResult

reactor.core.publisher.Mono<ResultBlock> getResult(String cacheKey)

getSubmissionFileResults

reactor.core.publisher.Mono<SubmissionFileResults> getSubmissionFileResults(String sid,
                                                                            String sha256)

getSubmissionTree

reactor.core.publisher.Mono<SubmissionTree> getSubmissionTree(String sid)

getSubmission

reactor.core.publisher.Mono<Submission> getSubmission(String sid)

getSubmissionFull

reactor.core.publisher.Mono<SubmissionFull> getSubmissionFull(String sid)

ingestUrlOrSha256

reactor.core.publisher.Mono<IngestResponse> ingestUrlOrSha256(NonBinaryIngest ingest)

ingestBinary

reactor.core.publisher.Mono<IngestResponse> ingestBinary(BinaryFile<IngestBase> binaryIngest)

getIngestMessageList

reactor.core.publisher.Flux<IngestSubmissionResponse> getIngestMessageList(String notification)

submitUrlOrSha256

reactor.core.publisher.Mono<Submission> submitUrlOrSha256(NonBinarySubmit submit)

submitBinary

reactor.core.publisher.Mono<Submission> submitBinary(BinaryFile<SubmitMetadata> binaryIngest)

downloadFile

InputStream downloadFile(String sha256)

downloadFile

InputStream downloadFile(String sha256,
                         DownloadFileParams params)

getHashSearchDataSources

reactor.core.publisher.Mono<List<String>> getHashSearchDataSources()

hashSearch

reactor.core.publisher.Mono<Map<String,HashSearchResult>> hashSearch(String fileHash,
                                                                           List<String> dataSources,
                                                                           Integer maxTimeout)

hashSearch

reactor.core.publisher.Mono<Map<String,HashSearchResult>> hashSearch(String fileHash)

getSession

String getSession()