Class BasicKeystoreKeyStrategyTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
net.shibboleth.idp.installer.ant.impl.BasicKeystoreKeyStrategyTask
All Implemented Interfaces:
Cloneable

public class BasicKeystoreKeyStrategyTask extends org.apache.tools.ant.Task
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description

    Fields inherited from class org.apache.tools.ant.Task

    target, taskName, taskType, wrapper

    Fields inherited from class org.apache.tools.ant.ProjectComponent

    description, location, project
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    void
    Set the encryption key alias base name.
    void
    setKeyCount(int count)
    Set the number of keys to maintain.
    void
    setKeySize(int size)
    Set the size of the generated key.
    void
    Set the keystore file to create or modify.
    void
    Set the password for the keystore.
    void
    Set the type of keystore to create.
    void
    Set the type of key that will be generated.
    void
    Set the key versioning file to create or modify.

    Methods inherited from class org.apache.tools.ant.Task

    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

    Methods inherited from class org.apache.tools.ant.ProjectComponent

    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • BasicKeystoreKeyStrategyTask

      public BasicKeystoreKeyStrategyTask()
      Constructor.
  • Method Details

    • setKeyType

      public void setKeyType(@Nonnull @NotEmpty String type)
      Set the type of key that will be generated. Defaults to AES.
      Parameters:
      type - type of key that will be generated
    • setKeySize

      public void setKeySize(@Positive int size)
      Set the size of the generated key. Defaults to 128
      Parameters:
      size - size of the generated key
    • setKeyAlias

      public void setKeyAlias(@Nonnull @NotEmpty String alias)
      Set the encryption key alias base name.
      Parameters:
      alias - the encryption key alias base
    • setKeyCount

      public void setKeyCount(@Positive int count)
      Set the number of keys to maintain. Defaults to 3.
      Parameters:
      count - number of keys to maintain
    • setKeystoreType

      public void setKeystoreType(@Nonnull @NotEmpty String type)
      Set the type of keystore to create. Defaults to JCEKS.
      Parameters:
      type - keystore type
    • setKeystoreFile

      public void setKeystoreFile(@Nonnull File file)
      Set the keystore file to create or modify.
      Parameters:
      file - keystore file
    • setKeystorePassword

      public void setKeystorePassword(@Nullable String password)
      Set the password for the keystore.
      Parameters:
      password - password for the keystore
    • setVersionFile

      public void setVersionFile(@Nonnull File file)
      Set the key versioning file to create or modify.
      Parameters:
      file - key versioning file
    • execute

      public void execute()
      Overrides:
      execute in class org.apache.tools.ant.Task