Skip navigation links
A C E F G I N O P R S U V 

A

adaptResources(Collection<Resource>, Class<T>) - Static method in class org.apache.sling.cms.CMSUtils
Adapts the collection of resources ensuring that if any cannot be adapted it is excluded from the returned list.
adaptResources(Resource[], Class<T>) - Static method in class org.apache.sling.cms.CMSUtils
Adapts the array of resources ensuring that if any cannot be adapted it is excluded from the returned list.
ATTR_EDIT_ENABLED - Static variable in class org.apache.sling.cms.CMSConstants
The Request attribute for whether or not editing is enabled

C

CMSConstants - Class in org.apache.sling.cms
Constants used throughout the Sling CMS
CMSUtils - Class in org.apache.sling.cms
Shared utility functions
Component - Interface in org.apache.sling.cms
A interface to represent a sling:Component
COMPONENT_TYPE_PAGE - Static variable in class org.apache.sling.cms.CMSConstants
The Component type for pages
ComponentManager - Interface in org.apache.sling.cms
A interface for retrieving sling:Component resources and information about the available sling:Components
CONTENT_PATH - Static variable in class org.apache.sling.cms.CMSConstants
Content path.
createUGCContainer(SlingHttpServletRequest, UGCBucketConfig, String, String) - Method in interface org.apache.sling.cms.usergenerated.UserGeneratedContentService
Creates a new container for adding user generated content which should be published when approved.

E

EditableResource - Interface in org.apache.sling.cms
A interface for representing a resource that can be edited through the Sling CMS.

F

findParentResourceofType(Resource, String) - Static method in class org.apache.sling.cms.CMSUtils
Looks up the resource tree to find the parent resource with the specified jcr:primaryType.
findPublishableParent(Resource) - Static method in class org.apache.sling.cms.CMSUtils
Look up the resource tree to find a parent of a publishable type.

G

getAction() - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
getAllComponents() - Method in interface org.apache.sling.cms.ComponentManager
Returns all of the components in Sling CMS with a component type specified.
getAllowedPaths() - Method in interface org.apache.sling.cms.PageTemplate
Gets the paths under which pages for this template can be created.
getAvailableComponentTypes() - Method in interface org.apache.sling.cms.PageTemplate
Gets the list of Component Types which will be available for pages created with this template
getAvailableTemplates() - Method in interface org.apache.sling.cms.PageTemplateManager
Gets the available templates for the current resource based on the templates in the repository and then limiting the templates by their allowed pathF
getBucket() - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
getComponent() - Method in interface org.apache.sling.cms.EditableResource
Get the component associated with this resource
getComponentConfigs() - Method in interface org.apache.sling.cms.PageTemplate
Gets the Component Configurations for this template
getComponentResource() - Method in interface org.apache.sling.cms.EditableResource
Gets the resource backing the component for the specified resource.
getComponentsByType() - Method in interface org.apache.sling.cms.ComponentManager
Returns a Map of the components with a component type specified with the key of the map being the component type and the value being the list of components for that type.
getComponentType() - Method in interface org.apache.sling.cms.Component
Returns the type of the component.
getComponentTypes() - Method in interface org.apache.sling.cms.ComponentManager
Returns a list of all of the registered component types
getContentResource() - Method in interface org.apache.sling.cms.Page
Retrieves the content Resource of the page
getContentType() - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
getCreated() - Method in interface org.apache.sling.cms.Page
Gets the date the page was created
getCreatedBy() - Method in interface org.apache.sling.cms.Page
Gets the name of the user whom created this page
getDescription() - Method in interface org.apache.sling.cms.Site
Gets the description of the site.
getEditPath() - Method in interface org.apache.sling.cms.Component
Returns the path for the editor for this resource if available
getEditPath() - Method in interface org.apache.sling.cms.EditableResource
Returns the path for the editor for this resource if available
getEditResource() - Method in interface org.apache.sling.cms.Component
Returns the resource for the editor for this resource if available
getEditResource() - Method in interface org.apache.sling.cms.EditableResource
Returns the resource for the editor for this resource if available
getKeywords() - Method in interface org.apache.sling.cms.Page
Gets the keywords for the page
getLastModified() - Method in interface org.apache.sling.cms.Page
Gets the last time this page was modified
getLastModifiedBy() - Method in interface org.apache.sling.cms.Page
Gets the username of the user who last modified the page
getLocale() - Method in interface org.apache.sling.cms.Site
Gets the locale for the sites
getLocaleString() - Method in interface org.apache.sling.cms.Site
Gets the locale as it is stored in the Sling repository
getName() - Method in interface org.apache.sling.cms.Page
Gets the name of the Sling Resource backing the page
getPage() - Method in interface org.apache.sling.cms.PageManager
Get the page containing the adapted resource
getParent() - Method in interface org.apache.sling.cms.Page
Gets the parent of the current page.
getPath() - Method in interface org.apache.sling.cms.Page
Get the path this page resides within the repository
getPath() - Method in interface org.apache.sling.cms.Site
Gets the path of the site
getPathDepth() - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
getProperties() - Method in interface org.apache.sling.cms.Page
Gets a ValueMap of the properties of the content resource for this page
getPublishedPath() - Method in interface org.apache.sling.cms.Page
Gets the path of this page after it is published on the site's primary domain with the the html extension
getPublishedUrl() - Method in interface org.apache.sling.cms.Page
Gets the full url (including domain) of this page after it is published on the site's primary domain with the the html extension
getReferences() - Method in interface org.apache.sling.cms.References
Returns a list of the resources referencing the adapted resource
getResource() - Method in interface org.apache.sling.cms.Component
The underlying Sling Resource
getResource() - Method in interface org.apache.sling.cms.EditableResource
Gets the current resource.
getResource() - Method in interface org.apache.sling.cms.Page
Gets the resource backing this pages
getResource() - Method in interface org.apache.sling.cms.PageTemplate
Gets the Resource backing this template
getResource() - Method in interface org.apache.sling.cms.Site
Gets the resource backing the site
getSite() - Method in interface org.apache.sling.cms.Page
Gets the site this page is contained within
getSite() - Method in interface org.apache.sling.cms.SiteManager
Get the site containing the current resource.
getTemplate() - Method in interface org.apache.sling.cms.Page
Gets the sling:Template this page was configured with
getTemplate() - Method in interface org.apache.sling.cms.PageTemplate
Gets the Handlebars template to use for creating the content of the page
getTemplatePath() - Method in interface org.apache.sling.cms.Page
Gets the path to the template this page was configured with.
getTitle() - Method in interface org.apache.sling.cms.Component
Get the title of the component
getTitle() - Method in interface org.apache.sling.cms.Page
Gets the title of this page, will fall back to the name of the page
getTitle() - Method in interface org.apache.sling.cms.PageTemplate
Gets the title of the template
getTitle() - Method in interface org.apache.sling.cms.Site
Gets the title of the site
getUrl() - Method in interface org.apache.sling.cms.Site
Gets the "primary" URL for the site as configured

I

isPublished(Resource) - Static method in class org.apache.sling.cms.CMSUtils
Return true of the resource (or it's publishable parent) is published or false otherwise.
isPublished() - Method in interface org.apache.sling.cms.Page
Returns true if the page is published, false otherwise
isType(String) - Method in interface org.apache.sling.cms.Component
Returns true if the only component type on the component is the specified type.

N

NAMESPACE - Static variable in class org.apache.sling.cms.CMSConstants
Node type base.
NT_COMPONENT - Static variable in class org.apache.sling.cms.CMSConstants
Component node type.
NT_FILE - Static variable in class org.apache.sling.cms.CMSConstants
File node type
NT_PAGE - Static variable in class org.apache.sling.cms.CMSConstants
Page node type.
NT_SITE - Static variable in class org.apache.sling.cms.CMSConstants
Site node type.
NT_UGC - Static variable in class org.apache.sling.cms.CMSConstants
User Generated Content node type.

O

org.apache.sling.cms - package org.apache.sling.cms
Package with all of the common models used to access content in the Sling reference CMS
org.apache.sling.cms.usergenerated - package org.apache.sling.cms.usergenerated
Handling for User Generated Content

P

Page - Interface in org.apache.sling.cms
An interface representing a sling:Page resource.
PageManager - Interface in org.apache.sling.cms
A interface used to retrieve sling:Page Resources.
PageTemplate - Interface in org.apache.sling.cms
An interface for representing a page template.
PageTemplateManager - Interface in org.apache.sling.cms
An interface for retrieving the available templates to create a page under the specified resource.
PN_CONFIG_REF - Static variable in class org.apache.sling.cms.CMSConstants
Constant for the CA Config Reference
PN_DESCRIPTION - Static variable in class org.apache.sling.cms.CMSConstants
Description attribute name
PN_LANGUAGE - Static variable in class org.apache.sling.cms.CMSConstants
i18n Locale property
PN_PUBLISHED - Static variable in class org.apache.sling.cms.CMSConstants
Published flag property
PN_SITE_URL - Static variable in class org.apache.sling.cms.CMSConstants
Constant for the Site URL
PN_TAXONOMY - Static variable in class org.apache.sling.cms.CMSConstants
Taxonomy attribute name
PN_TITLE - Static variable in class org.apache.sling.cms.CMSConstants
Title attribute name
PUBLISHABLE_TYPES - Static variable in class org.apache.sling.cms.CMSConstants
The resource types which can be published

R

References - Interface in org.apache.sling.cms
An interface for finding the references to a Resource.

S

setAction(UserGeneratedContentService.APPROVE_ACTION) - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
setBucket(String) - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
setContentType(UserGeneratedContentService.CONTENT_TYPE) - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
setPathDepth(int) - Method in class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
Site - Interface in org.apache.sling.cms
A inteface representing a sling:Site.
SiteManager - Interface in org.apache.sling.cms
A manager for retrieving the sling:Site containing the current resource.

U

UGCBucketConfig - Class in org.apache.sling.cms.usergenerated
 
UGCBucketConfig() - Constructor for class org.apache.sling.cms.usergenerated.UGCBucketConfig
 
UserGeneratedContentService - Interface in org.apache.sling.cms.usergenerated
Service for creating User Generated Content
UserGeneratedContentService.APPROVE_ACTION - Enum in org.apache.sling.cms.usergenerated
 
UserGeneratedContentService.CONTENT_TYPE - Enum in org.apache.sling.cms.usergenerated
 

V

valueOf(String) - Static method in enum org.apache.sling.cms.usergenerated.UserGeneratedContentService.APPROVE_ACTION
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.sling.cms.usergenerated.UserGeneratedContentService.CONTENT_TYPE
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.sling.cms.usergenerated.UserGeneratedContentService.APPROVE_ACTION
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.sling.cms.usergenerated.UserGeneratedContentService.CONTENT_TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
A C E F G I N O P R S U V 
Skip navigation links

Copyright © 2007–2018 The Apache Software Foundation. All rights reserved.