Configuring api-manager.xml
- Former user (Deleted)
- Former user (Deleted)
Note
This page is still under construction.
Users can change the default API Manager-specific configurations by editing api-manager.xml file using the information given below.
File Details
- File Name: api-manager.xml
- Location: $CARBON_HOME\repository\conf
- Purpose: Store all API Manager functionality related configurations.
XML Elements
Click on a main element to view its details along with specifics on its sub elements.
- <APIManager>
- <DataSourceName>
- <Database>
- <URL>
- <Username>
- <Password>
- <Driver>
<ServerURL>
<Username>
<Password>
<SecurityContextHeader>
<ClaimsRetrieverImplClass>
<ConsumerDialectURI>
<SignatureAlgorithm>
- <EnableTokenGeneration>
- <APIGateway>
<ServerURL>
<Username>
<Password>
- <APIEndpointURL>
- <EnableGatewayKeyCache>
<Enabled>
<PublisherClass>
<ThriftPort>
<BAMServerURL>
<BAMUsername>
<BAMPassword>
<DataSourceName>
<ServerURL>
<Username>
<Password>
<EnableJWTCache>
<EnableKeyMgtValidationInfoCache>
<KeyValidatorClientType>
<ThriftClientPort>
<ThriftClientConnectionTimeOut>
<ThriftServerPort>
<RemoveUserNameToJWTForApplicationToken>
<EnableUnlimitedTier>
<Enabled>
<SubscriberRoleName>
<CreateSubscriberRole>
<DisplayMultipleVersions>
<DisplayAllAPIs>
<DisplayComments>
<DisplayRatings>
<Observer>
<APIManager>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sample Implementations
<DataSourceName>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sample Implementations
<Database>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <URL> | ||||||
| <Username> | ||||||
<Password> | ||||||
<Driver> |
Sample Implementations
<AuthManager>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | ||||||
| <Username> | ||||||
<Password> |
Sample Implementations
<APIConsumerAuthentication>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <SecurityContextHeader> | ||||||
| <ClaimsRetrieverImplClass> | ||||||
<ConsumerDialectURI> | ||||||
| <SignatureAlgorithm> | ||||||
| <EnableTokenGeneration> |
Sample Implementations
<APIGateway>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | ||||||
| <Username> | ||||||
<Password> | ||||||
| <APIEndpointURL> | ||||||
| <EnableGatewayKeyCache> |
Sample Implementations
<APIUsageTracking>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <Enabled> | ||||||
| <PublisherClass> | ||||||
<ThriftPort> | ||||||
| <BAMServerURL> | ||||||
| <BAMUsername> | ||||||
| <BAMPassword> | ||||||
<DataSourceName> |
Sample Implementations
<APIKeyManager>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | ||||||
| <Username> | ||||||
<Password> | ||||||
| <EnableJWTCache> | ||||||
| <EnableKeyMgtValidationInfoCache> | ||||||
| <KeyValidatorClientType> | ||||||
<ThriftClientPort> | ||||||
| <ThriftClientConnectionTimeOut> | ||||||
| <ThriftServerPort> | ||||||
| <RemoveUserNameToJWTForApplicationToken> |
Sample Implementations
<TierManagement>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <EnableUnlimitedTier> |
Sample Implementations
<SelfSignUp>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <Enabled> | ||||||
| <SubscriberRoleName> | ||||||
<CreateSubscriberRole> |
Sample Implementations
<APIStore>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <DisplayMultipleVersions> | ||||||
| <DisplayAllAPIs> | ||||||
<DisplayComments> | ||||||
| <DisplayRatings> |
Sample Implementations
<StatusObservers>
| XML Syntax | |
|---|---|
| Description | |
| Type | |
| Default Value | |
| Fixed Values | |
| Mandatory/Optional |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <Observer> |
Sample Implementations
<ExtensionHandlerPosition>
When an API is invoked, a list of handlers gets engaged to its execution flow. The Extension Handler by default is the last handler in the execution flow. This attribute enables configuring its position.
Supported values: top, bottom
Defaults to: bottom