org.apache.hadoop.yarn.util.timeline

Class TimelineUtils

java.lang.Object

org.apache.hadoop.yarn.util.timeline.TimelineUtils

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class TimelineUtils
extends Object

The helper class for the timeline module.

Constructor Summary

Constructors

Constructor and Description
TimelineUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.hadoop.io.Text	buildTimelineTokenService(org.apache.hadoop.conf.Configuration conf)
static org.apache.hadoop.yarn.api.records.timeline.TimelineAbout	createTimelineAbout(String about)
static String	dumpTimelineRecordtoJSON(Object o) Serialize a POJO object into a JSON string not in a pretty format
static String	dumpTimelineRecordtoJSON(Object o, boolean pretty) Serialize a POJO object into a JSON string
static float	getTimelineServiceVersion(org.apache.hadoop.conf.Configuration conf) Returns the timeline service version.
static InetSocketAddress	getTimelineTokenServiceAddress(org.apache.hadoop.conf.Configuration conf)
static boolean	timelineServiceEnabled(org.apache.hadoop.conf.Configuration conf) Returns whether the timeline service is enabled via configuration.
static boolean	timelineServiceV1_5Enabled(org.apache.hadoop.conf.Configuration conf) Returns whether the timeline service v.1.5 is enabled via configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineUtils

public TimelineUtils()

Method Detail

dumpTimelineRecordtoJSON

public static String dumpTimelineRecordtoJSON(Object o)
                                       throws org.codehaus.jackson.JsonGenerationException,
                                              org.codehaus.jackson.map.JsonMappingException,
                                              IOException

Serialize a POJO object into a JSON string not in a pretty format

Parameters:

o - an object to serialize

Returns:

a JSON string

Throws:

IOException

org.codehaus.jackson.map.JsonMappingException

org.codehaus.jackson.JsonGenerationException

dumpTimelineRecordtoJSON

public static String dumpTimelineRecordtoJSON(Object o,
                              boolean pretty)
                                       throws org.codehaus.jackson.JsonGenerationException,
                                              org.codehaus.jackson.map.JsonMappingException,
                                              IOException

Serialize a POJO object into a JSON string

Parameters:

o - an object to serialize

pretty - whether in a pretty format or not

Returns:

a JSON string

Throws:

IOException

org.codehaus.jackson.map.JsonMappingException

org.codehaus.jackson.JsonGenerationException

timelineServiceEnabled

public static boolean timelineServiceEnabled(org.apache.hadoop.conf.Configuration conf)

Returns whether the timeline service is enabled via configuration.

Parameters:

conf - the configuration

Returns:

whether the timeline service is enabled.

getTimelineServiceVersion

public static float getTimelineServiceVersion(org.apache.hadoop.conf.Configuration conf)

Returns the timeline service version. It does not check whether the timeline service itself is enabled.

Parameters:

conf - the configuration

Returns:

the timeline service version as a float.

timelineServiceV1_5Enabled

public static boolean timelineServiceV1_5Enabled(org.apache.hadoop.conf.Configuration conf)

Returns whether the timeline service v.1.5 is enabled via configuration.

Parameters:

conf - the configuration

Returns:

whether the timeline service v.1.5 is enabled. V.1.5 refers to a version equal to 1.5.

createTimelineAbout

public static org.apache.hadoop.yarn.api.records.timeline.TimelineAbout createTimelineAbout(String about)

getTimelineTokenServiceAddress

public static InetSocketAddress getTimelineTokenServiceAddress(org.apache.hadoop.conf.Configuration conf)

buildTimelineTokenService

public static org.apache.hadoop.io.Text buildTimelineTokenService(org.apache.hadoop.conf.Configuration conf)