Skip to main content
Kinetic Community

Github Adapter

The Github Adapter is used to retrieve data about repositories from Github.

Requirements

  • The Kinetic Schedule web server must be using JDK 6.0 or higher.
  • The following java libraries must be included in the Kinetic Schedule web application classpath:​
    • Http Client 4.1.2 (httpclient-4.1.2.jar)
    • Http Core 4.1.2 (httpcore-4.1.2.jar)
    • Apache Commons Logging (commons-logging-1.1.1.jar)
    • Kinetic Schedule Github Adapter (kinetic-schedule-github-adapter.jar)
  • The adapter and required jars can be downloaded using this zip file

Adapter Configuration

The following properties are required for all adapters.

 

Property Description
name

Any alpha-numeric value is acceptable, but should indicate this is a Github adapter.

Example: "github"

className

The value of the main adapter class file.  This will be a unique value specific to the adapter.

Value: "com.kineticdata.schedule.adapter.github.GithubAdapter"

 

Example Adapters Configuration File

{
    "adaptersConfig": {
        "adapters": [
            {
                "name": "github",
                "className": "com.kineticdata.schedule.adapter.github.GithubAdapter"
            }
        ]
    }
}

 

Connection Configuration

The following properties are required for all connections, regardless of what type of adapter is used.  If the value for that property is not used by the adapter, the property must still exist in the configuration file.  The value for the property should be set to the blank string ("") if it is not used.

 

Property Description
name

The name of the connection that will be used in data source configuration files that use this connection.  Should be a name that correlates the adapter and server.

Example: "github"

type

The value that was entered as the "name" property for the GithubAdapter in the adapters configuration file.

Example: in the adapter configuration example above, the value would be "github"

description

A description of the connection.  This is not seen by the end users, it is simply a way to describe what this connection interacts with.

Example:  "Github connection"

location

The name of the Github organization or username that the repos will be pulled from.

Example: "company"

username

The username used to login to Github.

Example: "Demo"

password

The password used to login to Github.  This value can be entered as plain-text or encrypted with the Password Encryption form.

Example: "pass123"

useEncryption

Indicates if the password is stored in plain-text or encrypted form.

"true" if encrypted, "false" if plain-text

 

The additional parameters that are specific to the Salesforce Adapter are all required (Instructions on how to find these values are found later on in the article).

 

Property Description
Location Type

The type of the location that was inputted in the core fields. If you inputted a organization, the Location Type would be Organization. If you inputted a username, the Location Type would be Username.

Example: "Organization"

Example Connector Configuration File

{
    "connection": {
        "name": "github",
        "type": "github",
        "description": "Github connection",
        "location": "company",
        "username": "Demo",
        "password": "pass123",
        "useEncryption": "false",
        "additionalParameters": [
            {
                "name": "Location Type",
                "value": "Organization"
            }
        ]
    }
}