Package org.apache.hadoop.yarn.client.api.impl

Class TimelineReaderClientImpl

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.hadoop.yarn.client.api.TimelineReaderClient

org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Service

@Public
@Evolving
public class TimelineReaderClientImpl
extends TimelineReaderClient

Implementation of TimelineReaderClient interface.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

Service.STATE

Field Summary

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Constructor Summary

Constructors

Constructor	Description
TimelineReaderClientImpl()

Method Summary

Modifier and Type	Method	Description
protected javax.ws.rs.core.Response	doGetUri(URI base, String path, javax.ws.rs.core.MultivaluedMap<String,String> params)
protected String	encodeValue(String value)
List<TimelineEntity>	getApplicationAttemptEntities(ApplicationId appId, String fields, Map<String,String> filters, long limit, String fromId)	Gets application attempt entities.
TimelineEntity	getApplicationAttemptEntity(ApplicationAttemptId appAttemptId, String fields, Map<String,String> filters)	Gets application attempt entity.
TimelineEntity	getApplicationEntity(ApplicationId appId, String fields, Map<String,String> filters)	Gets application entity.
List<TimelineEntity>	getContainerEntities(ApplicationId appId, String fields, Map<String,String> filters, long limit, String fromId)	Gets container entities for an application.
TimelineEntity	getContainerEntity(ContainerId containerId, String fields, Map<String,String> filters)	Gets Timeline entity for the container.
protected void	serviceInit(Configuration conf)	All initialization code needed by a service.

Methods inherited from class org.apache.hadoop.yarn.client.api.TimelineReaderClient

createTimelineReaderClient

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService, serviceStart, serviceStop

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Constructor Details

TimelineReaderClientImpl

public TimelineReaderClientImpl()

Method Details

serviceInit

protected void serviceInit(Configuration conf)
                    throws Exception

Description copied from class: AbstractService

All initialization code needed by a service. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.init(Configuration) prevents re-entrancy. The base implementation checks to see if the subclass has created a new configuration instance, and if so, updates the base class value

Overrides:

serviceInit in class CompositeService

Parameters:

conf - configuration

Throws:

Exception - on a failure -these will be caught, possibly wrapped, and will trigger a service stop

getApplicationEntity

public TimelineEntity getApplicationEntity(ApplicationId appId,
 String fields,
 Map<String,String> filters)
                                    throws IOException

Description copied from class: TimelineReaderClient

Gets application entity.

Specified by:

getApplicationEntity in class TimelineReaderClient

Parameters:

appId - application id

fields - Fields to be fetched. Defaults to INFO.

filters - Filters to be applied while fetching entities.

Returns:

entity of the application

Throws:

IOException - io error occur.

getApplicationAttemptEntity

public TimelineEntity getApplicationAttemptEntity(ApplicationAttemptId appAttemptId,
 String fields,
 Map<String,String> filters)
                                           throws IOException

Description copied from class: TimelineReaderClient

Gets application attempt entity.

Specified by:

getApplicationAttemptEntity in class TimelineReaderClient

Parameters:

appAttemptId - application attempt id

fields - Fields to be fetched. Defaults to INFO.

filters - Filters to be applied while fetching entities.

Returns:

entity associated with application attempt

Throws:

IOException - io error occur.

getApplicationAttemptEntities

public List<TimelineEntity> getApplicationAttemptEntities(ApplicationId appId,
 String fields,
 Map<String,String> filters,
 long limit,
 String fromId)
                                                   throws IOException

Description copied from class: TimelineReaderClient

Gets application attempt entities.

Specified by:

getApplicationAttemptEntities in class TimelineReaderClient

Parameters:

appId - application id

fields - Fields to be fetched. Defaults to INFO.

filters - Filters to be applied while fetching entities.

limit - Number of entities to return.

fromId - Retrieve next set of generic ids from given fromId

Returns:

list of application attempt entities

Throws:

IOException - io error occur.

getContainerEntity

public TimelineEntity getContainerEntity(ContainerId containerId,
 String fields,
 Map<String,String> filters)
                                  throws IOException

Description copied from class: TimelineReaderClient

Gets Timeline entity for the container.

Specified by:

getContainerEntity in class TimelineReaderClient

Parameters:

containerId - container id

fields - Fields to be fetched. Defaults to INFO.

filters - Filters to be applied while fetching entities.

Returns:

timeline entity for container

Throws:

IOException - io error occur.

getContainerEntities

public List<TimelineEntity> getContainerEntities(ApplicationId appId,
 String fields,
 Map<String,String> filters,
 long limit,
 String fromId)
                                          throws IOException

Description copied from class: TimelineReaderClient

Gets container entities for an application.

Specified by:

getContainerEntities in class TimelineReaderClient

Parameters:

appId - application id

fields - Fields to be fetched. Defaults to INFO.

filters - Filters to be applied while fetching entities.

limit - Number of entities to return.

fromId - Retrieve next set of generic ids from given fromId

Returns:

list of entities

Throws:

IOException - io error occur.

encodeValue

@VisibleForTesting
protected String encodeValue(String value)
                      throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

doGetUri

@VisibleForTesting
protected javax.ws.rs.core.Response doGetUri(URI base,
 String path,
 javax.ws.rs.core.MultivaluedMap<String,String> params)
                                      throws IOException

Throws:

IOException