com.adobe.cq.social.srp.internal

Class Configuration

java.lang.Object

com.adobe.cq.social.srp.internal.Configuration

All Implemented Interfaces:

Configuration

public class Configuration
extends java.lang.Object
implements Configuration

Implementation of com.day.cq.wcm.webservicesupport.Configuration. Used to provide a Configuration return for deprecated APIs that return it.

Constructor Summary

Constructors

Constructor and Description
Configuration(SocialResourceConfiguration socialResourceConfig) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String name, T defaultValue) Returns a property with provided name of type T or the default value if property was not found.
Resource	getContentResource() Returns the Resources content or null.
java.lang.String	getDescription() Return jcr:description property of the service.
java.lang.String	getIconPath() Returns the path to an icon for this service or null if this service does not provide an icon.
<T> T	getInherited(java.lang.String name, T defaultValue) Returns a property with provided name of type T or the default value if property was not found.
java.lang.Long	getLastModified() Return the Date of last modification of the configuration.
java.lang.String	getName() Returns the name of the configuration.
Resource	getParent() Returns the relative parent configuration Resource.
java.lang.String	getPath() Returns the path of the configuration.
InheritanceValueMap	getProperties() Returns all properties of this node accessible through the current Session.
Resource	getResource() Returns the configuration Resource.
Template	getTemplate() Returns the pages Template or null if no template has been found or the current user does not have read access to the template resource specified by the path in the page's template property.
java.lang.String	getThumbnailPath() Returns the path to a thumbnail for this service or null if this service does not provide a thumbnail.
java.lang.String	getTitle() Return the jcr:title property of the service.
java.util.Iterator<Configuration>	listChildren() Returns an Iterator of Configuration objects loaded from the children of the given Resource

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(SocialResourceConfiguration socialResourceConfig)

Constructor. Note: this is to allow for deprecated API which returns a com.day.cq.wcm.webservicesupport.Configuration Save the configuration associated with this provider

Parameters:

socialResourceConfig - the SocialResourceConfiguration.

Method Detail

getTitle

public java.lang.String getTitle()

Return the jcr:title property of the service.

Specified by:

getTitle in interface Configuration

Returns:

String representation of title

getDescription

public java.lang.String getDescription()

Return jcr:description property of the service.

Specified by:

getDescription in interface Configuration

Returns:

String representation of description

getName

public java.lang.String getName()

Returns the name of the configuration. This is the last segment of the configuration path.

Specified by:

getName in interface Configuration

Returns:

String representation of name

getPath

public java.lang.String getPath()

Returns the path of the configuration.

Specified by:

getPath in interface Configuration

Returns:

String representation of path

getLastModified

public java.lang.Long getLastModified()

Return the Date of last modification of the configuration.

Specified by:

getLastModified in interface Configuration

Returns:

UTC milliseconds of the last modification date

getIconPath

public java.lang.String getIconPath()

Returns the path to an icon for this service or null if this service does not provide an icon.

Specified by:

getIconPath in interface Configuration

Returns:

Path to an icon or null

getThumbnailPath

public java.lang.String getThumbnailPath()

Returns the path to a thumbnail for this service or null if this service does not provide a thumbnail.

Specified by:

getThumbnailPath in interface Configuration

Returns:

Path to an icon or null

getTemplate

public Template getTemplate()

Returns the pages Template or null if no template has been found or the current user does not have read access to the template resource specified by the path in the page's template property. This is the case on publish instances using default ACL configuration (anonymous cannot read templates).

Specified by:

getTemplate in interface Configuration

Returns:

Page Template or null

getParent

public Resource getParent()

Returns the relative parent configuration Resource.

Specified by:

getParent in interface Configuration

Returns:

Resource or null

getResource

public Resource getResource()

Returns the configuration Resource.

Specified by:

getResource in interface Configuration

Returns:

Resource or null

getContentResource

public Resource getContentResource()

Returns the Resources content or null.

Specified by:

getContentResource in interface Configuration

Returns:

Resource or null

getProperties

public InheritanceValueMap getProperties()

Returns all properties of this node accessible through the current Session.

Specified by:

getProperties in interface Configuration

Returns:

InheritanceValueMap with all inherited properties

get

public <T> T get(java.lang.String name,
                 T defaultValue)

Returns a property with provided name of type T or the default value if property was not found. Return the requested configuration information Only String type returned.

Specified by:

get in interface Configuration

Type Parameters:

T - Type of the property

Parameters:

name - Property name

defaultValue - Default value

Returns:

Property value

getInherited

public <T> T getInherited(java.lang.String name,
                          T defaultValue)

Returns a property with provided name of type T or the default value if property was not found. Takes properties of parent resources / pages into account, if the property is not found locally.

Specified by:

getInherited in interface Configuration

Type Parameters:

T - Type of the property

Parameters:

name - Property name

defaultValue - Default value

Returns:

Property value

listChildren

public java.util.Iterator<Configuration> listChildren()

Returns an Iterator of Configuration objects loaded from the children of the given Resource

Specified by:

listChildren in interface Configuration

Returns:

Configuration child Iterator