Package com.veeva.vault.sdk.api.connection

Enum Class ConnectionUser

java.lang.Object

java.lang.Enum<ConnectionUser>

com.veeva.vault.sdk.api.connection.ConnectionUser

All Implemented Interfaces:

Serializable, Comparable<ConnectionUser>, Constable

public enum ConnectionUser
extends Enum<ConnectionUser>

Valid users to establish a connection to at least one Vault.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTION_AUTHORIZED_USER	Authorized user defined in the connection record.
INITIATING_USER	Indicates the user that initiated the request.
REQUEST_OWNER	Indicates the owner of the sdk request.
SDK_CURRENT_USER	Deprecated. as of 22R3.4, replaced by REQUEST_OWNER and INITIATING_USER.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUEST_OWNER

public static final ConnectionUser REQUEST_OWNER

Indicates the owner of the sdk request. This is usually the same as the INITIATING_USER, but it can be different in some cases like workflow. The user id associated with this type can change during a request.

INITIATING_USER

public static final ConnectionUser INITIATING_USER

Indicates the user that initiated the request. This can be a Vault User (user at keyboard) or the System. The user id associated with this type will never change during a request.

SDK_CURRENT_USER

@Deprecated
public static final ConnectionUser SDK_CURRENT_USER

Deprecated.

as of 22R3.4, replaced by REQUEST_OWNER and INITIATING_USER.

Current user used in Vault Java SDK code.

CONNECTION_AUTHORIZED_USER

public static final ConnectionUser CONNECTION_AUTHORIZED_USER

Authorized user defined in the connection record.

Method Details

values

public static ConnectionUser[] 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 ConnectionUser 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