Deprecated API

Contents

• Deprecated Packages
• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Packages

Package and Description
com.endeca.infront.assembler.perf As of release 11.0. The performance package contains utility classes and interfaces to monitor timing and performance events in an application. A good starting place to understand how to use this package would be to examine the AssemblerPerfUtils static interface.
com.endeca.infront.assembler.perf.config As of release 11.0. A set of configuration beans used for configuring the Assembler Perf monitoring system.
com.endeca.infront.assembler.perf.serializers As of release 11.0. Contains serializers to be used with the Assembler performance monitoring package.

Deprecated Interfaces

Interface and Description
com.endeca.infront.assembler.perf.Event 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.
com.endeca.infront.assembler.perf.EventFactory As of release 11.0. An interface to produce Events for an EventSerializer. See TimeEventFactory for an implementation that produces TimeEvents.
com.endeca.infront.assembler.perf.EventSerializer As of release 11.0. An interface that serializes EventSummary instances.
com.endeca.infront.assembler.perf.EventSummary 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.

Deprecated Classes

Class and Description
com.endeca.infront.assembler.perf.AssemblerPerfUtils 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
com.endeca.infront.content.source.AuthoringContentSource
com.endeca.infront.content.source.LiveContentSource
com.endeca.infront.assembler.perf.config.LoggableEventConfiguration 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.
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer As of release 11.0. An implementation of EventSerializer that logs time taken, per request, into the assembler performance log.
com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration As of release 11.0. A bean for listing all performance events that are desired for monitoring in an application.
com.endeca.infront.cartridge.StatsPageCartridgeHandler As of release 11.0. An implementation of CartridgeHandler that provides content for the performance stats page.
com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer As of release 11.0. An implementation of EventSerializer that stores information for the performance stats page.
com.endeca.infront.assembler.perf.TimeEvent 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.
com.endeca.infront.assembler.perf.TimeEventFactory As of release 11.0. An EventFactory implementation that produces TimeEvents.
com.endeca.infront.assembler.perf.TimeSummary As of release 11.0. An implementation of EventSummary that aggregates the time recorded by one or more TimeEvents.
com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary As of release 11.0. A convenience wrapper class to store the total, min, and max time.

Deprecated Fields

Field and Description
com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller.SHOW_MORE As of release 3.1.1, replaced by RefinementMenuRequestParamMarshaller.NAV_REFINEMENT_MENU_CONFIG. Name of request parameter that sets the list of Dimension IDs for which ALL dimension values will be shown. The value can be pipe delimited to expand multiple refinement menus. e.g. /N-83092?showMoreIds=10021|1000482
com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller.SHOW_MORE As of release 3.1.1, replaced by NavigationContainerRequestParamMarshaller.NAV_REFINEMENT_MENU_CONFIG. Name of request parameter that sets the list of Dimension IDs for which ALL dimension values will be shown. The value can be pipe delimited to expand multiple refinement menus. e.g. /N-83092?showMoreIds=10021|1000482

Deprecated Methods

Method and Description
com.endeca.infront.assembler.perf.AssemblerPerfUtils.addEventSerializer(EventSerializer) As of release 11.0. Registers a serializer with the system.
com.endeca.infront.assembler.perf.TimeSummary.combineWith(EventSummary) As of release 11.0.
com.endeca.infront.assembler.perf.EventSummary.combineWith(EventSummary) As of release 11.0. Aggregate this summary with another. The passed EventSummary must be of the same concrete type.
com.endeca.infront.assembler.perf.TimeEventFactory.createEvent(String) As of release 11.0.
com.endeca.infront.assembler.perf.EventFactory.createEvent(String) As of release 11.0. Create an event to represent the given id
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer.createHeaderForEventSummary(StringBuilder, String) As of release 11.0. Appends header text describing the event formatting and time units.
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer.emptySummary(StringBuilder)
com.endeca.infront.assembler.perf.TimeEvent.finished() As of release 11.0.
com.endeca.infront.assembler.perf.Event.finished() As of release 11.0. Produce a summary of this event, for storage and further summarization.
com.endeca.infront.assembler.perf.config.LoggableEventConfiguration.getClassName() As of release 11.0. Get the class name for this event configuration.
com.endeca.infront.cartridge.ContentSlotConfig.getContentCollection() Use ContentSlotConfig.getContentPaths() instead
com.endeca.infront.assembler.perf.EventSerializer.getEventFactory() As of release 11.0. Get the factory which is responsible for creating events for this serializer.
com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer.getEventFactory() As of release 11.0.
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer.getEventFactory()
com.endeca.infront.assembler.perf.config.LoggableEventConfiguration.getEvents() As of release 11.0. Get the events to be recorded for this class.
com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration.getRecordedEvents() As of release 11.0. Returns the list of events to record.
com.endeca.infront.cartridge.ResultsListConfig.getRelRank() use ResultsListConfig.getRelRankStrategy() instead.
com.endeca.infront.cartridge.DimensionSearchResultsConfig.getRelRank() use DimensionSearchResultsConfig.getRelRankStrategy() instead.
com.endeca.infront.cartridge.NavigationContainerConfig.getShowMoreIds() As of release 3.1.1, replaced by NavigationContainerConfig.getRefinementsShown(). Returns dimension IDs for which 'More' refinement expansion should happen.
com.endeca.infront.cartridge.RefinementMenuConfig.getUseShowMoreIdsParam() As of release 3.1.1. Returns true if the show more and less actions should use the deprecated showMoreIds parameter. The default value of this property is true.
com.endeca.infront.cartridge.NavigationContainerConfig.getUseShowMoreIdsParam() As of release 3.1.1. Returns true if the show more and less actions should use the deprecated showMoreIds parameter. The default value of this property is true.
com.endeca.infront.cartridge.RefinementMenuConfig.isShowMore() As of release 3.1.1, replaced by RefinementMenuConfig.getRefinementsShown(). When this value is false, the number of menu items generated is limited by numRefinements, and a more link will be generated. This value is intended to be overridden by request parameters when a "true" value is required in the link generation for the link generated when showMoreLink is "true". The default value for this property is false.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.isTimingPerformance() As of release 11.0. Returns whether performance is being monitored on the current request/thread.
com.endeca.infront.cartridge.StatsPageCartridgeHandler.process(ContentItem) As of release 11.0. If a StatsPageTimeEventSerializer has been set, stores performance information in the supplied ContentItem.
com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer.putStatsIntoContentItem(ContentItem) 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
com.endeca.infront.assembler.perf.TimeEvent.resume(Event) As of release 11.0.
com.endeca.infront.assembler.perf.Event.resume(Event) As of release 11.0. Resume this event; the old event is passed for reference.
com.endeca.infront.assembler.perf.EventSerializer.serialize(Map, HttpServletRequest) As of release 11.0. Record performance events with this serializer.
com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer.serialize(Map, HttpServletRequest) As of release 11.0.
com.endeca.infront.assembler.perf.TimeSummary.serialize(StringBuilder) As of release 11.0.
com.endeca.infront.assembler.perf.EventSummary.serialize(StringBuilder) As of release 11.0. Serializes this summary into a human-readable string.
com.endeca.infront.assembler.perf.config.LoggableEventConfiguration.setClassName(String) As of release 11.0. Sets the class name for this event configuration
com.endeca.infront.cartridge.ContentSlotConfig.setContentCollection(String) Use ContentSlotConfig.setContentPaths(java.util.List) instead
com.endeca.infront.assembler.perf.config.LoggableEventConfiguration.setEvents(List) As of release 11.0. Set the event names to be recorded that are related to this class.
com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration.setRecordedEvents(List) As of release 11.0. Sets the list of events to record.
com.endeca.infront.cartridge.ResultsListConfig.setRelRank(String) use ResultsListConfig.setRelRankStrategy(String) instead.
com.endeca.infront.cartridge.DimensionSearchResultsConfig.setRelRank(String) use DimensionSearchResultsConfig.setRelRankStrategy(String) instead.
com.endeca.infront.cartridge.RefinementMenuConfig.setShowMore(boolean) As of release 3.1.1, replaced by RefinementMenuConfig.getRefinementsShown(). Sets whether to "show more" refinements. When this value is false, the number of menu items generated is limited by numRefinements, and a more link will be generated. This value is intended to be overridden by request parameters when a "true" value is required in the link generation for the link generated when showMoreLink is "true".
com.endeca.infront.cartridge.NavigationContainerConfig.setShowMoreIds(List) As of release 3.1.1, replaced by NavigationContainerConfig.getRefinementsShown(). Sets dimension IDs for which 'More' refinement expansion should happen.
com.endeca.infront.cartridge.StatsPageCartridgeHandler.setStatsPageSerializer(StatsPageTimeEventSerializer) As of release 11.0. Sets the serializer used to store performance information.
com.endeca.infront.cartridge.RefinementMenuConfig.setUseShowMoreIdsParam(boolean) As of release 3.1.1. Sets whether the deprecated showMoreIds or the navigation refinement menu config parameter should be used. If false, the showMoreIds will be ignored and the expand and collapse action will appear in the RefinementMenu.
com.endeca.infront.cartridge.NavigationContainerConfig.setUseShowMoreIdsParam(boolean) As of release 3.1.1. Sets whether the deprecated showMoreIds or the navigation refinement menu config parameter should be used. If false, the showMoreIds will be ignored and the expand and collapse action will appear in the RefinementMenu.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.startEvent(Event) As of release 11.0. FOR INTERNAL ORACLE USE ONLY
com.endeca.infront.assembler.perf.AssemblerPerfUtils.startEvent(Object, String) 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.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.startEvent(String) 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.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.startPerformanceTiming(HttpServletRequest) 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.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.stopEvent(Event) As of release 11.0. FOR INTERNAL ORACLE USE ONLY
com.endeca.infront.assembler.perf.AssemblerPerfUtils.stopEvent(Object, String) 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.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.stopEvent(String) 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.
com.endeca.infront.assembler.perf.AssemblerPerfUtils.stopPerformanceTiming() 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)).
com.endeca.infront.assembler.perf.TimeEvent.suspend(Event) As of release 11.0.
com.endeca.infront.assembler.perf.Event.suspend(Event)

Deprecated Constructors

Constructor and Description
com.endeca.infront.content.source.AbstractContentSource(String)
com.endeca.infront.content.source.AuthoringContentSource(String, String, String, int, String, String, boolean)
com.endeca.infront.cartridge.ContentSlotConfig(String, int) Use ContentSlotConfig.ContentSlotConfig()
com.endeca.infront.cartridge.ContentSlotConfig(String, String, int) Use ContentSlotConfig.ContentSlotConfig(String)
com.endeca.infront.navigation.model.FilterState(List, List, List, GeoFilter, List, List, String, String, String, boolean) use the empty constructor FilterState.FilterState() and the requisite setter methods instead.
com.endeca.infront.content.source.LiveContentSource(String, String, String, int, int, String, String)
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer(String, RecordedEventsConfiguration) 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).
com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer(String, RecordedEventsConfiguration, int, int) As of release 11.0. Constructs a PerfLogTimeEventSerializer.
com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer(RecordedEventsConfiguration) As of release 11.0. Creates a StatsPageTimeEventSerializer.
com.endeca.infront.assembler.perf.TimeEvent() As of release 11.0. Constructs a TimeEvent. Note that time tracking starts immediately upon construction.
com.endeca.infront.assembler.perf.TimeSummary(long, long) 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).
com.endeca.infront.assembler.perf.TimeSummary(long, long, int) 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).
com.endeca.infront.content.source.WorkbenchContentSource(boolean, String, String, String, int, String, String, boolean, int, int, String, String)