ai.olami.cloudService

Class APIConfiguration

java.lang.Object

ai.olami.cloudService.APIConfiguration

public class APIConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_BASE_URL
protected static String	API_DOMAIN_NAME_CN
protected static String	API_DOMAIN_NAME_TW
static String	API_NAME_ASR
static String	API_NAME_NLI
static String	API_NAME_SEG
static int	LOCALIZE_OPTION_SIMPLIFIED_CHINESE
static int	LOCALIZE_OPTION_TRADITIONAL_CHINESE

Constructor Summary

Constructors

Constructor and Description
APIConfiguration(String appKey, String appSecret, int localizeOption) Configure to issue OLAMI HTTP API requests.

Method Summary

Modifier and Type	Method and Description
protected void	generateSignature(String apiName)
String	getAppKey()
String	getAppSecret()
String	getBaseRequestURL(String apiName) Get the base API end point URL for the given API name.
String	getBaseRequestURL(String apiName, Map<String,String> queryParams) Get the base API end point URL for the given API name.
int	getLocalizeOption()
String	getSdkType()
String	getSignature(String apiName) Get the signature by the given API name and the generated timestamp.
long	getTimestamp(String apiName) Get the generated timestamp value by the given API name.
protected void	initLocalization(int localizeOption)
void	setApiServerDomain(String domain) Not recommended for use.
void	setSdkType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALIZE_OPTION_SIMPLIFIED_CHINESE

public static final int LOCALIZE_OPTION_SIMPLIFIED_CHINESE

See Also:

Constant Field Values

LOCALIZE_OPTION_TRADITIONAL_CHINESE

public static final int LOCALIZE_OPTION_TRADITIONAL_CHINESE

See Also:

Constant Field Values

API_NAME_SEG

public static final String API_NAME_SEG

See Also:

Constant Field Values

API_NAME_NLI

public static final String API_NAME_NLI

See Also:

Constant Field Values

API_NAME_ASR

public static final String API_NAME_ASR

See Also:

Constant Field Values

API_DOMAIN_NAME_CN

protected static final String API_DOMAIN_NAME_CN

See Also:

Constant Field Values

API_DOMAIN_NAME_TW

protected static final String API_DOMAIN_NAME_TW

See Also:

Constant Field Values

API_BASE_URL

protected static final String API_BASE_URL

See Also:

Constant Field Values

Constructor Detail

APIConfiguration

public APIConfiguration(String appKey,
                        String appSecret,
                        int localizeOption)

Configure to issue OLAMI HTTP API requests.

Parameters:

appKey - - The 'APP KEY' you have, provided by OLAMI developer service.

appSecret - - The 'APP SECRET' you have, provided by OLAMI developer service.

localizeOption - - Select the location and language of the OLAMI service you want to use (0 for Simplified Chinese in China, 1 for Traditional Chinese in Taiwan)

Method Detail

setSdkType

public void setSdkType(String type)

Parameters:

type - - SDK type.

setApiServerDomain

public void setApiServerDomain(String domain)

Not recommended for use. Normally this is for commercial use, so you probably don't need to use this method.

Parameters:

domain - - API server domain name

getSdkType

public String getSdkType()

Returns:

The given SDK type string.

getAppKey

public String getAppKey()

Returns:

The given 'APP KEY'.

getAppSecret

public String getAppSecret()

Returns:

The given 'APP SECRET'.

getLocalizeOption

public int getLocalizeOption()

Returns:

The localize option you selected.

getTimestamp

public long getTimestamp(String apiName)

Get the generated timestamp value by the given API name.

Parameters:

apiName - - API name.

Returns:

Timestamp in milliseconds.

getSignature

public String getSignature(String apiName)

Get the signature by the given API name and the generated timestamp.

Parameters:

apiName - - API name.

Returns:

MD5 signature.

getBaseRequestURL

public String getBaseRequestURL(String apiName)
                         throws NoSuchAlgorithmException

Get the base API end point URL for the given API name.

Parameters:

apiName - - API name.

Returns:

URL of the specified API.

Throws:

NoSuchAlgorithmException - Filed to create signature.

getBaseRequestURL

public String getBaseRequestURL(String apiName,
                                Map<String,String> queryParams)
                         throws NoSuchAlgorithmException

Get the base API end point URL for the given API name.

Parameters:

apiName - - API name.

queryParams - - Query parameters by name-value collection.

Returns:

URL of the specified API.

Throws:

NoSuchAlgorithmException - Filed to create signature.

generateSignature

protected void generateSignature(String apiName)
                          throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

initLocalization

protected void initLocalization(int localizeOption)