org.dbflute.tomcat

クラス TomcatBoot

java.lang.Object

org.dbflute.tomcat.TomcatBoot

public class TomcatBoot
extends Object

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	baseDir
protected BootLogger	bootLogger
protected boolean	browseOnDesktop
protected String	configFile
protected Properties	configProps
protected String	contextPath
protected static String	DEFAULT_MARK_DIR
protected boolean	development
protected String[]	extendsConfigFiles
protected LikeItCatalinaSetupper	likeitCatalinaSetupper
protected String	loggingFile
protected Consumer<TomcatLoggingOption>	loggingOptionCall
protected int	port
protected BootPropsTranslator	propsTranslator
protected List<String>	readConfigList
protected org.apache.catalina.startup.Tomcat	server
protected boolean	suppressShutdownHook
protected Predicate<String>	tldFilesSelector
protected boolean	useAnnotationDetect
protected boolean	useMetaInfoResourceDetect
protected boolean	useTldDetect
protected boolean	useWebFragmentsDetect
protected Predicate<String>	webFragmentsSelector
protected YourValveOption	yourValveOption

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TomcatBoot(int port, String contextPath) Create with port number and context path.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	adjustServer()
TomcatBoot	asDevelopment() Does it boot the tomcat server as development mode?
TomcatBoot	asDevelopment(boolean development) Does it boot the tomcat server as development mode?
protected void	assertDevelopmentState()
TomcatBoot	asYouLikeIt(LikeItCatalinaSetupper resourceLambda) You can customize tomcat resource (e.g. host, context) as you like (it).
TomcatBoot	atBaseDir(String baseDir) Set base directory of tomcat server.
void	await()
TomcatBoot	bootAwait()
TomcatBoot	browseOnDesktop() Browse on desktop automatically after boot finished.
protected void	browseOnDesktop(URI uri)
protected String	buildMarkFilePath()
protected void	cleanPreviousExtractedWarDir(File appBaseFile)
void	close()
TomcatBoot	configure(String configFile, String... extendsConfigFiles) You can configure tomcat options by application properties.
protected BootPropsTranslator	createBootPropsTranslator()
protected org.apache.catalina.startup.Tomcat	createTomcat()
protected File	deriveWebappDir()
protected void	disableUnpackWARsOption()
protected void	doSetupWebappContextWar(String warPath)
protected void	doSetupWebappContextWebappDir()
protected File	findProjectWebappDir(String webappRelativePath)
protected String	getBasicWebappRelativePath()
protected String	getMarkDir()
org.apache.catalina.startup.Tomcat	getServer()
protected long	getShuwdownHookWaitMillis()
void	go()
protected void	info(String msg)
protected boolean	isUnpackWARsDisabled()
protected void	loadServerConfigIfNeeds()
protected void	loadServerLoggingIfNeeds()
TomcatBoot	logging(String loggingFile, Consumer<TomcatLoggingOption> opLambda) You can set tomcat logging by application properties.
protected boolean	needsShutdown(File markFile, long lastModified)
protected RhythmicalTomcat	newRhythmicalTomcat(BootLogger bootLogger, RhythmicalHandlingDef.AnnotationHandling annotationHandling, RhythmicalHandlingDef.MetaInfoResourceHandling metaInfoResourceHandling, RhythmicalHandlingDef.TldHandling tldHandling, Predicate<String> tldFilesSelector, RhythmicalHandlingDef.WebFragmentsHandling webFragmentsHandling, Predicate<String> webFragmentsSelector, AccessLogOption accessLogOption, YourValveOption yourValveOption, LikeItCatalinaSetupper likeitCatalinaSetupper)
protected AccessLogOption	prepareAccessLogOption()
protected RhythmicalHandlingDef.AnnotationHandling	prepareAnnotationHandling()
protected LikeItCatalinaSetupper	prepareLikeItCatalinaSetupper()
protected File	prepareMarkFile()
protected RhythmicalHandlingDef.MetaInfoResourceHandling	prepareMetaInfoResourceHandling()
protected void	prepareServer()
protected Predicate<String>	prepareTldFilesSelector()
protected RhythmicalHandlingDef.TldHandling	prepareTldHandling()
protected void	prepareUnpackWARsEnv()
protected RhythmicalHandlingDef.WebFragmentsHandling	prepareuseWebFragmentsHandling()
protected String	prepareWarPath()
protected String	prepareWebappPath()
protected Predicate<String>	prepareWebFragmentsSelector()
protected String	prepareWebXmlPath(String webappPath)
protected YourValveOption	prepareYourValveOption()
protected Properties	readConfigProps(String propFile)
void	ready()
protected void	registerShutdownHook()
protected String	resolveConfigEnvPath(String envPath)
protected void	setupServerConfigIfNeeds()
protected void	setupWebappContext()
protected void	shutdownForcedly()
protected URI	startServer()
TomcatBoot	suppressShutdownHook() Suppress shutdown hook.
TomcatBoot	useAnnotationDetect() You can detect annotations in all jar files.
TomcatBoot	useMetaInfoResourceDetect() You can detect 'META-INF' resources in jar files detected as web fragments.
TomcatBoot	useTldDetect() You can detect '.tdl' files in all jar files.
TomcatBoot	useTldDetect(Predicate<String> oneArgLambda) You can detect '.tdl' files in selected jar files.
TomcatBoot	useWebFragmentsDetect() You can detect web fragments in all jar files.
TomcatBoot	useWebFragmentsDetect(Predicate<String> oneArgLambda) You can detect web fragments in selected jar files.
TomcatBoot	valve(org.apache.catalina.Valve yourValve) Add your valve for tomcat server.
protected void	waitForExistingServerShuwdown()
protected void	waitForNextShuwdownHook()

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_MARK_DIR

protected static final String DEFAULT_MARK_DIR

関連項目:

定数フィールド値

port

protected final int port

contextPath

protected final String contextPath

development

protected boolean development

browseOnDesktop

protected boolean browseOnDesktop

suppressShutdownHook

protected boolean suppressShutdownHook

useAnnotationDetect

protected boolean useAnnotationDetect

useMetaInfoResourceDetect

protected boolean useMetaInfoResourceDetect

useTldDetect

protected boolean useTldDetect

tldFilesSelector

protected Predicate<String> tldFilesSelector

useWebFragmentsDetect

protected boolean useWebFragmentsDetect

webFragmentsSelector

protected Predicate<String> webFragmentsSelector

configFile

protected String configFile

extendsConfigFiles

protected String[] extendsConfigFiles

loggingFile

protected String loggingFile

loggingOptionCall

protected Consumer<TomcatLoggingOption> loggingOptionCall

baseDir

protected String baseDir

yourValveOption

protected YourValveOption yourValveOption

likeitCatalinaSetupper

protected LikeItCatalinaSetupper likeitCatalinaSetupper

configProps

protected Properties configProps

readConfigList

protected List<String> readConfigList

bootLogger

protected BootLogger bootLogger

server

protected org.apache.catalina.startup.Tomcat server

propsTranslator

protected final BootPropsTranslator propsTranslator

コンストラクタの詳細

TomcatBoot

public TomcatBoot(int port,
                  String contextPath)

Create with port number and context path.

 e.g. has context path
  TomcatBoot boot = new TomcatBoot(8152, "/fortress");
 
 e.g. no context path
  TomcatBoot boot = new TomcatBoot(8152, "");
 

パラメータ:

port - The port number for the tomcat server.

contextPath - The context path for the tomcat server, basically has slash prefix. (NotNull, EmptyAllowed)

メソッドの詳細

createBootPropsTranslator

protected BootPropsTranslator createBootPropsTranslator()

asDevelopment

public TomcatBoot asDevelopment()

Does it boot the tomcat server as development mode?

戻り値:

this. (NotNull)

asDevelopment

public TomcatBoot asDevelopment(boolean development)

Does it boot the tomcat server as development mode?

パラメータ:

development - Is it development mode?

戻り値:

this. (NotNull)

browseOnDesktop

public TomcatBoot browseOnDesktop()

Browse on desktop automatically after boot finished.

戻り値:

this. (NotNull)

suppressShutdownHook

public TomcatBoot suppressShutdownHook()

Suppress shutdown hook. (for development only)

戻り値:

this. (NotNull)

assertDevelopmentState

protected void assertDevelopmentState()

useAnnotationDetect

public TomcatBoot useAnnotationDetect()

You can detect annotations in all jar files.

戻り値:

this. (NotNull)

useMetaInfoResourceDetect

public TomcatBoot useMetaInfoResourceDetect()

You can detect 'META-INF' resources in jar files detected as web fragments.
So you also needs to enable web fragments detect.

戻り値:

this. (NotNull)

useTldDetect

public TomcatBoot useTldDetect()

You can detect '.tdl' files in all jar files.

戻り値:

this. (NotNull)

useTldDetect

public TomcatBoot useTldDetect(Predicate<String> oneArgLambda)

You can detect '.tdl' files in selected jar files.

 boot.useTldDetect(jarName -> {
     return jarName.contains("lasta-taglib");
 });
 

パラメータ:

oneArgLambda - The callback for selector of tld files, argument is jar name. (NotNull)

戻り値:

this. (NotNull)

useWebFragmentsDetect

public TomcatBoot useWebFragmentsDetect()

You can detect web fragments in all jar files.

戻り値:

this. (NotNull)

useWebFragmentsDetect

public TomcatBoot useWebFragmentsDetect(Predicate<String> oneArgLambda)

You can detect web fragments in selected jar files.

 boot.useMetaInfoResourceDetect().useWebFragmentsDetect(jarName -> { // for swagger
     return jarName.contains("swagger-ui");
 });
 

パラメータ:

oneArgLambda - The callback for selector of web fragments, argument is jar name. (NotNull)

戻り値:

this. (NotNull)

configure

public TomcatBoot configure(String configFile,
                            String... extendsConfigFiles)

You can configure tomcat options by application properties.

 boot.configure("fortress_config.properties", "fortress_env.properties");
 

パラメータ:

configFile - The path of configuration file in classpath. (NotNull)

extendsConfigFiles - The paths of super configuration files. (NotNull, EmptyAllowed)

戻り値:

this. (NotNull)

logging

public TomcatBoot logging(String loggingFile,
                          Consumer<TomcatLoggingOption> opLambda)

You can set tomcat logging by application properties.

 boot.logging("tomcat_logging.properties", op -> {
     op.replace("tomcat.log.name", "catalina_out");
 }); // uses jdk14logger
 

パラメータ:

loggingFile - The path of logging file in classpath. (NotNull)

opLambda - The callback for logging option. (NotNull)

戻り値:

this. (NotNull)

atBaseDir

public TomcatBoot atBaseDir(String baseDir)

Set base directory of tomcat server.

パラメータ:

baseDir - The base directory for Tomcat@setBaseDir(). (NotNull)

戻り値:

this. (NotNull)

valve

public TomcatBoot valve(org.apache.catalina.Valve yourValve)

Add your valve for tomcat server. (can be called several times)

パラメータ:

yourValve - The your valve. (NotNull)

戻り値:

this. (NotNull)

asYouLikeIt

public TomcatBoot asYouLikeIt(LikeItCatalinaSetupper resourceLambda)

You can customize tomcat resource (e.g. host, context) as you like (it).

パラメータ:

resourceLambda - The setupper of tomcat resource (e.g. host, context). (NotNull)

戻り値:

this. (NotNull)

bootAwait

public TomcatBoot bootAwait()

ready

public void ready()

loadServerConfigIfNeeds

protected void loadServerConfigIfNeeds()

resolveConfigEnvPath

protected String resolveConfigEnvPath(String envPath)

readConfigProps

protected Properties readConfigProps(String propFile)

loadServerLoggingIfNeeds

protected void loadServerLoggingIfNeeds()

go

public void go()

prepareServer

protected void prepareServer()

adjustServer

protected void adjustServer()

setupWebappContext

protected void setupWebappContext()

doSetupWebappContextWar

protected void doSetupWebappContextWar(String warPath)
                                throws javax.servlet.ServletException

例外:

javax.servlet.ServletException

doSetupWebappContextWebappDir

protected void doSetupWebappContextWebappDir()
                                      throws javax.servlet.ServletException

例外:

javax.servlet.ServletException

createTomcat

protected org.apache.catalina.startup.Tomcat createTomcat()

newRhythmicalTomcat

protected RhythmicalTomcat newRhythmicalTomcat(BootLogger bootLogger,
                                               RhythmicalHandlingDef.AnnotationHandling annotationHandling,
                                               RhythmicalHandlingDef.MetaInfoResourceHandling metaInfoResourceHandling,
                                               RhythmicalHandlingDef.TldHandling tldHandling,
                                               Predicate<String> tldFilesSelector,
                                               RhythmicalHandlingDef.WebFragmentsHandling webFragmentsHandling,
                                               Predicate<String> webFragmentsSelector,
                                               AccessLogOption accessLogOption,
                                               YourValveOption yourValveOption,
                                               LikeItCatalinaSetupper likeitCatalinaSetupper)

prepareAnnotationHandling

protected RhythmicalHandlingDef.AnnotationHandling prepareAnnotationHandling()

prepareMetaInfoResourceHandling

protected RhythmicalHandlingDef.MetaInfoResourceHandling prepareMetaInfoResourceHandling()

prepareTldHandling

protected RhythmicalHandlingDef.TldHandling prepareTldHandling()

prepareTldFilesSelector

protected Predicate<String> prepareTldFilesSelector()

prepareuseWebFragmentsHandling

protected RhythmicalHandlingDef.WebFragmentsHandling prepareuseWebFragmentsHandling()

prepareWebFragmentsSelector

protected Predicate<String> prepareWebFragmentsSelector()

prepareAccessLogOption

protected AccessLogOption prepareAccessLogOption()

prepareYourValveOption

protected YourValveOption prepareYourValveOption()

prepareLikeItCatalinaSetupper

protected LikeItCatalinaSetupper prepareLikeItCatalinaSetupper()

await

public void await()

prepareWarPath

protected String prepareWarPath()

prepareWebappPath

protected String prepareWebappPath()

prepareWebXmlPath

protected String prepareWebXmlPath(String webappPath)

deriveWebappDir

protected File deriveWebappDir()

getBasicWebappRelativePath

protected String getBasicWebappRelativePath()

findProjectWebappDir

protected File findProjectWebappDir(String webappRelativePath)

isUnpackWARsDisabled

protected boolean isUnpackWARsDisabled()

disableUnpackWARsOption

protected void disableUnpackWARsOption()

prepareUnpackWARsEnv

protected void prepareUnpackWARsEnv()

cleanPreviousExtractedWarDir

protected void cleanPreviousExtractedWarDir(File appBaseFile)

setupServerConfigIfNeeds

protected void setupServerConfigIfNeeds()

startServer

protected URI startServer()

registerShutdownHook

protected void registerShutdownHook()

prepareMarkFile

protected File prepareMarkFile()

waitForExistingServerShuwdown

protected void waitForExistingServerShuwdown()

buildMarkFilePath

protected String buildMarkFilePath()

getMarkDir

protected String getMarkDir()

needsShutdown

protected boolean needsShutdown(File markFile,
                                long lastModified)

shutdownForcedly

protected void shutdownForcedly()

waitForNextShuwdownHook

protected void waitForNextShuwdownHook()

getShuwdownHookWaitMillis

protected long getShuwdownHookWaitMillis()

browseOnDesktop

protected void browseOnDesktop(URI uri)

close

public void close()

info

protected void info(String msg)

getServer

public org.apache.catalina.startup.Tomcat getServer()