Class ResourceMetadata
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<String,Object>
-
- org.apache.sling.api.resource.ResourceMetadata
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<String,Object>
public class ResourceMetadata extends HashMap<String,Object>
TheResourceMetadata
interface defines the API for the metadata of a SlingResource
. Essentially the resource's metadata is just a map of objects indexed by string keys.The actual contents of the meta data map is implementation specific with the exception of the
sling.resolutionPath
property which must be provided by all implementations and contain the part of the request URI used to resolve the resource. The type of this property value is defined to beString
.Note, that the prefix sling. to key names is reserved for the Sling implementation. Once a resource is returned by the
ResourceResolver
, the resource metadata is made read-only and therefore can't be changed by client code!- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static String
CHARACTER_ENCODING
The name of the optional property providing the character encoding of the resource if the resource is streamable and contains character data (value is "sling.characterEncoding").static String
CONTENT_LENGTH
The name of the optional property providing the content length of the resource if the resource is streamable (value is "sling.contentLength").static String
CONTENT_TYPE
The name of the optional property providing the content type of the resource if the resource is streamable (value is "sling.contentType").static String
CREATION_TIME
Returns the creation time of this resource in the repository in milliseconds (value is "sling.creationTime").static String
INTERNAL_CONTINUE_RESOLVING
Deprecated.This flag is not supported anymore when implementing the SPI basedorg.apache.sling.spi.resource.provider.ResourceProvider
static String
MODIFICATION_TIME
Returns the last modification time of this resource in the repository in milliseconds (value is "sling.modificationTime").static String
PARAMETER_MAP
Returns a map containing parameters added to path after semicolon.static String
RESOLUTION_PATH
The name of the required property providing the part of the request URI which was used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPath").static String
RESOLUTION_PATH_INFO
The name of the required property providing the part of the request URI which was not used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPathInfo").
-
Constructor Summary
Constructors Constructor Description ResourceMetadata()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Object
clone()
@NotNull Set<Map.Entry<String,Object>>
entrySet()
@Nullable String
getCharacterEncoding()
long
getContentLength()
@Nullable String
getContentType()
long
getCreationTime()
long
getModificationTime()
@Nullable Map<String,String>
getParameterMap()
@Nullable String
getResolutionPath()
@Nullable String
getResolutionPathInfo()
@NotNull Set<String>
keySet()
void
lock()
Make this object read-only.Object
put(@NotNull String key, Object value)
void
putAll(@NotNull Map<? extends String,? extends Object> m)
Object
remove(@NotNull Object key)
void
setCharacterEncoding(String encoding)
void
setContentLength(long contentLength)
void
setContentType(String contentType)
void
setCreationTime(long creationTime)
Sets theCREATION_TIME
property tocreationTime
if not negative.void
setModificationTime(long modificationTime)
Sets theMODIFICATION_TIME
property tomodificationTime
if not negative.void
setParameterMap(Map<String,String> parameterMap)
void
setResolutionPath(String resolutionPath)
void
setResolutionPathInfo(String resolutionPathInfo)
@NotNull Collection<Object>
values()
-
Methods inherited from class java.util.HashMap
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, getOrDefault, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
-
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
-
-
-
Field Detail
-
RESOLUTION_PATH
public static final String RESOLUTION_PATH
The name of the required property providing the part of the request URI which was used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPath").- See Also:
- Constant Field Values
-
RESOLUTION_PATH_INFO
public static final String RESOLUTION_PATH_INFO
The name of the required property providing the part of the request URI which was not used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPathInfo"). The value of this property concatenated to the value of thesling.resolutionPath
property returns the original request URI leading to the resource.This property is optional. If missing, it should be assumed equal to an empty string.
- Since:
- 2.0.4 (Sling API Bundle 2.0.4)
- See Also:
- Constant Field Values
-
CONTENT_TYPE
public static final String CONTENT_TYPE
The name of the optional property providing the content type of the resource if the resource is streamable (value is "sling.contentType"). This property may be missing if the resource is not streamable or if the content type is not known.- See Also:
- Constant Field Values
-
CONTENT_LENGTH
public static final String CONTENT_LENGTH
The name of the optional property providing the content length of the resource if the resource is streamable (value is "sling.contentLength"). This property may be missing if the resource is not streamable or if the content length is not known.Note, that unlike the other properties, this property may be set only after the resource has successfully been adapted to an
InputStream
for performance reasons.- See Also:
- Constant Field Values
-
CHARACTER_ENCODING
public static final String CHARACTER_ENCODING
The name of the optional property providing the character encoding of the resource if the resource is streamable and contains character data (value is "sling.characterEncoding"). This property may be missing if the resource is not streamable or if the character encoding is not known.- See Also:
- Constant Field Values
-
CREATION_TIME
public static final String CREATION_TIME
Returns the creation time of this resource in the repository in milliseconds (value is "sling.creationTime"). The type of this property isjava.lang.Long
. The property may be missing if the resource is not streamable or if the creation time is not known.- See Also:
- Constant Field Values
-
MODIFICATION_TIME
public static final String MODIFICATION_TIME
Returns the last modification time of this resource in the repository in milliseconds (value is "sling.modificationTime"). The type of this property isjava.lang.Long
. The property may be missing if the resource is not streamable or if the last modification time is not known.- See Also:
- Constant Field Values
-
INTERNAL_CONTINUE_RESOLVING
@Deprecated public static final String INTERNAL_CONTINUE_RESOLVING
Deprecated.This flag is not supported anymore when implementing the SPI basedorg.apache.sling.spi.resource.provider.ResourceProvider
Returns whether the resource resolver should continue to search for a resource. A resource provider can set this flag to indicate that the resource resolver should search for a provider with a lower priority. If it finds a resource using such a provider, that resource is returned instead. If none is found this resource is returned. This flag should never be manipulated by application code! The value of this property has no meaning, the resource resolver just checks whether this flag is set or not.- Since:
- 2.2 (Sling API Bundle 2.2.0)
- See Also:
- Constant Field Values
-
PARAMETER_MAP
public static final String PARAMETER_MAP
Returns a map containing parameters added to path after semicolon. For instance, map for path/content/test;v='1.2.3'.html
will contain one entry keyv
and value1.2.3
.- See Also:
- Constant Field Values
-
-
Method Detail
-
setCharacterEncoding
public void setCharacterEncoding(String encoding)
- Parameters:
encoding
- The encoding
-
getCharacterEncoding
@Nullable public @Nullable String getCharacterEncoding()
Returns theCHARACTER_ENCODING
property if notnull
and aString
instance. Otherwisenull
is returned.- Returns:
- The character encoding
-
setContentType
public void setContentType(String contentType)
- Parameters:
contentType
- The content type
-
getContentType
@Nullable public @Nullable String getContentType()
- Returns:
- The content type
-
setContentLength
public void setContentLength(long contentLength)
- Parameters:
contentLength
- The content length
-
getContentLength
public long getContentLength()
- Returns:
- The content length
-
setCreationTime
public void setCreationTime(long creationTime)
Sets theCREATION_TIME
property tocreationTime
if not negative.- Parameters:
creationTime
- The creation time
-
getCreationTime
public long getCreationTime()
- Returns:
- The creation time
-
setModificationTime
public void setModificationTime(long modificationTime)
Sets theMODIFICATION_TIME
property tomodificationTime
if not negative.- Parameters:
modificationTime
- The modification time
-
getModificationTime
public long getModificationTime()
- Returns:
- The modification time
-
setResolutionPath
public void setResolutionPath(String resolutionPath)
- Parameters:
resolutionPath
- The resolution path
-
getResolutionPath
@Nullable public @Nullable String getResolutionPath()
- Returns:
- The resolution path
-
setResolutionPathInfo
public void setResolutionPathInfo(String resolutionPathInfo)
- Parameters:
resolutionPathInfo
- The resolution path info
-
getResolutionPathInfo
@Nullable public @Nullable String getResolutionPathInfo()
Returns theRESOLUTION_PATH_INFO
property if notnull
and aString
instance. Otherwisenull
is returned.- Returns:
- The resolution path info
-
setParameterMap
public void setParameterMap(Map<String,String> parameterMap)
- Parameters:
parameterMap
- The parameter map
-
getParameterMap
@Nullable public @Nullable Map<String,String> getParameterMap()
- Returns:
- The parameter map
-
lock
public void lock()
Make this object read-only. All method calls trying to modify this object result in an exception!- Since:
- 2.3 (Sling API Bundle 2.4.0)
-
clear
public void clear()
-
-