com.adobe.cq.social.srp.internal

Class MapResourceImpl

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.api.resource.AbstractResource

com.adobe.cq.social.srp.internal.MapResourceImpl

All Implemented Interfaces:

MapResource, SocialResource, Adaptable, Resource

public class MapResourceImpl
extends AbstractResource
implements MapResource

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor and Description
MapResourceImpl(ResourceResolver resolver, CachingResourceProvider provider, java.lang.String resolvedPath, java.util.Map<java.lang.String,java.lang.Object> doc, boolean isAttachment)

Method Summary

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(java.lang.Class<AdapterType> type) Calls into the registered AdapterManager to adapt this object to the desired type.
boolean	checkPermissions(java.lang.String permission)
static java.lang.String	getAclPathGivenBase(java.lang.String path, java.lang.String providerBase)
Resource	getParent() Returns the parent resource of this resource.
java.lang.String	getPath() Returns the absolute path of this resource in the resource tree.
ResourceMetadata	getResourceMetadata() Returns the meta data of this resource.
SocialResourceProvider	getResourceProvider()
ResourceResolver	getResourceResolver() Returns the ResourceResolver from which this resource has been retrieved.
java.lang.String	getResourceSuperType() Returns the super type of the resource if the resource defines its own super type.
java.lang.String	getResourceType() The resource type is meant to point to rendering/processing scripts, editing dialogs, etc.
Resource	getRootJCRNode()
boolean	isAttachment()
void	unlockMetadata() Unlocks the metadata for this resource.
void	update()

Methods inherited from class org.apache.sling.api.resource.AbstractResource

getChild, getChildren, getName, getValueMap, hasChildren, isResourceType, listChildren

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sling.api.resource.Resource

getChild, getChildren, getName, getValueMap, hasChildren, isResourceType, listChildren

Constructor Detail

MapResourceImpl

public MapResourceImpl(ResourceResolver resolver,
                       CachingResourceProvider provider,
                       java.lang.String resolvedPath,
                       java.util.Map<java.lang.String,java.lang.Object> doc,
                       boolean isAttachment)

Method Detail

getParent

public Resource getParent()

Returns the parent resource of this resource.

This method is implemented calling the ResourceResolver.getParent(Resource) method.

Specified by:

getParent in interface Resource

Overrides:

getParent in class AbstractResource

Returns:

The parent resource or null.

See Also:

ResourceResolver.getParent(Resource)

getPath

public java.lang.String getPath()

Returns the absolute path of this resource in the resource tree.

Specified by:

getPath in interface Resource

Returns:

The resource path

getResourceType

public java.lang.String getResourceType()

The resource type is meant to point to rendering/processing scripts, editing dialogs, etc. It is usually a path in the repository, where scripts and other tools definitions are found, but the ResourceResolver is free to set this to any suitable value such as the primary node type of the JCR node from which the resource is created.

If the resource instance represents a resource which is not actually existing, this method returns Resource.RESOURCE_TYPE_NON_EXISTING.

Specified by:

getResourceType in interface Resource

Returns:

The resource type

getResourceSuperType

public java.lang.String getResourceSuperType()

Returns the super type of the resource if the resource defines its own super type. Otherwise null is returned. A resource might return a resource super type to overwrite the resource type hierarchy. If a client is interested in the effective resource super type of a resource, it should call ResourceResolver.getParentResourceType(Resource).

Specified by:

getResourceSuperType in interface Resource

Returns:

The super type of the resource or null.

getResourceMetadata

public ResourceMetadata getResourceMetadata()

Returns the meta data of this resource. The concrete data contained in the ResourceMetadata object returned is implementation specific except for the ResourceMetadata.RESOLUTION_PATH property which is required to be set to the part of the request URI used to resolve the resource.

Specified by:

getResourceMetadata in interface Resource

Returns:

The resource meta data

See Also:

ResourceMetadata

getResourceResolver

public ResourceResolver getResourceResolver()

Returns the ResourceResolver from which this resource has been retrieved.

Specified by:

getResourceResolver in interface Resource

Returns:

The resource resolver

getResourceProvider

public SocialResourceProvider getResourceProvider()

Specified by:

getResourceProvider in interface SocialResource

adaptTo

public <AdapterType> AdapterType adaptTo(java.lang.Class<AdapterType> type)

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

AdapterType - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type

update

public void update()

getRootJCRNode

public Resource getRootJCRNode()

Specified by:

getRootJCRNode in interface SocialResource

isAttachment

public boolean isAttachment()

Specified by:

isAttachment in interface MapResource

Returns:

true if this resource represents an attachment.

unlockMetadata

public void unlockMetadata()

Unlocks the metadata for this resource. When the resources are cached their metatadata needs to be unlocked before being returned to the caller.

Specified by:

unlockMetadata in interface MapResource

getAclPathGivenBase

public static java.lang.String getAclPathGivenBase(java.lang.String path,
                                                   java.lang.String providerBase)

checkPermissions

public boolean checkPermissions(java.lang.String permission)

Specified by:

checkPermissions in interface SocialResource