code
stringlengths 23
201k
| docstring
stringlengths 17
96.2k
| func_name
stringlengths 0
235
| language
stringclasses 1
value | repo
stringlengths 8
72
| path
stringlengths 11
317
| url
stringlengths 57
377
| license
stringclasses 7
values |
|---|---|---|---|---|---|---|---|
public void processSucceed(final TriggerInstance triggerInst) {
//todo chengren311: publishing Trigger events to Azkaban Project Events page
this.executorService.submit(() -> executeFlowAndUpdateExecID(triggerInst));
}
|
Process the case where status of trigger instance becomes success
|
processSucceed
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
Apache-2.0
|
public void processTermination(final TriggerInstance triggerInst) {
//sendFailureEmailIfConfigured takes 1/3 secs
this.executorService.submit(() -> sendFailureEmailIfConfigured(triggerInst));
}
|
Process the case where status of trigger instance becomes cancelled
|
processTermination
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
Apache-2.0
|
public void shutdown() {
this.executorService.shutdown();
this.executorService.shutdownNow();
}
|
Process the case where a new trigger instance is created
|
shutdown
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/TriggerInstanceProcessor.java
|
Apache-2.0
|
@Override
public Collection<TriggerInstance> getRecentlyFinished(final int limit) {
final String query = String.format(SELECT_RECENTLY_FINISHED, limit);
try {
return this.dbOperator
.query(query, new TriggerInstanceHandler(SORT_MODE.SORT_ON_START_TIME_ASC));
} catch (final SQLException ex) {
handleSQLException(ex);
}
return Collections.emptyList();
}
|
Retrieve recently finished trigger instances, but flow trigger properties are not populated
into the returned trigger instances for efficiency. Flow trigger properties will be
retrieved only on request time.
|
getRecentlyFinished
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public Collection<TriggerInstance> getRunning() {
try {
//todo chengren311:
// 1. add index for the execution_dependencies table to accelerate selection.
return this.dbOperator.query(SELECT_ALL_RUNNING_EXECUTIONS, new TriggerInstanceHandler
(SORT_MODE.SORT_ON_START_TIME_ASC));
} catch (final SQLException ex) {
handleSQLException(ex);
}
return Collections.emptyList();
}
|
Retrieve recently finished trigger instances, but flow trigger properties are not populated
into the returned trigger instances for efficiency. Flow trigger properties will be
retrieved only on request time.
|
getRunning
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
private void populateFlowTriggerProperties(final TriggerInstance triggerInstance) {
if (triggerInstance != null) {
final int projectId = triggerInstance.getProject().getId();
final int projectVersion = triggerInstance.getProject().getVersion();
final String flowFileName = triggerInstance.getFlowId() + ".flow";
final int flowVersion = triggerInstance.getFlowVersion();
final File tempDir = Files.createTempDir();
try {
final File flowFile = this.projectLoader
.getUploadedFlowFile(projectId, projectVersion, flowFileName, flowVersion, tempDir);
if (flowFile != null) {
final FlowTrigger flowTrigger = FlowLoaderUtils.getFlowTriggerFromYamlFile(flowFile);
if (flowTrigger != null) {
triggerInstance.setFlowTrigger(flowTrigger);
}
} else {
logger.error("Unable to find flow file for " + triggerInstance);
}
} catch (final Exception ex) {
logger.error("error in getting flow file", ex);
} finally {
FlowLoaderUtils.cleanUpDir(tempDir);
}
}
}
|
Retrieve recently finished trigger instances, but flow trigger properties are not populated
into the returned trigger instances for efficiency. Flow trigger properties will be
retrieved only on request time.
|
populateFlowTriggerProperties
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public TriggerInstance getTriggerInstanceByFlowExecId(final int flowExecId) {
if (flowExecId == Constants.FAILED_EXEC_ID || flowExecId == Constants.UNASSIGNED_EXEC_ID) {
return null;
}
TriggerInstance triggerInstance = null;
try {
final Collection<TriggerInstance> res = this.dbOperator
.query(SELECT_EXECUTIONS_BY_EXEC_ID,
new TriggerInstanceHandler(SORT_MODE.SORT_ON_START_TIME_ASC), flowExecId);
triggerInstance = !res.isEmpty() ? res.iterator().next() : null;
} catch (final SQLException ex) {
handleSQLException(ex);
}
populateFlowTriggerProperties(triggerInstance);
return triggerInstance;
}
|
Retrieve a trigger instance given a flow execution id. Flow trigger properties will
also be populated into the returned trigger instance. If flow exec id is -1 or -2, then
null will be returned.
|
getTriggerInstanceByFlowExecId
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
/**
* Retrieve sorted trigger instances on start time in descending order
* given projectId, flowId, start position and length.
* @param projectId
* @param flowId
* @param from starting position of the range of trigger instance to retrieve
* @param length number of consecutive trigger instances to retrieve
*/
public Collection<TriggerInstance> getTriggerInstances(
final int projectId, final String flowId, final int from,
final int length) {
try {
final Collection<TriggerInstance> res = this.dbOperator
.query(SELECT_RECENT_WITH_START_AND_LENGTH, new TriggerInstanceHandler(SORT_MODE
.SORT_ON_START_TIME_DESC), projectId,
flowId, length, from);
return res;
} catch (final SQLException ex) {
handleSQLException(ex);
}
return Collections.emptyList();
}
|
Retrieve a trigger instance given a flow execution id. Flow trigger properties will
also be populated into the returned trigger instance. If flow exec id is -1 or -2, then
null will be returned.
|
getTriggerInstances
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public int deleteTriggerExecutionsFinishingOlderThan(final long timestamp) {
try {
final Collection<TriggerInstance> res = this.dbOperator
.query(SELECT_EXECUTION_OLDER_THAN,
new TriggerInstanceHandler(SORT_MODE.SORT_ON_START_TIME_DESC), timestamp);
final Set<String> toBeDeleted = new HashSet<>();
for (final TriggerInstance inst : res) {
if ((inst.getStatus() == Status.CANCELLED || (inst.getStatus() == Status.SUCCEEDED && inst
.getFlowExecId() != -1)) && inst.getEndTime() <= timestamp) {
toBeDeleted.add(inst.getId());
}
}
int numDeleted = 0;
if (!toBeDeleted.isEmpty()) {
final String ids = toBeDeleted.stream().map(s -> "'" + s + "'")
.collect(Collectors.joining(", "));
numDeleted = this.dbOperator.update(DELETE_EXECUTIONS.replace("?", ids));
}
logger.info("{} dependency instance record(s) deleted", numDeleted);
return numDeleted;
} catch (final SQLException ex) {
handleSQLException(ex);
return 0;
}
}
|
Retrieve sorted trigger instances on start time in descending order
given projectId, flowId, start position and length.
@param projectId
@param flowId
@param from starting position of the range of trigger instance to retrieve
@param length number of consecutive trigger instances to retrieve
|
deleteTriggerExecutionsFinishingOlderThan
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public TriggerInstance getTriggerInstanceById(final String triggerInstanceId) {
TriggerInstance triggerInstance = null;
try {
final Collection<TriggerInstance> res = this.dbOperator
.query(SELECT_EXECUTIONS_BY_INSTANCE_ID,
new TriggerInstanceHandler(SORT_MODE.SORT_ON_START_TIME_ASC),
triggerInstanceId);
triggerInstance = !res.isEmpty() ? res.iterator().next() : null;
} catch (final SQLException ex) {
handleSQLException(ex);
}
populateFlowTriggerProperties(triggerInstance);
return triggerInstance;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
getTriggerInstanceById
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
public int getProjectId() {
return this.projectId;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
getProjectId
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
public int getProjectVersion() {
return this.projectVerison;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
getProjectVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
public String getFlowId() {
return this.flowId;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
getFlowId
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final FlowConfigID that = (FlowConfigID) o;
return new EqualsBuilder()
.append(this.projectId, that.projectId)
.append(this.projectVerison, that.projectVerison)
.append(this.flowVersion, that.flowVersion)
.append(this.flowId, that.flowId)
.isEquals();
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
equals
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public int hashCode() {
return new HashCodeBuilder(17, 37)
.append(this.projectId)
.append(this.projectVerison)
.append(this.flowId)
.append(this.flowVersion)
.toHashCode();
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
hashCode
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
public int getFlowVersion() {
return this.flowVersion;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
getFlowVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public Collection<TriggerInstance> handle(final ResultSet rs) throws SQLException {
final Map<TriggerInstKey, List<DependencyInstance>> triggerInstMap = new HashMap<>();
while (rs.next()) {
final String triggerInstId = rs.getString(DEPENDENCY_EXECUTIONS_COLUMNS[0]);
final String depName = rs.getString(DEPENDENCY_EXECUTIONS_COLUMNS[1]);
final long startTime = rs.getLong(DEPENDENCY_EXECUTIONS_COLUMNS[2]);
final long endTime = rs.getLong(DEPENDENCY_EXECUTIONS_COLUMNS[3]);
final Status status = Status.values()[rs.getInt(DEPENDENCY_EXECUTIONS_COLUMNS[4])];
final CancellationCause cause = CancellationCause.values()[rs.getInt
(DEPENDENCY_EXECUTIONS_COLUMNS[5])];
final int projId = rs.getInt(DEPENDENCY_EXECUTIONS_COLUMNS[6]);
final int projVersion = rs.getInt(DEPENDENCY_EXECUTIONS_COLUMNS[7]);
final String flowId = rs.getString(DEPENDENCY_EXECUTIONS_COLUMNS[8]);
final int flowVersion = rs.getInt(DEPENDENCY_EXECUTIONS_COLUMNS[9]);
final Project project = JdbcFlowTriggerInstanceLoaderImpl.this.projectManager
.getProject(projId);
final int flowExecId = rs.getInt(DEPENDENCY_EXECUTIONS_COLUMNS[10]);
final TriggerInstKey key = new TriggerInstKey(triggerInstId, project.getLastModifiedUser(),
projId, projVersion, flowId, flowVersion, flowExecId, project);
List<DependencyInstance> dependencyInstanceList = triggerInstMap.get(key);
final DependencyInstance depInst = new DependencyInstance(depName, startTime, endTime,
null, status, cause);
if (dependencyInstanceList == null) {
dependencyInstanceList = new ArrayList<>();
triggerInstMap.put(key, dependencyInstanceList);
}
dependencyInstanceList.add(depInst);
}
final List<TriggerInstance> res = new ArrayList<>();
for (final Map.Entry<TriggerInstKey, List<DependencyInstance>> entry : triggerInstMap
.entrySet()) {
res.add(new TriggerInstance(entry.getKey().triggerInstId, null, entry.getKey()
.flowConfigID.flowId, entry.getKey().flowConfigID.flowVersion, entry.getKey()
.submitUser, entry.getValue(), entry.getKey().flowExecId, entry.getKey().project));
}
if (this.mode == SORT_MODE.SORT_ON_START_TIME_ASC) {
Collections.sort(res, Comparator.comparing(TriggerInstance::getStartTime));
} else if (this.mode == SORT_MODE.SORT_ON_START_TIME_DESC) {
Collections.sort(res, Comparator.comparing(TriggerInstance::getStartTime).reversed());
}
return res;
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
handle
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final TriggerInstKey that = (TriggerInstKey) o;
return new EqualsBuilder()
.append(this.triggerInstId, that.triggerInstId)
.append(this.flowConfigID, that.flowConfigID)
.isEquals();
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
equals
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
@Override
public int hashCode() {
return new HashCodeBuilder(17, 37)
.append(this.triggerInstId)
.append(this.flowConfigID)
.toHashCode();
}
|
Retrieve a trigger instance given an instance id. Flow trigger properties will also be
populated into the returned trigger instance.
|
hashCode
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/database/JdbcFlowTriggerInstanceLoaderImpl.java
|
Apache-2.0
|
private File[] getFilesMatchingPath(final String path) {
if (path.endsWith("*")) {
final File dir = new File(path.substring(0, path.lastIndexOf("/") + 1));
final FileFilter fileFilter = new WildcardFileFilter(path.substring(path.lastIndexOf("/")
+ 1));
final File[] files = dir.listFiles(fileFilter);
return files;
} else {
return new File[]{new File(path)};
}
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
getFilesMatchingPath
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private Map<String, String> readConfig(final File file) throws
FlowTriggerDependencyPluginException {
final Properties props = new Properties();
InputStream input = null;
try {
input = new BufferedInputStream(new FileInputStream(file));
props.load(input);
} catch (final Exception e) {
logger.debug("unable to read the file " + file, e);
throw new FlowTriggerDependencyPluginException(e);
} finally {
try {
if (input != null) {
input.close();
}
} catch (final IOException e) {
logger.error("unable to close input stream when reading config from file " + file
.getAbsolutePath(), e);
}
}
return Maps.fromProperties(props);
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
readConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private void validatePluginConfig(final DependencyPluginConfig pluginConfig)
throws FlowTriggerDependencyPluginException {
for (final String requiredField : ImmutableSet
.of(DEPENDENCY_CLASS, CLASS_PATH)) {
if (StringUtils.isEmpty(pluginConfig.get(requiredField))) {
throw new FlowTriggerDependencyPluginException("missing " + requiredField + " in "
+ "dependency plugin properties");
}
}
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
validatePluginConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private DependencyPluginConfig mergePluginConfig(final Map<String, String> publicProps,
final Map<String, String> privateProps) throws FlowTriggerDependencyPluginException {
final Map<String, String> combined = new HashMap<>();
combined.putAll(publicProps);
combined.putAll(privateProps);
if (combined.size() != publicProps.size() + privateProps.size()) {
throw new FlowTriggerDependencyPluginException("duplicate property found in both public and"
+ " private properties");
}
return new DependencyPluginConfigImpl(combined);
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
mergePluginConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private DependencyCheck createDependencyCheck(final DependencyPluginConfig pluginConfig)
throws FlowTriggerDependencyPluginException {
final String classPath = pluginConfig.get(CLASS_PATH);
final String[] cpList = classPath.split(",");
final List<URL> resources = new ArrayList<>();
try {
for (final String cp : cpList) {
final File[] files = getFilesMatchingPath(cp);
if (files != null) {
for (final File file : files) {
final URL cpItem = file.toURI().toURL();
if (!resources.contains(cpItem)) {
logger.info("adding to classpath " + cpItem);
resources.add(cpItem);
}
}
}
}
} catch (final Exception ex) {
throw new FlowTriggerDependencyPluginException(ex);
}
final ClassLoader dependencyClassloader = new ParentLastURLClassLoader(
resources.toArray(new URL[resources.size()]), this.getClass().getClassLoader());
Thread.currentThread().setContextClassLoader(dependencyClassloader);
Class<? extends DependencyCheck> clazz = null;
try {
clazz = (Class<? extends DependencyCheck>) dependencyClassloader.loadClass(pluginConfig.get
(DEPENDENCY_CLASS));
return (DependencyCheck) Utils.callConstructor(clazz);
} catch (final Exception ex) {
throw new FlowTriggerDependencyPluginException(ex);
}
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
createDependencyCheck
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
public void loadDependencyPlugin(final File pluginDir)
throws FlowTriggerDependencyPluginException {
if (pluginDir.isDirectory() && pluginDir.canRead()) {
try {
final DependencyPluginConfig pluginConfig = createPluginConfig(pluginDir);
final DependencyCheck depCheck = createDependencyCheck(pluginConfig);
final String pluginName = getPluginName(pluginDir);
depCheck.init(pluginConfig);
this.dependencyTypeMap.put(pluginName, depCheck);
} catch (final Exception ex) {
logger.error("failed to initializing plugin in " + pluginDir, ex);
throw new FlowTriggerDependencyPluginException(ex);
}
}
}
|
retrieve files with wildcard matching.
Only support "dir/*". Pattern like "dir/foo*" or "dir/*foo*" will not be supported
since user shouldn't upload the jars they don't want to import
the reason for supporting dir/* is to provide another packaging option
which let user upload a dir of all required jars
in addition to one fat jar.
|
loadDependencyPlugin
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
public void loadAllPlugins() throws FlowTriggerDependencyPluginException {
final File pluginDir = new File(this.pluginDir);
for (final File dir : pluginDir.listFiles()) {
loadDependencyPlugin(dir);
}
//reset thread context loader so that other azkaban class will be loaded with the old
// classloader
Thread.currentThread().setContextClassLoader(this.prevClassLoader);
}
|
Initialize all dependency plugins.
todo chengren311: Current design aborts loadAllPlugins if any of the plugin fails to be
initialized.
However, this might not be the optimal design. Suppose we have two dependency plugin types
- MySQL and Kafka, if MySQL is down, then kafka dependency type will also be unavailable.
|
loadAllPlugins
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private String getPluginName(final File dependencyPluginDir) {
//the name of the dependency plugin dir is treated as the name of the plugin
return dependencyPluginDir.getName();
}
|
Initialize all dependency plugins.
todo chengren311: Current design aborts loadAllPlugins if any of the plugin fails to be
initialized.
However, this might not be the optimal design. Suppose we have two dependency plugin types
- MySQL and Kafka, if MySQL is down, then kafka dependency type will also be unavailable.
|
getPluginName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private Map<String, String> readPublicConfig(final File publicConfigFile)
throws FlowTriggerDependencyPluginException {
return readConfig(publicConfigFile);
}
|
Initialize all dependency plugins.
todo chengren311: Current design aborts loadAllPlugins if any of the plugin fails to be
initialized.
However, this might not be the optimal design. Suppose we have two dependency plugin types
- MySQL and Kafka, if MySQL is down, then kafka dependency type will also be unavailable.
|
readPublicConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private Map<String, String> readPrivateConfig(final File privateConfigFile) {
try {
return readConfig(privateConfigFile);
} catch (final Exception ex) {
return new HashMap<>();
}
}
|
read config from private property file, if the file is not present, then return empty.
|
readPrivateConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
private DependencyPluginConfig createPluginConfig(final File dir) throws
FlowTriggerDependencyPluginException {
final File publicConfigFile = new File(dir.getAbsolutePath() + "/" + CONFIG_FILE);
final File privateConfigFile = new File(dir.getAbsolutePath() + "/" + PRIVATE_CONFIG_FILE);
try {
final DependencyPluginConfig pluginConfig = mergePluginConfig(
readPublicConfig(publicConfigFile),
readPrivateConfig(privateConfigFile));
validatePluginConfig(pluginConfig);
return pluginConfig;
} catch (final FlowTriggerDependencyPluginException exception) {
throw new FlowTriggerDependencyPluginException("exception when initializing plugin "
+ "config in " + dir.getAbsolutePath() + ": " + exception.getMessage());
}
}
|
read config from private property file, if the file is not present, then return empty.
|
createPluginConfig
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
public DependencyCheck getDependencyCheck(final String type) {
return this.dependencyTypeMap.get(type);
}
|
return or create a dependency check based on type
@return if the dependencyCheck of the same type already exists, return the check,
otherwise create a new one and return.
|
getDependencyCheck
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
public void shutdown() {
for (final DependencyCheck depCheck : this.dependencyTypeMap.values()) {
try {
depCheck.shutdown();
} catch (final Exception ex) {
logger.error("failed to shutdown dependency check " + depCheck, ex);
}
}
}
|
return or create a dependency check based on type
@return if the dependencyCheck of the same type already exists, return the check,
otherwise create a new one and return.
|
shutdown
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/FlowTriggerDependencyPluginManager.java
|
Apache-2.0
|
@Override
protected synchronized Class<?> loadClass(final String name, final boolean resolve)
throws ClassNotFoundException {
try {
// first we try to find a class inside the child classloader
return this.childClassLoader.findClass(name);
} catch (final ClassNotFoundException e) {
// didn't find it, try the parent
return super.loadClass(name, resolve);
}
}
|
A parent-last classloader that will try the child classloader first and then the parent.
Adopted from https://stackoverflow.com/questions/5445511/how-do-i-create-a-parent-last-child-first-classloader-in-java-or-how-to-overr
|
loadClass
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
Apache-2.0
|
@Override
public Class<?> findClass(final String name) throws ClassNotFoundException {
return super.findClass(name);
}
|
This class allows me to call findClass on a classloader
|
findClass
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
Apache-2.0
|
@Override
public Class<?> findClass(final String name) throws ClassNotFoundException {
try {
final Class<?> loaded = super.findLoadedClass(name);
if (loaded != null) {
return loaded;
}
// first try to use the URLClassLoader findClass
return super.findClass(name);
} catch (final ClassNotFoundException e) {
// if that fails, we ask our real parent classloader to load the class (we give up)
return this.realParent.loadClass(name);
}
}
|
This class delegates (child then parent) for the findClass method for a URLClassLoader.
We need this because findClass is protected in URLClassLoader
|
findClass
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/plugin/ParentLastURLClassLoader.java
|
Apache-2.0
|
public void schedule(final Project project, final String submitUser)
throws ProjectManagerException, IOException, SchedulerException {
for (final Flow flow : project.getFlows()) {
//todo chengren311: we should validate embedded flow shouldn't have flow trigger defined.
if (flow.isEmbeddedFlow()) {
// skip scheduling embedded flow since embedded flow are not allowed to have flow trigger
continue;
}
final String flowFileName = flow.getId() + ".flow";
final int latestFlowVersion = this.projectLoader
.getLatestFlowVersion(flow.getProjectId(), flow
.getVersion(), flowFileName);
if (latestFlowVersion > 0) {
final File tempDir = Files.createTempDir();
final File flowFile;
try {
flowFile = this.projectLoader
.getUploadedFlowFile(project.getId(), project.getVersion(),
flowFileName, latestFlowVersion, tempDir);
final FlowTrigger flowTrigger = FlowLoaderUtils.getFlowTriggerFromYamlFile(flowFile);
if (flowTrigger != null) {
final Map<String, Object> contextMap = ImmutableMap
.of(FlowTriggerQuartzJob.SUBMIT_USER, submitUser,
FlowTriggerQuartzJob.FLOW_TRIGGER, flowTrigger,
FlowTriggerQuartzJob.FLOW_ID, flow.getId(),
FlowTriggerQuartzJob.FLOW_VERSION, latestFlowVersion,
FlowTriggerQuartzJob.PROJECT_ID, project.getId());
final boolean scheduleSuccess = this.scheduler
.scheduleJobIfAbsent(flowTrigger.getSchedule().getCronExpression(),
new QuartzJobDescription
(FlowTriggerQuartzJob.class, FlowTriggerQuartzJob.JOB_NAME,
generateGroupName(flow), contextMap));
if (scheduleSuccess) {
logger.info("Successfully registered flow {}.{} to scheduler", project.getName(),
flow.getId());
} else {
logger.info("Fail to register a duplicate flow {}.{} to scheduler", project.getName(),
flow.getId());
}
}
} catch (final SchedulerException | IOException ex) {
logger.error("Error in registering flow {}.{}", project.getName(), flow.getId(), ex);
throw ex;
} finally {
FlowLoaderUtils.cleanUpDir(tempDir);
}
}
}
}
|
Schedule flows containing flow triggers for this project.
|
schedule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public boolean pauseFlowTriggerIfPresent(final int projectId, final String flowId)
throws SchedulerException {
return this.scheduler
.pauseJobIfPresent(FlowTriggerQuartzJob.JOB_NAME, generateGroupName(projectId, flowId));
}
|
Schedule flows containing flow triggers for this project.
|
pauseFlowTriggerIfPresent
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public boolean resumeFlowTriggerIfPresent(final int projectId, final String flowId) throws
SchedulerException {
return this.scheduler
.resumeJobIfPresent(FlowTriggerQuartzJob.JOB_NAME, generateGroupName(projectId, flowId));
}
|
Schedule flows containing flow triggers for this project.
|
resumeFlowTriggerIfPresent
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public List<ScheduledFlowTrigger> getScheduledFlowTriggerJobs() {
try {
final Scheduler quartzScheduler = this.scheduler.getScheduler();
if(quartzScheduler == null) {
logger.warn("Unable to get scheduled flow triggers - Quartz scheduler has not been initialized");
return new ArrayList<>();
}
final List<String> groupNames = quartzScheduler.getJobGroupNames();
final List<ScheduledFlowTrigger> flowTriggerJobDetails = new ArrayList<>();
for (final String groupName : groupNames) {
final JobKey jobKey = new JobKey(FlowTriggerQuartzJob.JOB_NAME, groupName);
ScheduledFlowTrigger scheduledFlowTrigger = null;
try {
final JobDetail job = quartzScheduler.getJobDetail(jobKey);
final JobDataMap jobDataMap = job.getJobDataMap();
final String flowId = jobDataMap.getString(FlowTriggerQuartzJob.FLOW_ID);
final int projectId = jobDataMap.getInt(FlowTriggerQuartzJob.PROJECT_ID);
final FlowTrigger flowTrigger = (FlowTrigger) jobDataMap
.get(FlowTriggerQuartzJob.FLOW_TRIGGER);
final String submitUser = jobDataMap.getString(FlowTriggerQuartzJob.SUBMIT_USER);
final List<? extends Trigger> quartzTriggers = quartzScheduler.getTriggersOfJob(jobKey);
final boolean isPaused = this.scheduler
.isJobPaused(FlowTriggerQuartzJob.JOB_NAME, groupName);
final Project project = projectManager.getProject(projectId);
final Flow flow = project.getFlow(flowId);
scheduledFlowTrigger = new ScheduledFlowTrigger(projectId,
this.projectManager.getProject(projectId).getName(),
flowId, flowTrigger, submitUser, quartzTriggers.isEmpty() ? null
: quartzTriggers.get(0), isPaused, flow.isLocked());
} catch (final Exception ex) {
logger.error("Unable to get flow trigger by job key {}", jobKey, ex);
scheduledFlowTrigger = null;
}
flowTriggerJobDetails.add(scheduledFlowTrigger);
}
return flowTriggerJobDetails;
} catch (final Exception ex) {
logger.error("Unable to get scheduled flow triggers", ex);
return new ArrayList<>();
}
}
|
Retrieve the list of scheduled flow triggers from quartz database
|
getScheduledFlowTriggerJobs
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public void unschedule(final Project project) throws SchedulerException {
unschedule(project.getFlows(), project.getName());
}
|
Unschedule all possible flows in a project
|
unschedule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
private String generateGroupName(final Flow flow) {
return generateGroupName(flow.getProjectId(), flow.getId());
}
|
Unschedule all possible flows in a project
|
generateGroupName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
private String generateGroupName(final int projectId, final String flowId) {
return String.valueOf(projectId) + "." + flowId;
}
|
Unschedule all possible flows in a project
|
generateGroupName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public boolean isPaused() {
return this.isPaused;
}
|
Unschedule all possible flows in a project
|
isPaused
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public int getProjectId() {
return this.projectId;
}
|
Unschedule all possible flows in a project
|
getProjectId
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public String getProjectName() {
return this.projectName;
}
|
Unschedule all possible flows in a project
|
getProjectName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public String getFlowId() {
return this.flowId;
}
|
Unschedule all possible flows in a project
|
getFlowId
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public FlowTrigger getFlowTrigger() {
return this.flowTrigger;
}
|
Unschedule all possible flows in a project
|
getFlowTrigger
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public String getDependencyListJson() {
return new GsonBuilder().setPrettyPrinting().create()
.toJson(this.flowTrigger.getDependencies());
}
|
Unschedule all possible flows in a project
|
getDependencyListJson
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public Trigger getQuartzTrigger() {
return this.quartzTrigger;
}
|
Unschedule all possible flows in a project
|
getQuartzTrigger
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
public String getSubmitUser() {
return this.submitUser;
}
|
Unschedule all possible flows in a project
|
getSubmitUser
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/flowtrigger/quartz/FlowTriggerScheduler.java
|
Apache-2.0
|
@Override
public DeleteResponse deleteImageVersion(
final String imageType, final int versionId, final Boolean forceDelete)
throws ImageMgmtException {
final DeleteResponse deleteResponse = imageMgmtCommonDao.deleteImageVersion(imageType,
versionId, forceDelete);
// Check if there are errors and data. If present convert to API specific response
if (deleteResponse.hasErrors() && deleteResponse.getData().isPresent()) {
final ImageVersionUsageData imageVersionUsageData =
(ImageVersionUsageData) deleteResponse.getData().get();
final ImageVersionDTO imageVersionDTO = imageVersionUsageData.getImageVersion() == null ? null :
versionConverter.convertToApiResponseDTO(imageVersionUsageData.getImageVersion());
final List<ImageRampupPlanResponseDTO> imageRampupPlanResponseDTOs =
imageVersionUsageData.getImageRampupPlans() == null ? null :
rampupPlanConverter
.convertToApiResponseDTOs(imageVersionUsageData.getImageRampupPlans());
final ImageVersionUsageDataDTO imageVersionUsageDataDTO = new ImageVersionUsageDataDTO(
imageVersionDTO, imageRampupPlanResponseDTOs);
deleteResponse.setData(imageVersionUsageDataDTO);
}
return deleteResponse;
}
|
Implementation for image management common service
|
deleteImageVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageMgmtCommonServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageMgmtCommonServiceImpl.java
|
Apache-2.0
|
@Override
public void createRule(final ImageRampRuleRequestDTO rampRuleRequest, final User ldapUser){
// validate image_name and image_version
final ImageType imageType = imageTypeDao
.getImageTypeByName(rampRuleRequest.getImageName())
.orElseThrow(() -> new ImageMgmtInvalidInputException(ErrorCode.NOT_FOUND, String.format("Unable to"
+ " fetch image type metadata. Invalid image type: %s.", rampRuleRequest.getImageName())));
if (this.imageVersionDao.isInvalidVersion(rampRuleRequest.getImageName(), rampRuleRequest.getImageVersion())) {
log.error("fail to validate image version: " + rampRuleRequest.getImageVersion());
throw new ImageMgmtInvalidInputException(ErrorCode.NOT_FOUND, String.format(
"Unable to fetch image version metadata. Invalid image version: %s.", rampRuleRequest.getImageVersion()));
}
Set<String> ownerships;
// if user does not specify owners of a normal ramp rule, use ImageType owners as default
if (rampRuleRequest.getOwnerships() == null || rampRuleRequest.getOwnerships().isEmpty()) {
// fetch ownerships from image_ownerships and validate user permission
ownerships = permissionManager.validatePermissionAndGetOwnerships(imageType.getName(), ldapUser);
} else {
List<String> ruleOwners = Arrays.asList(rampRuleRequest.getOwnerships().split(","));
permissionManager.validateIdentity(ruleOwners);
ownerships = new HashSet<>(ruleOwners);
}
// convert ImageRampRule and insert new ramp rule into DB
ImageRampRule rampRule = new ImageRampRule.Builder()
.setRuleName(rampRuleRequest.getRuleName())
.setImageName(rampRuleRequest.getImageName())
.setImageVersion(rampRuleRequest.getImageVersion())
.setOwners(ownerships)
.setHPRule(false)
.setCreatedBy(rampRuleRequest.getCreatedBy())
.setModifiedBy(rampRuleRequest.getModifiedBy())
.build();
rampRuleDao.addRampRule(rampRule);
}
|
Create ramp rule converted from ramp rule request, validate image version and user permission.
Then call for {@link RampRuleDao} to insert the entry into DB.
@param rampRuleRequest
@param ldapUser
@throws ImageMgmtInvalidInputException when failing on invalid image metadata
@throws ImageMgmtDaoException when DB insertion fail
@throws ImageMgmtInvalidPermissionException when user does not have permission
|
createRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public void createHpFlowRule(final RampRuleOwnershipDTO hpFlowRuleOwnershipRequestDTO, final User user) {
if (hpFlowRuleOwnershipRequestDTO.getOwnerships() == null
|| hpFlowRuleOwnershipRequestDTO.getOwnerships().isEmpty()) {
throw new ImageMgmtInvalidInputException(ErrorCode.BAD_REQUEST,
"missing ownerships, please specify valid ldap user");
}
List<String> ruleOwners = Arrays.asList(hpFlowRuleOwnershipRequestDTO.getOwnerships().split(","));
permissionManager.validateIdentity(ruleOwners);
ImageRampRule rampRule = new ImageRampRule.Builder()
.setRuleName(hpFlowRuleOwnershipRequestDTO.getRuleName())
.setOwners(new HashSet<>(ruleOwners))
.setHPRule(true)
.setCreatedBy(hpFlowRuleOwnershipRequestDTO.getCreatedBy())
.setModifiedBy(hpFlowRuleOwnershipRequestDTO.getModifiedBy())
.build();
rampRuleDao.addRampRule(rampRule);
}
|
Create HP Flow rule converted from HPFlowRule request, validate input ownerships.
Then call for {@link RampRuleDao} to insert the entry into DB.
@param hpFlowRuleOwnershipRequestDTO
@param user
@throws ImageMgmtDaoException when DB insertion fail
@throws ImageMgmtValidationException when user does not have permission
|
createHpFlowRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public String updateRuleOwnership(final RampRuleOwnershipDTO ruleOwnershipDTO, final User user,
final OperationType operationType) {
Set<String> existingOwners = rampRuleDao.getOwners(ruleOwnershipDTO.getRuleName());
// validate current user has permission to change owner
if (!permissionManager.hasPermission(user, existingOwners)) {
throw new ImageMgmtInvalidPermissionException(ErrorCode.UNAUTHORIZED,
"current user "+ user.getUserId() + " does not have permission to change ownership");
}
// validate input ldaps
List<String> deltaOwners = Arrays.asList(ruleOwnershipDTO.getOwnerships().split(","));
permissionManager.validateIdentity(deltaOwners);
switch (operationType) {
case ADD:
Set<String> missingLdaps = deltaOwners.stream()
.filter(owner -> !existingOwners.contains(owner))
.collect(Collectors.toSet());
String newOwners = String.join(",", existingOwners).concat(",").concat(String.join(",", missingLdaps));
rampRuleDao.updateOwnerships(newOwners, ruleOwnershipDTO.getRuleName(), ruleOwnershipDTO.getModifiedBy());
return newOwners;
case REMOVE:
Set<String> alteredOwnership = existingOwners.stream()
.filter(owner -> !deltaOwners.contains(owner)).collect(Collectors.toSet());
String newOwnership = String.join(",", alteredOwnership);
rampRuleDao.updateOwnerships(newOwnership, ruleOwnershipDTO.getRuleName(), ruleOwnershipDTO.getModifiedBy());
return newOwnership;
}
return Strings.EMPTY;
}
|
Update Ramp Rule ownership based on {@link RampRuleOwnershipDTO} from user request to add/remove owners,
generate new owner list and update at DB.
Only azkaban admin or existing owners has the permission.
@param ruleOwnershipDTO DTO from requestBody
@param user
@param operationType Add/Remove owners
@throws ImageMgmtDaoException when DB update fail
@throws ImageMgmtValidationException when user does not have permission
@return newOwners
|
updateRuleOwnership
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public void deleteRule(final String ruleName, final User user) {
// validate permission
final Set<String> owners = rampRuleDao.getOwners(ruleName);
if (!permissionManager.hasPermission(user, owners)) {
log.error("current user "+ user.getUserId() + " does not have permission to delete ramp rule");
throw new ImageMgmtInvalidPermissionException(ErrorCode.UNAUTHORIZED,
"current user "+ user.getUserId() + " does not have permission to ramp rule");
}
rampRuleDao.deleteRampRule(ruleName);
}
|
delete ramp rule's metadata based on given ruleName
@param ruleName - ruleName in {@link ImageRampRule}
@param user - user to operate
|
deleteRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public void addFlowsToRule(final List<ProjectFlow> flowIds, final String ruleName, final User user) {
// validate permission
final Set<String> owners = rampRuleDao.getOwners(ruleName);
if (!permissionManager.hasPermission(user, owners)) {
log.error("current user "+ user.getUserId() + " does not have permission to add flows to Ramp rule");
throw new ImageMgmtInvalidPermissionException(ErrorCode.UNAUTHORIZED,
"current user "+ user.getUserId() + " does not have permission to add flows to Ramp rule");
}
// validate flowId is correct (valid and in right format)
try {
for (final ProjectFlow flowId : flowIds) {
// validate flows and projects exist and flows are in the active project
if (!projectLoader.isFlowInProject(flowId.projectName, flowId.flowName)) {
log.error("flowId " + flowId + " invalid, either project or flow not exist or active.");
throw new ImageMgmtInvalidInputException(ErrorCode.BAD_REQUEST,
"flowId " + flowId + " invalid, either project or flow not exist or active.");
}
}
} catch (ProjectManagerException e) {
log.error("failed to validate inputs" + e);
throw new ImageMgmtException(ErrorCode.BAD_REQUEST, "failed to validate inputs: " + e.getMessage());
}
// insert into flow.deny.list table with record {flowId, denyMode, denyVersions, ruleName}
rampRuleDao.addFlowDenyInfo(flowIds, ruleName);
}
|
add flows into ramp rules. Validation will be performed based on owner list, active project and valid flows.
call Dao layer to insert flow to image deny metadata into DB.
@param flowIds
@param ruleName
@param user
|
addFlowsToRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public void updateVersionOnRule(final String newVersion, final String ruleName, final User user) {
// validate permission
final ImageRampRule imageRampRule = rampRuleDao.getRampRule(ruleName);
final Set<String> owners = new HashSet<>(Arrays.asList(imageRampRule.getOwners().split(",")));
if (!permissionManager.hasPermission(user, owners)) {
log.error("current user "+ user.getUserId() + " does not have permission to add flows to Ramp rule");
throw new ImageMgmtInvalidPermissionException(ErrorCode.UNAUTHORIZED,
"current user "+ user.getUserId() + " does not have permission to add flows to Ramp rule");
}
if (imageRampRule.isHPRule()) {
log.error("Can't update version on a HP flow rule");
throw new ImageMgmtInvalidInputException(ErrorCode.BAD_REQUEST, "Can't update version on a HP flow rule");
}
if (this.imageVersionDao.isInvalidVersion(imageRampRule.getImageName(), newVersion)) {
log.error("fail to validate image version: " + newVersion);
throw new ImageMgmtInvalidInputException(ErrorCode.NOT_FOUND, String.format(
"Unable to fetch image version metadata. Invalid image version: %s.", newVersion));
}
rampRuleDao.updateVersionOnRule(newVersion, ruleName, user.getUserId());
}
|
Update normal ramp rule's version based on given ruleName, validated based on current user.
@param ruleName - ruleName in {@link ImageRampRule}
@param newVersion - new version to be updated
@param user - user must have the permission to operate
@throws ImageMgmtException
|
updateVersionOnRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampRuleServiceImpl.java
|
Apache-2.0
|
@Override
public int createImageRampupPlan(final ImageRampupPlanRequestDTO imageRampupPlanRequest)
throws ImageMgmtException {
// input validation for ImageRampupPlanRequest
final List<String> validationErrors = new ArrayList<>();
if (!ValidatorUtils.validateObject(imageRampupPlanRequest, validationErrors,
ValidationOnCreate.class)) {
final String errors = validationErrors.stream().collect(Collectors.joining(","));
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for creating image rampup plan. Error(s): [%s]", errors));
}
// Validate image rampup plan request
vaidateRampup(imageRampupPlanRequest);
// Invoke DAO method to create rampup plan and rampup details
return this.imageRampupDao
.createImageRampupPlan(this.converter.convertToDataModel(imageRampupPlanRequest));
}
|
This service layer implementation for processing and delegation of image rampup APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
createImageRampupPlan
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
Apache-2.0
|
@Override
public Optional<ImageRampupPlanResponseDTO> getActiveRampupPlan(final String imageTypeName)
throws ImageMgmtException {
final Optional<ImageRampupPlan> optionalImageRampupPlan =
this.imageRampupDao.getActiveImageRampupPlan(imageTypeName, true);
if (optionalImageRampupPlan.isPresent()) {
return Optional.of(this.converter.convertToApiResponseDTO(optionalImageRampupPlan.get()));
}
return Optional.empty();
}
|
This service layer implementation for processing and delegation of image rampup APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
getActiveRampupPlan
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
Apache-2.0
|
@Override
public void updateImageRampupPlan(final ImageRampupPlanRequestDTO imageRampupPlanRequest) throws
ImageMgmtException {
// input validation for image version create request
final List<String> validationErrors = new ArrayList<>();
if (!ValidatorUtils.validateObject(imageRampupPlanRequest, validationErrors,
ValidationOnUpdate.class)) {
final String errors = validationErrors.stream().collect(Collectors.joining(","));
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for updating image rampup plan. Error(s): [%s]", errors));
}
// Validate rampup details and set the modified by user
if (!CollectionUtils.isEmpty(imageRampupPlanRequest.getImageRampups())) {
vaidateRampup(imageRampupPlanRequest);
}
this.imageRampupDao.updateImageRampupPlan(this.converter.convertToDataModel(imageRampupPlanRequest));
}
|
This service layer implementation for processing and delegation of image rampup APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
updateImageRampupPlan
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
Apache-2.0
|
private boolean vaidateRampup(final ImageRampupPlanRequestDTO imageRampupPlanRequest)
throws ImageMgmtValidationException {
final List<ImageRampupDTO> imageRampupRequests = imageRampupPlanRequest.getImageRampups();
log.info("vaidateRampup imageRampupRequests: {} ", imageRampupRequests);
if (CollectionUtils.isEmpty(imageRampupRequests)) {
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "Missing rampup details");
}
// Check for total rampup percentage
int totalRampupPercentage = 0;
for (final ImageRampupDTO imageRampupRequest : imageRampupRequests) {
totalRampupPercentage += imageRampupRequest.getRampupPercentage();
}
if (totalRampupPercentage != 100) {
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "Total rampup percentage for "
+ "all the version must be 100");
}
// Check for duplicate image version
final Set<String> versions = new HashSet<>();
for (final ImageRampupDTO imageRampupRequest : imageRampupRequests) {
if (!versions.contains(imageRampupRequest.getImageVersion())) {
versions.add(imageRampupRequest.getImageVersion());
} else {
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Duplicate "
+ "image version: %s.",
imageRampupRequest.getImageVersion()));
}
}
// check for stability tag and ramp up percentage
for (final ImageRampupDTO imageRampupRequest : imageRampupRequests) {
if (StabilityTag.UNSTABLE.equals(imageRampupRequest.getStabilityTag())
&& imageRampupRequest.getRampupPercentage() != 0) {
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("The image "
+ "version: %s is marked as UNSTABLE in the input and hence the rampup percentage "
+ "must be 0.",
imageRampupRequest.getImageVersion()));
}
}
return true;
}
|
Validate input provided as part of rampup request. Here are the validations - 1. Total rampup
percentage must add upto 100. 2. Rampup details must not have duplicate image versions. 3. If a
specific version is marked as UNSTABLE in the rampup, the corresponding rampup percentage must
be zero.
@param imageRampupPlanRequest
@return boolean
@throws ImageMgmtValidationException
|
vaidateRampup
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageRampupServiceImpl.java
|
Apache-2.0
|
@Override
public List<ImageTypeDTO> getAllImageTypesWithOwnerships() {
List<ImageType> imageTypes = this.imageTypeDao.getAllImageTypesWithOwnerships();
List<ImageTypeDTO> imageTypeDTOs =
imageTypes.stream().map(i -> this.converter.convertToApiResponseDTO(i))
.collect(Collectors.toList());
return imageTypeDTOs;
}
|
This service layer implementation for processing and delegation of image type APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
getAllImageTypesWithOwnerships
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
@Override
public ImageTypeDTO findImageTypeWithOwnershipsById(String id) {
ImageType imageType = this.imageTypeDao.getImageTypeWithOwnershipsById(id);
return this.converter.convertToApiResponseDTO(imageType);
}
|
This service layer implementation for processing and delegation of image type APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
findImageTypeWithOwnershipsById
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
@Override
public ImageTypeDTO findImageTypeWithOwnershipsByName(String imageTypeName)
throws ImageMgmtException {
Optional<ImageType> imageType =
this.imageTypeDao.getImageTypeWithOwnershipsByName(imageTypeName);
if (imageType.isPresent()) {
return this.converter.convertToApiResponseDTO(imageType.get());
} else {
log.info("No Image Type Exists for ImageType name " + imageTypeName);
throw new ImageMgmtException(ErrorCode.NOT_FOUND, "No Image Type Exists for ImageType name "
+ imageTypeName);
}
}
|
This service layer implementation for processing and delegation of image type APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
findImageTypeWithOwnershipsByName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
@Override
public int createImageType(final ImageTypeDTO imageType) throws ImageMgmtException {
// By default always image.
if (imageType.getDeployable() == null) {
imageType.setDeployable(Deployable.IMAGE);
}
// Input validation for image type create request
final List<String> validationErrors = new ArrayList<>();
if (!ValidatorUtils.validateObject(imageType, validationErrors)) {
final String errors = validationErrors.stream().collect(Collectors.joining(","));
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for creating image type metadata. Error(s): [%s].", errors));
}
// Validate ownership metadata
validateOwnership(imageType);
return this.imageTypeDao.createImageType(this.converter.convertToDataModel(imageType));
}
|
This service layer implementation for processing and delegation of image type APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
createImageType
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
@Override
public int updateImageType(final ImageTypeDTO imageType,
final String updateOp) throws ImageMgmtException {
// Check if update operation is valid
if (updateOp.equals(IMAGE_UPDATE_ADD_USER)) {
return this.imageTypeDao.addImageTypeOwner(this.converter.convertToDataModel(imageType));
}
if (updateOp.equals(IMAGE_UPDATE_REMOVE_USER)) {
return this.imageTypeDao.removeImageTypeOwner(this.converter.convertToDataModel(imageType));
}
else{
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for image update operation"));
}
}
|
This service layer implementation for processing and delegation of image type APIs. For example
API request processing and validation are handled in this layer. Eventually the requests are
routed to the DAO layer for data access.
|
updateImageType
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
private boolean validateOwnership(final ImageTypeDTO imageType)
throws ImageMgmtValidationException {
// Check if ownership record exists
if (CollectionUtils.isEmpty(imageType.getOwnerships())
|| imageType.getOwnerships().size() < 2) {
log.error("Please specify at least two owners for the image type: {} ", imageType.getName());
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Please specify"
+ " at least two owners for the image type: %s. ", imageType.getName()));
}
// Check if one of the owner is admin
if (!hasAdminRole(imageType)) {
log.error("Please specify at least one ADMIN owner for image type: {} ", imageType.getName());
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Please specify"
+ " at least one ADMIN owner for image type: %s. ", imageType.getName()));
}
// Ownership metadata must not contain duplicate owners.
if (hasDuplicateOwner(imageType)) {
log.error("The ownership data contains duplicate owners.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST,
"The ownership data contains duplicate owners.");
}
return true;
}
|
Validate image type ownership metadata.
@param imageType
@return boolean
@throws ImageMgmtValidationException
|
validateOwnership
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
private boolean hasAdminRole(final ImageTypeDTO imageType) {
boolean hasAdminRole = false;
for (final ImageOwnershipDTO imageOwnership : imageType.getOwnerships()) {
if (Role.ADMIN.equals(imageOwnership.getRole())) {
hasAdminRole = true;
}
}
return hasAdminRole;
}
|
Validate if ownership information contains ADMIN role.
@param imageType
@return boolean
|
hasAdminRole
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
private boolean hasDuplicateOwner(final ImageTypeDTO imageType) {
final Set<String> owners = new HashSet<>();
for (final ImageOwnershipDTO imageOwnership : imageType.getOwnerships()) {
if (owners.contains(imageOwnership.getOwner())) {
return true;
} else {
owners.add(imageOwnership.getOwner());
}
}
return false;
}
|
Validate if ownership information contains duplicate owners.
@param imageType
@return boolean
|
hasDuplicateOwner
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageTypeServiceImpl.java
|
Apache-2.0
|
@Override
public Map<String, ImageVersionMetadataResponseDTO> getVersionMetadataForAllImageTypes()
throws ImageMgmtException {
final Map<String, ImageVersionMetadata> versionMetadataMap =
this.imageRampupManager.getVersionMetadataForAllImageTypes();
final Map<String, ImageVersionMetadataResponseDTO> versionMetadataResponseMap = new TreeMap<>();
versionMetadataMap.forEach((k, v) -> versionMetadataResponseMap.put(k,
convertToVersionMetadataResponse(v)));
return versionMetadataResponseMap;
}
|
Method for getting image version metadata such as version specific details, rampup information.
This method provides image version information and rampup details in
ImageVersionMetadataResponseDTO format and used as a response for dispaying on /status API
page.
@return
@throws ImageMgmtException
|
getVersionMetadataForAllImageTypes
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionMetadataServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionMetadataServiceImpl.java
|
Apache-2.0
|
private ImageVersionMetadataResponseDTO convertToVersionMetadataResponse(
final ImageVersionMetadata versionMetadata) {
List<RampupMetadata> rampups = new ArrayList<>();
if (!CollectionUtils.isEmpty(versionMetadata.getImageRampups())) {
rampups = versionMetadata.getImageRampups().stream().map(
imageRampup -> new RampupMetadata(imageRampup.getImageVersion(),
imageRampup.getRampupPercentage(), imageRampup.getStabilityTag(), imageRampup.getReleaseTag()))
.collect(Collectors.toList());
}
final ImageVersion imageVersion = versionMetadata.getImageVersion();
final String version = imageVersion != null ? imageVersion.getVersion() : null;
final State state = imageVersion != null ? imageVersion.getState() : null;
final String path = imageVersion != null ? imageVersion.getPath() : null;
final String releaseTag = imageVersion != null ? imageVersion.getReleaseTag() : null;
return new ImageVersionMetadataResponseDTO(version, state, path, rampups,
versionMetadata.getMessage(), releaseTag);
}
|
Method for getting image version metadata such as version specific details, rampup information.
This method provides image version information and rampup details in
ImageVersionMetadataResponseDTO format and used as a response for dispaying on /status API
page.
@return
@throws ImageMgmtException
|
convertToVersionMetadataResponse
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionMetadataServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionMetadataServiceImpl.java
|
Apache-2.0
|
@Override
public int createImageVersion(final ImageVersionDTO imageVersion) throws ImageMgmtException {
// Override the state to NEW during creation of new image version for all the state except TEST
if (!State.TEST.equals(imageVersion.getState())) {
imageVersion.setState(State.NEW);
}
// Input validation for image version create request
final List<String> validationErrors = new ArrayList<>();
if (!ValidatorUtils
.validateObject(imageVersion, validationErrors, ValidationOnCreate.class)) {
final String errors = validationErrors.stream().collect(Collectors.joining(","));
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for creating image version metadata. Error(s): [%s].", errors));
}
return this.imageVersionsDao
.createImageVersion(this.converter.convertToDataModel(imageVersion));
}
|
This service layer implementation for processing and delegation of image version APIs. For
example API request processing and validation are handled in this layer. Eventually the requests
are routed to the DAO layer for data access.
|
createImageVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
Apache-2.0
|
@Override
public List<ImageVersionDTO> findImageVersions(final ImageMetadataRequest imageMetadataRequest)
throws ImageMgmtException {
return this.converter.convertToApiResponseDTOs(this.imageVersionsDao
.findImageVersions(imageMetadataRequest));
}
|
This service layer implementation for processing and delegation of image version APIs. For
example API request processing and validation are handled in this layer. Eventually the requests
are routed to the DAO layer for data access.
|
findImageVersions
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
Apache-2.0
|
@Override
public void updateImageVersion(final ImageVersionDTO imageVersion) throws ImageMgmtException {
// Input validation for image version create request
final List<String> validationErrors = new ArrayList<>();
if (!ValidatorUtils.validateObject(imageVersion, validationErrors,
ValidationOnUpdate.class)) {
final String errors = validationErrors.stream().collect(Collectors.joining(","));
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, String.format("Provide valid "
+ "input for creating image version metadata. Error(s): [%s].", errors));
}
this.imageVersionsDao.updateImageVersion(this.converter.convertToDataModel(imageVersion));
}
|
This service layer implementation for processing and delegation of image version APIs. For
example API request processing and validation are handled in this layer. Eventually the requests
are routed to the DAO layer for data access.
|
updateImageVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/services/ImageVersionServiceImpl.java
|
Apache-2.0
|
@Override
public void init(final ServletConfig config) throws ServletException {
super.init(config);
final AzkabanWebServer server = (AzkabanWebServer) getApplication();
this.imageRampRuleService = server.getImageRampRuleService();
this.utils = server.getConverterUtils();
}
|
This servlet exposes the REST APIs such as create, delete and update rampup for image type.
Current only supports:
Create Image Ramp Rule API: POST /imageRampRule/createRule
Create Image Ramp Rule API for HP flows: POST /imageRampRule/createHPFlowRule
Add managed flows into rule: POST /imageRampRule/addFlowsToRule
Modify image version on Rule: POST /imageRampRule/updateVersion
Delete rule: POST /imageRampRule/deleteRule
Modify ownerships: POST /imageRampRule/addOwners or POST /imageRampRule/removeOwners
|
init
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
@Override
protected void handleGet(HttpServletRequest req, HttpServletResponse resp, Session session)
throws ServletException, IOException {
}
|
This servlet exposes the REST APIs such as create, delete and update rampup for image type.
Current only supports:
Create Image Ramp Rule API: POST /imageRampRule/createRule
Create Image Ramp Rule API for HP flows: POST /imageRampRule/createHPFlowRule
Add managed flows into rule: POST /imageRampRule/addFlowsToRule
Modify image version on Rule: POST /imageRampRule/updateVersion
Delete rule: POST /imageRampRule/deleteRule
Modify ownerships: POST /imageRampRule/addOwners or POST /imageRampRule/removeOwners
|
handleGet
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
@Override
protected void handlePost(HttpServletRequest req, HttpServletResponse resp, Session session)
throws ServletException, IOException {
final String requestURI = req.getRequestURI();
LOG.info("handle request from post uri: " + requestURI);
final User user = session.getUser();
switch (requestURI) {
case CREATE_RULE_URI:
handleCreateRampRule(req, resp, user);
break;
case CREATE_HP_FLOW_RULE_URI:
handleCreateHPFlowRule(req, resp, user);
break;
case ADD_OWNERS_URI:
handleUpdateOwnerships(req, resp, user, ImageRampRuleService.OperationType.ADD);
break;
case REMOVE_OWNERS_URI:
handleUpdateOwnerships(req, resp, user, ImageRampRuleService.OperationType.REMOVE);
break;
case ADD_FLOWS_TO_RULE_URI:
handleAddFlowsToRule(req, resp, user);
break;
case UPDATE_VERSION_ON_RULE_URI:
handleUpdateVersionOnRule(req, resp, user);
break;
case DELETE_RULE_URI:
handleDeleteRule(req, resp, user);
break;
}
}
|
This servlet exposes the REST APIs such as create, delete and update rampup for image type.
Current only supports:
Create Image Ramp Rule API: POST /imageRampRule/createRule
Create Image Ramp Rule API for HP flows: POST /imageRampRule/createHPFlowRule
Add managed flows into rule: POST /imageRampRule/addFlowsToRule
Modify image version on Rule: POST /imageRampRule/updateVersion
Delete rule: POST /imageRampRule/deleteRule
Modify ownerships: POST /imageRampRule/addOwners or POST /imageRampRule/removeOwners
|
handlePost
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleCreateRampRule(final HttpServletRequest req,
final HttpServletResponse resp,
final User user)
throws ServletException {
String requestBody = HttpRequestUtils.getBody(req);
ImageRampRuleRequestDTO rampRuleRequestDTO;
try {
// while converting to requestDTO, validation on json/required parameters would be performed.
rampRuleRequestDTO = utils.convertToDTO(requestBody, ImageRampRuleRequestDTO.class);
rampRuleRequestDTO.setCreatedBy(user.getUserId());
rampRuleRequestDTO.setModifiedBy(user.getUserId());
imageRampRuleService.createRule(rampRuleRequestDTO, user);
resp.setStatus(HttpStatus.SC_CREATED);
} catch (ImageMgmtException e) {
LOG.error("failed to create a rampRule: " + requestBody);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
create an exclusive rule for a certain version of the image,
Successful call would return CREATED(201).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleCreateRampRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleCreateHPFlowRule(final HttpServletRequest req,
final HttpServletResponse resp,
final User user)
throws ServletException {
String requestBody = HttpRequestUtils.getBody(req);
RampRuleOwnershipDTO hpFlowRuleRequestDTO;
try {
// while converting to requestDTO, validation on json/required parameters would be performed.
hpFlowRuleRequestDTO = utils.convertToDTO(requestBody, RampRuleOwnershipDTO.class);
hpFlowRuleRequestDTO.setCreatedBy(user.getUserId());
hpFlowRuleRequestDTO.setModifiedBy(user.getUserId());
imageRampRuleService.createHpFlowRule(hpFlowRuleRequestDTO, user);
resp.setStatus(HttpStatus.SC_CREATED);
} catch (ImageMgmtException e) {
LOG.error("failed to create a rampRule: " + requestBody);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
create an exclusive rule for High priority flows which will deny all image Ramp Versions,
Successful call would return CREATED(201).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleCreateHPFlowRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleUpdateOwnerships(final HttpServletRequest req,
final HttpServletResponse resp,
final User user,
final ImageRampRuleService.OperationType type)
throws ServletException, IOException {
String requestBody = HttpRequestUtils.getBody(req);
RampRuleOwnershipDTO deltaOwnershipRequestDTO;
try {
// while converting to requestDTO, validation on json/required parameters would be performed.
deltaOwnershipRequestDTO = utils.convertToDTO(requestBody, RampRuleOwnershipDTO.class);
deltaOwnershipRequestDTO.setModifiedBy(user.getUserId());
String updatedOwners = imageRampRuleService.updateRuleOwnership(deltaOwnershipRequestDTO, user, type);
// prepare response
RampRuleOwnershipDTO responseModel = new RampRuleOwnershipDTO();
responseModel.setOwnerships(updatedOwners);
responseModel.setRuleName(deltaOwnershipRequestDTO.getRuleName());
sendResponse(resp, HttpServletResponse.SC_OK, responseModel);
} catch (ImageMgmtException e) {
LOG.error("failed to update ownerships: " + requestBody);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
Add/Remove owners for a ramp rule.
Successful call would return OK(200).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleUpdateOwnerships
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleAddFlowsToRule(final HttpServletRequest req,
final HttpServletResponse resp,
final User user) throws ServletException {
String requestBody = HttpRequestUtils.getBody(req);
RampRuleFlowsDTO rampRuleFlowsDTO;
try {
rampRuleFlowsDTO = utils.convertToDTO(requestBody, RampRuleFlowsDTO.class);
imageRampRuleService.addFlowsToRule(rampRuleFlowsDTO.getFlowIds(), rampRuleFlowsDTO.getRuleName(), user);
resp.setStatus(HttpServletResponse.SC_OK);
} catch (ImageMgmtException e) {
LOG.error("fail to add flow to the rule: " + requestBody);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
Add a list of flowIds to the rule.
flowIds will come with projectName and flowName.
Successful call would return OK(200).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleAddFlowsToRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleUpdateVersionOnRule(final HttpServletRequest req,
final HttpServletResponse resp,
final User user) {
try {
final String ruleName = getReqParam(req, RULE_NAME);
final String version = getReqParam(req, VERSION);
imageRampRuleService.updateVersionOnRule(version, ruleName, user);
resp.setStatus(HttpServletResponse.SC_OK);
} catch (ImageMgmtException e) {
LOG.error("fail to update version by rule " + req);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
Updates a ramp rule's version based on given ruleName and version in parameters.
Successful call would return OK(200).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleUpdateVersionOnRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private void handleDeleteRule(final HttpServletRequest req,
final HttpServletResponse resp,
final User user) {
try {
final String ruleName = getReqParam(req, RULE_NAME);
imageRampRuleService.deleteRule(ruleName, user);
resp.setStatus(HttpServletResponse.SC_OK);
} catch (ImageMgmtException e) {
LOG.error("fail to delete rule " + req);
resp.setStatus(e.getErrorCode().getCode(), e.getMessage());
}
}
|
Delete a ramp rule.
Successful call would return OK(200).
@throws ImageMgmtException with different ErrorCode, and the detailed error message.
|
handleDeleteRule
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
private String getReqParam(final HttpServletRequest req, final String requiredParam) {
final String ruleName = req.getParameter(requiredParam);
if (ruleName == null || ruleName.length() == 0) {
LOG.error("{} must not be null or empty", requiredParam);
throw new ImageMgmtInvalidInputException(ErrorCode.BAD_REQUEST, requiredParam +" must not be null or empty");
}
return ruleName;
}
|
Fetch RuleName parameter from request.
@param req - Http request {@link HttpServletRequest}
@return targetParam values
@throws ImageMgmtInvalidInputException if not found required param
|
getReqParam
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampRuleServlet.java
|
Apache-2.0
|
@Override
public void init(final ServletConfig config) throws ServletException {
super.init(config);
final AzkabanWebServer server = (AzkabanWebServer) getApplication();
this.imageRampupService = server.getImageRampupService();
this.converterUtils = server.getConverterUtils();
}
|
This servlet exposes the REST APIs such as create, get and update rampup for image type. Below
are the supported APIs. Create Image Rampup API: POST /imageRampup?session.id=? --data
@payload.json Get active rampup for an image type : GET /imageRampup/spark_job?session.id=?
Update Image Rampup API: POST /imageRampup/spark_job?session.id=? --data @payload.json
|
init
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
Apache-2.0
|
@Override
protected void handleGet(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
/* Get specific record */
try {
ImageRampupPlanResponseDTO imageRampupPlanResponse = null;
if (BASE_IMAGE_RAMPUP_URI.equals(req.getRequestURI())) {
// imageType must present. If not present throws ImageMgmtValidationException
final String imageType = HttpRequestUtils.getParam(req, IMAGE_TYPE);
if (imageType == null) {
log.error("Image type can't be null. Must provide valid image type to get active rampup"
+ " plan");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST,
"Image type can't be null. Must provide valid image type to get rampup plan.");
}
// Check for required permission to invoke the API
if (!hasImageManagementPermission(imageType, session.getUser(), Type.GET)) {
log.debug(String.format("Invalid permission to get image rampup "
+ "plan for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission "
+ "to get image rampup plan");
}
// invoke service method and get response in string format
final Optional<ImageRampupPlanResponseDTO> optionalImageRampupPlan =
this.imageRampupService.getActiveRampupPlan(imageType);
if (optionalImageRampupPlan.isPresent()) {
imageRampupPlanResponse = optionalImageRampupPlan.get();
} else {
throw new ImageMgmtException(ErrorCode.NOT_FOUND,
String.format("There is no active rampup plan found for image "
+ "type: %s.", imageType));
}
}
sendResponse(resp, HttpServletResponse.SC_OK, imageRampupPlanResponse);
} catch (final ImageMgmtException e) {
log.error("Exception while getting rampup plan", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Requested image rampup not found " + e);
sendErrorResponse(resp, HttpServletResponse.SC_NOT_FOUND,
"Requested image rampup not found. Reason : " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get and update rampup for image type. Below
are the supported APIs. Create Image Rampup API: POST /imageRampup?session.id=? --data
@payload.json Get active rampup for an image type : GET /imageRampup/spark_job?session.id=?
Update Image Rampup API: POST /imageRampup/spark_job?session.id=? --data @payload.json
|
handleGet
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
Apache-2.0
|
@Override
protected void handlePost(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
final Map<String, String> templateVariableToValue = new HashMap<>();
if (BASE_IMAGE_RAMPUP_URI.equals(req.getRequestURI())) {
handleCreateImageRampup(req, resp, session);
} else if (UPDATE_IMAGE_RAMPUP_URI_TEMPLATE.match(req.getRequestURI(),
templateVariableToValue)) {
handleUpdateImageRampup(req, resp, session, templateVariableToValue);
} else {
// Unsupported route, return an error.
log.error("Invalid route for imageVersions endpoint: " + req.getRequestURI());
sendErrorResponse(resp, HttpServletResponse.SC_NOT_FOUND,
"The requested resource was not found.");
}
}
|
This servlet exposes the REST APIs such as create, get and update rampup for image type. Below
are the supported APIs. Create Image Rampup API: POST /imageRampup?session.id=? --data
@payload.json Get active rampup for an image type : GET /imageRampup/spark_job?session.id=?
Update Image Rampup API: POST /imageRampup/spark_job?session.id=? --data @payload.json
|
handlePost
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
Apache-2.0
|
private void handleCreateImageRampup(final HttpServletRequest req,
final HttpServletResponse resp, final Session session) throws ServletException, IOException {
try {
final String jsonPayload = HttpRequestUtils.getBody(req);
final ImageRampupPlanRequestDTO imageRampupPlanRequest =
this.converterUtils.convertToDTO(jsonPayload, ImageRampupPlanRequestDTO.class);
// Check for required permission to invoke the API
final String imageType = imageRampupPlanRequest.getImageTypeName();
if (imageType == null) {
log.error("Required field imageType is null. Must provide valid imageType to "
+ "create rampup.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST,
"Required field imageType is null. Must provide valid imageType to create rampup.");
}
if (!hasImageManagementPermission(imageType, session.getUser(), Type.CREATE)) {
log.debug(String.format("Invalid permission to create image rampup "
+ "plan for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "create image rampup plan");
}
// Polupate ImageRampupPlanRequestDTO to transfer the input request
imageRampupPlanRequest.setCreatedBy(session.getUser().getUserId());
imageRampupPlanRequest.setModifiedBy(session.getUser().getUserId());
if (!CollectionUtils.isEmpty(imageRampupPlanRequest.getImageRampups())) {
for (final ImageRampupDTO imageRampupRequest : imageRampupPlanRequest.getImageRampups()) {
imageRampupRequest.setCreatedBy(session.getUser().getUserId());
imageRampupRequest.setModifiedBy(session.getUser().getUserId());
}
}
// Create image version metadata and image version id
final Integer imageRampupPlanId = this.imageRampupService
.createImageRampupPlan(imageRampupPlanRequest);
// prepare to send response
resp.setStatus(HttpStatus.SC_CREATED);
resp.setHeader("Location",
CREATE_IMAGE_RAMPUP_URI_TEMPLATE.createURI(imageRampupPlanId.toString()));
sendResponse(resp, HttpServletResponse.SC_CREATED, new HashMap<>());
} catch (final ImageMgmtException e) {
log.error("Exception while creating image rampup plan", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Exception while creating image rampup plan", e);
sendErrorResponse(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
"Exception while creating image rampup plan. " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get and update rampup for image type. Below
are the supported APIs. Create Image Rampup API: POST /imageRampup?session.id=? --data
@payload.json Get active rampup for an image type : GET /imageRampup/spark_job?session.id=?
Update Image Rampup API: POST /imageRampup/spark_job?session.id=? --data @payload.json
|
handleCreateImageRampup
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
Apache-2.0
|
private void handleUpdateImageRampup(final HttpServletRequest req,
final HttpServletResponse resp, final Session session,
final Map<String, String> templateVariableToValue) throws ServletException,
IOException {
try {
final String imageType = templateVariableToValue.get(IMAGE_TYPE);
if (imageType == null) {
log.error("Required field imageType is null. Must provide valid imageType to "
+ "update rampup.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST,
"Required field imageType is null. Must provide valid imageType to update rampup.");
}
// Check for required permission to invoke the API
if (!hasImageManagementPermission(imageType, session.getUser(), Type.UPDATE)) {
log.debug(String.format("Invalid permission to update image rampup "
+ "plan for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "update image rampup plan");
}
final String jsonPayload = HttpRequestUtils.getBody(req);
final ImageRampupPlanRequestDTO imageRampupPlanRequest =
this.converterUtils.convertToDTO(jsonPayload, ImageRampupPlanRequestDTO.class);
// Build ImageMetadataRequest DTO to transfer the input request
imageRampupPlanRequest.setModifiedBy(session.getUser().getUserId());
if (!CollectionUtils.isEmpty(imageRampupPlanRequest.getImageRampups())) {
for (final ImageRampupDTO imageRampupRequest : imageRampupPlanRequest.getImageRampups()) {
imageRampupRequest.setModifiedBy(session.getUser().getUserId());
}
}
imageRampupPlanRequest.setImageTypeName(imageType);
// update image rampup details
this.imageRampupService.updateImageRampupPlan(imageRampupPlanRequest);
sendResponse(resp, HttpServletResponse.SC_OK, new HashMap<>());
} catch (final ImageMgmtValidationException e) {
log.error("Exception while updating image rampup metadata", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Exception while updating image rampup metadata", e);
sendErrorResponse(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
"Exception while updating image rampup metadata. " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get and update rampup for image type. Below
are the supported APIs. Create Image Rampup API: POST /imageRampup?session.id=? --data
@payload.json Get active rampup for an image type : GET /imageRampup/spark_job?session.id=?
Update Image Rampup API: POST /imageRampup/spark_job?session.id=? --data @payload.json
|
handleUpdateImageRampup
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageRampupServlet.java
|
Apache-2.0
|
@Override
public void init(final ServletConfig config) throws ServletException {
super.init(config);
final AzkabanWebServer server = (AzkabanWebServer) getApplication();
this.imageTypeService = server.getImageTypeService();
this.converterUtils = server.getConverterUtils();
this.permissionManager = server.getPermissionManager();
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Type API: POST /imageTypes?session.id=? --data @payload.json Get
Image Type API: GET /imageTypes?&imageType=? GET /imageTypes/{imageType} GET /imageTypes/{id} GET
/imageTypes
|
init
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
Apache-2.0
|
@Override
protected void handleGet(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
try {
final Map<String, String> templateVariableToValue = new HashMap<>();
if (IMAGE_TYPE_NAME_OR_ID_URI_TEMPLATE.match(req.getRequestURI(), templateVariableToValue)) {
getImageTypeDTOByIdOrImageTypeName(resp, session, templateVariableToValue);
} else if (GET_IMAGE_TYPE_URI.equals(req.getRequestURI())) {
ImageTypeDTO imageTypeDTO;
if (req.getQueryString().contains(ImageMgmtConstants.IMAGE_TYPE)) {
final String imageTypeName = HttpRequestUtils
.getParam(req, ImageMgmtConstants.IMAGE_TYPE);
if (!hasImageManagementPermission(imageTypeName, session.getUser(), Type.GET)) {
log.info(FORBIDDEN_USER_ERR_MSG);
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN,
FORBIDDEN_USER_ERR_MSG);
}
imageTypeDTO = this.imageTypeService.findImageTypeWithOwnershipsByName(imageTypeName);
sendResponse(resp, HttpServletResponse.SC_OK, imageTypeDTO);
}
getAllImageTypeDTOs(resp, session);
} else {
log.info(PATH_NOT_SUPPORTED);
throw new ImageMgmtInvalidInputException(ErrorCode.NOT_FOUND, PATH_NOT_SUPPORTED);
}
} catch (final ImageMgmtInvalidPermissionException e) {
log.error("The user provided does not have permissions to access the resource");
resp.setStatus(HttpStatus.SC_FORBIDDEN);
sendErrorResponse(resp, HttpServletResponse.SC_FORBIDDEN,
"User does not have permissions. Error Message: " + e.getMessage());
} catch (final ImageMgmtException e) {
int status;
if (e.getErrorCode() != null) {
log.error("An error has occurred");
status = e.getErrorCode().getCode();
} else {
status = HttpStatus.SC_BAD_REQUEST;
}
sendErrorResponse(resp, status,
"Exception on GET call to /imageTypes. Reason: " + e.getMessage());
} catch (final Exception e) {
log.error("Content is likely not present " + e);
resp.setStatus(HttpStatus.SC_NOT_FOUND);
sendErrorResponse(resp, HttpServletResponse.SC_NOT_FOUND,
"Exception on GET call to /imageTypes. Reason: " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Type API: POST /imageTypes?session.id=? --data @payload.json Get
Image Type API: GET /imageTypes?&imageType=? GET /imageTypes/{imageType} GET /imageTypes/{id} GET
/imageTypes
|
handleGet
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
Apache-2.0
|
private void getImageTypeDTOByIdOrImageTypeName(
final HttpServletResponse resp, final Session session,
final Map<String, String> templateVariableToValue) throws IOException {
ImageTypeDTO imageTypeDTO;
String imageTypeIdOrName = templateVariableToValue.get(IMAGE_TYPE_NAME_OR_ID);
if (!StringUtils.isNumeric(imageTypeIdOrName)) {
imageTypeDTO = this.imageTypeService.findImageTypeWithOwnershipsByName(imageTypeIdOrName);
} else {
imageTypeDTO = this.imageTypeService.findImageTypeWithOwnershipsById(imageTypeIdOrName);
}
if (!hasImageManagementPermission(imageTypeDTO.getName(), session.getUser(), Type.GET)) {
log.info(FORBIDDEN_USER_ERR_MSG);
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, FORBIDDEN_USER_ERR_MSG);
}
sendResponse(resp, HttpServletResponse.SC_OK, imageTypeDTO);
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Type API: POST /imageTypes?session.id=? --data @payload.json Get
Image Type API: GET /imageTypes?&imageType=? GET /imageTypes/{imageType} GET /imageTypes/{id} GET
/imageTypes
|
getImageTypeDTOByIdOrImageTypeName
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
Apache-2.0
|
private void getAllImageTypeDTOs(final HttpServletResponse resp, final Session session)
throws IOException {
if (!permissionManager.isAzkabanAdmin(session.getUser())) {
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, FORBIDDEN_USER_ERR_MSG);
}
List<ImageTypeDTO> imageTypesDTO =
this.imageTypeService.getAllImageTypesWithOwnerships();
sendResponse(resp, HttpServletResponse.SC_OK, imageTypesDTO);
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Type API: POST /imageTypes?session.id=? --data @payload.json Get
Image Type API: GET /imageTypes?&imageType=? GET /imageTypes/{imageType} GET /imageTypes/{id} GET
/imageTypes
|
getAllImageTypeDTOs
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
Apache-2.0
|
@Override
protected void handlePost(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
try {
final String jsonPayload = HttpRequestUtils.getBody(req);
// Convert to GenericImageType DTO to transfer the input request
final ImageTypeDTO genericImageType = this.converterUtils.convertToDTO(jsonPayload,
ImageTypeDTO.class);
// Check for required permission to invoke the API
final String imageType = genericImageType.getName();
if (imageType == null) {
log.info("Required field imageType is null. Must provide valid imageType to "
+ "create/register image type.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "Required field imageType is"
+ " null. Must provide valid imageType to create/register image type.");
}
final Integer imageTypeId;
genericImageType.setModifiedBy(session.getUser().getUserId());
genericImageType.setCreatedBy(session.getUser().getUserId());
if (!HttpRequestUtils.hasParam(req, "updateImageOwners")){
if (!hasImageManagementPermission(imageType, session.getUser(), Type.CREATE)) {
log.debug(String.format("Invalid permission to create image type for "
+ "user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "create image type");
}
// Create image type /Update and get image type id
imageTypeId = this.imageTypeService.createImageType(genericImageType);
}else {
if (!hasImageManagementPermission(imageType, session.getUser(), Type.UPDATE)) {
log.debug(String.format("Invalid permission to update image type for "
+ "user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "create image type");
}
final String updateOp = req.getParameter("updateImageOwners");
imageTypeId = this.imageTypeService.updateImageType(genericImageType, updateOp);
}
// prepare to send response
resp.setStatus(HttpStatus.SC_CREATED);
resp.setHeader("Location",
IMAGE_TYPE_WITH_ID_URI_TEMPLATE.createURI(imageTypeId.toString()));
sendResponse(resp, HttpServletResponse.SC_CREATED, new HashMap<>());
} catch (final ImageMgmtException e) {
log.error("Exception while creating / updating an image type", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Exception while creating / updating an image type", e);
sendErrorResponse(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
"Exception while creating / updating an image type. Reason: " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Type API: POST /imageTypes?session.id=? --data @payload.json Get
Image Type API: GET /imageTypes?&imageType=? GET /imageTypes/{imageType} GET /imageTypes/{id} GET
/imageTypes
|
handlePost
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageTypeServlet.java
|
Apache-2.0
|
@Override
public void init(final ServletConfig config) throws ServletException {
super.init(config);
final AzkabanWebServer server = (AzkabanWebServer) getApplication();
this.imageVersionService = server.getImageVersionsService();
this.converterUtils = server.getConverterUtils();
this.imageMgmtCommonService = server.getImageMgmtCommonService();
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
init
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
@Override
protected void handleGet(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
/* Get specific record */
try {
List<ImageVersionDTO> imageVersions = null;
if (BASE_IMAGE_VERSION_URI.equals(req.getRequestURI())) {
// imageType must present. If not present throws ServletException
final String imageType = HttpRequestUtils.getParam(req, ImageMgmtConstants.IMAGE_TYPE);
// Check for required permission to invoke the API
if (!hasImageManagementPermission(imageType, session.getUser(), Type.GET)) {
log.debug(String.format("Invalid permission to get image version "
+ "for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission "
+ "to get image version");
}
// imageVersion is optional. Hence can be null
final Optional<String> imageVersion = Optional.ofNullable(HttpRequestUtils.getParam(req,
ImageMgmtConstants.IMAGE_VERSION,
null));
// imageVersion is optional. Hence can be null
final String versionStateString = HttpRequestUtils
.getParam(req, ImageMgmtConstants.VERSION_STATE,
null);
final Optional<State> versionState =
Optional.ofNullable(versionStateString != null ? State.valueOf(versionStateString) :
null);
// create RequestContext DTO to transfer the input request
final ImageMetadataRequest imageMetadataRequest = ImageMetadataRequest.newBuilder()
.addParam(ImageMgmtConstants.IMAGE_TYPE, imageType) // mandatory parameter
.addParamIfPresent(ImageMgmtConstants.IMAGE_VERSION, imageVersion) // optional parameter
.addParamIfPresent(ImageMgmtConstants.VERSION_STATE, versionState) // optional parameter
.build();
// invoke service method and get response in string format
imageVersions = this.imageVersionService.findImageVersions(imageMetadataRequest);
}
sendResponse(resp, HttpServletResponse.SC_OK, imageVersions);
} catch (final ImageMgmtException e) {
log.error("Unable to get image version.", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Requested image metadata not found " + e);
sendErrorResponse(resp, HttpServletResponse.SC_NOT_FOUND,
"Requested image metadata not found. Reason : " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
handleGet
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
@Override
protected void handlePost(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
final Map<String, String> templateVariableToValue = new HashMap<>();
if (BASE_IMAGE_VERSION_URI.equals(req.getRequestURI())) {
handleCreateImageVersion(req, resp, session);
} else if (SINGLE_IMAGE_VERSION_URI_TEMPLATE.match(req.getRequestURI(),
templateVariableToValue)) {
handleUpdateImageVersion(req, resp, session, templateVariableToValue);
} else {
// Unsupported route, return an error.
log.error("Invalid route for imageVersions endpoint: " + req.getRequestURI());
sendErrorResponse(resp, HttpServletResponse.SC_NOT_FOUND,
"The requested resource was not found.");
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
handlePost
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
@Override
protected void handleDelete(
final HttpServletRequest req, final HttpServletResponse resp, final Session session)
throws ServletException, IOException {
final Map<String, String> templateVariableToValue = new HashMap<>();
if (SINGLE_IMAGE_VERSION_URI_TEMPLATE.match(req.getRequestURI(),
templateVariableToValue)) {
handleDeleteImageVersion(req, resp, session, templateVariableToValue);
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
handleDelete
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
private void handleCreateImageVersion(final HttpServletRequest req,
final HttpServletResponse resp, final Session session) throws ServletException, IOException {
try {
final String jsonPayload = HttpRequestUtils.getBody(req);
final ImageVersionDTO imageVersion = this.converterUtils.convertToDTO(jsonPayload,
ImageVersionDTO.class);
// Check for required permission to invoke the API
final String imageType = imageVersion.getName();
if (imageType == null) {
log.info("Required field imageType is null. Must provide valid imageType to create image "
+ "version.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "Required field imageType is"
+ " null. Must provide valid imageType to create image version.");
}
if(imageType.equals("az-platform-image")){
final String imagePath = imageVersion.getPath().toLowerCase();
if(!imagePath.contains(imageType)) {
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "The image type name must"
+ " be included in the path");
}
}
if (!hasImageManagementPermission(imageType, session.getUser(), Type.CREATE)) {
log.debug(String.format("Invalid permission to create image version "
+ "for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "create image version");
}
// Set the user who invoked the API
imageVersion.setCreatedBy(session.getUser().getUserId());
imageVersion.setModifiedBy(session.getUser().getUserId());
// Create image version metadata and image version id
final Integer imageVersionId = this.imageVersionService.createImageVersion(imageVersion);
// prepare to send response
resp.setStatus(HttpStatus.SC_CREATED);
resp.setHeader("Location",
SINGLE_IMAGE_VERSION_URI_TEMPLATE.createURI(imageVersionId.toString()));
sendResponse(resp, HttpServletResponse.SC_CREATED, new HashMap<>());
log.info("ImageType {} with imageVersionId {} is created successfully: payload {}", imageType, imageVersionId, imageVersion);
} catch (final ImageMgmtException e) {
log.error("Exception while creating image version metadata.", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Exception while creating image version metadata", e);
sendErrorResponse(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
"Exception while creating image version metadata. " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
handleCreateImageVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
private void handleUpdateImageVersion(final HttpServletRequest req,
final HttpServletResponse resp, final Session session,
final Map<String, String> templateVariableToValue) throws IOException {
try {
final String idString = templateVariableToValue.get(IMAGE_VERSION_ID_KEY);
final Integer id = Ints.tryParse(idString);
if (id == null) {
log.error("Invalid image version id: ", idString);
throw new ImageMgmtValidationException("Image version id is invalid");
}
final String jsonPayload = HttpRequestUtils.getBody(req);
final ImageVersionDTO imageVersion = this.converterUtils.convertToDTO(jsonPayload,
ImageVersionDTO.class);
// Check for required permission to invoke the API
final String imageType = imageVersion.getName();
if (imageType == null) {
log.info("Required field imageType is null. Must provide valid imageType to update image "
+ "version.");
throw new ImageMgmtValidationException(ErrorCode.BAD_REQUEST, "Required field imageType is"
+ " null. Must provide valid imageType to update image version.");
}
if (!hasImageManagementPermission(imageType, session.getUser(), Type.UPDATE)) {
log.debug(String.format("Invalid permission to update image version "
+ "for user: %s, image type: %s.", session.getUser().getUserId(), imageType));
throw new ImageMgmtInvalidPermissionException(ErrorCode.FORBIDDEN, "Invalid permission to "
+ "update image version");
}
// Populate ImageVersionDTO to transfer the input request
imageVersion.setId(id);
imageVersion.setCreatedBy(session.getUser().getUserId());
imageVersion.setModifiedBy(session.getUser().getUserId());
// Create image version metadata and image version id
this.imageVersionService.updateImageVersion(imageVersion);
sendResponse(resp, HttpServletResponse.SC_OK, new HashMap<>());
log.info("ImageType {} with imageVersionId {} is updated successfully: payload {}", imageType, idString, imageVersion);
} catch (final ImageMgmtException e) {
log.error("Exception while updating image version metadata", e);
sendErrorResponse(resp, e.getErrorCode().getCode(), e.getMessage());
} catch (final Exception e) {
log.error("Exception while updating image version metadata", e);
sendErrorResponse(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
"Exception while updating image version metadata. " + e.getMessage());
}
}
|
This servlet exposes the REST APIs such as create, get etc. for image type. Below are the
supported APIs. Create Image Version API: POST /imageVersions?session.id=? --data @payload.json
Search/Get Image Versions API: GET /imageVersions?session.id=?&imageType=?&imageVersion=?&versionState=?
GET /imageVersions/{id}?session.id=? Update image version API: POST
/imageVersions/{id}?session.id=? --data @payload.json
|
handleUpdateImageVersion
|
java
|
azkaban/azkaban
|
azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/imagemgmt/servlets/ImageVersionServlet.java
|
Apache-2.0
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.