Module vault.java.driver
Package io.github.jopenlibs.vault.api.database

Class DatabaseRoleOptions

java.lang.Object
io.github.jopenlibs.vault.api.database.DatabaseRoleOptions
public class DatabaseRoleOptions extends Object

  • Constructor Details

    • DatabaseRoleOptions

      public DatabaseRoleOptions()

  • Method Details

    • getName

      public String getName()

    • getDbName

      public String getDbName()

    • getDefaultTtl

      public String getDefaultTtl()

    • getMaxTtl

      public String getMaxTtl()

    • getCreationStatements

      public List<String> getCreationStatements()

    • getRenewStatements

      public List<String> getRenewStatements()

    • getRevocationStatements

      public List<String> getRevocationStatements()

    • getRollbackStatements

      public List<String> getRollbackStatements()

    • name

      public DatabaseRoleOptions name(String name)
      Parameters:
      name - String – Specifies the name of the role to create. This is specified as part of the URL.
      Returns:
      This object, with name populated, ready for other builder methods or immediate use.

    • dbName

      public DatabaseRoleOptions dbName(String dbName)
      Parameters:
      dbName - String - The name of the database connection to use for this role.
      Returns:
      This object, with dbName populated, ready for other builder methods or immediate use.

    • defaultTtl

      public DatabaseRoleOptions defaultTtl(String defaultTtl)
      Parameters:
      defaultTtl - (string/int: 0) - Specifies the TTL for the leases associated with this role. Accepts time suffixed strings ("1h") or an integer number of seconds. Defaults to system/engine default TTL time.
      Returns:
      This object, with defaultTtl populated, ready for other builder methods or immediate use.

    • maxTtl

      public DatabaseRoleOptions maxTtl(String maxTtl)
      Parameters:
      maxTtl - (string/int: 0) - Specifies the maximum TTL for the leases associated with this role. Accepts time suffixed strings ("1h") or an integer number of seconds. Defaults to system/mount default TTL time; this value is allowed to be less than the mount max TTL (or, if not set, the system max TTL), but it is not allowed to be longer. See also The TTL General Case.
      Returns:
      This object, with maxTtl populated, ready for other builder methods or immediate use.

    • creationStatements

      public DatabaseRoleOptions creationStatements(List<String> creationStatements)
      Parameters:
      creationStatements - List<String> – Specifies the database statements executed to create and configure a user. See the plugin's API page for more information on support and formatting for this parameter.
      Returns:
      This object, with creationStatements populated, ready for other builder methods or immediate use.

    • revocationStatements

      public DatabaseRoleOptions revocationStatements(List<String> revocationStatements)
      Parameters:
      revocationStatements - (list: []) – Specifies the database statements to be executed to revoke a user. See the plugin's API page for more information on support and formatting for this parameter.
      Returns:
      This object, with revocationStatements populated, ready for other builder methods or immediate use.

    • rollbackStatements

      public DatabaseRoleOptions rollbackStatements(List<String> rollbackStatements)
      Parameters:
      rollbackStatements - (list: []) – Specifies the database statements to be executed rollback a create operation in the event of an error. Not every plugin type will support this functionality. See the plugin's API page for more information on support and formatting for this parameter.
      Returns:
      This object, with rollbackStatements populated, ready for other builder methods or immediate use.

    • renewStatements

      public DatabaseRoleOptions renewStatements(List<String> renewStatements)
      Parameters:
      renewStatements - (list: []) – Specifies the database statements to be executed to renew a user. Not every plugin type will support this functionality. See the plugin's API page for more information on support and formatting for this parameter.
      Returns:
      This object, with renewStatements populated, ready for other builder methods or immediate use.