# jenkins-client-java

**Repository Path**: linuxsuren/jenkins-client-java

## Basic Information

- **Project Name**: jenkins-client-java
- **Description**: 实现了绝大多数对Jenkins的操作（推荐使用 https://gitee.com/surenpi/jenkins-cli）
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/jenkins-zh/jenkins-client-java
- **GVP Project**: No

## Statistics

- **Stars**: 135
- **Forks**: 43
- **Created**: 2017-12-16
- **Last Updated**: 2024-12-07

## Categories & Tags

**Categories**: jenkins-plugins

**Tags**: None

## README

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.surenpi/jenkins.client.java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.surenpi/jenkins.client.java)

# jenkins-client-java

Java binding for the Jenkins client.

[sonar](https://sonarcloud.io/dashboard?id=com.surenpi.ci%3Ajenkins.client.java)

# How to use it

Add the following dependency to the pom.xml file of your project:

```xml
<dependency>
    <groupId>com.surenpi.ci</groupId>
    <artifactId>jenkins.client.java</artifactId>
    <version>1.0.0-20171217</version>
</dependency>
```
# Example of get all jobs from jenkins

```java
import com.surenpi.jenkins.client.Jenkins;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.List;

/**
 * @author suren
 */
public class Demo
{
    public static void main(String[] args) throws URISyntaxException, IOException
    {
        URI serverURI = new URI("http://localhost:8080/jenkins");
        Jenkins jenkins = new Jenkins(serverURI, "admin", "admin");

        Jobs jobMgr = jenkins.getJobs();
        List<Job> allJobs = jobMgr.getAllJobs();

        for(Job job : allJobs)
        {
            System.out.println(job.getName());
        }
    }
}
```

# Example of get all installed plugins from jenkins

```java
import com.surenpi.jenkins.client.Jenkins;
import com.surenpi.jenkins.client.plugin.Plugin;
import com.surenpi.jenkins.client.plugin.Plugins;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.List;

/**
 * @author suren
 */
public class Demo
{
    public static void main(String[] args) throws URISyntaxException, IOException
    {
        URI serverURI = new URI("http://localhost:8080/jenkins");
        Jenkins jenkins = new Jenkins(serverURI, "admin", "admin");

        Plugins pluginMgr = jenkins.getPlugins();
        List<Plugin> allInstalledPlugins = pluginMgr.getPluginManager().getPlugins();
        for(Plugin plugin : allInstalledPlugins)
        {
            System.out.println(plugin.getShortName());
        }
    }
}
```

# Example of get all credentials from jenkins

```java
import com.surenpi.jenkins.client.Jenkins;
import com.surenpi.jenkins.client.credential.Credential;
import com.surenpi.jenkins.client.credential.Credentials;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Map;

/**
 * @author suren
 */
public class Demo
{
    public static void main(String[] args) throws URISyntaxException, IOException
    {
        URI serverURI = new URI("http://localhost:8080/jenkins");
        Jenkins jenkins = new Jenkins(serverURI, "admin", "admin");

        Credentials credentialMgr = jenkins.getCredentials();
        Map<String, Credential> credentialMap = credentialMgr.list();
        for(String key : credentialMap.keySet())
        {
            System.out.println(credentialMap.get(key).getDescription());
        }
    }
}
```

# Compile & Package

If you want to compile project, you can via `mvn clean compile`

If you want to package project and skip the junit test, you can via `mvn clean package -DskipTest`