Package org.filestack

Class Config

java.lang.Object

org.filestack.Config

All Implemented Interfaces:

Serializable

public class Config
extends Object
implements Serializable

Holds config common to Client, FileLink, and Transform classes.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	apiKey
protected final String	policy
protected final String	returnUrl
protected final String	signature

Constructor Summary

Constructors

Constructor	Description
Config(String apiKey)	Constructs basic configuration for Client class without any security policy.
Config(String apiKey, String returnUrl)	Deprecated. use Config(String) instead and manually pass returnUrl to CloudServiceUtil.buildBaseJson(Config, String, String) if necessary
Config(String apiKey, String encodedPolicy, String signature)	Constructs configuration for Client class.
Config(String apiKey, String returnUrl, String encodedPolicy, String signature)	Deprecated. use Config(String, String, String) instead and manually pass returnUrl to CloudServiceUtil.buildBaseJson(Config, String, String) if necessary
Config(String apiKey, Policy policy)	Constructs configuration for Client class.

Method Summary

Modifier and Type	Method	Description
String	getApiKey()
String	getPolicy()
String	getReturnUrl()	Deprecated.
String	getSignature()
boolean	hasSecurity()

Methods inherited from class java.lang.Object

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

Field Details

apiKey

protected final String apiKey

policy

protected final String policy

signature

protected final String signature

returnUrl

protected final String returnUrl

Constructor Details

Config

public Config(String apiKey,
 Policy policy)

Constructs configuration for Client class.

Parameters:

apiKey - - an API key obtained from the Developer Portal

policy - - access policy, one can be created with Policy.Builder

Config

public Config(String apiKey)

Constructs basic configuration for Client class without any security policy.

Parameters:

apiKey - - an API key obtained from the Developer Portal

Config

@Deprecated
public Config(String apiKey,
 @Nullable
 String returnUrl)

Deprecated.

use Config(String) instead and manually pass returnUrl to CloudServiceUtil.buildBaseJson(Config, String, String) if necessary

Constructs basic configuration for Client class without any security policy.

Parameters:

apiKey - - an API key obtained from the Developer Portal

returnUrl - - returnUrl used for building JSON bodies with CloudServiceUtil

Config

public Config(String apiKey,
 @Nullable
 String encodedPolicy,
 @Nullable
 String signature)

Constructs configuration for Client class.

Parameters:

apiKey - - an API key obtained from the Developer Portal

encodedPolicy - - encoded policy, obtain one using Policy.getEncodedPolicy()

signature - - policy signature, obtain one using Policy.getSignature()

Config

@Deprecated
public Config(String apiKey,
 @Nullable
 String returnUrl,
 @Nullable
 String encodedPolicy,
 @Nullable
 String signature)

Deprecated.

use Config(String, String, String) instead and manually pass returnUrl to CloudServiceUtil.buildBaseJson(Config, String, String) if necessary

Constructs configuration for Client class.

Parameters:

apiKey - - an API key obtained from the Developer Portal

returnUrl - - returnUrl used for building JSON bodies with CloudServiceUtil

encodedPolicy - - encoded policy, obtain one using Policy.getEncodedPolicy()

signature - - policy signature, obtain one using Policy.getSignature()

Method Details

getApiKey

public String getApiKey()

getReturnUrl

@Deprecated
public String getReturnUrl()

Deprecated.

hasSecurity

public boolean hasSecurity()

getPolicy

public String getPolicy()

getSignature

public String getSignature()