gov.nist.secauto.swid.builder.resource.firmware

Class FirmwareBuilder

java.lang.Object

gov.nist.secauto.swid.builder.AbstractBuilder

gov.nist.secauto.swid.builder.AbstractLanguageSpecificBuilder<E>

gov.nist.secauto.swid.builder.resource.AbstractResourceBuilder<FirmwareBuilder>

gov.nist.secauto.swid.builder.resource.firmware.FirmwareBuilder

All Implemented Interfaces:

Builder, ResourceBuilder

public class FirmwareBuilder
extends AbstractResourceBuilder<FirmwareBuilder>

Constructor Summary

Constructors

Constructor and Description
FirmwareBuilder()

Method Summary

Modifier and Type	Method and Description
<T> void	accept(T parentContext, ResourceCollectionEntryGenerator<T> creator)
FirmwareBuilder	addAlias(ResourceReference alias) Adds a new alias to the list of aliases.
FirmwareBuilder	addDependency(ResourceReference dependency) Adds a new dependency to the list of aliases.
FirmwareBuilder	addExtension(int extenstionType, byte[] extension) Adds a new extension object.
FirmwareBuilder	addPayload(FirmwarePayloadBuilder payload) Adds a new payload to the list of payloads.
FirmwareBuilder	blockDeviceIdentifier(String blockDeviceIdentifier) Set the block device identifier.
static FirmwareBuilder	create()
FirmwareBuilder	creationTimestamp(ZonedDateTime dateTime) Set the creation timestamp of the firmware manifest.
FirmwareBuilder	description(String description) Set the version of the firmware manifest.
List<ResourceReference>	getAliases() Retrieve the aliases of the firmware manifest.
String	getBlockDeviceIdentifier() Retrieve the block device identifier for the firmware.
ZonedDateTime	getCreationTimestamp() Retrieve the identifier of the firmware manifest.
List<ResourceReference>	getDependencies() Retrieve the dependencies of the firmware manifest.
String	getDescription() Retrieve the description of the firmware manifest.
Map<Integer,byte[]>	getExtensions() Retrieve the firmware manifest extensions.
FirmwareIdentifier	getId() Retrieve the identifier of the firmware manifest.
byte[]	getNonce() Retrieve the nonce of the firmware manifest.
List<FirmwarePayloadBuilder>	getPayloads() Retrieve the firmware payloads of the firmware manifest.
DeviceIdentifier	getTargetDeviceIdentifier() Retrieve the target device identifier for the firmware manifest.
BigInteger	getVersion() Retrieve the version of the firmware manifest.
FirmwareBuilder	id(FirmwareIdentifier id) Set the id of the firmware manifest.
FirmwareBuilder	nonce(byte[] nonce) Set the nonce of the firmware manifest.
FirmwareBuilder	targetDeviceIdentifier(DeviceIdentifier targetDeviceIdentifier) Set the target device identifier.
void	validate()
FirmwareBuilder	version(BigInteger version) Set the version of the firmware manifest.

Methods inherited from class gov.nist.secauto.swid.builder.AbstractLanguageSpecificBuilder

getLanguage, language, reset

Methods inherited from class gov.nist.secauto.swid.builder.AbstractBuilder

isValid, validateNonEmpty, validateNonEmpty, validateNonEmpty, validateNonEmpty, validateNonNull, validatePatternMatch

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.swid.builder.Builder

isValid, reset

Constructor Detail

FirmwareBuilder

public FirmwareBuilder()

Method Detail

accept

public <T> void accept(T parentContext,
                       ResourceCollectionEntryGenerator<T> creator)

getId

public FirmwareIdentifier getId()

Retrieve the identifier of the firmware manifest.

Returns:

the id

id

public FirmwareBuilder id(FirmwareIdentifier id)

Set the id of the firmware manifest.

Parameters:

id - the firmware's identifier

Returns:

the same builder instance

getCreationTimestamp

public ZonedDateTime getCreationTimestamp()

Retrieve the identifier of the firmware manifest.

Returns:

the creationTimestamp

creationTimestamp

public FirmwareBuilder creationTimestamp(ZonedDateTime dateTime)

Set the creation timestamp of the firmware manifest.

Parameters:

dateTime - the creationTimestamp to set

Returns:

the same builder instance

getVersion

public BigInteger getVersion()

Retrieve the version of the firmware manifest.

Returns:

the version

version

public FirmwareBuilder version(BigInteger version)

Set the version of the firmware manifest.

Parameters:

version - the firmware's version

Returns:

the same builder instance

getDescription

public String getDescription()

Retrieve the description of the firmware manifest.

Returns:

the description

description

public FirmwareBuilder description(String description)

Set the version of the firmware manifest.

Parameters:

description - the firmware's description

Returns:

the same builder instance

getNonce

public byte[] getNonce()

Retrieve the nonce of the firmware manifest.

Returns:

the nonce

nonce

public FirmwareBuilder nonce(byte[] nonce)

Set the nonce of the firmware manifest.

Parameters:

nonce - the firmware's nonce

Returns:

the same builder instance

getAliases

public List<ResourceReference> getAliases()

Retrieve the aliases of the firmware manifest.

Returns:

the aliases

addAlias

public FirmwareBuilder addAlias(ResourceReference alias)

Adds a new alias to the list of aliases.

Parameters:

alias - the alias to add

Returns:

the same builder instance

getDependencies

public List<ResourceReference> getDependencies()

Retrieve the dependencies of the firmware manifest.

Returns:

the dependencies

addDependency

public FirmwareBuilder addDependency(ResourceReference dependency)

Adds a new dependency to the list of aliases.

Parameters:

dependency - the dependency to add

Returns:

the same builder instance

getBlockDeviceIdentifier

public String getBlockDeviceIdentifier()

Retrieve the block device identifier for the firmware.

Returns:

the blockDeviceIdentifier

blockDeviceIdentifier

public FirmwareBuilder blockDeviceIdentifier(String blockDeviceIdentifier)

Set the block device identifier.

Parameters:

blockDeviceIdentifier - a non-null block device identifier

Returns:

the same builder instance

getTargetDeviceIdentifier

public DeviceIdentifier getTargetDeviceIdentifier()

Retrieve the target device identifier for the firmware manifest.

Returns:

the targetDeviceIdentifier

targetDeviceIdentifier

public FirmwareBuilder targetDeviceIdentifier(DeviceIdentifier targetDeviceIdentifier)

Set the target device identifier.

Parameters:

targetDeviceIdentifier - a non-null target device identifier

Returns:

the same builder instance

getPayloads

public List<FirmwarePayloadBuilder> getPayloads()

Retrieve the firmware payloads of the firmware manifest.

Returns:

the payloads

addPayload

public FirmwareBuilder addPayload(FirmwarePayloadBuilder payload)

Adds a new payload to the list of payloads.

Parameters:

payload - the payload to add

Returns:

the same builder instance

getExtensions

public Map<Integer,byte[]> getExtensions()

Retrieve the firmware manifest extensions.

Returns:

the extensions

addExtension

public FirmwareBuilder addExtension(int extenstionType,
                                    byte[] extension)

Adds a new extension object.

Parameters:

extenstionType - the extension type identifier

extension - the extension content

Returns:

the same builder instance

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Builder

Overrides:

validate in class AbstractLanguageSpecificBuilder<FirmwareBuilder>

Throws:

ValidationException

create

public static FirmwareBuilder create()