Package fr.gouv.vitam.common.storage.cas.container.api

Interface VitamResourceMetadata<T extends Enum<T>>

Type Parameters:

T - the VitamResourceMetadata

All Superinterfaces:

Comparable<VitamResourceMetadata<T>>

All Known Subinterfaces:

VitamStorageMetadata

public interface VitamResourceMetadata<T extends Enum<T>>
extends Comparable<VitamResourceMetadata<T>>

VitamResourceMetadata interface describing a resource metadata

Method Summary

Modifier and Type	Method	Description
Location	getLocation()	Physical location of the resource, or null if n/a
String	getName()	Name of this resource.
String	getProviderId()	Unique identifier of this resource within its enclosing namespace.
T	getType()	Whether this resource is a container, file, node, queue, etc.
URI	getUri()	URI used to access this resource
Map<String,String>	getUserMetadata()	Any key-value pairs associated with the resource.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getType

T getType()

Whether this resource is a container, file, node, queue, etc.

getProviderId

String getProviderId()

Unique identifier of this resource within its enclosing namespace. In some scenarios, this id is not user assignable. For files, this may be an system generated key, or the full path to the resource. ex. /path/to/file.txt

getName

String getName()

Name of this resource. Names are dictated by the user. For files, this may be the filename, ex. file.txt

getLocation

Location getLocation()

Physical location of the resource, or null if n/a

ex. us-west-1

getUri

URI getUri()

URI used to access this resource

getUserMetadata

Map<String,String> getUserMetadata()

Any key-value pairs associated with the resource.