| Interface and Description |
|---|
| com.endeca.infront.assembler.perf.Event |
| 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. |
| 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:
Events may be serialized by registering EventSerializer's with
this interface, two of which are provided:
|
| com.endeca.infront.content.source.AuthoringContentSource |
| com.endeca.infront.web.tags.IncludeSlot
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. |
| 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.web.tags.PageBody
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. |
| 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.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. |
| com.endeca.infront.navigation.UserState
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:
|
| 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.content.RequestParamUserStateBuilder.createUserState(HttpServletRequest)
as of 11.2, replaced by
parseUserState
Returns a UserState object by parsing the information present in the
HttpServletRequest. |
| 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.serializers.StatsPageTimeEventSerializer.getEventFactory()
As of release 11.0.
|
| com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer.getEventFactory() |
| 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.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.assembler.perf.AssemblerPerfUtils.isTimingPerformance()
As of release 11.0.
Returns whether performance is being monitored on the current request/thread. |
| 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:
|
| com.endeca.infront.content.source.WorkbenchContentSource.resolveContent(String)
Use resolveContent(String, SiteState)
|
| 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.serializers.StatsPageTimeEventSerializer.serialize(Map<String, EventSummary>, HttpServletRequest)
As of release 11.0.
|
| com.endeca.infront.assembler.perf.EventSerializer.serialize(Map<String, EventSummary>, HttpServletRequest)
As of release 11.0.
Record performance events with this serializer. |
| 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) |
| com.endeca.infront.assembler.perf.config.LoggableEventConfiguration.setEvents(List<String>)
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<LoggableEventConfiguration>)
As of release 11.0.
Sets the list of events to record. |
| 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) |
Copyright © 2015, Oracle and/or its affiliates. All rights reserved.