AGConnProp (agraph-java-client 5.0.4-SNAPSHOT API)
Description: declaration: package: com.franz.agraph.pool, enum: AGConnProp

Package com.franz.agraph.pool

# Enum Class AGConnProp

java.lang.Object
java.lang.Enum<AGConnProp>
com.franz.agraph.pool.AGConnProp

All Implemented Interfaces:
  `Serializable`, `Comparable<AGConnProp>`, `Constable`

public enum AGConnProp extends Enum<AGConnProp>
Property names to open a `AGRepositoryConnection`.

TODO: `AGRepositoryConnection.setSessionLoadInitFile(boolean)`

TODO: `AGRepositoryConnection.addSessionLoadScript(String)`

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static enum`
  `AGConnProp.Session`
  Property values for `session`.

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `catalog`
  Catalog name - "/" or no value for `AGServer.getRootCatalog()`.
  `httpSocketTimeout`
  Socket timeout (SO_TIMEOUT) in milliseconds to be used when executing the method.
  `password`
  `repository`
  `serverUrl`
  `session`
  Value must be one of `AGConnProp.Session`.
  `sessionLifetime`
  Sets the 'lifetime' (in seconds) for a dedicated session.
  `username`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static AGConnProp`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static AGConnProp[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### serverUrl

    public static final AGConnProp serverUrl
    See Also:
      - `AGServer(String, String, String)`

  - ### username

    public static final AGConnProp username
    See Also:
      - `AGServer(String, String, String)`

  - ### password

    public static final AGConnProp password
    See Also:
      - `AGServer(String, String, String)`

  - ### catalog

    public static final AGConnProp catalog
    Catalog name - "/" or no value for `AGServer.getRootCatalog()`.
    See Also:
      - `AGServer.getCatalog(String)`

  - ### repository

    public static final AGConnProp repository
    See Also:
      - `AGCatalog.openRepository(String)`

  - ### session

    public static final AGConnProp session
    Value must be one of `AGConnProp.Session`.

  - ### sessionLifetime

    public static final AGConnProp sessionLifetime
    Sets the 'lifetime' (in seconds) for a dedicated session. Seconds a session can be idle before being collected.
    See Also:
      - `AGRepositoryConnection.setSessionLifetime(int)`

  - ### httpSocketTimeout

    public static final AGConnProp httpSocketTimeout
    Socket timeout (SO_TIMEOUT) in milliseconds to be used when executing the method. A timeout value of zero is interpreted as an infinite timeout.

    WARNING: this may break long queries.

    Since:
      v4.4
    See Also:
      - `SocketConfig.getSoTimeout()`

- ## Method Details

  - ### values

    public static AGConnProp[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static AGConnProp valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
    Parameters:
      `name` - the name of the enum constant to be returned.
    Returns:
      the enum constant with the specified name
    Throws:
      `IllegalArgumentException` - if this enum class has no constant with the specified name
      `NullPointerException` - if the argument is null