com.boomi.connector.api

Interface AtomConfig

All Known Implementing Classes:

SimpleAtomConfig

public interface AtomConfig

Atom configuration information which may be of use to a Connector. Most of these values are enforced by the Atom in the relevant context.

Method Summary

Modifier and Type	Method and Description
Boolean	getBooleanContainerProperty(String key) Gets the property value for the given key as a Boolean.
boolean	getBooleanContainerProperty(String key, boolean defaultValue) Gets the property value for the given key as a boolean, returning the defaultValue if the located property value null.
String	getContainerProperty(String key) Gets the property value for the given key as a String.
String	getContainerProperty(String key, String defaultValue) Gets the property value for the given key as a String., returning the defaultValue if the located property value is blank (null or all characters are whitespace).
Level	getLogLevel() The current log level for the Atom.
Long	getLongContainerProperty(String key) Gets the property value for the given key as a Long.
long	getLongContainerProperty(String key, long defaultValue) Gets the property value for the given key as a Long, returning the defaultValue if the located property value null.
int	getMaxNumberObjectTypes() Returns the maximum number of object types allowed to be returned from a browse request.
int	getMaxObjectTypeCookieLength() Returns the maximum number of characters allowed in an ObjectType cookie.
int	getMaxPageSize() Returns the maximum page size recommended by the Atom.
AtomProxyConfig	getProxyConfig() Returns ProxyConfig object with access to Atom proxy properties such as proxyHost, proxyPort etc.

Method Detail

getContainerProperty

String getContainerProperty(String key)

Gets the property value for the given key as a String.

Parameters:

key - key of the desired property

Returns:

String property value or null if not found.

getContainerProperty

String getContainerProperty(String key,
                            String defaultValue)

Gets the property value for the given key as a String., returning the defaultValue if the located property value is blank (null or all characters are whitespace).

Parameters:

key - key of the desired property

defaultValue - value to return if property value is blank

Returns:

String property value or defaultValue if not found.

getBooleanContainerProperty

Boolean getBooleanContainerProperty(String key)

Gets the property value for the given key as a Boolean.

Parameters:

key - key of the desired property

Returns:

Boolean property value or null if not found or isn't "true" or "false".

getBooleanContainerProperty

boolean getBooleanContainerProperty(String key,
                                    boolean defaultValue)

Gets the property value for the given key as a boolean, returning the defaultValue if the located property value null.

Parameters:

key - key of the desired property

defaultValue - value to return if property value is null

Returns:

boolean property value or defaultValue if not found.

getLongContainerProperty

Long getLongContainerProperty(String key)

Gets the property value for the given key as a Long.

Parameters:

key - key of the desired property

Returns:

Long property value or null if not found.

Throws:

NumberFormatException - If the string cannot be parsed as a long.

Example:

     Container property : com.boomi.container.exampleKey->TestValue123
     getLongContainerProperty("com.boomi.container.exampleKey") throws a NumberFormatException
             

getLongContainerProperty

long getLongContainerProperty(String key,
                              long defaultValue)

Gets the property value for the given key as a Long, returning the defaultValue if the located property value null.

Parameters:

key - key of the desired property

defaultValue - value to return if property value is null

Returns:

Long property value or defaultValue if not found.

getProxyConfig

AtomProxyConfig getProxyConfig()

Returns ProxyConfig object with access to Atom proxy properties such as proxyHost, proxyPort etc.

Returns:

Proxy configuration properties set on an Atom.

getMaxPageSize

int getMaxPageSize()

Returns the maximum page size recommended by the Atom. Connector implementations should use this value along with any internal limits to determine a reasonable page size when working with pageable results.

Returns:

the maximum page size that the atom recommends

getMaxNumberObjectTypes

int getMaxNumberObjectTypes()

Returns the maximum number of object types allowed to be returned from a browse request. More than this number of object types will be considered an error by the Atom and will fail the browsing process.

Returns:

the maximum number of object types allowed

getMaxObjectTypeCookieLength

int getMaxObjectTypeCookieLength()

Returns the maximum number of characters allowed in an ObjectType cookie. Cookies which are longer than this value will be considered an error by the Atom and will fail the browsing process.

Returns:

the maximum number of characters allowed in an ObjectDefinition cookie.

getLogLevel

Level getLogLevel()

The current log level for the Atom.