Optional metadataGenerator: MetadataGeneratorOptional validator: ValidatorPrivate Readonly identifierPrivate Optional Readonly metadataPrivate Readonly ownPrivate Readonly requiredPrivate Optional Readonly validatorAdds metadata related to this auxiliary resource, in case this is required for this type of auxiliary resource. The metadata that is added depends on the given identifier being an auxiliary or subject resource: the metadata will be used to link to the other one, and potentially add extra typing info.
Used for: Solid, ยง4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource." https://solid.github.io/specification/protocol#auxiliary-resources-server
The above is an example of how that metadata would only be added in case the input is the subject identifier.
Metadata to update.
Returns the identifier of the auxiliary resource corresponding to the given resource. This does not guarantee that this auxiliary resource exists.
Should error if there are multiple results: see getAuxiliaryIdentifiers.
The ResourceIdentifier of which we need the corresponding auxiliary resource.
The ResourceIdentifier of the corresponding auxiliary resource.
Returns all the identifiers of corresponding auxiliary resources. This can be used when there are potentially multiple results. In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.
The ResourceIdentifier of which we need the corresponding auxiliary resources.
The ResourceIdentifiers of the corresponding auxiliary resources.
Returns the identifier of the resource which this auxiliary resource is referring to. This does not guarantee that this resource exists.
Identifier of the auxiliary resource.
The ResourceIdentifier of the subject resource.
Checks if the input identifier corresponds to an auxiliary resource. This does not check if that auxiliary resource exists, only if the identifier indicates that there could be an auxiliary resource there.
Identifier to check.
true if the input identifier points to an auxiliary resource.
Validates if the representation contains valid data for an auxiliary resource. Should throw an error in case the data is invalid.
Representation of the auxiliary resource.
An AuxiliaryStrategy that provides its functionality through the combination of an AuxiliaryIdentifierStrategy, MetadataGenerator and Validator.