Index (hawkBit :: Artifact :: API 1.0.2 API)

A C D E F G H I M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractArtifactStorage - Class in org.eclipse.hawkbit.artifact: Abstract utility class for ArtifactRepository implementations with common functionality, e.g. computation of hashes.
AbstractArtifactStorage() - Constructor for class org.eclipse.hawkbit.artifact.AbstractArtifactStorage
addEncryptionSecrets(long) - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService: Generates encryption secrets and saves them in secret store by id reference.
addSecret(long, String, String) - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionSecretsStorage: Adds secret key/value pair associated with particular id (e.g. software module id) to the store.
ArtifactBinaryNoLongerExistsException - Exception Class in org.eclipse.hawkbit.artifact.exception: Exception indicating that an artifact's binary does not exist anymore.
ArtifactBinaryNoLongerExistsException() - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactBinaryNoLongerExistsException
ArtifactBinaryNotFoundException - Exception Class in org.eclipse.hawkbit.artifact.exception
ArtifactBinaryNotFoundException(String) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactBinaryNotFoundException
ArtifactDeleteFailedException - Exception Class in org.eclipse.hawkbit.artifact.exception: Thrown if artifact deletion failed.
ArtifactDeleteFailedException(Throwable) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactDeleteFailedException
ArtifactEncryption - Interface in org.eclipse.hawkbit.artifact.encryption: Interface definition for artifact encryption.
ArtifactEncryptionFailedException - Exception Class in org.eclipse.hawkbit.artifact.exception: Exception being thrown in case of error while generating encryption secrets, encrypting or decrypting artifacts.
ArtifactEncryptionFailedException(ArtifactEncryptionFailedException.EncryptionOperation, String, Throwable) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException
ArtifactEncryptionFailedException.EncryptionOperation - Enum Class in org.eclipse.hawkbit.artifact.exception: Encryption operation that caused the exception.
ArtifactEncryptionSecretsStorage - Interface in org.eclipse.hawkbit.artifact.encryption: Interface definition for artifact encryption secrets store.
ArtifactEncryptionService - Class in org.eclipse.hawkbit.artifact.encryption: Service responsible for encryption operations.
ArtifactEncryptionService() - Constructor for class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService
ArtifactEncryptionUnsupportedException - Exception Class in org.eclipse.hawkbit.artifact.exception: Exception being thrown when artifact encryption is not supported
ArtifactEncryptionUnsupportedException(String) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionUnsupportedException
ArtifactHashes - Record Class in org.eclipse.hawkbit.artifact.model: Representation of artifact hashes.
ArtifactHashes(String, String, String) - Constructor for record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Creates an instance of a ArtifactHashes record class.
ArtifactStorage - Interface in org.eclipse.hawkbit.artifact: Artifact Store service interface.
ArtifactStoreException - Exception Class in org.eclipse.hawkbit.artifact.exception: ArtifactStoreException is thrown in case storing of an artifact was not successful.
ArtifactStoreException(String) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactStoreException
ArtifactStoreException(String, Throwable) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactStoreException
ArtifactStream - Class in org.eclipse.hawkbit.artifact.model
ArtifactStream(InputStream, long, String) - Constructor for class org.eclipse.hawkbit.artifact.model.ArtifactStream
ArtifactUploadFailedException - Exception Class in org.eclipse.hawkbit.artifact.exception
ArtifactUploadFailedException(Throwable) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.ArtifactUploadFailedException
ArtifactUrl - Record Class in org.eclipse.hawkbit.artifact.urlresolver: Container for a generated Artifact URL.
ArtifactUrl(String, String, String) - Constructor for record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Creates an instance of a ArtifactUrl record class.
ArtifactUrlResolver - Interface in org.eclipse.hawkbit.artifact.urlresolver: Interface declaration of the ArtifactUrlResolver which generates the URLs to specific artifacts.
ArtifactUrlResolver.ApiType - Enum Class in org.eclipse.hawkbit.artifact.urlresolver: hawkBit API type.
ArtifactUrlResolver.DownloadDescriptor - Record Class in org.eclipse.hawkbit.artifact.urlresolver: Container for variables available to the ArtifactUrlResolver.

C

close() - Method in class org.eclipse.hawkbit.artifact.model.ArtifactStream
controllerId() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns the value of the controllerId record component.
createTempFile(boolean) - Static method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage

D

DDI - Enum constant in enum class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.ApiType: Support for Direct Device Integration API.
DECRYPT - Enum constant in enum class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException.EncryptionOperation
decryptArtifact(long, InputStream) - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService: Decrypts artifact stream using the keys retrieved from secrets store by id reference.
decryptStream(Map<String, String>, InputStream) - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryption: Decrypts encrypted artifact stream based on provided secrets.
deleteBySha1(String, String) - Method in interface org.eclipse.hawkbit.artifact.ArtifactStorage: Deletes an artifact by its SHA1 hash.
deleteByTenant(String) - Method in interface org.eclipse.hawkbit.artifact.ArtifactStorage: Deletes all artifacts of given tenant.
deleteTempFile(File) - Method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage
DMF - Enum constant in enum class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.ApiType: Support for Device Management Federation API.
DownloadDescriptor(String, String, Long, String, String) - Constructor for record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Creates an instance of a DownloadDescriptor record class.

E

ENCRYPT - Enum constant in enum class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException.EncryptionOperation
encryptArtifact(long, InputStream) - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService: Encrypts artifact stream using the keys retrieved from secrets store by id reference.
encryptionSizeOverhead() - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryption: Size of the underlying encryption algorithm overhead in bytes
encryptionSizeOverhead() - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService: Size of the underlying encryption algorithm overhead in bytes
encryptStream(Map<String, String>, InputStream) - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryption: Encrypts artifact stream with provided secrets.
equals(Object) - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Indicates whether some other object is "equal to" this one.
existsBySha1(String, String) - Method in interface org.eclipse.hawkbit.artifact.ArtifactStorage: Checks if an artifact exists for a given tenant by its sha1 hash

F

filename() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns the value of the filename record component.
FileSizeQuotaExceededException - Exception Class in org.eclipse.hawkbit.artifact.exception: Thrown if file size quota is exceeded
FileSizeQuotaExceededException(long) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.FileSizeQuotaExceededException

G

GENERATE_SECRETS - Enum constant in enum class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException.EncryptionOperation
generateSecrets() - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryption: Generates required secrets key/value pairs.
getBySha1(String, String) - Method in interface org.eclipse.hawkbit.artifact.ArtifactStorage: Retrieves a StoredArtifactInfo from the store by its SHA1 hash.
getInstance() - Static method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService
getSecret(long, String) - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionSecretsStorage: Retrieves secret value associated with particular id and key from the store.
getUrls(ArtifactUrlResolver.DownloadDescriptor, ArtifactUrlResolver.ApiType) - Method in interface org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver: Returns a generated download URL for a given artifact parameters for a specific protocol.
getUrls(ArtifactUrlResolver.DownloadDescriptor, ArtifactUrlResolver.ApiType) - Method in class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolver
getUrls(ArtifactUrlResolver.DownloadDescriptor, ArtifactUrlResolver.ApiType, URI) - Method in interface org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver: Returns a generated download URL for a given artifact parameters for a specific protocol.
getUrls(ArtifactUrlResolver.DownloadDescriptor, ArtifactUrlResolver.ApiType, URI) - Method in class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolver

H

hashCode() - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Returns a hash code value for this object.
hashCode() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Returns a hash code value for this object.
hashCode() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns a hash code value for this object.
HashNotMatchException - Exception Class in org.eclipse.hawkbit.artifact.exception: HashNotMatchException is thrown when provided hashes and hashes calculated during storing are not matching.
HashNotMatchException(String, String) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.HashNotMatchException

I

isEncryptionSupported() - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService: Checks if required encryption and secrets store beans are present.

M

md5() - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Returns the value of the md5 record component.
MD5 - Static variable in exception class org.eclipse.hawkbit.artifact.exception.HashNotMatchException
MGMT - Enum constant in enum class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.ApiType: Support for Management API.

O

org.eclipse.hawkbit.artifact - package org.eclipse.hawkbit.artifact
org.eclipse.hawkbit.artifact.encryption - package org.eclipse.hawkbit.artifact.encryption
org.eclipse.hawkbit.artifact.exception - package org.eclipse.hawkbit.artifact.exception
org.eclipse.hawkbit.artifact.model - package org.eclipse.hawkbit.artifact.model
org.eclipse.hawkbit.artifact.urlresolver - package org.eclipse.hawkbit.artifact.urlresolver

P

PropertyBasedArtifactUrlResolver - Class in org.eclipse.hawkbit.artifact.urlresolver: Implementation for ArtifactUrlHandler for creating urls to download resource based on patterns configured by PropertyBasedArtifactUrlResolverProperties.
PropertyBasedArtifactUrlResolver(PropertyBasedArtifactUrlResolverProperties, String) - Constructor for class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolver
PropertyBasedArtifactUrlResolverProperties - Class in org.eclipse.hawkbit.artifact.urlresolver: Artifact handler properties class for holding all supported protocols with host, ip, port and download pattern.
PropertyBasedArtifactUrlResolverProperties() - Constructor for class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolverProperties
PropertyBasedArtifactUrlResolverProperties.UrlProtocol - Class in org.eclipse.hawkbit.artifact.urlresolver: Protocol specific properties to generate URLs accordingly.
protocol() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Returns the value of the protocol record component.

R

read() - Method in class org.eclipse.hawkbit.artifact.model.ArtifactStream
read(byte[], int, int) - Method in class org.eclipse.hawkbit.artifact.model.ArtifactStream
ref() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Returns the value of the ref record component.
rel() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Returns the value of the rel record component.
requiredSecretKeys() - Method in interface org.eclipse.hawkbit.artifact.encryption.ArtifactEncryption: Defines the required secret keys for particular encryption algorithm.

S

sanitizeTenant(String) - Static method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage
setArtifactEncryption(ArtifactEncryption) - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService
setArtifactEncryptionSecretsStore(ArtifactEncryptionSecretsStorage) - Method in class org.eclipse.hawkbit.artifact.encryption.ArtifactEncryptionService
setSupports(List<ArtifactUrlResolver.ApiType>) - Method in class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolverProperties.UrlProtocol
sha1() - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Returns the value of the sha1 record component.
sha1() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns the value of the sha1 record component.
SHA1 - Static variable in exception class org.eclipse.hawkbit.artifact.exception.HashNotMatchException
sha256() - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Returns the value of the sha256 record component.
SHA256 - Static variable in exception class org.eclipse.hawkbit.artifact.exception.HashNotMatchException
softwareModuleId() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns the value of the softwareModuleId record component.
StorageQuotaExceededException - Exception Class in org.eclipse.hawkbit.artifact.exception: Thrown if storage quota is exceeded
StorageQuotaExceededException(long) - Constructor for exception class org.eclipse.hawkbit.artifact.exception.StorageQuotaExceededException
store(String, InputStream, String, String, ArtifactHashes) - Method in interface org.eclipse.hawkbit.artifact.ArtifactStorage: Stores an artifact into the repository.
store(String, InputStream, String, String, ArtifactHashes) - Method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage
store(String, ArtifactHashes, String, File) - Method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage
StoredArtifactInfo - Class in org.eclipse.hawkbit.artifact.model: Info for an imported artifact binary.
StoredArtifactInfo(String, long, ArtifactHashes) - Constructor for class org.eclipse.hawkbit.artifact.model.StoredArtifactInfo
storeTempFile(InputStream) - Method in class org.eclipse.hawkbit.artifact.AbstractArtifactStorage

T

tenant() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns the value of the tenant record component.
toString() - Method in record class org.eclipse.hawkbit.artifact.model.ArtifactHashes: Returns a string representation of this record class.
toString() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrl: Returns a string representation of this record class.
toString() - Method in record class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.DownloadDescriptor: Returns a string representation of this record class.

U

UrlProtocol() - Constructor for class org.eclipse.hawkbit.artifact.urlresolver.PropertyBasedArtifactUrlResolverProperties.UrlProtocol

V

valueOf(String) - Static method in enum class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException.EncryptionOperation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.ApiType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.eclipse.hawkbit.artifact.exception.ArtifactEncryptionFailedException.EncryptionOperation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.eclipse.hawkbit.artifact.urlresolver.ArtifactUrlResolver.ApiType: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form