A B C D E F G H I J L M O P R S T U V W X

A

AbstractAdminServlet - Class in com.endeca.infront.assembler.servlet.admin

The AbstractAdminServlet serves as a hook into the Assembler in order to retrieve additional information, or act upon the Assembler's runtime configuration.

AbstractAdminServlet() - Constructor for class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

AbstractAssemblerServlet - Class in com.endeca.infront.assembler.servlet

Servlet used to invoke the Assembler and process its results.

AbstractAssemblerServlet() - Constructor for class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet

AbstractCartridgeHandler - Class in com.endeca.infront.assembler

An abstract implementation of CartridgeHandler that provides no-op implementations of CartridgeHandler.initialize(ContentItem) and CartridgeHandler.preprocess(ContentItem).

AbstractCartridgeHandler() - Constructor for class com.endeca.infront.assembler.AbstractCartridgeHandler

AbstractContentSource - Class in com.endeca.infront.content.source

Base implementation of the ContentSource interface.

AbstractContentSource(String) - Constructor for class com.endeca.infront.content.source.AbstractContentSource

Deprecated.

AbstractContentSource() - Constructor for class com.endeca.infront.content.source.AbstractContentSource

Constructs a content source.

addAssemblerEventListener(AssemblerEventListener) - Method in interface com.endeca.infront.assembler.Assembler

Adds a listener to all activity within the context of this request.

addDefaults(ContentItem, ContentItem) - Static method in class com.endeca.infront.cartridge.ConfigInitializer

Helper method for adding defaults "below" the values present in a given ContentItem.

addEventSerializer(EventSerializer) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Registers a serializer with the system.

addHandler(String, EventHandler) - Static method in class com.endeca.infront.perf.PerfUtil

Registers the given handler to receive Events with topics that match the specified pattern.

addProfileGroups(String) - Method in class com.endeca.infront.content.UserState

Convenience method to add a profile groups to the currently active set of profile groups.

addProfileGroups(String) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Convenience method to add a profile groups to the currently active set of profile groups.

addProperty(String, String) - Method in class com.endeca.infront.site.model.SiteState

Sets a String property in SiteState.

addUserSegments(String) - Method in class com.endeca.infront.content.UserState

Convenience method to add a user segments to the currently active set of user segments.

addUserSegments(String) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Convenience method to add a user segments to the currently active set of user segments.

ADMIN_SERVICE_BEAN_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.admin.SpringAdminServlet

AdministrationOperations - Enum in com.endeca.infront.assembler.servlet.admin

Potential Administrative Operations supported by the Administration Service in the Assembler.

AdministrationService - Class in com.endeca.infront.assembler.servlet.admin

The Administration Service is designed to handle requests that require communication and updates to and from Assembler services.

AdministrationService() - Constructor for class com.endeca.infront.assembler.servlet.admin.AdministrationService

all - Variable in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

All the inclusive (descendant and self) time recorded

assemble(ContentItem) - Method in interface com.endeca.infront.assembler.Assembler

Invokes the assembly process and returns the assembled results.

Assembler - Interface in com.endeca.infront.assembler

Used to invoke a single assembly process.

ASSEMBLER_FACTORY_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

The servlet parameter used to specify the Spring bean ID of the AssemblerFactory to use.

AssemblerEvent - Class in com.endeca.infront.assembler.event

Event type that transmits information about activity within the Assembler.

AssemblerEvent(Assembler, ContentItem, CartridgeHandler<?>, Throwable) - Constructor for class com.endeca.infront.assembler.event.AssemblerEvent

Constructor.

AssemblerEventAdapter - Class in com.endeca.infront.assembler.event

Contains an empty implementation of each method on the AssemblerEventListener interface.

AssemblerEventAdapter() - Constructor for class com.endeca.infront.assembler.event.AssemblerEventAdapter

AssemblerEventListener - Interface in com.endeca.infront.assembler.event

AssemblerEventListeners are notified before and after each step of the assembly process.

AssemblerException - Exception in com.endeca.infront.assembler

Indicates that an exception occurred while creating or processing an assembler request.

AssemblerException() - Constructor for exception com.endeca.infront.assembler.AssemblerException

Constructs a new AssemblerException with null as its detail message.

AssemblerException(String) - Constructor for exception com.endeca.infront.assembler.AssemblerException

Constructs a new AssemblerException with the specified detail message.

AssemblerException(Throwable) - Constructor for exception com.endeca.infront.assembler.AssemblerException

Constructs a new AssemblerException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

AssemblerException(String, Throwable) - Constructor for exception com.endeca.infront.assembler.AssemblerException

Constructs a new AssemblerException with the specified detail message and cause.

AssemblerFactory - Interface in com.endeca.infront.assembler

Interface for assembler factory implementations.

AssemblerPerfUtils - Class in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0, replaced by PerfUtil
A static interface to ease use of Assembler performance timing primitives. A thread-local is used to store the current thread's performance events. The only provided Event is the TimeEvent. Events may be serialized by registering EventSerializer's with this interface, two of which are provided:

• PerfLogTimeEventSerializer
• StatsPageTimeEventSerializer

Events may be serialized by registering EventSerializer's with this interface, two of which are provided:

• PerfLogTimeEventSerializer
• StatsPageTimeEventSerializer

AssemblerSettings - Class in com.endeca.infront.assembler

Used to configure an Assembler.

AssemblerSettings() - Constructor for class com.endeca.infront.assembler.AssemblerSettings

assemblyComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

assemblyComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

An assembly process has completed.

assemblyComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

This method sets the assembly finish time in the request event and calls RequestEventFactory.resetEvent().

assemblyComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener

This method calls RequestEventListener.handleAssemblerRequestEvent(RequestEvent, ContentItem).

assemblyError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

assemblyError(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

An assembly has been aborted due to an unrecoverable error.

assemblyError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

Cleans up the RequestEvent for the current request

assemblyStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

assemblyStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A new assembly is about to start.

assemblyStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

Initializes the RequestEvent for the current request and request id.

AUDIT_CONTENTS - Static variable in class com.endeca.infront.cartridge.ContentSlotHandler

Key for the list of audit content items.

AuthoringContentSource - Class in com.endeca.infront.content.source

Deprecated.

AuthoringContentSource(String, String, String, int, String, String, boolean) - Constructor for class com.endeca.infront.content.source.AuthoringContentSource

Deprecated.

B

BasicContentItem - Class in com.endeca.infront.assembler

Convenience class to extend when implementing ContentItem

BasicContentItem() - Constructor for class com.endeca.infront.assembler.BasicContentItem

Creates a new BasicContentItem without a type.

BasicContentItem(String) - Constructor for class com.endeca.infront.assembler.BasicContentItem

Creates a new BasicContentItem without the specified type.

BasicContentItem(ContentItem) - Constructor for class com.endeca.infront.assembler.BasicContentItem

Copy constructor.

BasicContentPathTranslator - Class in com.endeca.infront.site

This is a basic implementation of the ContentPathTranslator.

BasicContentPathTranslator() - Constructor for class com.endeca.infront.site.BasicContentPathTranslator

C

cartridgeError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgeError(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

Processing of a cartridge has failed due to a local error.

CartridgeHandler<T extends ContentItem> - Interface in com.endeca.infront.assembler

An interface for inserting custom cartridge logic into the assembler.

CartridgeHandlerException - Exception in com.endeca.infront.assembler

Indicates that an exception occurred while invoking a single cartridge handler.

CartridgeHandlerException() - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException

Constructs a new CartridgeHandlerException with null as its detail message.

CartridgeHandlerException(String) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException

Constructs a new CartridgeHandlerException with the specified detail message.

CartridgeHandlerException(Throwable) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException

Constructs a new CartridgeHandlerException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

CartridgeHandlerException(String, Throwable) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException

Constructs a new CartridgeHandlerException with the specified detail message and cause.

cartridgeInitializeComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgeInitializeComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler has finished its CartridgeHandler.initialize(ContentItem) method.

cartridgeInitializeStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgeInitializeStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler is about to start its CartridgeHandler.initialize(ContentItem) method.

cartridgePreprocessComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgePreprocessComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler has finished its CartridgeHandler.preprocess(ContentItem) method.

cartridgePreprocessStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgePreprocessStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler is about to start its CartridgeHandler.preprocess(ContentItem) method.

cartridgeProcessComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgeProcessComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler has finished its CartridgeHandler.process(ContentItem) method.

cartridgeProcessStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter

cartridgeProcessStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener

A cartridge handler is about to start its CartridgeHandler.process(ContentItem) method.

closeInternalNode() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

closeItem() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

closeList() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

com.endeca.infront.assembler - package com.endeca.infront.assembler

Contains the core interfaces for the Assembler.

com.endeca.infront.assembler.event - package com.endeca.infront.assembler.event

The Assembler Event listening interface.

com.endeca.infront.assembler.event.request - package com.endeca.infront.assembler.event.request

Interface for tracking information related to individual Assembler.assemble() calls.

com.endeca.infront.assembler.perf - package com.endeca.infront.assembler.perf

Contains a HTTP filter to monitor requests to an Assembler-based application.

com.endeca.infront.assembler.perf.config - package com.endeca.infront.assembler.perf.config

Deprecated as of release 11.0. A set of configuration beans used for configuring the Assembler Perf monitoring system.

com.endeca.infront.assembler.perf.serializers - package com.endeca.infront.assembler.perf.serializers

Deprecated as of release 11.0. Contains serializers to be used with the Assembler performance monitoring package.

com.endeca.infront.assembler.servlet - package com.endeca.infront.assembler.servlet

This package provides an HttpServlet interface over an Assembler to serve Assembler clients over the wire.

com.endeca.infront.assembler.servlet.admin - package com.endeca.infront.assembler.servlet.admin

Provides a hook into the Assembler to perform administrative operations at runtime.

com.endeca.infront.assembler.servlet.spring - package com.endeca.infront.assembler.servlet.spring

Contains an implementation of the Assembler Servlet powered by Spring for bean resolution.

com.endeca.infront.assembler.servlet.spring.admin - package com.endeca.infront.assembler.servlet.spring.admin

Contains an implementation of the Assembler Administration Servlet powered by Spring for bean resolution.

com.endeca.infront.assembler.spring - package com.endeca.infront.assembler.spring

Contains an implementation of the Assembler that uses Spring for managing configuration and resolving it.

com.endeca.infront.assembler.util - package com.endeca.infront.assembler.util

Contains an interface for retrieving services without explicit injection.

com.endeca.infront.cartridge - package com.endeca.infront.cartridge

Contains a set of core handlers and conguration for requesting content from the Assembler.

com.endeca.infront.content - package com.endeca.infront.content

Contains all interfaces for accessing and representing content in an Assembler Application.

com.endeca.infront.content.source - package com.endeca.infront.content.source

Contains interfaces for content sources in an Assembler Application.

com.endeca.infront.event - package com.endeca.infront.event

Contains interfaces for events that are to be logged for performance statistics.

com.endeca.infront.navigation - package com.endeca.infront.navigation

Deprecated as of release 11.2. Contains a class for user state information.

com.endeca.infront.perf - package com.endeca.infront.perf

Contains interfaces and classes for collecting Assembler performance data.

com.endeca.infront.serialization - package com.endeca.infront.serialization

Contains serializers that may be used to serialize java beans to XML or JSON.

com.endeca.infront.site - package com.endeca.infront.site

Contains the interfaces and classes for managing site definitions.

com.endeca.infront.site.model - package com.endeca.infront.site.model

Contains model objects for use in managing site definitions.

com.endeca.infront.web.spring - package com.endeca.infront.web.spring

Contains Spring-powered utilities to get an Assembler app working.

com.endeca.infront.web.tags - package com.endeca.infront.web.tags

Contains tags to use when building an Assembler-powered application.

combineWith(EventSummary) - Method in interface com.endeca.infront.assembler.perf.EventSummary

Deprecated.

As of release 11.0.
Aggregate this summary with another. The passed EventSummary must be of the same concrete type.

combineWith(EventSummary) - Method in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

As of release 11.0.

ConfigInitializer - Class in com.endeca.infront.cartridge

Helper class for implementing CartridgeHandler.initialize(ContentItem).

ConfigInitializer() - Constructor for class com.endeca.infront.cartridge.ConfigInitializer

CONTENT_ITEM_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

The servlet parameter used to specify the content item class to use.

CONTENT_SLOT_LIST - Static variable in class com.endeca.infront.cartridge.ContentSlotListConfig

CONTENT_SOURCE_CONFIGURATION_ERROR - Static variable in class com.endeca.infront.cartridge.ContentSlotHandler

CONTENT_XML - Static variable in class com.endeca.infront.content.source.WorkbenchContentSource

contentBroker - Variable in class com.endeca.infront.cartridge.ContentSlotHandler

The broker for querying the MDEX.

ContentBroker - Interface in com.endeca.infront.content

Internal interface used by Endeca cartridge handlers used to retrieve content -- Should not be used directly outside of Endeca content cartridge handlers.

ContentException - Exception in com.endeca.infront.content

Indicates that an exception occurred while creating or processing a content request.

ContentException() - Constructor for exception com.endeca.infront.content.ContentException

ContentException(String) - Constructor for exception com.endeca.infront.content.ContentException

ContentException(Throwable) - Constructor for exception com.endeca.infront.content.ContentException

ContentException(String, Throwable) - Constructor for exception com.endeca.infront.content.ContentException

ContentInclude - Class in com.endeca.infront.cartridge

Contains a set of parameters used to make a request for content from the assembler.

ContentInclude() - Constructor for class com.endeca.infront.cartridge.ContentInclude

This empty constructor is used if content path is expected in site state.

ContentInclude(String) - Constructor for class com.endeca.infront.cartridge.ContentInclude

Constructor that requires a URI to get the desired content.

ContentInclude(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentInclude

Constructor that requires a ContentItem to describe the requested content.

ContentIncludeHandler - Class in com.endeca.infront.cartridge

Cartridge handler that handles content from a URI.

ContentIncludeHandler() - Constructor for class com.endeca.infront.cartridge.ContentIncludeHandler

ContentItem - Interface in com.endeca.infront.assembler

The interface that defines the data object (model) in the assembly process.

ContentItemAugmentAdapter - Class in com.endeca.infront.assembler.event.request

Implementation of RequestEventListener that attaches Assembler request information to the content item returned by the Assembler.

ContentItemAugmentAdapter() - Constructor for class com.endeca.infront.assembler.event.request.ContentItemAugmentAdapter

Constructor

ContentItemAugmentAdapter(SessionIdProvider) - Constructor for class com.endeca.infront.assembler.event.request.ContentItemAugmentAdapter

Deprecated.

use ContentItemAugmentAdapter.ContentItemAugmentAdapter() and followed by RequestEventListener.setSessionIdProvider(SessionIdProvider) method

ContentItemInitializer - Interface in com.endeca.infront.assembler

An interface for initializing a ContentItem with configuration properties.

ContentLocator - Interface in com.endeca.infront.content.source

Implementations of the ContentLocator interface provide information about the location of a specific ContentItem as well as a means to retrieve that item.

ContentPathTranslator - Interface in com.endeca.infront.site

Implement this interface to translate an incoming request to a contentPath without site context.

CONTENTS - Static variable in class com.endeca.infront.cartridge.ContentSlotHandler

The key for the list of content items to be added to the content slot

ContentSlotConfig - Class in com.endeca.infront.cartridge

ContentSlotHandler configuration model.

ContentSlotConfig(String, int) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig

Deprecated.

Use ContentSlotConfig.ContentSlotConfig()

ContentSlotConfig(String, String, int) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig

Deprecated.

Use ContentSlotConfig.ContentSlotConfig(String)

ContentSlotConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig

Creates a ContentSlotConfig and copies the configuration present in the input ContentItem.

ContentSlotConfig() - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig

Constructor that sets the type to "ContentSlot".

ContentSlotConfig(String) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig

Creates a ContentSlotConfig.

ContentSlotHandler - Class in com.endeca.infront.cartridge

This CartridgeHandler handles content slot invocations.

ContentSlotHandler() - Constructor for class com.endeca.infront.cartridge.ContentSlotHandler

ContentSlotListConfig - Class in com.endeca.infront.cartridge

ContentSlotListHandler configuration model.

ContentSlotListConfig() - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig

Creates a new ContentSlotListConfig, with type = "ContentSlotList".

ContentSlotListConfig(List<ContentItem>) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig

Creates a new ContentSlotListConfig wrapping the specified list, with type = "ContentSlotList".

ContentSlotListConfig(String, List<ContentItem>) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig

Creates a new ContentSlotListConfig wrapping the specified list, with the specified type string.

ContentSlotListConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig

Wraps the specified ContentItem with the ContentSlotListConfig type.

ContentSlotListHandler - Class in com.endeca.infront.cartridge

Cartridge handler that provides a pass through for ContentSlotListConfig objects.

ContentSlotListHandler() - Constructor for class com.endeca.infront.cartridge.ContentSlotListHandler

contentSource - Variable in class com.endeca.infront.cartridge.ContentSlotHandler

ContentSource - Interface in com.endeca.infront.content.source

Defines a source to retrieve content for the application.

convertToBoolean(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller

Helper method for converting the String value associated with a key to a boolean.

convertToInt(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller

Helper method for converting the String value associated with a key to an integer.

convertToList(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller

Helper method for converting a pipe delimited String value associated with a key to a list of strings.

convertToLong(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller

Helper method for converting the String value associated with a key to a long.

count - Variable in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

The number of invocations recorded for this summary

createAssembler() - Method in interface com.endeca.infront.assembler.AssemblerFactory

Creates and returns a new assembler.

createAssembler() - Method in class com.endeca.infront.assembler.spring.SpringAssemblerFactory

createEvent(String) - Method in interface com.endeca.infront.assembler.perf.EventFactory

Deprecated.

As of release 11.0.
Create an event to represent the given id

createEvent(String) - Method in class com.endeca.infront.assembler.perf.TimeEventFactory

Deprecated.

As of release 11.0.

createHeaderForEventSummary(StringBuilder, String) - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

Deprecated.

As of release 11.0.
Appends header text describing the event formatting and time units.

createSiteState(HttpServletRequest) - Method in class com.endeca.infront.site.SiteStateBuilder

Resolve a SiteState from the incoming http request.

createUserState(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Deprecated.

as of 11.2, replaced by parseUserState Returns a UserState object by parsing the information present in the HttpServletRequest.

D

DefaultSiteParser - Class in com.endeca.infront.site

Returns the default site if configured.

DefaultSiteParser() - Constructor for class com.endeca.infront.site.DefaultSiteParser

description - Variable in enum com.endeca.infront.assembler.servlet.admin.AdministrationOperations

DESCRIPTION - Static variable in class com.endeca.infront.perf.PerfUtil

Key used to store the event description in the event property map

destroy() - Method in class com.endeca.infront.assembler.perf.PerfEventFilter

Empty implementation of Filter.destroy().

destroy() - Method in class com.endeca.infront.content.source.AbstractContentSource

destroy() - Method in interface com.endeca.infront.content.source.ContentSource

Performs any actions needed to clean up after the content source.

destroy() - Method in class com.endeca.infront.content.source.FileStoreFactory

doAfterBody() - Method in class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

doAfterBody() - Method in class com.endeca.infront.web.tags.PageBody

Deprecated.

As of version 11.1, this method does nothing.

doAfterBody() - Method in class com.endeca.infront.web.tags.PreviewAnchor

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.endeca.infront.assembler.perf.PerfEventFilter

Starts performance monitoring on invocation, and stops it once the filter chain returns.

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet

Creates an Assembler, passes it input based on the request, and processes the results.

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

doPost(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

doTag() - Method in class com.endeca.infront.web.tags.PageHead

E

emptySummary(StringBuilder) - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

Deprecated.

ENDECA_CONTENT_PATH - Static variable in class com.endeca.infront.cartridge.ContentIncludeHandler

The key for the content root value.

ENDECA_PREVIEW_ENABLED - Static variable in class com.endeca.infront.web.tags.PreviewAnchor

ENDECA_SITE_ROOT_PATH - Static variable in class com.endeca.infront.cartridge.ContentIncludeHandler

The key for the site root value.

ENDECA_SITE_STATE - Static variable in class com.endeca.infront.cartridge.ContentIncludeHandler

The key for the current site state value.

Event - Interface in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0, replaced by Event
An abstract interface that represents a performance event. TimeEvent provides a concrete implementation that most will want to use.

Event - Interface in com.endeca.infront.event

Represents some event that happens in the Assembler.

EventCounter - Class in com.endeca.infront.perf

Simple EventHandler implementation which counts the number of events that complete (successfully or not).

EventCounter() - Constructor for class com.endeca.infront.perf.EventCounter

EventFactory - Interface in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An interface to produce Events for an EventSerializer. See TimeEventFactory for an implementation that produces TimeEvents.

EventHandler - Interface in com.endeca.infront.event

Interface for handlers to be notified when various events occur.

EventSerializer - Interface in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An interface that serializes EventSummary instances.

EventSummary - Interface in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An interface which represents the summary of multiple Events. TimeSummary provides an implementation that tracks time spent in various parts of a request.

F

fail() - Method in interface com.endeca.infront.event.Event

Indicates that the event has completed with an error.

fail(Map<String, Object>) - Method in interface com.endeca.infront.event.Event

Indicates that the event has completed with an error.

failed(Event, Map<String, Object>) - Method in interface com.endeca.infront.event.EventHandler

Used to indicate to the handler that a particular event has finished with an error.

failed(Event, Map<String, Object>) - Method in class com.endeca.infront.perf.EventCounter

Increments the count of events that have finished

failIfNotCompleted() - Method in interface com.endeca.infront.event.Event

Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).

failIfNotCompleted(Map<String, Object>) - Method in interface com.endeca.infront.event.Event

Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).

FileStoreFactory - Class in com.endeca.infront.content.source

The FileStoreFactory reads files from disk to create the Assembler's internal content and configuration store.

FileStoreFactory() - Constructor for class com.endeca.infront.content.source.FileStoreFactory

finished() - Method in interface com.endeca.infront.assembler.perf.Event

Deprecated.

As of release 11.0.
Produce a summary of this event, for storage and further summarization.

finished() - Method in class com.endeca.infront.assembler.perf.TimeEvent

Deprecated.

As of release 11.0.

G

generateContentItemId(ContentItem, Map<String, String>) - Method in class com.endeca.infront.web.tags.PreviewAnchor

Generate a unique content item id and put it in the map.

GenericJsonSerializer - Class in com.endeca.infront.serialization

Serializes a given object as JSON.

GenericJsonSerializer(Writer) - Constructor for class com.endeca.infront.serialization.GenericJsonSerializer

Constructor.

GenericJsonSerializer(Writer, int) - Constructor for class com.endeca.infront.serialization.GenericJsonSerializer

Constructor.

GenericJsonSerializer(Writer, int, boolean) - Constructor for class com.endeca.infront.serialization.GenericJsonSerializer

Constructor.

GenericJsonSerializer.PropertyCounter - Class in com.endeca.infront.serialization

get() - Method in class com.endeca.infront.perf.EventCounter

getAdministrationService() - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

getAdministrationService() - Method in class com.endeca.infront.assembler.servlet.spring.admin.SpringAdminServlet

getAllSites() - Method in class com.endeca.infront.site.SiteManager

Returns all site definitions for the applications.

getApplicationName() - Method in interface com.endeca.infront.content.source.ContentLocator

The name of the application to which this locator's content item belongs.

getAppName() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getAssembler() - Method in class com.endeca.infront.assembler.event.AssemblerEvent

Returns the Assembler instance that fired the event.

getAssemblerFactory() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet

A method to retrieve an AssemblerFactory.

getAssemblerFactory() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

Retrieves an AssemblerFactory using the Spring Framework.

getAssemblerResponseDecorators() - Method in class com.endeca.infront.assembler.AssemblerSettings

getAssemblyFinishTime() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getAssemblyStartTime() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getAuditContents(List<String>, List<String>, List<String>, int) - Method in interface com.endeca.infront.content.ContentBroker

This method is for internal Oracle use only and should never be called.

getBooleanProperty(String, boolean) - Method in class com.endeca.infront.assembler.BasicContentItem

Convenience method for getting a boolean property value.

getCartridgeHandler() - Method in class com.endeca.infront.assembler.event.AssemblerEvent

Returns the cartridge handler pertinent to this event.

getClassName() - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration

Deprecated.

As of release 11.0.
Get the class name for this event configuration.

getClientPort() - Method in class com.endeca.infront.content.source.FileStoreFactory

Returns the client port

getClientPort() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getContent(ContentLocator) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

A method that allows subclasses to control the content returned by the ContentIncludeHandler.preprocess(com.endeca.infront.assembler.ContentItem) method.

getContent() - Method in interface com.endeca.infront.content.source.ContentLocator

Retrieves this locator's content item.

getContent(List<String>) - Method in interface com.endeca.infront.content.source.ContentSource

This method fetches a list of content items given the paths to those items.

getContent(List<String>) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

Implementation of the getContent contract.

getContentCollection() - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Deprecated.

Use ContentSlotConfig.getContentPaths() instead

getContentItem() - Method in class com.endeca.infront.assembler.event.AssemblerEvent

Returns the content item related to this event.

getContentItem() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet

A method to retrieve a ContentItem.

getContentItem() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

Retrieves a ContentItem using the Spring Framework.

getContentItem() - Method in class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

getContentItem() - Method in class com.endeca.infront.web.tags.PreviewAnchor

getContentItemInitializer() - Method in class com.endeca.infront.cartridge.ContentSlotListHandler

Returns the ContentItemInitializer used to create the full cartridge configuration.

getContentPath() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getContentPath() - Method in interface com.endeca.infront.content.source.ContentLocator

The path within the site that refers to this locator's content item.

getContentPath(HttpServletRequest) - Method in class com.endeca.infront.site.BasicContentPathTranslator

Retrieves the content path from the request examining the HttpServletRequest.getServletPath() and HttpServletRequest.getPathInfo() to determine the content path.

getContentPath(HttpServletRequest) - Method in interface com.endeca.infront.site.ContentPathTranslator

Retrieves the content path from the request examining the HttpServletRequest.getServletPath() and HttpServletRequest.getPathInfo() to determine the content path.

getContentPath() - Method in class com.endeca.infront.site.model.SiteState

getContentPaths() - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Returns the paths which will be searched for content items to be considered for inclusion in this slot.

getContentPaths(List<String>, List<String>, List<String>, int) - Method in interface com.endeca.infront.content.ContentBroker

This method is for internal Oracle use only and should never be called.

getContentPathTranslated(HttpServletRequest, SiteState) - Method in class com.endeca.infront.site.BasicContentPathTranslator

Translate the incoming request if necessary to remove the site context pattern.

getContentPathTranslated(String, HttpServletRequest, SiteState) - Method in class com.endeca.infront.site.BasicContentPathTranslator

Translate the incoming request if necessary to remove the site context pattern.

getContentPathTranslated(String, HttpServletRequest, SiteState) - Method in interface com.endeca.infront.site.ContentPathTranslator

Translate the incoming request if necessary to remove the site context pattern.

getContentPathTranslated(HttpServletRequest, SiteState) - Method in interface com.endeca.infront.site.ContentPathTranslator

Translate the incoming request if necessary to remove the site context pattern.

getContentPathTranslator() - Method in class com.endeca.infront.site.SiteStateBuilder

getContentSlotList() - Method in class com.endeca.infront.cartridge.ContentSlotListConfig

Gets the ContentSlotConfig list contained in this ContentSlotListConfig.

getContentSource() - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Gets the content source used by this handler.

getContentUri() - Method in class com.endeca.infront.cartridge.ContentInclude

The URI to retrieve content from a configured ContentSource.

getContentUri() - Method in interface com.endeca.infront.content.source.ContentLocator

Convenience method for getting the full content URI.

getContextPath() - Method in class com.endeca.infront.web.spring.SpringUtility

Retrieves the context path from the ServletContext via the Spring WebApplicationContext.

getDate() - Method in class com.endeca.infront.content.UserState

getDate() - Method in class com.endeca.infront.navigation.UserState

Deprecated.

getDateAsString() - Method in class com.endeca.infront.content.UserState

getDateAsString() - Method in class com.endeca.infront.navigation.UserState

Deprecated.

getDefaultServletRoot() - Method in class com.endeca.infront.site.BasicContentPathTranslator

getDefaultSite() - Method in class com.endeca.infront.site.SiteManager

Returns the application's default site.

getDefaultSiteRootPath() - Method in class com.endeca.infront.content.source.AbstractContentSource

If a valid content URI cannot be extracted from the request in the AbstractContentSource.resolveContent(HttpServletRequest) method, it will attempt to resolve the content URI using this default site root path.

getDefaultSiteRootPath() - Method in class com.endeca.infront.site.SiteManager

Configure the root node for site definitions.

getDefaultSiteStateParser() - Method in class com.endeca.infront.site.SiteStateBuilder

getDisplayName() - Method in class com.endeca.infront.site.model.SiteDefinition

getDynamicAttribute() - Method in class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

getDynamicAttribute() - Method in class com.endeca.infront.web.tags.PreviewAnchor

getError() - Method in class com.endeca.infront.assembler.event.AssemblerEvent

If there was an error, returns the exception that was thrown by the Assembler, else returns null.

getEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory

getEventFactory() - Method in interface com.endeca.infront.assembler.perf.EventSerializer

Deprecated.

As of release 11.0.
Get the factory which is responsible for creating events for this serializer.

getEventFactory() - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

Deprecated.

getEventFactory() - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

As of release 11.0.

getEvents() - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration

Deprecated.

As of release 11.0.
Get the events to be recorded for this class.

getFilterStateConfiguration() - Method in class com.endeca.infront.site.model.SiteDefinition

This method returns site's filter state xml.

getHost() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getHttpServletRequest() - Method in class com.endeca.infront.web.spring.SpringUtility

Uses org.springframework.web to retrieve the current servlet request

getId() - Method in class com.endeca.infront.site.model.SiteDefinition

getIntProperty(String, int) - Method in class com.endeca.infront.assembler.BasicContentItem

Convenience method for getting an int property value.

getLongProperty(String, long) - Method in class com.endeca.infront.assembler.BasicContentItem

Convenience method for getting a long property value.

getMatchedUrlPattern() - Method in class com.endeca.infront.site.model.SiteState

Returns the portion of URL from the incoming request that are matched with a pattern configured on a site.

getMessageTimeout() - Method in class com.endeca.infront.content.source.FileStoreFactory

Return the message timeout value in milliseconds

getMessageTimeout() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getPatterns() - Method in class com.endeca.infront.site.model.SiteDefinition

Returns a list of url patterns from the Site Definition - empty if no patterns defined

getPreviewModuleUrl() - Method in class com.endeca.infront.assembler.AssemblerSettings

Returns the preview module URL, for use when preview is enabled.

getProfileGroups() - Method in class com.endeca.infront.content.UserState

getProfileGroups() - Method in class com.endeca.infront.navigation.UserState

Deprecated.

getProperties() - Method in class com.endeca.infront.site.model.SiteState

getProperty(String) - Method in class com.endeca.infront.site.model.SiteState

getRealPath() - Method in class com.endeca.infront.web.spring.SpringUtility

Retrieves the real path from the ServletContext via the Spring WebApplicationContext.

getRecordedEvents() - Method in class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration

Deprecated.

As of release 11.0.
Returns the list of events to record.

getRequestId() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getRequestId() - Method in interface com.endeca.infront.assembler.event.request.RequestIdProvider

getRequestId() - Method in class com.endeca.infront.web.spring.SpringUtility

Get the current request ID.

getRequestIdProvider() - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

getResponseWriter() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet

A method to retrieve a ResponseWriter.

getResponseWriter() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

Retrieves a ResponseWriter using the Spring Framework.

getRuleLimit() - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Returns the maximum number of rules that can fire for this slot.

getSecondsSinceStart() - Method in class com.endeca.infront.perf.EventCounter

Returns seconds since counter was started.

getServerPort() - Method in class com.endeca.infront.content.source.FileStoreFactory

Returns the workbench server port

getServerPort() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getServletPathMap() - Method in class com.endeca.infront.site.BasicContentPathTranslator

getSessionId() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getSessionId() - Method in interface com.endeca.infront.assembler.event.request.SessionIdProvider

getSessionId() - Method in class com.endeca.infront.web.spring.SpringUtility

Uses org.springframework.web to retrieve the current servlet request's session id

getSessisonIdProvider() - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

getSessisonIdProvider() - Method in class com.endeca.infront.assembler.event.request.RequestEventListener

getSite(String) - Method in class com.endeca.infront.site.SiteManager

Returns the site definition using the site id.

getSiteDefinition() - Method in class com.endeca.infront.site.model.SiteState

getSiteDisplayName() - Method in class com.endeca.infront.site.model.SiteState

getSiteId() - Method in class com.endeca.infront.site.model.SiteState

getSiteId(String) - Static method in class com.endeca.infront.site.SiteUtils

Returns the site id given a content path of the form

getSiteManager() - Method in class com.endeca.infront.content.source.AbstractContentSource

getSiteManager() - Method in class com.endeca.infront.site.SiteStateBuilder

getSiteManager() - Method in class com.endeca.infront.site.SiteUtils

getSiteRootPath() - Method in class com.endeca.infront.assembler.event.request.RequestEvent

getSiteRootPath() - Method in interface com.endeca.infront.content.source.ContentLocator

The path of the site to which this locator's content item belongs.

getSiteState() - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Gets the current site state.

getSiteStateParsers() - Method in class com.endeca.infront.site.SiteStateBuilder

getSiteUrl(SiteState, String) - Static method in class com.endeca.infront.site.SiteUtils

Converts a URL into a site-aware URL.

getStartTime() - Method in class com.endeca.infront.perf.EventCounter

Returns the clock time in seconds, when counter was initialized.

getStats() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

Returns Assembler statistics, or null if stats are disabled

getStore() - Method in class com.endeca.infront.content.source.FileStoreFactory

getStore() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getStoreFactory() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

getStoreFactory() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

getStoreFactory() - Method in class com.endeca.infront.site.SiteManager

getTemplateIds() - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Returns the template IDs from which content items must have been created in order to be considered for inclusion in this slot.

getTemplateTypes() - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Returns the template types from which content items must have been created in order to be considered for inclusion in this slot.

getTopic() - Method in interface com.endeca.infront.event.Event

getType() - Method in class com.endeca.infront.assembler.BasicContentItem

Returns the type of this content item.

getType() - Method in interface com.endeca.infront.assembler.ContentItem

getTypedProperty(String) - Method in class com.endeca.infront.assembler.BasicContentItem

Convenience method for returning a property value without having to cast the return value to the desired type.

getTypedProperty(String) - Method in class com.endeca.infront.site.model.SiteDefinition

getUrlPattern() - Method in class com.endeca.infront.site.model.SiteDefinition

getUsageCounter() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

Retrieves Assembler usage information

getUserAgent() - Method in class com.endeca.infront.content.UserState

getUserAgent() - Method in class com.endeca.infront.navigation.UserState

Deprecated.

getUserSegments() - Method in class com.endeca.infront.content.UserState

getUserSegments() - Method in class com.endeca.infront.navigation.UserState

Deprecated.

getUserState() - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Get the current user state

getWorkspaceId() - Method in class com.endeca.infront.content.UserState

H

handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.assembler.event.request.ContentItemAugmentAdapter

Attaches Assembler request information to the given Assembler output ContentItem.

handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener

This method is invoked when an Assembler invocation is complete.

handleGetOperation(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

handlePostOperation(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

handleUpdate() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

Checks for a store update and processes it if found

I

IGNORE_STATS_EVENT_ID - Static variable in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

Signals that the following events should not be included in the performance statistics.

IncludeSlot - Class in com.endeca.infront.web.tags

Deprecated.

as of version 11.1 use PreviewAnchor instead.
Tag for enabling Workbench preview functionality. This tag wraps content slot components in a <div data-oc-content-item-id=""></div> element and enables audit/edit functionality.

IncludeSlot() - Constructor for class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

init(FilterConfig) - Method in class com.endeca.infront.assembler.perf.PerfEventFilter

Empty implementation of Filter.init(javax.servlet.FilterConfig).

init(ServletConfig) - Method in class com.endeca.infront.assembler.servlet.spring.admin.SpringAdminServlet

init(ServletConfig) - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

init() - Method in class com.endeca.infront.content.source.FileStoreFactory

init() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

If the StoreFactory has been specified, we'll want to use that.

initEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory

Initialize the RequestEvent for the current request.

initialize(ContentItem) - Method in class com.endeca.infront.assembler.AbstractCartridgeHandler

This implementation simply returns the input ContentItem without modification.

initialize(ContentItem) - Method in interface com.endeca.infront.assembler.CartridgeHandler

Called by the assembler once for each cartridge instance, immediately before CartridgeHandler.preprocess(ContentItem) is called.

initialize(ContentItem) - Method in interface com.endeca.infront.assembler.ContentItemInitializer

Initialize the input ContentItem.

initialize(ContentItem) - Method in class com.endeca.infront.cartridge.ConfigInitializer

Subclasses can extend this method to add layers or re-order layers.

initialize(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler

Uses the ContentItemInitializer, if one has been set, to create the full configuration for this cartridge.

isAuditEnabled() - Method in class com.endeca.infront.assembler.AssemblerSettings

Returns whether or not audit contents should be retrieved.

isAuditEnabled() - Method in interface com.endeca.infront.content.ContentBroker

This method is for internal Oracle use only and should never be called.

isAuthoring() - Method in class com.endeca.infront.content.source.WorkbenchContentSource

isEnabled() - Method in class com.endeca.infront.site.RequestParamParser

The siteId parameter is only considered if this parser is enabled.

isInitialized() - Method in class com.endeca.infront.content.source.FileStoreFactory

Returns the value of whether the store factory was properly initialized

isLoggingEnabled() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory

isPreviewEnabled() - Method in class com.endeca.infront.assembler.AssemblerSettings

isTimingPerformance() - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Returns whether performance is being monitored on the current request/thread.

isValidSite() - Method in class com.endeca.infront.site.model.SiteState

itemStack - Variable in class com.endeca.infront.serialization.GenericJsonSerializer

J

JSONP_CALLBACK_PATTERN - Static variable in class com.endeca.infront.serialization.JsonSerializer

JsonResponseWriter - Class in com.endeca.infront.assembler.servlet

Serializes the Assembler output as JSON and writes it to the response.

JsonResponseWriter() - Constructor for class com.endeca.infront.assembler.servlet.JsonResponseWriter

JsonSerializer - Class in com.endeca.infront.serialization

A class for serializing java objects to JSON.

JsonSerializer(Writer) - Constructor for class com.endeca.infront.serialization.JsonSerializer

Create a JsonSerializer with the given Writer.

L

listServerOperations(String, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

LiveContentSource - Class in com.endeca.infront.content.source

Deprecated.

LiveContentSource(String, String, String, int, int, String, String) - Constructor for class com.endeca.infront.content.source.LiveContentSource

Deprecated.

local - Variable in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

All the local (non-descendant) time recorded

locate(String) - Method in interface com.endeca.infront.assembler.util.ObjectLocator

Retrieves the requested resource by name.

locate(String) - Method in class com.endeca.infront.web.spring.SpringUtility

Retrieves a bean from the application context.

LoggableEventConfiguration - Class in com.endeca.infront.assembler.perf.config

Deprecated.

As of release 11.0.
A bean to configure what performance events are loggable with PerfLogTimeEventSerializer. Record the events for each class that is instrumented for recording performance events using the Event class.

LoggableEventConfiguration() - Constructor for class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration

Deprecated.

M

marshall() - Method in class com.endeca.infront.cartridge.RequestParamMarshaller

Creates a new ContentItem and populates it with information from the HttpServletRequest.

matchPattern(String, String) - Method in class com.endeca.infront.site.UrlPatternParser

Apply a site's urlPattern on the incoming request.

max - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary

Deprecated.

The maximum time observed across all invocations of this event.

mDateParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder

min - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary

Deprecated.

The minimum time observed across all invocations of this event.

mRequest - Variable in class com.endeca.infront.cartridge.RequestParamMarshaller

mRequestMap - Variable in class com.endeca.infront.cartridge.RequestParamMarshaller

mUserAgentParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder

mUserSegmentParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder

mWorkspaceIdParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder

O

ObjectLocator - Interface in com.endeca.infront.assembler.util

ObjectLocator allows the retrieval of services without explicit injection.

openElement(int) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

openInternalNode() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

openItem(Map<String, String>) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

openList() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

openProperty(String) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

override(ContentItem) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller

Helper method for layering a ContentItem on top of another ContentItem.

P

PageBody - Class in com.endeca.infront.web.tags

Deprecated.

as of version 11.1 use the pageBody.tag file instead Tag for enabling Workbench preview functionality; each <body> tag must contain a reference to the PageBody tag. This tag wraps content slot components in a <div class="endeca-slot"> element and enables audit functionality.

PageBody() - Constructor for class com.endeca.infront.web.tags.PageBody

Deprecated.

PageHead - Class in com.endeca.infront.web.tags

Tag for enabling Workbench preview functionality; each <head> tag must contain a reference to the PageHead tag.

PageHead() - Constructor for class com.endeca.infront.web.tags.PageHead

parseDate(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder

parseDate(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Returns the date parameter value, using the parameter name set by RequestParamUserStateBuilder.setDateParam(String).

parseSiteState(String, HttpServletRequest, SiteManager) - Method in class com.endeca.infront.site.DefaultSiteParser

parseSiteState(String, HttpServletRequest, SiteManager) - Method in class com.endeca.infront.site.RequestParamParser

parseSiteState(String, HttpServletRequest, SiteManager) - Method in interface com.endeca.infront.site.SiteStateParser

parseSiteState(String, HttpServletRequest, SiteManager) - Method in class com.endeca.infront.site.UrlPatternParser

parseUserAgent(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder

parseUserAgent(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Returns the user agent parameter value, using the parameter name set by RequestParamUserStateBuilder.setUserAgentParam(String).

parseUserSegments(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder

parseUserSegments(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Returns the user segment parameter value, using the parameter name set by RequestParamUserStateBuilder.setUserSegmentsParam(String).

parseUserState(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Returns a UserState object by parsing the information present in the HttpServletRequest.

parseWorkspaceId(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder

parseWorkspaceId(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Returns the workspace id parameter value, using the parameter name set by RequestParamUserStateBuilder.setWorkspaceIdParam(String).

PerfEventFilter - Class in com.endeca.infront.assembler.perf

An implementation of Filter that starts performance monitoring when a request comes in.

PerfEventFilter() - Constructor for class com.endeca.infront.assembler.perf.PerfEventFilter

PerfLogTimeEventSerializer - Class in com.endeca.infront.assembler.perf.serializers

Deprecated.

As of release 11.0.
An implementation of EventSerializer that logs time taken, per request, into the assembler performance log.

PerfLogTimeEventSerializer(String, RecordedEventsConfiguration) - Constructor for class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

Deprecated.

As of release 11.0.
Constructs a PerfLogTimeEventSerializer with a log file count of 5 and a log file limit of 1000 (that is, 1000 megabytes).

PerfLogTimeEventSerializer(String, RecordedEventsConfiguration, int, int) - Constructor for class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

Deprecated.

As of release 11.0.
Constructs a PerfLogTimeEventSerializer.

PerfUtil - Class in com.endeca.infront.perf

A static interface to ease the use of Assembler performance timing primitives.

preprocess(ContentItem) - Method in class com.endeca.infront.assembler.AbstractCartridgeHandler

This implementation does nothing and does not modify the input ContentItem.

preprocess(T) - Method in interface com.endeca.infront.assembler.CartridgeHandler

Called by the assembler once for each cartridge instance in a response model.

preprocess(ContentItem) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Gets content from the ContentSource and stores it in the input ContentItem.

preprocess(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotHandler

Adds the List of ContentItem objects returned by the ContentManager to the input content item using the key, ContentSlotHandler.CONTENTS.

preprocess(ContentSlotListConfig) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler

Does nothing.

PREVIEW_MODULE_URL - Static variable in class com.endeca.infront.assembler.AssemblerSettings

Key for storing preview URL on content items output by the Assembler.

PreviewAnchor - Class in com.endeca.infront.web.tags

Tag for enabling Workbench preview functionality.

PreviewAnchor() - Constructor for class com.endeca.infront.web.tags.PreviewAnchor

PreviewUserStateBuilder - Class in com.endeca.infront.content

Builds UserState objects for use with Experience Manager preview.

PreviewUserStateBuilder() - Constructor for class com.endeca.infront.content.PreviewUserStateBuilder

Constructor.

process(T) - Method in interface com.endeca.infront.assembler.CartridgeHandler

Called by the assembler after the preprocess method has been called for all cartridges in a complete response model.

process(ContentItem) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Returns the content obtained from the ContentSource (retrieved in ContentIncludeHandler.preprocess(com.endeca.infront.assembler.ContentItem)).

process(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotHandler

process(ContentSlotListConfig) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler

Returns the input ContentSlotListConfig.

PROFILE_GROUP_PREFIX - Static variable in class com.endeca.infront.content.RequestParamUserStateBuilder

Attribute key expected by MDEX to disambiguate ATG profile groups from Endeca user segments.

PropertyCounter() - Constructor for class com.endeca.infront.serialization.GenericJsonSerializer.PropertyCounter

putStatsIntoContentItem(ContentItem) - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

As of release 11.0.
Adds performance statistics to the supplied content item. The following keys will be used:

• perRequestStats
• perEventStats
• worstQueries
(in descending order)
• systemStats

R

ready - Variable in enum com.endeca.infront.assembler.servlet.admin.AdministrationOperations

RecordedEventsConfiguration - Class in com.endeca.infront.assembler.perf.config

Deprecated.

As of release 11.0.
A bean for listing all performance events that are desired for monitoring in an application.

RecordedEventsConfiguration() - Constructor for class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration

Deprecated.

release() - Method in class com.endeca.infront.web.tags.PreviewAnchor

removeAssemblerEventListener(AssemblerEventListener) - Method in interface com.endeca.infront.assembler.Assembler

Removes a listener previously added by Assembler.addAssemblerEventListener(AssemblerEventListener)

removeHandler(EventHandler) - Static method in class com.endeca.infront.perf.PerfUtil

Un-registers the given handler from all topic patterns.

removeHandler(String, EventHandler) - Static method in class com.endeca.infront.perf.PerfUtil

Un-registers the given handler from the given topic pattern.

REQUEST_PARAMETER_OPERATION - Static variable in class com.endeca.infront.assembler.servlet.admin.AbstractAdminServlet

RequestEvent - Class in com.endeca.infront.assembler.event.request

Tracks information about a single Assembler invocation.

RequestEvent() - Constructor for class com.endeca.infront.assembler.event.request.RequestEvent

Constructs a new RequestEvent

RequestEventFactory - Class in com.endeca.infront.assembler.event.request

Used to get the RequestEvent for the current Assembler request.

RequestEventFactory() - Constructor for class com.endeca.infront.assembler.event.request.RequestEventFactory

RequestEventInitializer - Class in com.endeca.infront.assembler.event.request

This class initializes RequestEvent.

RequestEventInitializer() - Constructor for class com.endeca.infront.assembler.event.request.RequestEventInitializer

Creates a new RequestEventListener without a SessionIdProvider.

RequestEventListener - Class in com.endeca.infront.assembler.event.request

If you want to access the request event, you could directly access the request information using RequestEventFactory#getEvent() instead of extending this class.

RequestEventListener() - Constructor for class com.endeca.infront.assembler.event.request.RequestEventListener

Creates a new RequestEventListener without a SessionIdProvider.

RequestEventListener(SessionIdProvider) - Constructor for class com.endeca.infront.assembler.event.request.RequestEventListener

Deprecated.

use RequestEventListener.RequestEventListener() and followed by RequestEventListener.setSessionIdProvider(SessionIdProvider) method

RequestIdProvider - Interface in com.endeca.infront.assembler.event.request

Provides the ID for the current request

RequestParamMarshaller - Class in com.endeca.infront.cartridge

A class that transforms request parameter values into a ContentItem.

RequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.RequestParamMarshaller

RequestParamParser - Class in com.endeca.infront.site

Returns the site ID if a request param RequestParamParser.SITEID_PARAM_NAME is found.

RequestParamParser() - Constructor for class com.endeca.infront.site.RequestParamParser

RequestParamUserStateBuilder - Class in com.endeca.infront.content

Builds UserState objects from parameter values present in the HttpServletRequest.

RequestParamUserStateBuilder() - Constructor for class com.endeca.infront.content.RequestParamUserStateBuilder

RESET_STATS_EVENT_ID - Static variable in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

Resets the collection of performance statistics.

resetEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory

Reset the RequestEvent.

resetRequestId() - Method in class com.endeca.infront.web.spring.SpringUtility

Reset the current request ID so a new one can be created.

resetStats() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

Resets Assembler statistics

resolveContent(HttpServletRequest) - Method in class com.endeca.infront.content.source.AbstractContentSource

Attempts to resolve content based on the given request by retrieving the path, siteId, workspaceId.

resolveContent(String, SiteState, UserState) - Method in interface com.endeca.infront.content.source.ContentSource

Similar to ContentSource.resolveContent(String, SiteState), but explicitly passes the User State.

resolveContent(String, SiteState) - Method in interface com.endeca.infront.content.source.ContentSource

Similar to ContentSource.resolveContent(String), but explicitly passes the site state.

resolveContent(String) - Method in interface com.endeca.infront.content.source.ContentSource

Returns a ContentLocator which can be used to provide information about the location of the content represented by the given URI or retrieve the actual content.

resolveContent(HttpServletRequest) - Method in interface com.endeca.infront.content.source.ContentSource

Similar to ContentSource.resolveContent(String), but attempts to infer the content URI from the path info of the given servlet request.

resolveContent(String) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

Deprecated.

Use resolveContent(String, SiteState)

resolveContent(String, SiteState, UserState) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

Similar to WorkbenchContentSource.resolveContent(String, com.endeca.infront.site.model.SiteState), but explicitly passes the User State to resolve the content in context of a workspace.

resolveContent(String, SiteState) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

Similar to WorkbenchContentSource.resolveContent(String), but explicitly passes the site state.

resolveContent(HttpServletRequest) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

Calls the resolveContent method of the content source

resolver - Variable in class com.endeca.infront.content.source.WorkbenchContentSource

RESPONSE_WRITER_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

The servlet parameter used to specify the Spring bean ID of the ResponseWriter to use.

ResponseWriter - Interface in com.endeca.infront.assembler.servlet

A ResponseWriter is responsible for writing the servlet response based on the Assembler output.

resume(Event) - Method in interface com.endeca.infront.assembler.perf.Event

Deprecated.

As of release 11.0.
Resume this event; the old event is passed for reference.

resume(Event) - Method in class com.endeca.infront.assembler.perf.TimeEvent

Deprecated.

As of release 11.0.

S

serialize(Map<String, EventSummary>, HttpServletRequest) - Method in interface com.endeca.infront.assembler.perf.EventSerializer

Deprecated.

As of release 11.0.
Record performance events with this serializer.

serialize(StringBuilder) - Method in interface com.endeca.infront.assembler.perf.EventSummary

Deprecated.

As of release 11.0.
Serializes this summary into a human-readable string.

serialize(Map<String, EventSummary>, HttpServletRequest) - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

As of release 11.0.

serialize(StringBuilder) - Method in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

As of release 11.0.

SERVLET_PATH - Static variable in class com.endeca.infront.site.BasicContentPathTranslator

SessionIdProvider - Interface in com.endeca.infront.assembler.event.request

Provides the ID for the current user session

setApplicationContext(ApplicationContext) - Method in class com.endeca.infront.assembler.spring.SpringAssemblerFactory

Sets the Spring Framework bean factory used by this assembler for resolving cartridge handlers and other services within an assembler request context.

setApplicationContext(ApplicationContext) - Method in class com.endeca.infront.web.spring.SpringUtility

Implementation of the Spring ApplicationContextAware interface.

setAppName(String) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setAssemblyFinishTime(Long) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

Sets the time (in milliseconds from Epoch) that the assembly finished

setAssemblyStartTime(Long) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

Sets the time (in milliseconds from Epoch) that the assembly started

setClassName(String) - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration

Deprecated.

As of release 11.0.
Sets the class name for this event configuration

setClientPort(int) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setContentBroker(ContentBroker) - Method in class com.endeca.infront.cartridge.ContentSlotHandler

Provider of essential services to dynamic content handlers.

setContentCollection(String) - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Deprecated.

Use ContentSlotConfig.setContentPaths(java.util.List) instead

setContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

setContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.PreviewAnchor

setContentItemInitializer(ContentItemInitializer) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler

Sets the ContentItemInitializer used to create the full cartridge configuration in the ContentSlotListHandler.initialize(com.endeca.infront.assembler.ContentItem) method.

setContentPath(String) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

setContentPath(String) - Method in class com.endeca.infront.site.model.SiteState

setContentPaths(List<String>) - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Sets which paths will be searched for content items to be considered for inclusion in this slot.

setContentPathTranslator(ContentPathTranslator) - Method in class com.endeca.infront.site.SiteStateBuilder

setContentSlotList(List<ContentItem>) - Method in class com.endeca.infront.cartridge.ContentSlotListConfig

Sets the ContentSlotConfig list contained in this ContentSlotListConfig.

setContentSource(ContentSource) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Sets the content source used by this handler.

setContentSource(ContentSource) - Method in class com.endeca.infront.cartridge.ContentSlotHandler

setContentUri(String) - Method in class com.endeca.infront.cartridge.ContentInclude

Sets the URI to retrieve content from a configured ContentSource.

setDate(Date) - Method in class com.endeca.infront.content.UserState

Sets the date; this is useful for previewing what a site looks like on a particular date.

setDate(Date) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Sets the date; this is useful for previewing what a site looks like on a particular date.

setDateAsString(String) - Method in class com.endeca.infront.content.UserState

Convenience method to set the date from a String of the format "yyyy-MM-dd'T'HH:mm".

setDateAsString(String) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Convenience method to set the date from a String of the format "yyyy-MM-dd'T'HH:mm".

setDateParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Sets the name of the parameter used for obtaining the date information from the HttpServletRequest.

setDefaults(ContentItem) - Method in class com.endeca.infront.cartridge.ConfigInitializer

Set the default configuration for a given CartridgeHandler.

setDefaultServletRoot(String) - Method in class com.endeca.infront.site.BasicContentPathTranslator

setDefaultSiteRootPath(String) - Method in class com.endeca.infront.content.source.AbstractContentSource

setDefaultSiteRootPath(String) - Method in class com.endeca.infront.site.SiteManager

setDefaultSiteStateParser(SiteStateParser) - Method in class com.endeca.infront.site.SiteStateBuilder

setDynamicAttribute(String, String, Object) - Method in class com.endeca.infront.web.tags.IncludeSlot

Deprecated.

setDynamicAttribute(String, String, Object) - Method in class com.endeca.infront.web.tags.PreviewAnchor

setEnabled(boolean) - Method in class com.endeca.infront.site.RequestParamParser

setEvents(List<String>) - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration

Deprecated.

As of release 11.0.
Set the event names to be recorded that are related to this class.

setHost(String) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setHttpServletRequest(HttpServletRequest) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller

Sets the current servlet request.

setInPageBody(boolean) - Method in class com.endeca.infront.web.tags.PreviewAnchor

Sets whether the anchors are inside the html body or not.

setIsAuthoring(boolean) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setMatchedUrlPattern(String) - Method in class com.endeca.infront.site.model.SiteState

See SiteState.getMatchedUrlPattern()

setMessageTimeout(long) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setPageContext(PageContext) - Method in class com.endeca.infront.web.tags.PreviewAnchor

setPreviewEnabled(boolean) - Method in class com.endeca.infront.assembler.AssemblerSettings

Sets whether or not preview should be enabled.

setPreviewModuleUrl(String) - Method in class com.endeca.infront.assembler.AssemblerSettings

Sets the preview module URL.

setProfileGroups(Set<String>) - Method in class com.endeca.infront.content.UserState

Sets the set of profile groups.

setProfileGroups(Set<String>) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Sets the set of profile groups.

setProperties(Map<String, String>) - Method in class com.endeca.infront.site.model.SiteState

setRecordedEvents(List<LoggableEventConfiguration>) - Method in class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration

Deprecated.

As of release 11.0.
Sets the list of events to record.

setRequestId(String) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

Sets the unique identifier for the current request

setRequestIdProvider(RequestIdProvider) - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

Sets the current RequestIdProvider

setRequestMap(Map<String, String>) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller

Sets the mapping of request parameters to ContentItem keys.

setRequestParamMarshaller(RequestParamMarshaller) - Method in class com.endeca.infront.cartridge.ConfigInitializer

Set the RequestParamMarshaller that can create request-based configuration for a given CartridgeHandler.

setRootContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.PageBody

Deprecated.

Sets the root content item for obtaining the configuration information.

setRootContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.PageHead

Sets the root content item for obtaining the configuration information.

setRuleLimit(int) - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Sets the maximum number of rules that can fire for this slot.

setServerPort(int) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setServletPathMap(Map<String, String>) - Method in class com.endeca.infront.site.BasicContentPathTranslator

setSessionId(String) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

Sets the unique identifier for a user browser session

setSessionIdProvider(SessionIdProvider) - Method in class com.endeca.infront.assembler.event.request.RequestEventInitializer

Sets the current SessionIdProvider

setSessionIdProvider(SessionIdProvider) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener

Sets the current SessionIdProvider

setSiteDisplayName(String) - Method in class com.endeca.infront.site.model.SiteState

setSiteId(String) - Method in class com.endeca.infront.site.model.SiteState

setSiteManager(SiteManager) - Method in class com.endeca.infront.content.source.AbstractContentSource

setSiteManager(SiteManager) - Method in class com.endeca.infront.site.SiteStateBuilder

setSiteManager(SiteManager) - Method in class com.endeca.infront.site.SiteUtils

setSiteRootPath(String) - Method in class com.endeca.infront.assembler.event.request.RequestEvent

setSiteState(SiteState) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Sets the current site state.

setSiteStateParsers(SiteStateParser[]) - Method in class com.endeca.infront.site.SiteStateBuilder

setStatsEnabled(boolean) - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

setStoreFactory(StoreFactory) - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

setStoreFactory(StoreFactory) - Method in class com.endeca.infront.content.source.WorkbenchContentSource

setStoreFactory(StoreFactory) - Method in class com.endeca.infront.site.SiteManager

setTag(String) - Method in class com.endeca.infront.web.tags.PreviewAnchor

Sets the html tag to use.

setTemplateIds(List<String>) - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Sets the template IDs from which content items must have been created in order to be considered for inclusion in this slot.

setTemplateTypes(List<String>) - Method in class com.endeca.infront.cartridge.ContentSlotConfig

Sets the template types from which content items must have been created in order to be considered for inclusion in this slot.

setType(String) - Method in class com.endeca.infront.assembler.BasicContentItem

Sets the type for this content item.

setUserAgent(String) - Method in class com.endeca.infront.content.UserState

Sets the user-agent; this is useful for previewing what a site looks like with a particular user-agent.

setUserAgent(String) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Sets the user-agent; this is useful for previewing what a site looks like with a particular user-agent.

setUserAgentParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Sets the name of the parameter used for obtaining the user agent information from the HttpServletRequest.

setUserSegments(Set<String>) - Method in class com.endeca.infront.content.UserState

Sets the set of user segments.

setUserSegments(Set<String>) - Method in class com.endeca.infront.navigation.UserState

Deprecated.

Sets the set of user segments.

setUserSegmentsParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Sets the name of the parameter used for obtaining the user segment information from the HttpServletRequest.

setUserState(UserState) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler

Set the current user state

setWorkspaceId(String) - Method in class com.endeca.infront.content.UserState

Sets the workspace id.

setWorkspaceIdParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder

Sets the name of the parameter used for obtaining the workspace id information from the HttpServletRequest.

SITE_NOT_FOUND - Static variable in class com.endeca.infront.site.model.SiteState

SiteDefinition - Class in com.endeca.infront.site.model

This is a wrapper class for the site definition node.

SiteDefinition(Node, String) - Constructor for class com.endeca.infront.site.model.SiteDefinition

SITEID_PARAM_NAME - Static variable in class com.endeca.infront.site.RequestParamParser

SiteManager - Class in com.endeca.infront.site

SiteManager provides helper methods to retrieve site definitions.

SiteManager() - Constructor for class com.endeca.infront.site.SiteManager

SiteState - Class in com.endeca.infront.site.model

SiteState is an object containing the site ID, the matched URL pattern, the contentPath of the current request, and any additional properties.

SiteState() - Constructor for class com.endeca.infront.site.model.SiteState

Default constructor

SiteState(String, SiteDefinition) - Constructor for class com.endeca.infront.site.model.SiteState

Construct a SiteState with the site ID and the site definition.

SiteStateBuilder - Class in com.endeca.infront.site

This is a SiteState factory which runs through a list of SiteStateParsers to return the current SiteState.

SiteStateBuilder() - Constructor for class com.endeca.infront.site.SiteStateBuilder

SiteStateParser - Interface in com.endeca.infront.site

Implement this interface for custom site state parser.

SiteUtils - Class in com.endeca.infront.site

SiteUtils() - Constructor for class com.endeca.infront.site.SiteUtils

SpringAdminServlet - Class in com.endeca.infront.assembler.servlet.spring.admin

Spring Implementation of the AbstractAdminServlet.

SpringAdminServlet() - Constructor for class com.endeca.infront.assembler.servlet.spring.admin.SpringAdminServlet

SpringAssemblerFactory - Class in com.endeca.infront.assembler.spring

An assembler factory implementation that uses a Spring Framework bean factory to resolve cartridge handlers and other services.

SpringAssemblerFactory(AssemblerSettings) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory

Constructor to use when configuring and instantiating instances of this assembler from Spring.

SpringAssemblerFactory(AssemblerSettings, List<AssemblerEventListener>) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory

Constructor to use when configuring and instantiating instances of this assembler from Spring.

SpringAssemblerFactory(AssemblerSettings, List<AssemblerEventListener>, ApplicationContext) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory

Convenience constructor to use when instantiating a Spring-based assembler programmatically.

SpringAssemblerServlet - Class in com.endeca.infront.assembler.servlet.spring

Extends the AbstractAssemblerServlet to provide the needed AssemblerFactory and ResponseWriter using the Spring Framework.

SpringAssemblerServlet() - Constructor for class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet

SpringUtility - Class in com.endeca.infront.web.spring

Utility for interacting with the Spring Framework.

SpringUtility() - Constructor for class com.endeca.infront.web.spring.SpringUtility

start(Class<T>, String) - Static method in class com.endeca.infront.perf.PerfUtil

Calls PerfUtil.start(Class, String, String) with an empty description.

start(Class<T>, String, String) - Static method in class com.endeca.infront.perf.PerfUtil

Computes an event name by combining the name of the given class with the given name (separated by an underscore), and then calls PerfUtil.start(String, String).

start(String) - Static method in class com.endeca.infront.perf.PerfUtil

Calls PerfUtil.start(String, String) with an empty description.

start(String, String) - Static method in class com.endeca.infront.perf.PerfUtil

Called to start and return a new event.

started(Event, Map<String, Object>) - Method in interface com.endeca.infront.event.EventHandler

Used to indicate to the handler that a particular event has started.

started(Event, Map<String, Object>) - Method in class com.endeca.infront.perf.EventCounter

Empty implementation of started()

startEvent(Object, String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Called to start a new performance event. A new instance representing this event is added to the stack of timers. Adding a new event will pause the current event's timer and start a new timer for the new event. Please Note: A call to startEvent MUST always include a corresponding call to stopEvent or undefined behavior will result. The resulting full event name will be obj.getClass().getName() + "_" + name.

startEvent(String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Called to start a new performance event. A new instance representing this event is added to the stack of timers. Adding a new event will pause the current event's timer and start a new timer for the new event. Please Note: A call to startEvent MUST always include a corresponding call to stopEvent or undefined behavior will result.

startEvent(Event) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
FOR INTERNAL ORACLE USE ONLY

startPerformanceTiming(HttpServletRequest) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Starts performance timing on the current request/thread. Note that this should not be called more than once per request/thread.

StatsPageTimeEventSerializer - Class in com.endeca.infront.assembler.perf.serializers

Deprecated.

As of release 11.0.
An implementation of EventSerializer that stores information for the performance stats page.

StatsPageTimeEventSerializer(RecordedEventsConfiguration) - Constructor for class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer

Deprecated.

As of release 11.0.
Creates a StatsPageTimeEventSerializer.

stopEvent(Object, String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Called to stop an event that was previously started. The current top of the timer stack is stopped and any performance events are recorded. The next timer on the stack is resumed after this call. Please Note: Calls to startEvent/stopEvent must be matched or undefined behavior will result. The resulting full event name will be obj.getClass().getName() + "_" + name.

stopEvent(String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Called to stop an event that was previously started. The current top of the timer stack is stopped and any performance events are recorded. The next timer on the stack is resumed after this call. Please Note: Calls to startEvent/stopEvent must be matched or undefined behavior will result.

stopEvent(Event) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
FOR INTERNAL ORACLE USE ONLY

stopPerformanceTiming() - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils

Deprecated.

As of release 11.0.
Stops performance timing on the current request/thread. Note that this should NOT be called more than once per request/thread. After this method is called, current timing statistics will be sent to the currently registered serializers (registered using AssemblerPerfUtils.addEventSerializer(EventSerializer)).

succeed() - Method in interface com.endeca.infront.event.Event

Indicates that the event has completed successfully.

succeed(Map<String, Object>) - Method in interface com.endeca.infront.event.Event

Indicates that the event has completed successfully.

succeeded(Event, Map<String, Object>) - Method in interface com.endeca.infront.event.EventHandler

Used to indicate to the handler that a particular event has finished successfully.

succeeded(Event, Map<String, Object>) - Method in class com.endeca.infront.perf.EventCounter

Increments the count of events that have finished

suspend(Event) - Method in interface com.endeca.infront.assembler.perf.Event

Deprecated.

suspend(Event) - Method in class com.endeca.infront.assembler.perf.TimeEvent

Deprecated.

As of release 11.0.

T

TimeEvent - Class in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An implementation of the Event interface that tracks the time spent in performing an event. This class tracks both descendant time (all time not spent in the current invocation), and self time (time spent only in the current invocation, without descendant invocations). Note that this implementation tracks time in microseconds and utilizes System.nanoTime() for timing information.

TimeEvent() - Constructor for class com.endeca.infront.assembler.perf.TimeEvent

Deprecated.

As of release 11.0.
Constructs a TimeEvent. Note that time tracking starts immediately upon construction.

TimeEventFactory - Class in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An EventFactory implementation that produces TimeEvents.

TimeEventFactory() - Constructor for class com.endeca.infront.assembler.perf.TimeEventFactory

Deprecated.

TimeSummary - Class in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
An implementation of EventSummary that aggregates the time recorded by one or more TimeEvents.

TimeSummary(long, long) - Constructor for class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

As of release 11.0.
Constructs a summary over a single invocation. To create a summary over multiple invocations, create individual summaries for each invocation and use TimeSummary.combineWith(EventSummary).

TimeSummary(long, long, int) - Constructor for class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

As of release 11.0.
Constructs a summary over a single invocation. To create a summary over multiple invocations, create individual summaries for each invocation and use TimeSummary.combineWith(EventSummary).

TimeSummary.MinMaxTotalSummary - Class in com.endeca.infront.assembler.perf

Deprecated.

As of release 11.0.
A convenience wrapper class to store the total, min, and max time.

TOPIC_ASSEMBLE - Static variable in interface com.endeca.infront.assembler.Assembler

The topic of events dispatched when the assemble process is invoked

TOPIC_REQUEST - Static variable in class com.endeca.infront.assembler.perf.PerfEventFilter

The topic used for events that represents servlet requests

toString() - Method in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary

Deprecated.

toString() - Method in class com.endeca.infront.assembler.perf.TimeSummary

Deprecated.

Returns a human-readable representation of this summary.

toString() - Method in class com.endeca.infront.site.model.SiteState

total - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary

Deprecated.

The total time observed across all invocations of this event.

U

updateFileStore() - Method in class com.endeca.infront.assembler.servlet.admin.AdministrationService

Updates File store, if there are new content changes in the repository

updateStore() - Method in class com.endeca.infront.content.source.FileStoreFactory

Updates the store from an archive on disk.

UrlPatternParser - Class in com.endeca.infront.site

Returns a SiteState by applying the URL pattern configured on SiteDefinitions.

UrlPatternParser() - Constructor for class com.endeca.infront.site.UrlPatternParser

UserState - Class in com.endeca.infront.content

An object that contains user segments, date state and workspace information.

UserState() - Constructor for class com.endeca.infront.content.UserState

UserState - Class in com.endeca.infront.navigation

Deprecated.

as of 11.2, replaced by UserState An object that contains user segments and date state information. This state is used to control the experience that a particular user has when visiting a site.

Examples:

• For users fitting a particular user segment, the prices may be lower than for normal users.
• If the date provided falls between Thanksgiving and Christmas, the site's front page may be for a Christmas sale.

UserState() - Constructor for class com.endeca.infront.navigation.UserState

Deprecated.

V

value - Variable in enum com.endeca.infront.assembler.servlet.admin.AdministrationOperations

valueOf(String) - Static method in enum com.endeca.infront.assembler.servlet.admin.AdministrationOperations

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.endeca.infront.assembler.servlet.admin.AdministrationOperations

Returns an array containing the constants of this enum type, in the order they are declared.

visitBoolean(Boolean) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

visitDouble(Double) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

visitInteger(Integer) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

visitLong(Long) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

visitNull() - Method in class com.endeca.infront.serialization.GenericJsonSerializer

visitString(String) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

W

WorkbenchContentSource - Class in com.endeca.infront.content.source

The WorkbenchContentSource allows the retrieval of content from a Workbench Server.

WorkbenchContentSource(boolean, String, String, String, int, String, String, boolean, int, int, String, String) - Constructor for class com.endeca.infront.content.source.WorkbenchContentSource

Deprecated.

WorkbenchContentSource() - Constructor for class com.endeca.infront.content.source.WorkbenchContentSource

Constructs a new content source.

write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in class com.endeca.infront.assembler.servlet.JsonResponseWriter

Serializes the Assembler output as JSON and writes it to the response.

write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in interface com.endeca.infront.assembler.servlet.ResponseWriter

Writes the servlet response based on the given Assembler output.

write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in class com.endeca.infront.assembler.servlet.XmlResponseWriter

Serializes the Assembler output as XML and writes it to the response.

write(Object) - Method in class com.endeca.infront.serialization.JsonSerializer

Serialize the given object.

write(Object) - Method in class com.endeca.infront.serialization.XmlSerializer

Serialize the given object.

writeDataAttributes(JspWriter, BodyContent, Map<String, String>) - Method in class com.endeca.infront.web.tags.PreviewAnchor

Write all the entries of the map like a html tag attribute

writeSeparator(int) - Method in class com.endeca.infront.serialization.GenericJsonSerializer

X

XmlResponseWriter - Class in com.endeca.infront.assembler.servlet

Serializes the Assembler output as XML and writes it to the response.

XmlResponseWriter() - Constructor for class com.endeca.infront.assembler.servlet.XmlResponseWriter

XmlSerializer - Class in com.endeca.infront.serialization

A class for serializing java objects to XML.

XmlSerializer(Writer) - Constructor for class com.endeca.infront.serialization.XmlSerializer

Create a XmlSerializer with the given Writer.

A B C D E F G H I J L M O P R S T U V W X