Skip to content

dejpav/bot-score-java-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting Started with Bot Score

Building

Supported Java version is 8+.

The generated code uses a few Maven dependencies e.g., Jackson, OkHttp, and Apache HttpClient. The reference to these dependencies is already added in the pom.xml file will be installed automatically. Therefore, you will need internet access for a successful build.

  • In order to open the client library in Eclipse click on File -> Import.

Importing SDK into Eclipse - Step 1

  • In the import dialog, select Existing Java Project and click Next.

Importing SDK into Eclipse - Step 2

  • Browse to locate the folder containing the source code. Select the detected location of the project and click Finish.

Importing SDK into Eclipse - Step 3

  • Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.

Importing SDK into Eclipse - Step 4

  • After successfully building the project, the client library needs to be installed as a Maven package in your local cache. Right-click on the project, select Show in Local Terminal -> Terminal or use Ctrl + Alt + T to open Terminal.

Importing SDK into Eclipse - Step 5

  • In the terminal dialog, run the following command to install client library.
mvn install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true

Importing SDK into Eclipse - Step 6

Installation

The following section explains how to use the BotScoreLib library in a new project.

1. Starting a new project

For starting a new project, click the menu command File > New > Project.

Add a new project in Eclipse

Next, choose Maven > Maven Project and click Next.

Create a new Maven Project - Step 1

Here, make sure to use the current workspace by choosing Use default Workspace location, as shown in the picture below and click Next.

Create a new Maven Project - Step 2

Following this, select the quick start project type to create a simple project with an existing class and a main method. To do this, choose maven-archetype-quickstart item from the list and click Next.

Create a new Maven Project - Step 3

In the last step, provide a Group Id and Artifact Id as shown in the picture below and click Finish.

Create a new Maven Project - Step 4

2. Add reference of the library project

The created Maven project manages its dependencies using its pom.xml file. In order to add a dependency on the BotScoreLib client library, double click on the pom.xml file in the Package Explorer. Opening the pom.xml file will render a graphical view on the canvas. Here, switch to the Dependencies tab and click the Add button as shown in the picture below.

Adding dependency to the client library - Step 1

Clicking the Add button will open a dialog where you need to specify BotScoreLib in Group Id, bot-score-lib in Artifact Id and 1.0.0 in the Version fields. Once added click OK. Save the pom.xml file.

Adding dependency to the client library - Step 2

Adding sample code

3. Write sample code

Once the SimpleConsoleApp is created, a file named App.java will be visible in the Package Explorer with a main method. This is the entry point for the execution of the created project. Here, you can add code to initialize the client library and instantiate a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

Test the SDK

The generated code and the server can be tested using automatically generated test cases. JUnit is used as the testing framework and test runner.

In Eclipse, for running the tests do the following:

  1. Select the project BotScoreLib from the package explorer.
  2. Select Run -> Run as -> JUnit Test or use Alt + Shift + X followed by T to run the Tests.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
basePath String Default: "develop/bscore"
environment Environment The API environment.
Default: Environment.PRODUCTION
httpClientConfig Consumer<HttpClientConfiguration.Builder> Set up Http Client Configuration instance.
bearerAuthCredentials BearerAuthCredentials The Credentials Setter for OAuth 2 Bearer token

The API client can be initialized as follows:

BotScoreClient client = new BotScoreClient.Builder()
    .httpClientConfig(configBuilder -> configBuilder
            .timeout(0))
    .bearerAuthCredentials(new BearerAuthModel.Builder(
            "AccessToken"
        )
        .build())
    .environment(Environment.PRODUCTION)
    .basePath("develop/bscore")
    .build();

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages