Class AbstractJavaTool<Request extends JavaToolRequest>
java.lang.Object
org.codehaus.plexus.logging.AbstractLogEnabled
org.apache.maven.shared.utils.cli.javatool.AbstractJavaTool<Request>
- Type Parameters:
Request
- Tool-specific request type
- All Implemented Interfaces:
JavaTool<Request>
,org.codehaus.plexus.logging.LogEnabled
public abstract class AbstractJavaTool<Request extends JavaToolRequest>
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements JavaTool<Request>
Abstract implementation of a
JavaTool
.- Since:
- 0.5
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract Commandline
createCommandLine
(Request request, String javaToolFileLocation) Create the command line object given the request.protected JavaToolResult
protected StreamConsumer
createSystemErrorStreamConsumer
(Request request) protected InputStream
protected StreamConsumer
createSystemOutStreamConsumer
(Request request) Execute the input request and then returns the result of the execution.protected JavaToolResult
executeCommandLine
(Commandline cli, Request request) private String
findExecutable
(String command, String homeDir, String... subDirs) Finds the specified command in any of the given sub directories of the specified JDK/JRE home directory.protected String
private String
Run toolchain.findTool( javaToolName ); through reflection to avoid compile dependency on Maven core.Return the name of the java tool.void
setToolchain
(Object toolchain) Set an optional tool chain to find out the java tool executable location.Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Field Details
-
javaToolName
The java tool name to find out in the jdk. -
javaToolFile
The location of the java tool executable file. -
toolchain
Optional toolChain used to find java tool executable file.
-
-
Constructor Details
-
AbstractJavaTool
- Parameters:
javaToolName
- The name of the java tool.
-
-
Method Details
-
createCommandLine
protected abstract Commandline createCommandLine(Request request, String javaToolFileLocation) throws JavaToolException Create the command line object given the request.- Parameters:
request
- User request on the java tooljavaToolFileLocation
- Location of the java tool file to use- Returns:
- the command line
- Throws:
JavaToolException
- if could not create the command line from the request
-
getJavaToolName
Return the name of the java tool. This is exactly the name (without his extension) of the executable to find in the
jdk/bin
directory.For example:
jarsigner, keytool, javadoc, ...
- Specified by:
getJavaToolName
in interfaceJavaTool<Request extends JavaToolRequest>
- Returns:
- the name of the java tool.
-
setToolchain
Set an optional tool chain to find out the java tool executable location.- Specified by:
setToolchain
in interfaceJavaTool<Request extends JavaToolRequest>
- Parameters:
toolchain
- optional tool chain to find out the java tool executable location. To avoid direct dependency on Maven core, this parameter is an Object that will be used as Toolchain through reflection
-
execute
Execute the input request and then returns the result of the execution.
If could not create the java tool invocation, a
JavaToolException
will be thrown.If execution fails, then the result will have a none-zero
JavaToolResult.getExitCode()
and hisJavaToolResult.getExecutionException()
will be filled with the error, otherwise the exist code will be zero.- Specified by:
execute
in interfaceJavaTool<Request extends JavaToolRequest>
- Parameters:
request
- the request to perform- Returns:
- the result of the tool execution
- Throws:
JavaToolException
- if could not create the java tool invocation
-
createSystemInputStream
- Returns:
InputStream
-
createSystemErrorStreamConsumer
- Parameters:
request
- The request.- Returns:
StreamConsumer
-
createSystemOutStreamConsumer
- Parameters:
request
- The request.- Returns:
StreamConsumer
-
createResult
- Returns:
- The JavaToolResult.
-
findJavaToolExecutable
- Returns:
- The location of the java tool executable.
-
findToolchainExecutable
Run toolchain.findTool( javaToolName ); through reflection to avoid compile dependency on Maven core. -
findExecutable
Finds the specified command in any of the given sub directories of the specified JDK/JRE home directory.- Parameters:
command
- The command to find, must not benull
.homeDir
- The home directory to search in, may benull
.subDirs
- The sub directories of the home directory to search in, must not benull
.- Returns:
- The (absolute) path to the command if found,
null
otherwise.
-