io.fabric8.jenkins.openshiftsync

Class OpenShiftUtils

java.lang.Object

io.fabric8.jenkins.openshiftsync.OpenShiftUtils

public class OpenShiftUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenShiftUtils()

Method Summary

Modifier and Type	Method and Description
static NamespaceName	buildConfigNameFromJenkinsJobName(String jobName, String defaultNamespace) Maps a Jenkins Job name to an ObjectShift BuildConfig name
static void	cancelOpenShiftBuild(io.fabric8.openshift.api.model.Build build)
static String	dumpWithoutRuntimeStateAsYaml(io.fabric8.kubernetes.api.model.HasMetadata obj)
static String	formatTimestamp(long timestamp)
static String	getExternalServiceUrl(io.fabric8.openshift.client.OpenShiftClient openShiftClient, String protocolText, String namespace, String serviceName) Returns the public URL of the given service
static String	getJenkinsURL(io.fabric8.openshift.client.OpenShiftClient openShiftClient, String namespace) Calculates the external URL to access Jenkins
static String	getNamespaceOrUseDefault(String configuredNamespace, io.fabric8.openshift.client.OpenShiftClient client) Gets the current namespace running Jenkins inside or returns a reasonable default
static io.fabric8.openshift.client.OpenShiftClient	getOpenShiftClient()
static void	initializeOpenShiftClient(String serverUrl) Initializes an OpenShiftClient
static boolean	isJenkinsBuildConfig(io.fabric8.openshift.api.model.BuildConfig bc) Checks if a BuildConfig relates to a Jenkins build
static boolean	isResourceWithoutStateEqual(io.fabric8.kubernetes.api.model.HasMetadata oldObj, io.fabric8.kubernetes.api.model.HasMetadata newObj)
static String	jenkinsJobName(io.fabric8.openshift.api.model.BuildConfig bc, String defaultNamespace) Finds the Jenkins job for the given BuildConfig and defaultNamespace
static String	jenkinsJobName(String namespace, String buildConfigName, String defaultNamespace) Creates the Jenkins Job name for the given buildConfigName in a namespace and the default namespace for jenkins
static long	parseResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata obj)
static long	parseTimestamp(String timestamp)
static void	shutdownOpenShiftClient()
static void	updateGitSourceUrl(io.fabric8.openshift.api.model.BuildConfig buildConfig, String gitUrl, String ref) Lazily creates the GitSource if need be then updates the git URL

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenShiftUtils

public OpenShiftUtils()

Method Detail

initializeOpenShiftClient

public static void initializeOpenShiftClient(String serverUrl)

Initializes an OpenShiftClient

Parameters:

serverUrl - the optional URL of where the OpenShift cluster API server is running

getOpenShiftClient

public static io.fabric8.openshift.client.OpenShiftClient getOpenShiftClient()

shutdownOpenShiftClient

public static void shutdownOpenShiftClient()

isJenkinsBuildConfig

public static boolean isJenkinsBuildConfig(io.fabric8.openshift.api.model.BuildConfig bc)

Checks if a BuildConfig relates to a Jenkins build

Parameters:

bc - the BuildConfig

Returns:

true if this is an OpenShift BuildConfig which should be mirrored to a Jenkins Job

jenkinsJobName

public static String jenkinsJobName(io.fabric8.openshift.api.model.BuildConfig bc,
                                    String defaultNamespace)

Finds the Jenkins job for the given BuildConfig and defaultNamespace

Parameters:

bc - the BuildConfig

defaultNamespace - the default namespace which does not prefix job names with "$namespace-buildConfigName"

Returns:

the jenkins job name for the given BuildConfig and default namespace

jenkinsJobName

public static String jenkinsJobName(String namespace,
                                    String buildConfigName,
                                    String defaultNamespace)

Creates the Jenkins Job name for the given buildConfigName in a namespace and the default namespace for jenkins

Parameters:

namespace - the namespace of the build

buildConfigName - the name of the BuildConfig in in the namespace

defaultNamespace - the default namespace that Jenkins is running inside, which by doesn't prefix itself in front of jenkins job names

Returns:

the jenkins job name for the given namespace and build config name and default namesapce

getNamespaceOrUseDefault

public static String getNamespaceOrUseDefault(String configuredNamespace,
                                              io.fabric8.openshift.client.OpenShiftClient client)

Gets the current namespace running Jenkins inside or returns a reasonable default

Parameters:

configuredNamespace - the optional configured namespace

client - the OpenShift client

Returns:

the default namespace using either the configuration value, the default namespace on the client or "default"

getExternalServiceUrl

public static String getExternalServiceUrl(io.fabric8.openshift.client.OpenShiftClient openShiftClient,
                                           String protocolText,
                                           String namespace,
                                           String serviceName)

Returns the public URL of the given service

Parameters:

openShiftClient - the OpenShiftClient to use

protocolText - the protocol text part of a URL such as http://

namespace - the Kubernetes namespace

serviceName - the service name

Returns:

the external URL of the service

getJenkinsURL

public static String getJenkinsURL(io.fabric8.openshift.client.OpenShiftClient openShiftClient,
                                   String namespace)

Calculates the external URL to access Jenkins

Parameters:

namespace - the namespace Jenkins is runing inside

openShiftClient - the OpenShift client

Returns:

the external URL to access Jenkins

updateGitSourceUrl

public static void updateGitSourceUrl(io.fabric8.openshift.api.model.BuildConfig buildConfig,
                                      String gitUrl,
                                      String ref)

Lazily creates the GitSource if need be then updates the git URL

Parameters:

buildConfig - the BuildConfig to update

gitUrl - the URL to the git repo

ref -

cancelOpenShiftBuild

public static void cancelOpenShiftBuild(io.fabric8.openshift.api.model.Build build)

buildConfigNameFromJenkinsJobName

public static NamespaceName buildConfigNameFromJenkinsJobName(String jobName,
                                                              String defaultNamespace)

Maps a Jenkins Job name to an ObjectShift BuildConfig name

Parameters:

jobName - the job to associate to a BuildConfig name

defaultNamespace - the default namespace that Jenkins is running inside

Returns:

the namespaced name for the BuildConfig

parseResourceVersion

public static long parseResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata obj)

formatTimestamp

public static String formatTimestamp(long timestamp)

parseTimestamp

public static long parseTimestamp(String timestamp)

isResourceWithoutStateEqual

public static boolean isResourceWithoutStateEqual(io.fabric8.kubernetes.api.model.HasMetadata oldObj,
                                                  io.fabric8.kubernetes.api.model.HasMetadata newObj)

dumpWithoutRuntimeStateAsYaml

public static String dumpWithoutRuntimeStateAsYaml(io.fabric8.kubernetes.api.model.HasMetadata obj)
                                            throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException