com.boomi.common.rest

Class RestOperationConnection

java.lang.Object

com.boomi.connector.util.BaseConnection<C>

com.boomi.common.rest.RestConnection<OperationContext>

com.boomi.common.rest.RestOperationConnection

Direct Known Subclasses:

OpenAPIOperationConnection

public class RestOperationConnection
extends RestConnection<OperationContext>

Field Summary

Fields inherited from class com.boomi.common.rest.RestConnection

DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
RestOperationConnection(OperationContext context)

Method Summary

Modifier and Type	Method and Description
protected void	addCookiesToStore(org.apache.http.impl.client.BasicCookieStore cookieStore)
protected org.apache.http.client.config.RequestConfig	buildRequestConfig(AuthenticationType authType) Method to populate the RequestConfig to be used in the HttpContext at the time of the request.
protected void	configureCookieScope(org.apache.http.impl.client.HttpClientBuilder builder) Enables or disables cookie management of the given HttpClientBuilder instance based on the value of "Cookie Scope" connection property.
protected boolean	doPreemptiveAuthentication(AuthenticationType type) Returns true / false based off of the AuthenticationType if we want to pre-emptively send authentication information to a service.
protected org.apache.http.auth.Credentials	getAuthenticationCredentials(AuthenticationType authenticationType) Creates the authentication credentials for the request based off of AuthenticationType and connection property values.
protected org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider>	getAuthSchemeProviders() Creates a Default Lookup for Authentication Scheme Providers.
RestClient	getClient() Creates a RestClient for operation execution
org.apache.http.entity.ContentType	getEntityContentType() Returns the expected content type for outbound request data.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient() Returns an instance of CloseableHttpClient using HttpClientBuilder for operation execution.
org.apache.http.protocol.HttpContext	getHttpContext() Creates a HttpContext, if the target AuthenticationType needs credentials, then a credentials provider will be setup for this context.
protected org.apache.http.client.RedirectStrategy	getRedirectStrategy() Returns RedirectStrategy based on the chosen Follow Redirects operation field.
protected org.apache.http.client.HttpRequestRetryHandler	getRetryHandler() Returns a HttpRequestRetryHandler for the getHttpClient()
protected boolean	useSystemProperties() Always returns true for Rest Connector to enable using system properties by default.

Methods inherited from class com.boomi.common.rest.RestConnection

getAPIAuthenticationType, getAuthenticationType, getAWSAccessKey, getAWSRegion, getAWSSecretKey, getAWSService, getConnectionProperty, getConnectTimeout, getCookieScope, getCustomAuthCredentials, getDomain, getHttpMethod, getOAuthContext, getPassword, getPreemptive, getPrivateKeyStore, getPublicKeyStore, getReadTimeout, getUrl, getUsername, getWorkstation, isConnectionPoolingEnabled

Methods inherited from class com.boomi.connector.util.BaseConnection

generateConnectionInfo, generateConnectionInfo, getConnector, getContext, getOperationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RestOperationConnection

public RestOperationConnection(OperationContext context)

Method Detail

getClient

public RestClient getClient()

Creates a RestClient for operation execution

Returns:

the RestClient

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient()

Returns an instance of CloseableHttpClient using HttpClientBuilder for operation execution. This will configure proxy based off of AtomProxyConfig, account/ connection certificates, redirects based off of getRedirectStrategy()}, cookie scope based off of RestConnection.getCookieScope() and authentication based registry.

Returns:

CloseableHttpClient

getAuthSchemeProviders

protected org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider> getAuthSchemeProviders()

Creates a Default Lookup for Authentication Scheme Providers.

Returns:

the AuthSchemeProvider Lookup

getRedirectStrategy

protected org.apache.http.client.RedirectStrategy getRedirectStrategy()

Returns RedirectStrategy based on the chosen Follow Redirects operation field. If none or null redirect is specified on the operation, then the RedirectStrategy is null. if "LAX" is chosen on the operation, then LaxRedirectStrategy will be used. If "STRICT" is chosen on the operation, then the default apache client DefaultRedirectStrategy is used.

Returns:

the RedirectStrategy

configureCookieScope

protected void configureCookieScope(org.apache.http.impl.client.HttpClientBuilder builder)
                             throws IllegalArgumentException

Enables or disables cookie management of the given HttpClientBuilder instance based on the value of "Cookie Scope" connection property. Global cookie store is used when the "Cookie Scope" connection property is set to GLOBAL. In this case, cookies are shared across all the processes. Http Client's default cookie store is used and cookies are isolated to respective connector execution when the "Cookie Scope" connection property is null or missing or set to CONNECTOR_SHAPE. Cookies are disabled when the "Cookie Scope" connection property is set to IGNORED.

Throws:

IllegalArgumentException - if the Cookie Scope property is set with an invalid value.

addCookiesToStore

protected void addCookiesToStore(org.apache.http.impl.client.BasicCookieStore cookieStore)

getHttpContext

public org.apache.http.protocol.HttpContext getHttpContext()

Creates a HttpContext, if the target AuthenticationType needs credentials, then a credentials provider will be setup for this context. In addition, only the selected AuthenticationType scheme will be available during authentication negotiation. If the AuthenticationType allows pre-emptively sending the credentials, then an AuthCache will be created for the context.

Returns:

the Http Client Context

doPreemptiveAuthentication

protected boolean doPreemptiveAuthentication(AuthenticationType type)

Returns true / false based off of the AuthenticationType if we want to pre-emptively send authentication information to a service. BASIC and OAUTH2 is user defined, where as AWS and CUSTOM will always pre-emptively send authentication info. DIGEST will always be false, since it will need service side authentication information before providing the credentials.

Parameters:

type -

Returns:

true when PreemptivelyAuthenticate false otherwise.

getAuthenticationCredentials

protected org.apache.http.auth.Credentials getAuthenticationCredentials(AuthenticationType authenticationType)

Creates the authentication credentials for the request based off of AuthenticationType and connection property values.

Returns:

the authentication Credentials

getEntityContentType

public org.apache.http.entity.ContentType getEntityContentType()

Returns the expected content type for outbound request data.

Returns:

the ContentType

getRetryHandler

protected org.apache.http.client.HttpRequestRetryHandler getRetryHandler()

Returns a HttpRequestRetryHandler for the getHttpClient()

Returns:

the HttpRequestRetryHandler

useSystemProperties

protected boolean useSystemProperties()

Always returns true for Rest Connector to enable using system properties by default. System properties will be taken into account when configuring the default implementations within HttpClientBuilder class.

buildRequestConfig

protected org.apache.http.client.config.RequestConfig buildRequestConfig(AuthenticationType authType)

Method to populate the RequestConfig to be used in the HttpContext at the time of the request. Will set both Connect and Read timeouts if available.

Parameters:

authType - The authenticationType that is used for the request

Returns:

The RequestConfig with Auth schemes and timeouts set