com.veeva.vault.sdk.api.connection

Interface ConnectionService

All Superinterfaces:

Service

public interface ConnectionService
extends Service

Provides methods to build a new connection context for use with DocumentService.

Method Summary

Modifier and Type	Method and Description
boolean	isLocalConnectionContextAllowed(RequestContextUserType requestContextUserType) Indicates whether local access is available for the provided RequestContextUserType.
ConnectionContext	newConnectionContext(String connectionApiName, ConnectionUser connectionUser) Initializes the ConnectionContext for a given connectionApiName and connectionUser.
ConnectionContext	newLocalConnectionContext() Deprecated. as of 22R3.4, replaced by newLocalConnectionContext(RequestContextUserType).
ConnectionContext	newLocalConnectionContext(RequestContextUserType requestContextUserType) Initializes a local ConnectionContext for the local Vault and for the user type specified by the requestContextUserType.

Method Detail

newConnectionContext

ConnectionContext newConnectionContext(String connectionApiName,
                                       ConnectionUser connectionUser)

Initializes the ConnectionContext for a given connectionApiName and connectionUser.

Parameters:

connectionApiName - api name of a connection

connectionUser - connection user

Returns:

ConnectionContext

isLocalConnectionContextAllowed

boolean isLocalConnectionContextAllowed(RequestContextUserType requestContextUserType)

Indicates whether local access is available for the provided RequestContextUserType. If true, the user type can create local connections.

Parameters:

requestContextUserType - the user type to check access for

Returns:

true if local access is available for the provided user type

newLocalConnectionContext

ConnectionContext newLocalConnectionContext(RequestContextUserType requestContextUserType)

Initializes a local ConnectionContext for the local Vault and for the user type specified by the requestContextUserType. This method is not supported for operations initiated by the System. Use this method in cases where a full connection record is not required. If it is unclear whether the local connection will succeed for the provided user type, call the isLocalConnectionContextAllowed(RequestContextUserType) method prior to calling this method.

Parameters:

requestContextUserType - the user type establishing the connection

Returns:

ConnectionContext

newLocalConnectionContext

@Deprecated
ConnectionContext newLocalConnectionContext()

Deprecated. as of 22R3.4, replaced by newLocalConnectionContext(RequestContextUserType).

Initializes a local ConnectionContext for the local Vault and for the originating user. This method is not supported for operations initiated by the System. Use this method in cases where a full connection record is not required.

Returns:

ConnectionContext