Package org.apache.maven.api.cli.mvnenc

Interface EncryptInvoker

All Superinterfaces:
AutoCloseable, Invoker<EncryptInvokerRequest>
All Known Implementing Classes:
DefaultEncryptInvoker
@Experimental public interface EncryptInvoker extends Invoker<EncryptInvokerRequest>
Defines the contract for a component responsible for invoking the Maven encryption tool. This interface extends the general Invoker interface, specializing it for encryption-related operations.

The EncryptInvoker is designed to handle encryption tasks within the Maven ecosystem, such as encrypting passwords or other sensitive information in Maven settings files.

Since:
4.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    invoke(EncryptInvokerRequest invokerRequest)
    Invokes the encryption tool using the provided EncryptInvokerRequest.

    Methods inherited from interface org.apache.maven.api.cli.Invoker

    close

  • Method Details

    • invoke

      int invoke(EncryptInvokerRequest invokerRequest) throws InvokerException
      Invokes the encryption tool using the provided EncryptInvokerRequest. This method is responsible for executing the encryption command or process based on the information contained in the request.
      Specified by:
      invoke in interface Invoker<EncryptInvokerRequest>
      Parameters:
      invokerRequest - the request containing all necessary information for the encryption invocation
      Returns:
      an integer representing the exit code of the invocation (0 typically indicates success)
      Throws:
      InvokerException - if an error occurs during the encryption process