Java tutorial
/** * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.hadoop.yarn.client.api; import java.io.Flushable; import java.io.IOException; import org.apache.hadoop.classification.InterfaceAudience.Public; import org.apache.hadoop.classification.InterfaceStability.Evolving; import org.apache.hadoop.security.UserGroupInformation; import org.apache.hadoop.security.token.Token; import org.apache.hadoop.service.CompositeService; import org.apache.hadoop.yarn.api.records.ApplicationAttemptId; import org.apache.hadoop.yarn.api.records.timeline.TimelineDomain; import org.apache.hadoop.yarn.api.records.timeline.TimelineEntity; import org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId; import org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse; import org.apache.hadoop.yarn.client.api.impl.TimelineClientImpl; import org.apache.hadoop.yarn.exceptions.YarnException; import org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier; /** * A client library that can be used to post some information in terms of a * number of conceptual entities. This client library needs to be used along * with Timeline V.1.x server versions. * Refer {@link TimelineV2Client} for ATS V2 interface. */ @Public @Evolving public abstract class TimelineClient extends CompositeService implements Flushable { /** * Creates an instance of the timeline v.1.x client. * The current UGI when the user initialize the client will be used to do the * put and the delegation token operations. The current user may use * {@link UserGroupInformation#doAs} another user to construct and initialize * a timeline client if the following operations are supposed to be conducted * by that user. * * @return the created timeline client instance */ @Public public static TimelineClient createTimelineClient() { TimelineClient client = new TimelineClientImpl(); return client; } protected TimelineClient(String name) { super(name); } /** * <p> * 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. * </p> * * @param entities * the collection of {@link TimelineEntity} * @return the error information if the sent entities are not correctly stored * @throws IOException if there are I/O errors * @throws YarnException if entities are incomplete/invalid */ @Public public abstract TimelinePutResponse putEntities(TimelineEntity... entities) throws IOException, YarnException; /** * <p> * 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. * * This API is only for timeline service v1.5 * </p> * * @param appAttemptId {@link ApplicationAttemptId} * @param groupId {@link TimelineEntityGroupId} * @param entities * the collection of {@link TimelineEntity} * @return the error information if the sent entities are not correctly stored * @throws IOException if there are I/O errors * @throws YarnException if entities are incomplete/invalid */ @Public public abstract TimelinePutResponse putEntities(ApplicationAttemptId appAttemptId, TimelineEntityGroupId groupId, TimelineEntity... entities) throws IOException, YarnException; /** * <p> * 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. * </p> * * @param domain * an {@link TimelineDomain} object * @throws IOException * @throws YarnException */ @Public public abstract void putDomain(TimelineDomain domain) throws IOException, YarnException; /** * <p> * 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. * * This API is only for timeline service v1.5 * </p> * * @param domain * an {@link TimelineDomain} object * @param appAttemptId {@link ApplicationAttemptId} * @throws IOException * @throws YarnException */ @Public public abstract void putDomain(ApplicationAttemptId appAttemptId, TimelineDomain domain) throws IOException, YarnException; /** * <p> * Get a delegation token so as to be able to talk to the timeline server in a * secure way. * </p> * * @param renewer * Address of the renewer who can renew these tokens when needed by * securely talking to the timeline server * @return a delegation token ({@link Token}) that can be used to talk to the * timeline server * @throws IOException * @throws YarnException */ @Public public abstract Token<TimelineDelegationTokenIdentifier> getDelegationToken(String renewer) throws IOException, YarnException; /** * <p> * Renew a timeline delegation token. * </p> * * @param timelineDT * the delegation token to renew * @return the new expiration time * @throws IOException * @throws YarnException */ @Public public abstract long renewDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT) throws IOException, YarnException; /** * <p> * Cancel a timeline delegation token. * </p> * * @param timelineDT * the delegation token to cancel * @throws IOException * @throws YarnException */ @Public public abstract void cancelDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT) throws IOException, YarnException; }