Skip to content
API Manager Documentation 3.0.0 Java Documentation
3.0.0
  • Show all
Type to start searching
    • Get Started
    • Learn
    • Develop
    • Install and Setup
    • Administer
    • Reference
    • Troubleshooting
    
    Report Issues
    wso2/docs-apim
    • Welcome to WSO2 API Manager Documentation
      • Overview
      • Key Concepts
      • Quick Start Guide
      • About this Release
            • Create a REST API
            • Create a REST API from a Swagger Definition
            • Create a GraphQL API
            • Create a WebSocket API
            • Expose a SOAP Service as a REST API
            • Generate REST API from SOAP Backend
          • Adding Custom Properties to APIs
          • Change the Thumbnail of an API
          • Publish an API
          • Publish through Multiple API Gateways
          • Publish to Multiple External API Developer Portals
          • Create a Prototype API with an Inline Script
          • Deploy and Test Prototype APIs
          • API Product Overview
          • Create an API Product
          • Endpoint Types
            • Secure Endpoint with Basic Auth
            • Secure Endpoint with Digest Auth
          • High Availability for Endpoints
            • Endpoint Timeouts
            • Endpoint Suspension
            • Prevent API Suspension
          • Manage Certificates
          • API Lifecycle
          • Customize API Life Cycle
          • Extending the API Life Cycle
          • Create a New API Version
          • Deprecate the Old Version
          • Backward Compatibility
          • Enabling Notifications
          • Add API Documentation
            • Add a New Search Keyword
          • Enable Publisher Access Control
          • Control API Visibility and Subscription Availability in the Developer Portal
          • Enabling CORS for APIs
          • Adding an API State Change Workflow
          • Block Subscription to an API
          • Search
          • Create Application
            • Application Keys
              • Password Grant
              • Client Credentials Grant
              • JWT Grant
              • Kerberos OAuth2 Grant
              • Refresh Token Grant
              • Authorization Code Grant
              • SAML Extension Grant
              • Implicit Grant
              • NTLM Grant
              • Overview of Access Tokens
              • Access Tokens Per Device
              • Changing the Default Token Expiration Time
          • Sharing Applications
            • Add Custom Attributes to Applications
            • Changing the Owner of an Application
            • Adding an Application Creation Workflow
            • Adding an Application Key Generation Workflow
          • Subscribe to an API
            • Adding an API Subscription Workflow
          • Invoke an API Using the Integrated API Console
          • Include Additional Headers in the API Console
          • Invoke an API Using a SOAP Client
          • Use the Community Features
            • Overriding Developer Portal Theme
              • Categorizing and Grouping APIs
              • Change Default View
            • Enabling or Disabling API Detail Tabs
            • Override API Overview Page per API
            • Enable or Disable Rating
            • Enable or Disable Home Page
            • Enable or Disable Tag Cloud
            • Enable or Disable Footer
            • Enable or Disable Banner
            • Styling API Details Left Menu
            • Styling API Details Info Section
            • Styling the Logo and Header
            • Enabling or Disabling Self Signup
            • Advanced Customization
          • Log in to the Developer Portal using Social Media
          • Customizing the Developer Portal and Gateway URLs for Tenants
          • Adding a User Signup Workflow
          • Directing the Root Context to the Developer Portal
          • Customizing User Signup in Developer Portal
          • Customizing Login Pages for Developer Portal and Publisher
          • Generate SDKs in Developer Portal
          • Write a Client Application Using the SDK
        • Overview of the WSO2 API Gateway
          • Changing the Default Mediation Flow of API Requests
          • Creating and Uploading using Integration Studio
          • Adding Dynamic Endpoints
          • Removing Specific Request Headers From Response
          • Passing a Custom Authorization Token to the Backend
          • URL Mapping
          • Disabling Message Chunking
          • Transforming API Message Payload
          • Adding a Non-Blocking Send Operation
          • Adding a Class Mediator
          • Writing Custom Handlers
        • Response Caching
        • Message Tracing
          • Regular Expression Threat Protection
          • JSON Threat Protection
          • XML Threat Protection
          • Passing Enduser Attributes to the Backend Using JWT
        • Gateway Environments
        • Scaling the Gateway
          • API Gateways with Dedicated Backends
        • Grouping APIs with Labels
          • Overview
          • Secure APIs using OAuth2 Access Tokens
          • Secure APIs using API Keys
          • Secure APIs using Mutual SSL
          • Secure APIs using Basic Authentication
          • Overview
          • Role-Based Access Control using Scopes
          • Role-Based Access Control using XACML
          • JSON Schema Validator
            • JWT Access Tokens
            • Opaque Access Tokens
            • Role-Based Access Control with OAuth Scopes
            • Scope Whitelisting
            • Overview
            • Password Grant
            • Client Credentials Grant
            • Authorization Code Grant
            • Implicit Grant
            • Refresh Token Grant
            • JWT Grant
            • SAML Extension Grant
            • Kerberos OAuth2 Grant
            • NTLM Grant
          • Token Revocation
          • Token Expiration
          • Token Persistence
          • Encrypting OAuth2 Tokens
          • Hashing OAuth Keys
          • Provisioning Out-of-Band OAuth Clients
          • Securing OAuth Token with HMAC Validation
          • Bot Detection
          • Gateway Threat Protectors
          • Regular Expression Threat Protection
          • JSON Threat Protection
          • XML Threat Protection
          • Obtaining User Profile Information with OpenID Connect
        • Throttling Use-Cases
        • Adding New Throttling Policies
        • Setting Throttling Limits
        • Blacklisting and Whitelisting Requests
        • Enforce Throttling and Resource Access Policies
        • Setting Maximum Backend Throughput Limits
        • Engaging a New Throttling Policy at Runtime
          • Custom Throttling
        • Monetizing an API
        • Overview of API Analytics
        • Introducing the WSO2 API Manager Statistics Model
        • Configuring APIM Analytics
        • Configuring Keystores in API-M Analytics
        • Managing Analytics Dashboard Permissions
        • Viewing API Statistics
          • Alert Types
          • Configuring Alerts
          • Subscribing for Alerts
          • Viewing Alerts
          • Creating the Geo Location Data Set
          • Configuring Geo Location Based Statistics
          • Writing a Custom Geo Location Provider
        • Integrating with Google Analytics
        • Purging Analytics Data
        • Default Ports of WSO2 API-M Analytics
        • Adding Third Party Non OSGi Libraries
        • Getting Started with WSO2 API Controller
        • Importing APIs Via Dev First Approach
        • Migrating APIs to Different Environments
        • Migrating Apps to Different Environments
        • CI/CD with WSO2 API Manager
        • Building a Jenkins CI/CD Pipeline for Dev First Approach
          • Creating Custom Users to Perform API Controller Operations
          • Configuring Environment Specific Parameters
        • Create and Publish a GraphQL API
        • Expose a SOAP Service as a REST API
        • Create and Publish WebSocket API
        • Edit an API by Modifying the API Definition
          • Invoking the API Manager from the BPEL Engine
          • Customizing a Workflow Extension
          • Configuring HTTP Redirection for Workflows
          • Configuring Workflows for Tenants
          • Configuring Workflows in a Cluster
          • Changing the Default User Role in Workflows
          • Cleaning Up Workflow Tasks
          • Configuring Single Sign-on with SAML2
          • Configuring Identity Server as IDP for SSO
          • Configuring External IDP through Identity Server for SSO
        • Writing Custom Grant Types
        • Extending Key Validation
        • Extending the Key Manager Interface
        • Extending Scope Validation
        • RESTful APIs
          • Publisher API v1
          • Developer Portal API v1
          • Publisher API v0.15
          • Developer Portal API v0.15
          • Admin API v0.15
        • Configuring the REST API
            • Publisher API v1
            • Publisher API v0.15
            • Developer Portal API v1
            • Developer Portal API v0.15
            • Admin API v0.15
      • Admin Services
      • Working with the Source Code
      • Java Documentation
          • Customizing API Template
      • Using the Siddhi Store REST API
        • Installation Prerequisites
          • Overview
          • Installing via the Installer
            • Installing on Linux or OS X
            • Installing on Solaris
            • Installing on Windows
            • Installing as a Linux Service
            • Installing as a Windows Service
        • Running the Product
        • Basic Health Checks
          • Deployment Patterns Overview
            • All-in-One Deployment Overview
            • Configuring a Single Node
            • Configuring an Active-Active Deployment
            • Distributed Deployment Overview
            • Deploying WSO2 API-M in a Distributed Setup
            • Product Profiles
              • Configure WSO2 API-M Gateways in a Distributed Deployment
              • Configuring the Gateway in a Distributed Environment with rsync
              • Working with Hazelcast Clustering
            • Configure a Third Party Key Manager
            • Configuring WSO2 Identity Server as Key Manager
        • Changing the Hostname
        • Changing the Default Ports with Offset
        • Configuring the Proxy Server and the Load Balancer
        • Configuring message builders and formatters
        • Deploying API Manager with Kubernetes or OpenShift Resources
          • Active-Active
          • Active-Passive
          • Production Deployment Guidelines
          • Security Guidelines for Production Deployment
        • Configure WSO2 Identity Server As An External IDP Using OIDC
        • Configure WSO2 Identity Server As An External IDP using SAML
        • Overview
          • Changing to MySQL
          • Changing to MSSQL
          • Changing to PostgreSQL
          • Changing to Oracle
          • Changing to MariaDB
          • Changing to IBM DB2
          • Changing to Oracle RAC
      • Product Compatibility
      • Supported Cipher Suites
        • Tuning Performance
        • Performance Test Results
        • Upgrading Process
        • 2.6.0 to 3.0.0
        • 2.5.0 to 3.0.0
        • 2.2.0 to 3.0.0
        • 2.1.0 to 3.0.0
        • 2.0.0 to 3.0.0
        • 1.10.0 to 3.0.0
        • 1.8.0/1.9.0/1.9.1 to 3.0.0
        • Upgrading to Log4j2
        • 2.6.0 to 3.0.0
        • 2.5.0 to 3.0.0
        • 2.2.0 to 3.0.0
        • 2.1.0 to 3.0.0
        • 2.0.0 to 3.0.0
        • 1.10.0 to 3.0.0
        • 1.8.0/1.9.0/1.9.1 to 3.0.0
        • Updating WSO2 API Manager
          • Introduction to User Management
          • Managing User Roles
          • Managing Users
          • Managing Role Permissions
          • Introduction to User Stores
            • Configuring Primary User Stores
            • Configuring a JDBC User Store
            • Configuring a Read-Write LDAP User Store
            • Configuring a Read-Only LDAP User Store
            • Configuring a Read-Write Active Directory User Store
          • Configuring Secondary User Store
          • Writing a custom User Store Manager
          • Configuring the Authorization Manager
          • Introduction to Multitenancy
          • Managing Tenants
          • Configuring the Tenant Loading Policy
            • Setting up logging
            • Monitoring HTTP access logs
            • Monitoring audit Logs
            • Managing log growth
            • Masking sensitive information in logs
          • Working with Observability
          • Capturing System Data in Error Situations
          • JMX-Based Monitoring
          • Monitoring Message Flows
          • Monitoring Performance Statistics
          • Monitoring TCP-Based Messages
        • Revoke OAuth2 Application
        • Removing Unused Tokens from the Database
        • Changing the Default Transport
        • Default Product Ports
        • Configuring Caching
        • Common Runtime and Configuration Artifacts
        • Customizing the Management Console
        • Adding Internationalization and Localization
          • Configuring Keystores in API Manager
            • Creating a New Keystore
            • Renewing a CA Signed Certificate
            • About Asymetric Cryptography
          • Maintaining Logins and Passwords
            • Encrypting Passwords in Configuration Files
            • Customizing Secure Vault
            • Set Passwords using Environment Variables/System Properties
        • Mitigating Cross Site Request Forgery Attacks
        • Mitigating Cross Site Scripting Attacks
        • Enabling HostName Verification
        • Enabling Java Security Manager
        • General Data Protection Regulation (GDPR) for WSO2 API Manager
        • Configuring Transport Level Security
        • Mutual SSL Between API Gateway and Backend
        • Multi Factor Authentication (MFA) for Publisher and Developer Portals
        • Identity Management for the API Developer Portal
      • Configuration Catalog
      • Vendor Specific Extensions
      • WSO2 API Manager Best Practices
      • FAQ
        • Message Flow in the API Manager Gateway
        • Accessing API Manager by Multiple Devices Simultaneously
        • admin_Directory Structure of WSO2 Products
          • Managing APIs Sample
          • Collaborative API Development Sample
          • Development of Developer Optimized APIs Sample
        • API Governance Sample
        • API Lifecycle Management Sample
        • API Rate Limiting Sample
        • API Rate Monetization Sample
        • API Security Sample
        • API Versioning Sample
      • Error Handling
      • Troubleshooting in Production Environments
      • Cleaning Up Partially Created Keys
      • Troubleshooting 'Registered callback does not match with the provided url' error
    

    Java Documentation¶

    The following Java documentation describes all the classes, interfaces, and methods of the API Manager, which you can use to create custom classes: http://product-dist.wso2.com/javadocs/api-manager/2.1.0/

    Top
    Previous Working with the Source Code
    Next Customizing API Template
    WSO2 API Manager - Documentation
    ©2019-2020 WSO2