This documentation is for WSO2 API Manager 1.4.0 View documentation for the latest release.
Configuring api-manager.xml - API Manager 1.4.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

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>
  •        <AuthManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •        <APIConsumerAuthentication>

  •                <SecurityContextHeader>

  •                <ClaimsRetrieverImplClass>

  •                <ConsumerDialectURI>

  •                <SignatureAlgorithm>

  •                <EnableTokenGeneration>
  •        <APIGateway>
  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <APIEndpointURL>
  •                <EnableGatewayKeyCache>
  •        <APIUsageTracking>

  •                <Enabled>

  •                <PublisherClass>

  •                <ThriftPort>

  •                <BAMServerURL>

  •                <BAMUsername>

  •                <BAMPassword>

  •                <DataSourceName>

  •       <APIKeyManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <EnableJWTCache>

  •               <EnableKeyMgtValidationInfoCache>

  •               <KeyValidatorClientType>

  •               <ThriftClientPort>

  •               <ThriftClientConnectionTimeOut>

  •               <ThriftServerPort>

  •               <RemoveUserNameToJWTForApplicationToken>

  •       <TierManagement>

  •               <EnableUnlimitedTier>

  •       <SelfSignUp>

  •               <Enabled>

  •               <SubscriberRoleName>

  •               <CreateSubscriberRole>

  •       <APIStore>

  •               <DisplayMultipleVersions>

  •               <DisplayAllAPIs>

  •               <DisplayComments>

  •               <DisplayRatings>

  •       <StatusObservers>

  •               <Observer>


<APIManager>

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sample Implementations


Back to Top ^


 <DataSourceName> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 

 

Sample Implementations


Back to Top ^


<Database>

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<URL>      
<Username>      

<Password>

      

<Driver>

      
 
Sample Implementations

Back to Top ^


 <AuthManager> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
 
Sample Implementations

Back to Top ^


<APIConsumerAuthentication> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<SecurityContextHeader>      
<ClaimsRetrieverImplClass>      

<ConsumerDialectURI>

      
<SignatureAlgorithm>      
<EnableTokenGeneration>      
Sample Implementations

Back to Top ^


<APIGateway>

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
<APIEndpointURL>      
<EnableGatewayKeyCache>      
 
Sample Implementations

Back to Top ^


<APIUsageTracking> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<PublisherClass>      

<ThriftPort>

      
<BAMServerURL>      
<BAMUsername>      
<BAMPassword>      

<DataSourceName>

      
 
Sample Implementations

Back to Top ^


<APIKeyManager> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
<EnableJWTCache>      
<EnableKeyMgtValidationInfoCache>      
<KeyValidatorClientType>      

<ThriftClientPort>

      
<ThriftClientConnectionTimeOut>      
<ThriftServerPort>      
<RemoveUserNameToJWTForApplicationToken>      
 
Sample Implementations

Back to Top ^


<TierManagement> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<EnableUnlimitedTier>      
 
Sample Implementations

Back to Top ^


<SelfSignUp> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<SubscriberRoleName>      

<CreateSubscriberRole>

      
 
Sample Implementations

Back to Top ^


<APIStore> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<DisplayMultipleVersions>      
<DisplayAllAPIs>      

<DisplayComments>

      
<DisplayRatings>      
 
Sample Implementations

Back to Top ^


<StatusObservers> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/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

Back to Top ^


  • No labels