org.lastaflute.doc.generator.JobDocumentGenerator Maven / Gradle / Ivy
/*
* Copyright 2014-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.lastaflute.doc.generator;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import org.dbflute.helper.message.ExceptionMessageBuilder;
import org.dbflute.optional.OptionalThing;
import org.lastaflute.core.util.ContainerUtil;
import org.lastaflute.di.core.exception.ComponentNotFoundException;
import org.lastaflute.doc.meta.JobDocMeta;
import org.lastaflute.doc.meta.TypeDocMeta;
import org.lastaflute.doc.reflector.SourceParserReflector;
import org.lastaflute.doc.util.LaDocReflectionUtil;
/**
* @author p1us2er0
* @since 0.6.9 (2075/03/05 Sunday)
*/
public class JobDocumentGenerator extends BaseDocumentGenerator {
// ===================================================================================
// Attribute
// =========
/** source directory. (NotNull) */
protected final List srcDirList;
/** depth. */
protected int depth;
/** sourceParserReflector. */
protected final OptionalThing sourceParserReflector;
// ===================================================================================
// Constructor
// ===========
protected JobDocumentGenerator(List srcDirList, int depth, OptionalThing sourceParserReflector) {
this.srcDirList = srcDirList;
this.depth = depth;
this.sourceParserReflector = sourceParserReflector;
}
// -----------------------------------------------------
// Generate Meta List
// ------------------
public List generateJobDocMetaList() {
org.lastaflute.job.JobManager jobManager = getJobManager();
boolean rebooted = automaticallyRebootIfNeeds(jobManager);
try {
return doGenerateJobDocMetaList(jobManager);
} finally {
automaticallyDestroyIfNeeds(jobManager, rebooted);
}
}
protected org.lastaflute.job.JobManager getJobManager() {
try {
return ContainerUtil.getComponent(org.lastaflute.job.JobManager.class);
} catch (ComponentNotFoundException e) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Not found the job manager as Lasta Di component.");
br.addItem("Advice");
br.addElement("LastaDoc needs JobManager to get job information.");
br.addElement("So confirm your app.xml (or test_app.xml?)");
br.addElement("whether the Di xml includes lasta_job.xml or not.");
final String msg = br.buildExceptionMessage();
throw new IllegalStateException(msg, e);
}
}
protected boolean automaticallyRebootIfNeeds(org.lastaflute.job.JobManager jobManager) {
if (!jobManager.isSchedulingDone()) { // basically no scheduling in UTFlute
try {
jobManager.reboot();
} catch (RuntimeException e) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Cannot reboot job scheduling for LastaDoc.");
br.addItem("Advice");
br.addElement("Confirm nested exception message");
br.addElement("and your job environment in unit test.");
br.addItem("Job Manager");
br.addElement(jobManager);
final String msg = br.buildExceptionMessage();
throw new IllegalStateException(msg, e);
}
return true;
} else {
return false;
}
}
protected List doGenerateJobDocMetaList(org.lastaflute.job.JobManager jobManager) {
return jobManager.getJobList().stream().map(job -> {
JobDocMeta jobDocMeta = new JobDocMeta();
jobDocMeta.setJobKey(LaDocReflectionUtil.getNoException(() -> job.getJobKey().value()));
jobDocMeta.setJobUnique(LaDocReflectionUtil
.getNoException(() -> job.getJobUnique().map(jobUnique -> jobUnique.value()).orElse(null)));
jobDocMeta.setJobTitle(LaDocReflectionUtil
.getNoException(() -> job.getJobNote().flatMap(jobNote -> jobNote.getTitle()).orElse(null)));
jobDocMeta.setJobDescription(LaDocReflectionUtil
.getNoException(() -> job.getJobNote().flatMap(jobNote -> jobNote.getDesc()).orElse(null)));
jobDocMeta.setCronExp(LaDocReflectionUtil.getNoException(() -> job.getCronExp().orElse(null)));
Class jobClass = LaDocReflectionUtil.getNoException(() -> job.getJobType());
if (jobClass != null) {
jobDocMeta.setTypeName(jobClass.getName());
jobDocMeta.setSimpleTypeName(jobClass.getSimpleName());
jobDocMeta.setFieldTypeDocMetaList(Arrays.stream(jobClass.getDeclaredFields()).map(field -> {
TypeDocMeta typeDocMeta = new TypeDocMeta();
typeDocMeta.setName(field.getName());
typeDocMeta.setType(field.getType());
typeDocMeta.setTypeName(adjustTypeName(field.getGenericType()));
typeDocMeta.setSimpleTypeName(adjustSimpleTypeName((field.getGenericType())));
typeDocMeta.setAnnotationTypeList(Arrays.asList(field.getAnnotations()));
typeDocMeta.setAnnotationList(analyzeAnnotationList(typeDocMeta.getAnnotationTypeList()));
sourceParserReflector.ifPresent(sourceParserReflector -> {
sourceParserReflector.reflect(typeDocMeta, field.getType());
});
return typeDocMeta;
}).collect(Collectors.toList()));
jobDocMeta.setMethodName("run");
sourceParserReflector.ifPresent(sourceParserReflector -> {
sourceParserReflector.reflect(jobDocMeta, jobClass);
});
}
jobDocMeta.setParams(LaDocReflectionUtil.getNoException(
() -> job.getParamsSupplier().map(paramsSupplier -> paramsSupplier.supply()).orElse(null)));
jobDocMeta.setNoticeLogLevel(LaDocReflectionUtil.getNoException(() -> job.getNoticeLogLevel().name()));
jobDocMeta.setConcurrentExec(LaDocReflectionUtil.getNoException(() -> job.getConcurrentExec().name()));
jobDocMeta.setTriggeredJobKeyList(LaDocReflectionUtil.getNoException(() -> job.getTriggeredJobKeySet()
.stream()
.map(triggeredJobKey -> triggeredJobKey.value())
.collect(Collectors.toList())));
return jobDocMeta;
}).collect(Collectors.toList());
}
protected void automaticallyDestroyIfNeeds(org.lastaflute.job.JobManager jobManager, boolean rebooted) {
if (rebooted) {
jobManager.destroy();
}
}
}