org.apache.hadoop.yarn.api.records.ReservationId Maven / Gradle / Ivy
/**
* 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.api.records;
import java.io.IOException;
import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.util.FastNumberFormat;
import org.apache.hadoop.yarn.util.Records;
/**
*
* {@link ReservationId} represents the globally unique identifier for
* a reservation.
*
*
*
* The globally unique nature of the identifier is achieved by using the
* cluster timestamp i.e. start-time of the {@code ResourceManager}
* along with a monotonically increasing counter for the reservation.
*
*/
@Public
@Unstable
public abstract class ReservationId implements Comparable {
@Private
@Unstable
public static final String reserveIdStrPrefix = "reservation_";
protected long clusterTimestamp;
protected long id;
@Private
@Unstable
public static ReservationId newInstance(long clusterTimestamp, long id) {
ReservationId reservationId = Records.newRecord(ReservationId.class);
reservationId.setClusterTimestamp(clusterTimestamp);
reservationId.setId(id);
reservationId.build();
return reservationId;
}
/**
* Get the long identifier of the {@link ReservationId} which is unique for
* all Reservations started by a particular instance of the
* {@code ResourceManager}.
*
* @return long identifier of the {@link ReservationId}
*/
@Public
@Unstable
public abstract long getId();
@Private
@Unstable
protected abstract void setId(long id);
/**
* Get the start time of the {@code ResourceManager} which is used to
* generate globally unique {@link ReservationId}.
*
* @return start time of the {@code ResourceManager}
*/
@Public
@Unstable
public abstract long getClusterTimestamp();
@Private
@Unstable
protected abstract void setClusterTimestamp(long clusterTimestamp);
protected abstract void build();
private static final int RESERVATION_ID_MIN_DIGITS = 4;
@Override
public int compareTo(ReservationId other) {
if (this.getClusterTimestamp() - other.getClusterTimestamp() == 0) {
return Long.compare(getId(), other.getId());
} else {
return Long.compare(getClusterTimestamp(), other.getClusterTimestamp());
}
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder(64);
sb.append(reserveIdStrPrefix)
.append(getClusterTimestamp())
.append('_');
FastNumberFormat.format(sb, getId(), RESERVATION_ID_MIN_DIGITS);
return sb.toString();
}
/**
* Parse the string argument as a {@link ReservationId}
*
* @param reservationId the string representation of the {@link ReservationId}
* @return the {@link ReservationId} corresponding to the input string if
* valid, null if input is null
* @throws IOException if unable to parse the input string
*/
@Public
@Unstable
public static ReservationId parseReservationId(String reservationId)
throws IOException {
if (reservationId == null) {
return null;
}
if (!reservationId.startsWith(reserveIdStrPrefix)) {
throw new IOException("The specified reservation id is invalid: "
+ reservationId);
}
String[] resFields = reservationId.split("_");
if (resFields.length != 3) {
throw new IOException("The specified reservation id is not parseable: "
+ reservationId);
}
return newInstance(Long.parseLong(resFields[1]),
Long.parseLong(resFields[2]));
}
@Override
public int hashCode() {
// generated by eclipse
final int prime = 31;
int result = 1;
result =
prime * result
+ (int) (getClusterTimestamp() ^ (getClusterTimestamp() >>> 32));
result = prime * result + (int) (getId() ^ (getId() >>> 32));
return result;
}
@Override
public boolean equals(Object obj) {
// generated by eclipse
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
ReservationId other = (ReservationId) obj;
if (getClusterTimestamp() != other.getClusterTimestamp())
return false;
if (getId() != other.getId())
return false;
return true;
}
}