Package org.apache.hadoop.yarn.server.timeline

Class EntityCacheItem

java.lang.Object

org.apache.hadoop.yarn.server.timeline.EntityCacheItem

public class EntityCacheItem
extends java.lang.Object

Cache item for timeline server v1.5 reader cache. Each cache item has a TimelineStore that can be filled with data within one entity group.

Constructor Summary

Constructors

Constructor	Description
EntityCacheItem(org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId gId, org.apache.hadoop.conf.Configuration config)

Method Summary

Modifier and Type	Method	Description
void	forceRelease()	Force releasing the cache item for the given group id, even though there may be active references.
org.apache.hadoop.yarn.server.timeline.EntityGroupFSTimelineStore.AppLogs	getAppLogs()
org.apache.hadoop.yarn.server.timeline.TimelineStore	getStore()
org.apache.hadoop.yarn.server.timeline.TimelineStore	refreshCache(org.apache.hadoop.yarn.server.timeline.security.TimelineACLsManager aclManager, EntityGroupFSTimelineStoreMetrics metrics)	Refresh this cache item if it needs refresh.
void	setAppLogs(org.apache.hadoop.yarn.server.timeline.EntityGroupFSTimelineStore.AppLogs incomingAppLogs)	Set the application logs to this cache item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityCacheItem

public EntityCacheItem(org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId gId,
                       org.apache.hadoop.conf.Configuration config)

Method Detail

getAppLogs

public org.apache.hadoop.yarn.server.timeline.EntityGroupFSTimelineStore.AppLogs getAppLogs()

Returns:

The application log associated to this cache item, may be null.

setAppLogs

public void setAppLogs(org.apache.hadoop.yarn.server.timeline.EntityGroupFSTimelineStore.AppLogs incomingAppLogs)

Set the application logs to this cache item. The entity group should be associated with this application.

Parameters:

incomingAppLogs - Application logs this cache item mapped to

getStore

public org.apache.hadoop.yarn.server.timeline.TimelineStore getStore()

Returns:

The timeline store, either loaded or unloaded, of this cache item. This method will not hold the storage from being reclaimed.

refreshCache

public org.apache.hadoop.yarn.server.timeline.TimelineStore refreshCache(org.apache.hadoop.yarn.server.timeline.security.TimelineACLsManager aclManager,
                                                                         EntityGroupFSTimelineStoreMetrics metrics)
                                                                  throws java.io.IOException

Refresh this cache item if it needs refresh. This will enforce an appLogs rescan and then load new data. The refresh process is synchronized with other operations on the same cache item.

Parameters:

aclManager - ACL manager for the timeline storage

metrics - Metrics to trace the status of the entity group store

Returns:

a TimelineStore object filled with all entities in the group.

Throws:

java.io.IOException

forceRelease

public void forceRelease()

Force releasing the cache item for the given group id, even though there may be active references.