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

Class TimelineClientImpl

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.client.api.TimelineClient

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

All Implemented Interfaces:

Closeable, AutoCloseable, Service

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class TimelineClientImpl
extends TimelineClient

Nested Class Summary

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

Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
TimelineClientImpl()

Method Summary

Modifier and Type	Method and Description
void	cancelDelegationToken(org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier> timelineDT) Cancel a timeline delegation token.
com.sun.jersey.api.client.ClientResponse	doPostingObject(Object object, String path)
org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier>	getDelegationToken(String renewer) Get a delegation token so as to be able to talk to the timeline server in a secure way.
UserGroupInformation	getUgi()
static void	main(String[] argv)
void	putDomain(TimelineDomain domain) Send the information of a domain to the timeline server.
TimelinePutResponse	putEntities(TimelineEntity... entities) Send the information of a number of conceptual entities to the timeline server.
long	renewDelegationToken(org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier> timelineDT) Renew a timeline delegation token.
protected void	serviceInit(Configuration conf)
protected void	serviceStop()

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

createTimelineClient

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, serviceStart, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

TimelineClientImpl

public TimelineClientImpl()

Method Detail

serviceInit

protected void serviceInit(Configuration conf)
                    throws Exception

Overrides:

serviceInit in class AbstractService

Throws:

Exception

serviceStop

protected void serviceStop()
                    throws Exception

Overrides:

serviceStop in class AbstractService

Throws:

Exception

putEntities

public TimelinePutResponse putEntities(TimelineEntity... entities)
                                throws IOException,
                                       YarnException

Description copied from class: TimelineClient

Send the information of a number of conceptual entities to the timeline server. It is a blocking API. The method will not return until it gets the response from the timeline server.

Specified by:

putEntities in class TimelineClient

Parameters:

entities - the collection of TimelineEntity

Returns:

the error information if the sent entities are not correctly stored

Throws:

IOException

YarnException

putDomain

public void putDomain(TimelineDomain domain)
               throws IOException,
                      YarnException

Description copied from class: TimelineClient

Send the information of a domain to the timeline server. It is a blocking API. The method will not return until it gets the response from the timeline server.

Specified by:

putDomain in class TimelineClient

Parameters:

domain - an TimelineDomain object

Throws:

IOException

YarnException

getDelegationToken

public org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier> getDelegationToken(String renewer)
                                                                                             throws IOException,
                                                                                                    YarnException

Description copied from class: TimelineClient

Get a delegation token so as to be able to talk to the timeline server in a secure way.

Specified by:

getDelegationToken in class TimelineClient

Parameters:

renewer - Address of the renewer who can renew these tokens when needed by securely talking to the timeline server

Returns:

a delegation token (Token) that can be used to talk to the timeline server

Throws:

IOException

YarnException

renewDelegationToken

public long renewDelegationToken(org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier> timelineDT)
                          throws IOException,
                                 YarnException

Description copied from class: TimelineClient

Renew a timeline delegation token.

Specified by:

renewDelegationToken in class TimelineClient

Parameters:

timelineDT - the delegation token to renew

Returns:

the new expiration time

Throws:

IOException

YarnException

cancelDelegationToken

public void cancelDelegationToken(org.apache.hadoop.security.token.Token<TimelineDelegationTokenIdentifier> timelineDT)
                           throws IOException,
                                  YarnException

Description copied from class: TimelineClient

Cancel a timeline delegation token.

Specified by:

cancelDelegationToken in class TimelineClient

Parameters:

timelineDT - the delegation token to cancel

Throws:

IOException

YarnException

doPostingObject

@InterfaceAudience.Private
public com.sun.jersey.api.client.ClientResponse doPostingObject(Object object,
                                                                                           String path)

main

public static void main(String[] argv)
                 throws Exception

Throws:

Exception

getUgi

@InterfaceAudience.Private
public UserGroupInformation getUgi()