com.atlassian.confluence.rss

Class FeedTimeoutEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

com.atlassian.event.Event

com.atlassian.confluence.event.events.ConfluenceEvent

com.atlassian.confluence.rss.FeedTimeoutEvent

All Implemented Interfaces:

Serializable

public class FeedTimeoutEvent
extends ConfluenceEvent

An event sent when a Timeout occurs when rendering a SyndEntry.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FeedTimeoutEvent(Object src, ConfluenceEntityObject entity, long allowedTimeInSeconds, long exceededTimeInMilliseconds, int numResultsToRender, int numResultsRendered)

Method Summary

Modifier and Type	Method and Description
static FeedTimeoutEvent	createForTimeout(Object src, ConfluenceEntityObject entity, io.atlassian.util.concurrent.Timeout timeout, int numResultsToRender, int numResultsRendered)
static FeedTimeoutEvent	forTimeout(Object src, ConfluenceEntityObject entity, com.atlassian.util.concurrent.Timeout timeout, int numResultsToRender, int numResultsRendered) Deprecated. since 7.0.1. Use createForTimeout(Object, ConfluenceEntityObject, Timeout, int, int)
long	getAllowedTimeInSeconds()
ConfluenceEntityObject	getEntity()
long	getExceededTimeInMilliseconds()
int	getNumResultsRendered()
int	getNumResultsToRender()

Methods inherited from class com.atlassian.confluence.event.events.ConfluenceEvent

equals, hashCode

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FeedTimeoutEvent

public FeedTimeoutEvent(Object src,
                        ConfluenceEntityObject entity,
                        long allowedTimeInSeconds,
                        long exceededTimeInMilliseconds,
                        int numResultsToRender,
                        int numResultsRendered)

Method Detail

forTimeout

@Deprecated
public static FeedTimeoutEvent forTimeout(Object src,
                                                      ConfluenceEntityObject entity,
                                                      com.atlassian.util.concurrent.Timeout timeout,
                                                      int numResultsToRender,
                                                      int numResultsRendered)

Deprecated. since 7.0.1. Use createForTimeout(Object, ConfluenceEntityObject, Timeout, int, int)

createForTimeout

public static FeedTimeoutEvent createForTimeout(Object src,
                                                ConfluenceEntityObject entity,
                                                io.atlassian.util.concurrent.Timeout timeout,
                                                int numResultsToRender,
                                                int numResultsRendered)

Since:

7.0.1

getEntity

public ConfluenceEntityObject getEntity()

Returns:

the entity where this macro was being rendered.

getAllowedTimeInSeconds

public long getAllowedTimeInSeconds()

Returns:

the number of seconds the timeout was set for.

getExceededTimeInMilliseconds

public long getExceededTimeInMilliseconds()

Returns:

the number of milliseconds since the timeout expired at the time the event was created.

getNumResultsToRender

public int getNumResultsToRender()

Returns:

the number of results that were supposed to be rendered.

getNumResultsRendered

public int getNumResultsRendered()

Returns:

the number of results that were successfully rendered before the timeout.