com.adobe.platform.operation

Class ClientContext

java.lang.Object

com.adobe.platform.operation.ClientContext

public class ClientContext
extends Object

Represents the execution context of an Operation. An execution context typically consists of the desired authentication credentials and client configurations such as timeouts. Currently, it is set up using a JSON config file which is received as part of DC Services SDK On-boarding.

For each set of authentication credentials, a ClientContext instance can be reused across operations.

Sample Usage:

    ClientContext context = ClientContext.createFromFile("dc-services-sdk-config.json");
    CreatePDFOperation cpdfOperation = CreatePDFOperation.createNew();
    cpdfOperation.setInput(FileRef.createFromLocalFile("~/Documents/createPdfInput.docx"));
    cpdfOperation.execute(context);
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientContext()

Method Summary

Modifier and Type	Method and Description
static ClientContext	createFromFile(String filePath) Creates a context instance using the provided JSON config file path.
ClientContext	withAuthentication(Authentication authentication) Creates a copy of this ClientContext with the provided Authentication instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientContext

protected ClientContext()

Method Detail

createFromFile

public static ClientContext createFromFile(String filePath)
                                    throws IOException

Creates a context instance using the provided JSON config file path.

Returns:

a new ClientContext instance

Throws:

FileNotFoundException - if the config file is not found at the specified path

IOException - if an I/O error occurs while reading the config file

withAuthentication

public ClientContext withAuthentication(Authentication authentication)

Creates a copy of this ClientContext with the provided Authentication instance. This can be used to provide the authentication credentials at runtime, without storing them in a config file.

Parameters:

authentication - - an Authentication instance

Returns:

a new ClientContext instance