Constructor Detail

• AbstractJavaTool

  protected AbstractJavaTool(String javaToolName)

Method Detail

• createCommandLine

  protected abstract Commandline createCommandLine(Request request,
                              String javaToolFile)
                                            throws JavaToolException

  Create the commandline object given the request.

  Parameters:

  request - User request on the java tool

  javaToolFile - Location of the java tool file to use

  Returns:

  the commandline

  Throws:

  JavaToolException - if could not create the command line from the request

• getJavaToolName

  public String 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 interface JavaTool<Request extends JavaToolRequest>

  Returns:

  the name of the java tool.

• setToolchain

  public void setToolchain(org.apache.maven.toolchain.Toolchain toolchain)

  Set an optional tool chain to find out the java tool executable location.

  Specified by:

  setToolchain in interface JavaTool<Request extends JavaToolRequest>

  Parameters:

  toolchain - optional tool chain to find out the java tool executable location.

• execute

  public JavaToolResult execute(Request request)
                         throws JavaToolException

  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 his JavaToolResult.getExecutionException() will be filled with the error, otherwise the exist code will be zero.

  Specified by:

  execute in interface JavaTool<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

  protected InputStream createSystemInputStream()

• executeCommandLine

  protected JavaToolResult executeCommandLine(Commandline cli,
                                  Request request)

• createSystemErrorStreamConsumer

  protected StreamConsumer createSystemErrorStreamConsumer(Request request)

• createSystemOutStreamConsumer

  protected StreamConsumer createSystemOutStreamConsumer(Request request)

• createResult

  protected JavaToolResult createResult()

• findJavaToolExecutable

  protected String findJavaToolExecutable()