com.cdancy.jenkins.rest

Class JenkinsClient

java.lang.Object

com.cdancy.jenkins.rest.JenkinsClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class JenkinsClient
extends java.lang.Object
implements java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JenkinsClient.Builder

Constructor Summary

Constructors

Constructor and Description
JenkinsClient() Create a JenkinsClient inferring endpoint and authentication from environment and system properties.
JenkinsClient(java.lang.String endPoint, JenkinsAuthentication authentication, java.util.Properties overrides, java.util.List<com.google.inject.Module> modules) Create an JenkinsClient.

Method Summary

Modifier and Type	Method and Description
JenkinsApi	api()
AuthenticationType	authType()
java.lang.String	authValue()
static JenkinsClient.Builder	builder()
void	close()
java.lang.String	credentials() Deprecated.
java.lang.String	endPoint()
java.util.Properties	overrides()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JenkinsClient

public JenkinsClient()

Create a JenkinsClient inferring endpoint and authentication from environment and system properties.

JenkinsClient

public JenkinsClient(@Nullable
                     java.lang.String endPoint,
                     @Nullable
                     JenkinsAuthentication authentication,
                     @Nullable
                     java.util.Properties overrides,
                     @Nullable
                     java.util.List<com.google.inject.Module> modules)

Create an JenkinsClient. If any of the passed in variables are null we will query System Properties and Environment Variables, in order, to search for values that may be set in a devops/CI fashion. The only difference is the `overrides` which gets merged, but takes precedence, with those System Properties and Environment Variables found.

Parameters:

endPoint - URL of Jenkins instance.

authentication - authentication used to connect to Jenkins instance.

overrides - jclouds Properties to override defaults when creating a new JenkinsApi.

modules - a list of modules to be passed to the Contextbuilder, e.g. for logging.

Method Detail

endPoint

public java.lang.String endPoint()

credentials

@Deprecated
public java.lang.String credentials()

Deprecated.

overrides

public java.util.Properties overrides()

authValue

public java.lang.String authValue()

authType

public AuthenticationType authType()

api

public JenkinsApi api()

builder

public static JenkinsClient.Builder builder()

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException