kontent.ai.delivery

Class DeliveryOptions

java.lang.Object

kontent.ai.delivery.DeliveryOptions

public class DeliveryOptions
extends java.lang.Object

Keeps settings which are provided by customer or have default values, used in DeliveryClient.

See Also:

DeliveryClient, Kontent.ai API reference - Authentication, Kontent.ai API reference - Delivery API, Kontent.ai API reference - Secure access, Kontent.ai API reference - Securing public access

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeliveryOptions.DeliveryOptionsBuilder

Constructor Summary

Constructors

Constructor and Description
DeliveryOptions()
DeliveryOptions(java.lang.String projectId) Constructs a setting instance of DeliveryOptions using your Kontent.ai Project identifier.
DeliveryOptions(java.lang.String projectId, java.lang.String previewApiKey) Constructs a settings instance of DeliveryOptions using your Kontent.ai Project identifier and using the preview API.
DeliveryOptions(java.lang.String productionEndpoint, java.lang.String previewEndpoint, java.lang.String projectId, java.lang.String productionApiKey, java.lang.String previewApiKey, boolean usePreviewApi, boolean waitForLoadingNewContent, int retryAttempts, java.net.Proxy proxyServer, java.util.List<Header> customHeaders)

Method Summary

Modifier and Type	Method and Description
static DeliveryOptions.DeliveryOptionsBuilder	builder()
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.util.List<Header>	getCustomHeaders() Include custom request headers.
java.lang.String	getPreviewApiKey() The Preview API key configured with your Kontent.ai account.
java.lang.String	getPreviewEndpoint() The Preview endpoint address.
java.lang.String	getProductionApiKey() The Production API key (Secured access API key) configured with your Kontent.ai account.
java.lang.String	getProductionEndpoint() The Production endpoint address.
java.lang.String	getProjectId() The Project ID associated with your Kontent.ai account.
java.net.Proxy	getProxyServer() Sets the proxy server used by the http client.
int	getRetryAttempts() Sets the number of retry attempts the client should make when a request to the API fails.
int	hashCode()
boolean	isUsePreviewApi() This boolean flag determines if this client will use the preview API instead of the production API.
boolean	isWaitForLoadingNewContent() If the requested content has changed since the last request, the header determines whether to wait while fetching content.
void	setCustomHeaders(java.util.List<Header> customHeaders) Include custom request headers.
void	setPreviewApiKey(java.lang.String previewApiKey) The Preview API key configured with your Kontent.ai account.
void	setPreviewEndpoint(java.lang.String previewEndpoint) The Preview endpoint address.
void	setProductionApiKey(java.lang.String productionApiKey) The Production API key (Secured access API key) configured with your Kontent.ai account.
void	setProductionEndpoint(java.lang.String productionEndpoint) The Production endpoint address.
void	setProjectId(java.lang.String projectId) The Project ID associated with your Kontent.ai account.
void	setProxyServer(java.net.Proxy proxyServer) Sets the proxy server used by the http client.
void	setRetryAttempts(int retryAttempts) Sets the number of retry attempts the client should make when a request to the API fails.
void	setUsePreviewApi(boolean usePreviewApi) This boolean flag determines if this client will use the preview API instead of the production API.
void	setWaitForLoadingNewContent(boolean waitForLoadingNewContent) If the requested content has changed since the last request, the header determines whether to wait while fetching content.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeliveryOptions

public DeliveryOptions(java.lang.String projectId)

Constructs a setting instance of DeliveryOptions using your Kontent.ai Project identifier.

Parameters:

projectId - The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

DeliveryOptions

public DeliveryOptions(java.lang.String projectId,
                       java.lang.String previewApiKey)

Constructs a settings instance of DeliveryOptions using your Kontent.ai Project identifier and using the preview API.

Parameters:

projectId - The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

previewApiKey - The Preview API key configured with your Kontent.ai account.

DeliveryOptions

public DeliveryOptions()

DeliveryOptions

public DeliveryOptions(java.lang.String productionEndpoint,
                       java.lang.String previewEndpoint,
                       java.lang.String projectId,
                       java.lang.String productionApiKey,
                       java.lang.String previewApiKey,
                       boolean usePreviewApi,
                       boolean waitForLoadingNewContent,
                       int retryAttempts,
                       java.net.Proxy proxyServer,
                       java.util.List<Header> customHeaders)

Method Detail

setPreviewApiKey

public void setPreviewApiKey(java.lang.String previewApiKey)

The Preview API key configured with your Kontent.ai account.

Parameters:

previewApiKey - Sets the value of the preview API key in this DeliveryOptions instance. If not null, automatically sets setUsePreviewApi(boolean) to 'true'.

See Also:

Kontent.ai API reference - Production vs. preview, Kontent.ai API reference - Authentication

builder

public static DeliveryOptions.DeliveryOptionsBuilder builder()

getProductionEndpoint

public java.lang.String getProductionEndpoint()

The Production endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://deliver.kontent.ai"

Returns:

The value of the pstring used as the production endpoint to Kontent.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

getPreviewEndpoint

public java.lang.String getPreviewEndpoint()

The Preview endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://assets-us-01.kc-usercontent.com/"

Returns:

The value of the string used as the preview endpoint to Kontent.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

getProjectId

public java.lang.String getProjectId()

The Project ID associated with your Kontent.ai account. Must be in the format of an UUID. UUID.

Returns:

The Project identifier set in this DeliveryOptions instance.

See Also:

Kontent.ai API reference - Delivery API

getProductionApiKey

public java.lang.String getProductionApiKey()

The Production API key (Secured access API key) configured with your Kontent.ai account.

Returns:

The value of the production API key in this DeliveryOptions instance.

See Also:

Kontent.ai API reference - Production vs. preview, Secure access

getPreviewApiKey

public java.lang.String getPreviewApiKey()

The Preview API key configured with your Kontent.ai account.

Returns:

The value of the preview API key in this DeliveryOptions instance.

See Also:

Kontent.ai API reference - Production vs. preview, Kontent.ai API reference - Authentication

isUsePreviewApi

public boolean isUsePreviewApi()

This boolean flag determines if this client will use the preview API instead of the production API. Defaults to 'false'.

Returns:

Whether this DeliveryOptions instance is set to use the preview API instead of the production API.

See Also:

Kontent.ai API reference - Production vs. preview

isWaitForLoadingNewContent

public boolean isWaitForLoadingNewContent()

If the requested content has changed since the last request, the header determines whether to wait while fetching content. This can be useful when retrieving changed content in reaction to a webhook call. By default, when set to false, the API serves old content (if cached by the CDN) while it's fetching the new content to minimize wait time. To always fetch new content, set the header to true.

Returns:

Whether this DeliveryOptions instance is set to always fetch new content.

getRetryAttempts

public int getRetryAttempts()

Sets the number of retry attempts the client should make when a request to the API fails. Defaults to 3, meaning 1 normal request + 3 retrials.

Returns:

The number of retry attempts configured per request in this DeliveryOptions instance.

getProxyServer

public java.net.Proxy getProxyServer()

Sets the proxy server used by the http client. See Proxy.

Returns:

The ProxyServer configured for this instance, or null.

getCustomHeaders

public java.util.List<Header> getCustomHeaders()

Include custom request headers. Headers with name DeliveryClient.HEADER_ACCEPT, DeliveryClient.HEADER_AUTHORIZATION, DeliveryClient.HEADER_X_KC_SDK_ID, DeliveryClient.HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT will be ignored.

setProductionEndpoint

public void setProductionEndpoint(java.lang.String productionEndpoint)

The Production endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://deliver.kontent.ai"

Parameters:

productionEndpoint - New value for the productionEndpoint in this DeliveryOptions instance. Kontent.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

setPreviewEndpoint

public void setPreviewEndpoint(java.lang.String previewEndpoint)

The Preview endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://assets-us-01.kc-usercontent.com/"

Parameters:

previewEndpoint - New value for the productionEndpoint in this DeliveryOptions instance.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

setProjectId

public void setProjectId(java.lang.String projectId)

The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

Parameters:

projectId - The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

See Also:

Kontent.ai API reference - Delivery API

setProductionApiKey

public void setProductionApiKey(java.lang.String productionApiKey)

The Production API key (Secured access API key) configured with your Kontent.ai account.

Parameters:

productionApiKey - Sets the value of the production API key (Secured access API key) in this DeliveryOptions instance.

See Also:

Kontent.ai API reference - Production vs. preview, Secure access

setUsePreviewApi

public void setUsePreviewApi(boolean usePreviewApi)

This boolean flag determines if this client will use the preview API instead of the production API. Defaults to 'false'.

Parameters:

usePreviewApi - Whether the preview API should be used instead of the production API. Defaults to 'false'. production API.

See Also:

Kontent.ai API reference - Production vs. preview

setWaitForLoadingNewContent

public void setWaitForLoadingNewContent(boolean waitForLoadingNewContent)

If the requested content has changed since the last request, the header determines whether to wait while fetching content. This can be useful when retrieving changed content in reaction to a webhook call. By default, when set to false, the API serves old content (if cached by the CDN) while it's fetching the new content to minimize wait time. To always fetch new content, set the header to true.

Parameters:

waitForLoadingNewContent - New value for this DeliveryOptions instance.

setRetryAttempts

public void setRetryAttempts(int retryAttempts)

Sets the number of retry attempts the client should make when a request to the API fails. Defaults to 3, meaning 1 normal request + 3 retrials.

Parameters:

retryAttempts - New value for this DeliveryOptions instance.

setProxyServer

public void setProxyServer(java.net.Proxy proxyServer)

Sets the proxy server used by the http client. See Proxy.

Parameters:

proxyServer - The Proxy instance to use with the client each request.

setCustomHeaders

public void setCustomHeaders(java.util.List<Header> customHeaders)

Include custom request headers. Headers with name DeliveryClient.HEADER_ACCEPT, DeliveryClient.HEADER_AUTHORIZATION, DeliveryClient.HEADER_X_KC_SDK_ID, DeliveryClient.HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT will be ignored.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object