udda1996 / module-ballerina-oauth2

Ballerina OAuth2 Module

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ballerina OAuth2 Library

Build GitHub Last Commit GitHub issues License codecov

The oauth2 library is one of the standard library modules of the Ballerina language.

This module provides a framework for interacting with OAuth2 authorization servers as specified in the RFC 6749 and RFC 7662.

The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service or by allowing the third-party application to obtain access on its own behalf.

The Ballerina oauth2 module facilitates auth providers that are to be used by the clients and listeners of different protocol connectors.

For more information, go to the oauth2 module.

For example demonstrations of the usage, go to Ballerina By Examples.

Issues and Projects

Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina Standard Library parent repository.

This repository only contains the source code for the module.

Building from the Source

Setting Up the Prerequisites

  1. Download and install Java SE Development Kit (JDK) version 11 (from one of the following locations).

    • Oracle

    • OpenJDK

      Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

  2. Export your GitHub Personal Access Token (PAT) with the 'read package' permission as follows:

    export packageUser=<Username>
    export packagePAT=<Personal Access Token>
    
  3. Download and install Docker.

Building the Source

Execute the commands below to build from the source.

  1. To build the package:

    ./gradlew clean build
    
  2. To run the tests:

    ./gradlew clean test
    
  3. To run a group of tests

    ./gradlew clean test -Pgroups=<test_group_names>
    
  4. To build the without the tests:

    ./gradlew clean build -x test
    
  5. To debug package implementation:

    ./gradlew clean build -Pdebug=<port>
    
  6. To debug with Ballerina language:

    ./gradlew clean build -PbalJavaDebug=<port>
    
  7. Publish the generated artifacts to the local Ballerina central repository:

    ./gradlew clean build -PpublishToLocalCentral=true
    
  8. Publish the generated artifacts to the Ballerina central repository:

    ./gradlew clean build -PpublishToCentral=true
    

Contributing to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of Conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful Links

About

Ballerina OAuth2 Module

License:Apache License 2.0


Languages

Language:Ballerina 83.7%Language:Java 16.3%