Skip navigation links
A B C D E G H I J L O P R S U V W 

A

attachSessionContext(String, HttpSession) - Method in interface org.onehippo.cms7.services.cmscontext.CmsContextService
Creates a new CmsSessionContext attached to an existing (CMS Application HttpSession based) CmsSessionContext and stores it in the provided HttpSession under attribute CmsSessionContext.SESSION_KEY.
AutoReloadService - Interface in org.onehippo.cms7.services.autoreload
Automatically reloads the current page in connected browsers.

B

Binary - Interface in org.onehippo.cms7.services.webfiles
Binary data.
broadcastPageReload() - Method in interface org.onehippo.cms7.services.autoreload.AutoReloadService
Reloads the current page in all connected browsers.

C

CmsContextService - Interface in org.onehippo.cms7.services.cmscontext
 
CmsSessionContext - Interface in org.onehippo.cms7.services.cmscontext
Provides access to CMS Application Session Context specific information
ContentType - Interface in org.onehippo.cms7.services.contenttype
An immutable Hippo Content Type representation providing a more relaxed and enhanced form of an EffectiveNodeType exposing only non-residual ContentTypeProperty and ContentTypeChild elements with additional meta-data describing these ContentTypeItems.
ContentTypeChild - Interface in org.onehippo.cms7.services.contenttype
Represents a ContentType Property element denoting a NodeType Child Definition.
ContentTypeItem - Interface in org.onehippo.cms7.services.contenttype
Represents a ContentType property or child element representing an underlying NodeType Child or Property Definition.
ContentTypeProperty - Interface in org.onehippo.cms7.services.contenttype
Represents a ContentType Property element denoting a NodeType Property Definition.
ContentTypes - Interface in org.onehippo.cms7.services.contenttype
A lightweight and immutable representation of the ContentType definitions.
ContentTypeService - Interface in org.onehippo.cms7.services.contenttype
ContentType Service which provides access to: A lightweight and immutable representation of the current and aggregated or effective JCR Repository NodeType definitions A lightweight and immutable representation of the current ContentType definitions, including aggregated ones for specific Nodes within the repository
create(String, Binary) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
Creates a new WebFile at the given location.
createTag() - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
Creates a new tag for this entire WebFileBundle

D

delete(String) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
Removes the WebFile at absPath
dispose() - Method in interface org.onehippo.cms7.services.webfiles.Binary
Releases all resources associated with this binary and informs the implementation that these resources may now be reclaimed.

E

EffectiveNodeType - Interface in org.onehippo.cms7.services.contenttype
An immutable and aggregated or effective JCR Repository NodeType representation or an aggregation thereof to represent a concrete Node instance.
EffectiveNodeTypeChild - Interface in org.onehippo.cms7.services.contenttype
Represents a Child NodeDefinition for its containing EffectiveNodeType
EffectiveNodeTypeItem - Interface in org.onehippo.cms7.services.contenttype
Represents the common characteristics shared between the EffectiveNodeTypeChild and EffectiveNodeTypeProperty sub types.
EffectiveNodeTypeProperty - Interface in org.onehippo.cms7.services.contenttype
Represents a PropertyDefinition for its containing EffectiveNodeType
EffectiveNodeTypes - Interface in org.onehippo.cms7.services.contenttype
An lightweight and immutable representation of the aggregated or effective JCR Repository NodeType definitions.
EnvironmentSettings - Interface in org.onehippo.cms7.services.environment
 
exists(String) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
 

G

get(String) - Method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
Retrieve CMS Session Context specific information by key
get(String) - Method in interface org.onehippo.cms7.services.environment.EnvironmentSettings
Returns the String value of the environment setting for name.
get(String) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
 
get(String, String) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
 
getAccountId() - Method in interface org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService
 
getAggregatedTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getAggregatedTypes() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
getAntiCacheValue() - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
 
getBinary() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getChangedPath() - Method in class org.onehippo.cms7.services.webfiles.WebFileEvent
 
getChildren() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getChildren() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
Returns the aggregated map of all allowable Child Node definitions.
getClassLoader() - Method in class org.onehippo.cms7.services.HippoServiceRegistration
 
getCmsContextServiceId() - Method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
 
getContentTypeForNode(Node) - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
Returns the effective ContentType representation for a specific Node
getContentTypeForNodeByPath(Session, String) - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
Returns the effective ContentType representation for an existing Node identified by its absolute path
getContentTypeForNodeByUuid(Session, String) - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
Returns the effective ContentType representation for an existing Node identified by its uuid
getContentTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeService
 
getContext(HttpSession) - Static method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
Static method to retrieve the CmsSessionContext from a HttpSession
getContext(String) - Static method in class org.onehippo.cms7.services.ServletContextRegistry
 
getContexts() - Static method in class org.onehippo.cms7.services.ServletContextRegistry
 
getContexts(ServletContextRegistry.WebAppType) - Static method in class org.onehippo.cms7.services.ServletContextRegistry
 
getDefaultPrimaryType() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeChild
 
getDefaultValues() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeProperty
 
getDefiningType() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getDefiningType() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
getEffectiveNodeType() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getEffectiveNodeTypeItem() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeChild
 
getEffectiveNodeTypeItem() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getEffectiveNodeTypeItem() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeProperty
 
getEffectiveNodeTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
 
getEffectiveNodeTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeService
 
getEffectiveType() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getEncoding() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getId() - Method in interface org.onehippo.cms7.services.cmscontext.CmsContextService
Returns the unique identifier for this service
getId() - Method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
 
getItem(String) - Method in interface org.onehippo.cms7.services.contenttype.ContentType
A convenient method to directly access a defined ContentTypeProperty or ContentTypeChild element by its name.
getItemProperties() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getItemType() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
Returns the type of this item, which may be a qualified name of a ContentType (Child) or an (enhanced variant) of a NodeType property type name.
getJavaScript(String) - Method in interface org.onehippo.cms7.services.autoreload.AutoReloadService
 
getJcrWebFileBundle(Session, String) - Method in interface org.onehippo.cms7.services.webfiles.WebFilesService
Creates a web files implementation based on JCR.
getLastModified() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getLatestTagName() - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
e
getLocale() - Method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
 
getMimeType() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getMultiTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getName() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getName() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getName() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
getName() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
getName() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getPassword() - Method in interface org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService
Deprecated.
getPath() - Method in interface org.onehippo.cms7.services.webfiles.WebFile
 
getPrefix() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getPrefix() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
getPrimaryItemName() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
getPrivateKey() - Method in interface org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService
 
getProperties() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getProperties() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
Returns the aggregated map of all allowable Property definitions.
getRegistrations(Class) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
Retrieve a list of whiteboard services by it's default (class) name.
getRelativeChangedPath() - Method in class org.onehippo.cms7.services.webfiles.WebFileEvent
 
getRepositoryCredentials() - Method in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
 
getRequiredPrimaryTypes() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeChild
 
getRequiredType() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeProperty
 
getService() - Method in class org.onehippo.cms7.services.HippoServiceRegistration
 
getService(Class<T>) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
Retrieve a service by it's default (class) name.
getService(Class<T>, String) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
getSessionContext(String) - Method in interface org.onehippo.cms7.services.cmscontext.CmsContextService
Returns the CmsSessionContext by its unique id
getSize() - Method in interface org.onehippo.cms7.services.webfiles.Binary
 
getStream() - Method in interface org.onehippo.cms7.services.webfiles.Binary
Returns an InputStream representation of this binary.
getSuperTypes() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
getSuperTypes() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
getTableId() - Method in interface org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService
 
getTagNames() - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
 
getType(String) - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
 
getType() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
getType(String) - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypes
 
getTypesByPrefix() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
 
getTypesByPrefix() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypes
 
getUserName() - Method in interface org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService
 
getValidators() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
getValueConstraints() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeProperty
 
getVersion() - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
getWatchRootDir() - Method in class org.onehippo.cms7.services.webfiles.WebFileEvent
 
GoogleAnalyticsService - Interface in org.onehippo.cms7.services.googleanalytics
 

H

HippoEventBus - Interface in org.onehippo.cms7.services.eventbus
Generic Hippo event bus.
HippoEventListener - Interface in org.onehippo.cms7.services.eventbus
Developers can implement this HippoEventListener interface and implement HippoEventListener.onEvent(HippoEvent) to get a callback whenever a HippoEvent is posted to the HippoEventBus by HippoEventBus.post(Object) Note that this is a convenience interface; it is not necessary to use, as any method that is annotated with the @Subscribe annotation and has a HippoEvent argument type, will be invoked.
HippoServiceException - Exception in org.onehippo.cms7.services
 
HippoServiceException(String) - Constructor for exception org.onehippo.cms7.services.HippoServiceException
 
HippoServiceException(String, Throwable) - Constructor for exception org.onehippo.cms7.services.HippoServiceException
 
HippoServiceRegistration - Class in org.onehippo.cms7.services
The Service Registration represents a service with its context.
HippoServiceRegistry - Class in org.onehippo.cms7.services
The singleton Hippo service registry.

I

importJcrWebFileBundle(Session, File, boolean) - Method in interface org.onehippo.cms7.services.webfiles.WebFilesService
Imports a web file bundle from a directory.
importJcrWebFileBundle(Session, ZipFile, boolean) - Method in interface org.onehippo.cms7.services.webfiles.WebFilesService
Imports a web file bundle from the given zip file.
importJcrWebFiles(Session, String, String, File) - Method in interface org.onehippo.cms7.services.webfiles.WebFilesService
Imports a sub-tree of a web file bundle from a directory.
isAbstract() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
isAggregate() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isAggregate() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
isAutoCreated() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isAutoCreated() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
isCascadeValidate() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
isCascadeValidate indicates whether a content item will automatically be validated when it is of this type.
isCompoundType() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isContentType(String) - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isDerivedItem() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isDerivedType() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isDocumentType() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isEnabled() - Method in interface org.onehippo.cms7.services.autoreload.AutoReloadService
 
isMandatory() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isMandatory() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
isMixin() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
isMixin() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
isMultiple() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isMultiple() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
isMultiTyped() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isNodeType(String) - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
isOrdered() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isOrdered() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
isPrimaryItem() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
Primary items are for instance used in imagesets to define the cms preview resource.
isProperty() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
Gets the value of the property property.
isProtected() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypeItem
 
isProtected() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 
isResidual() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypeItem
 

J

JCR_ROOT_PATH - Static variable in interface org.onehippo.cms7.services.webfiles.WebFilesService
 

L

LOCALE - Static variable in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
Key to retrieve the locale applicable to the current CMS session.

O

onEvent(HippoEvent<?>) - Method in interface org.onehippo.cms7.services.eventbus.HippoEventListener
 
org.onehippo.cms7.services - package org.onehippo.cms7.services
 
org.onehippo.cms7.services.autoreload - package org.onehippo.cms7.services.autoreload
 
org.onehippo.cms7.services.cmscontext - package org.onehippo.cms7.services.cmscontext
 
org.onehippo.cms7.services.contenttype - package org.onehippo.cms7.services.contenttype
 
org.onehippo.cms7.services.environment - package org.onehippo.cms7.services.environment
 
org.onehippo.cms7.services.eventbus - package org.onehippo.cms7.services.eventbus
 
org.onehippo.cms7.services.googleanalytics - package org.onehippo.cms7.services.googleanalytics
 
org.onehippo.cms7.services.webfiles - package org.onehippo.cms7.services.webfiles
 

P

post(Object) - Method in interface org.onehippo.cms7.services.eventbus.HippoEventBus
Publish an event to registered listeners.
put(String, String) - Method in interface org.onehippo.cms7.services.environment.EnvironmentSettings
Puts a environment value for environment parameter name

R

register(Object) - Method in interface org.onehippo.cms7.services.eventbus.HippoEventBus
Deprecated.
register(ServletContext, ServletContextRegistry.WebAppType) - Static method in class org.onehippo.cms7.services.ServletContextRegistry
Register a ServletContext
registerService(Object, Class<?>) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
Register a service under a SingletonService annotated interface.
registerService(Object, Class[]) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
Register a service under a SingletonService annotated interface.
registerService(Object, Class<?>, String) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
registerService(Object, Class<?>[], String) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
REPOSITORY_CREDENTIALS - Static variable in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
Key to the the SimpleCredentials with which the CMS session authenticates with the Repository.

S

ServletContextRegistry - Class in org.onehippo.cms7.services
The ServletContextRegistry provides a central registration of web applications their ServletContext using their contextPath as key and optionally a ServletContextRegistry.WebAppType which gets set as ServletContext attribute as follows: ServletContext#setAttribute(org.onehippo.cms7.services.ServletContextRegistry.WebAppType, WebAppType).
ServletContextRegistry() - Constructor for class org.onehippo.cms7.services.ServletContextRegistry
 
ServletContextRegistry.WebAppType - Enum in org.onehippo.cms7.services
 
SESSION_KEY - Static variable in interface org.onehippo.cms7.services.cmscontext.CmsSessionContext
Attribute name under which the CmsSessionContext is bind in its HttpSession
setEnabled(boolean) - Method in interface org.onehippo.cms7.services.autoreload.AutoReloadService
Enables or disabled auto-reload.
SingletonService - Annotation Type in org.onehippo.cms7.services
Singleton annotation for a service interface.
Subscribe - Annotation Type in org.onehippo.cms7.services.eventbus
Annotation for single-argument (void) methods that indicates that the method is a listener.

U

unregister(Object) - Method in interface org.onehippo.cms7.services.eventbus.HippoEventBus
Deprecated.
use the whiteboard pattern instead
unregister(ServletContext) - Static method in class org.onehippo.cms7.services.ServletContextRegistry
Unregister a ServletContext
unregisterService(Object, Class<?>) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
unregisterService(Object, Class<?>, String) - Static method in class org.onehippo.cms7.services.HippoServiceRegistry
 
update(String, Binary) - Method in interface org.onehippo.cms7.services.webfiles.WebFileBundle
Updates the content of this WebFile.

V

valueOf(String) - Static method in enum org.onehippo.cms7.services.ServletContextRegistry.WebAppType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.onehippo.cms7.services.ServletContextRegistry.WebAppType
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in interface org.onehippo.cms7.services.contenttype.ContentType
 
version() - Method in interface org.onehippo.cms7.services.contenttype.ContentTypes
 
version() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeType
 
version() - Method in interface org.onehippo.cms7.services.contenttype.EffectiveNodeTypes
 

W

WebFile - Interface in org.onehippo.cms7.services.webfiles
A WebFile contains binary data that can be revisioned.
WebFileBundle - Interface in org.onehippo.cms7.services.webfiles
A collection of WebFiles, i.e.
WebFileEvent - Class in org.onehippo.cms7.services.webfiles
 
WebFileEvent(Path, Path) - Constructor for class org.onehippo.cms7.services.webfiles.WebFileEvent
 
WebFileException - Exception in org.onehippo.cms7.services.webfiles
 
WebFileException() - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileException
 
WebFileException(String) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileException
 
WebFileException(String, Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileException
 
WebFileException(Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileException
 
WebFileNotFoundException - Exception in org.onehippo.cms7.services.webfiles
 
WebFileNotFoundException() - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileNotFoundException
 
WebFileNotFoundException(String) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileNotFoundException
 
WebFileNotFoundException(String, Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileNotFoundException
 
WebFileNotFoundException(Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileNotFoundException
 
WebFilesService - Interface in org.onehippo.cms7.services.webfiles
 
WebFileTagNotFoundException - Exception in org.onehippo.cms7.services.webfiles
 
WebFileTagNotFoundException() - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileTagNotFoundException
 
WebFileTagNotFoundException(String) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileTagNotFoundException
 
WebFileTagNotFoundException(String, Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileTagNotFoundException
 
WebFileTagNotFoundException(Throwable) - Constructor for exception org.onehippo.cms7.services.webfiles.WebFileTagNotFoundException
 
WhiteboardService - Annotation Type in org.onehippo.cms7.services
Whiteboard annotation for a service interface.
A B C D E G H I J L O P R S U V W 
Skip navigation links

Copyright © 2012–2016 Hippo B.V. (http://www.onehippo.com). All rights reserved.