Index (Hippo CMS7 Commons 15.3.0 API)

A C D E F G H I J L M N O P R S T U V W
All Classes All Packages

A

AbstractPropertyFilter - Class in org.onehippo.cms7.logging.log4j: Deprecated.
since the switch to Log4j2 in CMS v12. Instead use LookupFilter which is log4j2 based.
AbstractPropertyFilter() - Constructor for class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.
action() - Method in class org.onehippo.cms7.event.HippoEvent
action(String) - Method in class org.onehippo.cms7.event.HippoEvent
application() - Method in class org.onehippo.cms7.event.HippoEvent
application(String) - Method in class org.onehippo.cms7.event.HippoEvent
authenticate(String, char[]) - Method in interface org.hippoecm.hst.security.AuthenticationProvider: Authenticate a user.
AuthenticationProvider - Interface in org.hippoecm.hst.security: AuthenticationProvider

C

category() - Method in class org.onehippo.cms7.event.HippoEvent
category(String) - Method in class org.onehippo.cms7.event.HippoEvent
CATEGORY_GROUP_MANAGEMENT - Static variable in class org.onehippo.cms7.event.HippoEventConstants
CATEGORY_PERMISSIONS_MANAGEMENT - Static variable in class org.onehippo.cms7.event.HippoEventConstants
CATEGORY_SECURITY - Static variable in class org.onehippo.cms7.event.HippoEventConstants
CATEGORY_USER_MANAGEMENT - Static variable in class org.onehippo.cms7.event.HippoEventConstants
CATEGORY_USERROLE_MANAGEMENT - Static variable in class org.onehippo.cms7.event.HippoEventConstants
CATEGORY_WORKFLOW - Static variable in class org.onehippo.cms7.event.HippoEventConstants
cleanUp() - Static method in class org.hippoecm.hst.diagnosis.HDC: Cleans up the HDC tasks and its context.
clear() - Method in class org.onehippo.cms7.util.WeakIdentityMap
clone() - Method in class org.onehippo.cms7.event.HippoEvent
close() - Method in interface org.hippoecm.hst.diagnosis.Task
CONTAINER_PREFIX - Static variable in class org.onehippo.cms7.logging.log4j.JndiPropertyFilter: Deprecated.

JNDI prefix used in a J2EE container
containsKey(Object) - Method in class org.onehippo.cms7.util.WeakIdentityMap
createFilter(String, String, Filter.Result, Filter.Result) - Static method in class org.onehippo.cms7.logging.log4j.LookupFilter
createSubtask(Task, String) - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl: Creates a real Task instance.
customEditor() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter: This is still experimental.

D

decide(LoggingEvent) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.
DefaultTaskImpl - Class in org.hippoecm.hst.diagnosis: DefaultTaskImpl
DefaultTaskImpl(Task, String) - Constructor for class org.hippoecm.hst.diagnosis.DefaultTaskImpl
defaultValue() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter
description() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter: Deprecated.
this value is not used anywhere. To provide extra information about a parameter to the user, configure component parameter hints in the ParametersInfo class resource bundle.
displayName() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter
doCleanUp() - Method in class org.hippoecm.hst.diagnosis.HDC: Cleans up the HDC tasks and its context.
doCreateTask(String) - Method in class org.hippoecm.hst.diagnosis.HDC: Internally create a task instance by the name.
doGetCurrentTask() - Method in class org.hippoecm.hst.diagnosis.HDC: Internally returns the task instance in the current thread context if available.
doGetRootTask() - Method in class org.hippoecm.hst.diagnosis.HDC: Internally returns the root task instance if available.
doIsStarted() - Method in class org.hippoecm.hst.diagnosis.HDC: Internally check whether or not the root task was started.
doSetCurrentTask(Task) - Method in class org.hippoecm.hst.diagnosis.HDC: Internally sets the task instance in the current thread context.
doStart(String) - Method in class org.hippoecm.hst.diagnosis.HDC: Internally starts the root task by the name.
DropDownList - Annotation Type in org.hippoecm.hst.core.parameters: Indicates that the value of the annotated method should be selected from a drop-down list.

E

EmptyPropertyEditor - Interface in org.hippoecm.hst.core.parameters: Marker interface for what doesn't support custom property editor
EmptyValueListProvider - Class in org.hippoecm.hst.core.parameters: A NOP implementation that can be used as the default ValueListProvider to indicate that there's no custom ValueListProvider configured in an annotation.
EmptyValueListProvider() - Constructor for class org.hippoecm.hst.core.parameters.EmptyValueListProvider
equals(Object) - Method in class org.hippoecm.hst.security.TransientRole
equals(Object) - Method in class org.hippoecm.hst.security.TransientUser
equals(Object) - Method in class org.onehippo.cms7.util.ObjectIdentityKey

F

FieldGroup - Annotation Type in org.hippoecm.hst.core.parameters: Indicates that the annotated class contains a set of channel properties that have to be rendered as a group in a certain order.
FieldGroupList - Annotation Type in org.hippoecm.hst.core.parameters: Indicates that the annotated class contains a set of field groups that have to be rendered in a certain order.
filter() - Method in class org.onehippo.cms7.logging.log4j.LookupFilter
filter(LogEvent) - Method in class org.onehippo.cms7.logging.log4j.LookupFilter
filter(Logger, Level, Marker, Object, Throwable) - Method in class org.onehippo.cms7.logging.log4j.LookupFilter
filter(Logger, Level, Marker, String, Object...) - Method in class org.onehippo.cms7.logging.log4j.LookupFilter
filter(Logger, Level, Marker, Message, Throwable) - Method in class org.onehippo.cms7.logging.log4j.LookupFilter

G

get(Object) - Method in class org.onehippo.cms7.util.WeakIdentityMap
get(String) - Method in class org.onehippo.cms7.event.HippoEvent
getAttribute(String) - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getAttribute(String) - Method in interface org.hippoecm.hst.diagnosis.Task: Retrieve the attribute value by the attribute name.
getAttributeMap() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getAttributeMap() - Method in interface org.hippoecm.hst.diagnosis.Task: Returns attribute map which is unmodifiable.
getAttributeNames() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getAttributeNames() - Method in interface org.hippoecm.hst.diagnosis.Task: Enumerates the attribute names
getChildTasks() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getChildTasks() - Method in interface org.hippoecm.hst.diagnosis.Task: Returns the child tasks collection
getCurrentTask() - Static method in class org.hippoecm.hst.diagnosis.HDC: Returns the task in the current thread context.
getDisplayValue(String) - Method in class org.hippoecm.hst.core.parameters.EmptyValueListProvider
getDisplayValue(String) - Method in interface org.hippoecm.hst.core.parameters.ValueListProvider: Return display string value for the picker value.
getDisplayValue(String, Locale) - Method in class org.hippoecm.hst.core.parameters.EmptyValueListProvider
getDisplayValue(String, Locale) - Method in interface org.hippoecm.hst.core.parameters.ValueListProvider: Return display string value for the picker value and the specified locale.
getDurationTimeMillis() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getDurationTimeMillis() - Method in interface org.hippoecm.hst.diagnosis.Task: Returns the task execution duration time in milliseconds
getName() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getName() - Method in interface org.hippoecm.hst.diagnosis.Task: returns the task name
getName() - Method in class org.hippoecm.hst.security.TransientRole
getName() - Method in class org.hippoecm.hst.security.TransientUser
getName() - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

The property name on which to filter.
getObject() - Method in class org.onehippo.cms7.util.ObjectIdentityKey
getOnMatch() - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Returns the deciding option whether or not the log message should be logged if a match is found.
getOnMatchOption() - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Returns string representation of the option flag whether or not the log message should be logged if a match is found.
getParentTask() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
getParentTask() - Method in interface org.hippoecm.hst.diagnosis.Task
getProperty(LoggingEvent, String) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Finds the property value by the name from the underlying environment.
getProperty(LoggingEvent, String) - Method in class org.onehippo.cms7.logging.log4j.JndiPropertyFilter: Deprecated.
getRolesByUser(User) - Method in interface org.hippoecm.hst.security.AuthenticationProvider: Returns security roles of the given user
getRolesByUsername(String) - Method in interface org.hippoecm.hst.security.AuthenticationProvider: Deprecated.
since v14, will be removed in v15+. Use AuthenticationProvider.getRolesByUser(User) instead
getRootTask() - Static method in class org.hippoecm.hst.diagnosis.HDC: Returns the root task.
getTaskLog(Task) - Static method in class org.hippoecm.hst.diagnosis.TaskLogFormatUtils: Returns a nicely formatted string showing all the tasks hierarchically.
getTaskLog(Task, int) - Static method in class org.hippoecm.hst.diagnosis.TaskLogFormatUtils: Returns a formatted string from the task including its descendant tasks.
getTaskLog(Task, int, long) - Static method in class org.hippoecm.hst.diagnosis.TaskLogFormatUtils: Returns a formatted string from the task including its descendant tasks.
getUserObject() - Method in class org.hippoecm.hst.security.TransientUser
getValue() - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Gets the value to match.
getValues() - Method in class org.hippoecm.hst.core.parameters.EmptyValueListProvider
getValues() - Method in interface org.hippoecm.hst.core.parameters.ValueListProvider: Return picker value list.
getValues() - Method in class org.onehippo.cms7.event.HippoEvent

H

hashCode() - Method in class org.hippoecm.hst.security.TransientRole
hashCode() - Method in class org.hippoecm.hst.security.TransientUser
hashCode() - Method in class org.onehippo.cms7.util.ObjectIdentityKey
HDC - Class in org.hippoecm.hst.diagnosis: Hierarchical Diagnostic Context.
HDC() - Constructor for class org.hippoecm.hst.diagnosis.HDC: Protected constructor which might be called by a child class.
hideInChannelManager() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter
HippoEvent<E extends HippoEvent<E>> - Class in org.onehippo.cms7.event: Event for Hippo.
HippoEvent(String) - Constructor for class org.onehippo.cms7.event.HippoEvent
HippoEvent(HippoEvent<?>) - Constructor for class org.onehippo.cms7.event.HippoEvent: Copy constructor
HippoEventConstants - Class in org.onehippo.cms7.event
HippoSecurityEvent<T extends HippoSecurityEvent<T>> - Class in org.onehippo.cms7.event
HippoSecurityEvent(String) - Constructor for class org.onehippo.cms7.event.HippoSecurityEvent
HippoSecurityEvent(HippoEvent<?>) - Constructor for class org.onehippo.cms7.event.HippoSecurityEvent

I

ImageSetPath - Annotation Type in org.hippoecm.hst.core.parameters: Indicates that the annotated method returns the absolute path to the handle of an image set.
isEmpty() - Method in class org.onehippo.cms7.util.WeakIdentityMap
isRelative() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: Whether this path is relative to the canonical content root path of the channel in which this annotation is used.
isResourceRef() - Method in class org.onehippo.cms7.logging.log4j.JndiPropertyFilter: Deprecated.

Return whether the lookup occurs in a J2EE container.
isRunning() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
isRunning() - Method in interface org.hippoecm.hst.diagnosis.Task: Returns true if the task was started but not stopped.
isSealed() - Method in class org.onehippo.cms7.event.HippoEvent
isStarted() - Static method in class org.hippoecm.hst.diagnosis.HDC: Returns true if the root task was started.

J

JcrPath - Annotation Type in org.hippoecm.hst.core.parameters: Indicates that the annotated method returns a JCR path that can be selected via a 'picker'.
JndiPropertyFilter - Class in org.onehippo.cms7.logging.log4j: Deprecated.
since the switch to Log4j2 in CMS v12. Instead use LookupFilter which is log4j2 based.
JndiPropertyFilter() - Constructor for class org.onehippo.cms7.logging.log4j.JndiPropertyFilter: Deprecated.

L

LookupFilter - Class in org.onehippo.cms7.logging.log4j: Generic log4j2 Filter using log4j lookup variable interpolation to decide if the log event will be logged by the Appender or not.
LookupFilter(String, String, Filter.Result, Filter.Result) - Constructor for class org.onehippo.cms7.logging.log4j.LookupFilter

M

message() - Method in class org.onehippo.cms7.event.HippoEvent
message(String) - Method in class org.onehippo.cms7.event.HippoEvent

N

name() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter
newConcurrentHashMap() - Static method in class org.onehippo.cms7.util.WeakIdentityMap: Creates a new WeakIdentityMap based on a ConcurrentHashMap.
newHashMap() - Static method in class org.onehippo.cms7.util.WeakIdentityMap: Creates a new WeakIdentityMap based on a non-synchronized HashMap.
NOOP_TASK - Static variable in class org.hippoecm.hst.diagnosis.HDC

O

ObjectIdentityKey - Class in org.onehippo.cms7.util: ObjectIdentityKey is an object wrapper to be used as an object identity based key in a Collection Map or Set.
ObjectIdentityKey(Object) - Constructor for class org.onehippo.cms7.util.ObjectIdentityKey
org.hippoecm.hst.core.parameters - package org.hippoecm.hst.core.parameters
org.hippoecm.hst.diagnosis - package org.hippoecm.hst.diagnosis
org.hippoecm.hst.security - package org.hippoecm.hst.security
org.onehippo.cms7.event - package org.onehippo.cms7.event
org.onehippo.cms7.logging.log4j - package org.onehippo.cms7.logging.log4j
org.onehippo.cms7.util - package org.onehippo.cms7.util

P

Parameter - Annotation Type in org.hippoecm.hst.core.parameters: Annotation indicating that a getter method returns the value of an HST parameter.
ParametersInfo - Annotation Type in org.hippoecm.hst.core.parameters: This is an annotation to be used for org.hippoecm.hst.core.component.HstComponent's.
pickerConfiguration() - Method in annotation type org.hippoecm.hst.core.parameters.ImageSetPath: The root path of the CMS configuration to use for the image picker dialog, relative to '/hippo:configuration/hippo:frontend/cms'.
pickerConfiguration() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: The root path of the CMS configuration to use for the picker, relative to '/hippo:configuration/hippo:frontend/cms'.
pickerInitialPath() - Method in annotation type org.hippoecm.hst.core.parameters.ImageSetPath: The initial path to use in the CMS image picker if nothing has been selected yet.
pickerInitialPath() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: The initial path to use in the picker if nothing has been selected yet.
pickerRemembersLastVisited() - Method in annotation type org.hippoecm.hst.core.parameters.ImageSetPath: Whether the image picker remembers the last visited folder and image.
pickerRemembersLastVisited() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: Whether the picker remembers the last visited path.
pickerRootPath() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: The root absolute path to use in the picker.
pickerSelectableNodeTypes() - Method in annotation type org.hippoecm.hst.core.parameters.ImageSetPath: Types of nodes to be able to select in the CMS image picker.
pickerSelectableNodeTypes() - Method in annotation type org.hippoecm.hst.core.parameters.JcrPath: Types of nodes to be able to select in the picker.
previewVariant() - Method in annotation type org.hippoecm.hst.core.parameters.ImageSetPath: The variant in the image set to use as the preview image in the CMS (i.e.
put(String, Object) - Method in class org.onehippo.cms7.event.HippoEvent
put(K, V) - Method in class org.onehippo.cms7.util.WeakIdentityMap

R

remove(Object) - Method in class org.onehippo.cms7.util.WeakIdentityMap
removeAttribute(String) - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
removeAttribute(String) - Method in interface org.hippoecm.hst.diagnosis.Task: Removes the attribute by the attribute name.
required() - Method in annotation type org.hippoecm.hst.core.parameters.Parameter
result() - Method in class org.onehippo.cms7.event.HippoEvent
result(String) - Method in class org.onehippo.cms7.event.HippoEvent
Role - Interface in org.hippoecm.hst.security: Role

S

sealEvent() - Method in class org.onehippo.cms7.event.HippoEvent
set(String, Object) - Method in class org.onehippo.cms7.event.HippoEvent
setAttribute(String, Object) - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
setAttribute(String, Object) - Method in interface org.hippoecm.hst.diagnosis.Task: Set an attribute for the task.
setCurrentTask(Task) - Static method in class org.hippoecm.hst.diagnosis.HDC: Sets a task in the current thread context.
setName(String) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Sets the property name on which to filter.
setOnMatch(int) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Sets the deciding option whether or not the log message should be logged.
setOnMatchOption(String) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Sets string representation of the option flag whether or not the log message should be logged.
setResourceRef(boolean) - Method in class org.onehippo.cms7.logging.log4j.JndiPropertyFilter: Deprecated.

Set whether the lookup occurs in a J2EE container, i.e.
setValue(String) - Method in class org.onehippo.cms7.logging.log4j.AbstractPropertyFilter: Deprecated.

Sets the value to match.
size() - Method in class org.onehippo.cms7.util.WeakIdentityMap
start(String) - Static method in class org.hippoecm.hst.diagnosis.HDC: Start the root task with the name.
startSubtask(String) - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
startSubtask(String) - Method in interface org.hippoecm.hst.diagnosis.Task: Starts and returns a child subtask with the name.
stop() - Method in class org.hippoecm.hst.diagnosis.DefaultTaskImpl
stop() - Method in interface org.hippoecm.hst.diagnosis.Task: Stops the task
success() - Method in class org.onehippo.cms7.event.HippoSecurityEvent
success(Boolean) - Method in class org.onehippo.cms7.event.HippoSecurityEvent
system() - Method in class org.onehippo.cms7.event.HippoEvent
system(Boolean) - Method in class org.onehippo.cms7.event.HippoEvent

T

Task - Interface in org.hippoecm.hst.diagnosis: A unit of execution.
TaskLogFormatUtils - Class in org.hippoecm.hst.diagnosis: Utility class to get a pretty printed hierarchical task log.
TaskLogFormatUtils() - Constructor for class org.hippoecm.hst.diagnosis.TaskLogFormatUtils
timestamp() - Method in class org.onehippo.cms7.event.HippoEvent
timestamp(long) - Method in class org.onehippo.cms7.event.HippoEvent
titleKey() - Method in annotation type org.hippoecm.hst.core.parameters.FieldGroup: Returns the title key of this field group.
TransientRole - Class in org.hippoecm.hst.security
TransientRole() - Constructor for class org.hippoecm.hst.security.TransientRole
TransientRole(String) - Constructor for class org.hippoecm.hst.security.TransientRole
TransientUser - Class in org.hippoecm.hst.security: An User Principal which optionally may hold a serializable TransientUser.getUserObject() which later can be used to provide additional user info
TransientUser() - Constructor for class org.hippoecm.hst.security.TransientUser
TransientUser(String) - Constructor for class org.hippoecm.hst.security.TransientUser
TransientUser(String, Serializable) - Constructor for class org.hippoecm.hst.security.TransientUser
type() - Method in annotation type org.hippoecm.hst.core.parameters.ParametersInfo

U

user() - Method in class org.onehippo.cms7.event.HippoEvent
user(String) - Method in class org.onehippo.cms7.event.HippoEvent
User - Interface in org.hippoecm.hst.security: User

V

value() - Method in annotation type org.hippoecm.hst.core.parameters.DropDownList: Static list of options to show in the drop-down list.
value() - Method in annotation type org.hippoecm.hst.core.parameters.FieldGroup: Returns the array of channel property names in this field group.
value() - Method in annotation type org.hippoecm.hst.core.parameters.FieldGroupList
valueListProvider() - Method in annotation type org.hippoecm.hst.core.parameters.DropDownList: Deprecated.
use valueListProviderKey instead. Dynamic value list provider class that can return a list of options to show in the drop-down list dynamically from any data sources. The selected option value is converted from a String to the return type
ValueListProvider - Interface in org.hippoecm.hst.core.parameters: Dynamic value list provider which can be used with DropDownList annotation to retrieve picker value list dynamically from any data sources.
valueListProviderKey() - Method in annotation type org.hippoecm.hst.core.parameters.DropDownList: Dynamic value list provider key that can be used to get a ValueListProvider instance from the ValueListProviderService.

W

WeakIdentityMap<K,V> - Class in org.onehippo.cms7.util: Implements a combination of WeakHashMap and IdentityHashMap.

A C D E F G H I J L M N O P R S T U V W
All Classes All Packages