io.fabric8.kubernetes.client.dsl.base

Class OperationSupport

java.lang.Object

io.fabric8.kubernetes.client.dsl.base.OperationSupport

Direct Known Subclasses:

BaseOperation, ClusterOperationsImpl, KubernetesListOperationsImpl, NamespaceVisitFromServerGetWatchDeleteRecreateWaitApplicableImpl, NamespaceVisitFromServerGetWatchDeleteRecreateWaitApplicableListImpl, NodeMetricOperationsImpl, PodMetricOperationsImpl, RawCustomResourceOperationsImpl, SubjectAccessReviewDSLImpl

public class OperationSupport
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiGroupName
protected String	apiGroupVersion
protected okhttp3.OkHttpClient	client
protected Config	config
protected OperationContext	context
static okhttp3.MediaType	JSON
protected static com.fasterxml.jackson.databind.ObjectMapper	JSON_MAPPER
static okhttp3.MediaType	JSON_PATCH
protected String	name
protected String	namespace
protected String	resourceT
protected static com.fasterxml.jackson.databind.ObjectMapper	YAML_MAPPER

Constructor Summary

Constructors

Constructor and Description
OperationSupport()
OperationSupport(okhttp3.OkHttpClient client, Config config)
OperationSupport(okhttp3.OkHttpClient client, Config config, String namespace)
OperationSupport(OperationContext ctx)

Method Summary

Modifier and Type	Method and Description
protected void	assertResponseCode(okhttp3.Request request, okhttp3.Response response) Checks if the response status code is the expected and throws the appropriate KubernetesClientException if not.
protected <T> String	checkName(T item)
protected <T> String	checkNamespace(T item)
static io.fabric8.kubernetes.api.model.Status	createStatus(int statusCode, String message)
static io.fabric8.kubernetes.api.model.Status	createStatus(okhttp3.Response response)
String	getAPIGroup()
String	getAPIVersion()
Config	getConfig()
String	getName()
String	getNamespace()
URL	getNamespacedUrl()
URL	getNamespacedUrl(String namespace)
<T> URL	getNamespacedUrl(T item)
String	getResourceT()
URL	getResourceUrl()
URL	getResourceUrl(String namespace, String name)
URL	getRootUrl()
protected <T,I> T	handleCreate(I resource, Class<T> outputType) Create a resource.
protected <T> void	handleDelete(T resource, long gracePeriodSeconds, String propagationPolicy, boolean cascading)
protected void	handleDelete(URL requestUrl, long gracePeriodSeconds, String propagationPolicy, boolean cascading)
protected io.fabric8.kubernetes.api.model.Status	handleDeploymentRollback(String resourceUrl, io.fabric8.kubernetes.api.model.extensions.DeploymentRollback deploymentRollback) Create rollback of a Deployment
protected <T> T	handleGet(URL resourceUrl, Class<T> type) Send an http get.
protected <T> T	handleGet(URL resourceUrl, Class<T> type, Map<String,String> parameters) Send an http, optionally performing placeholder substitution to the response.
protected <T> T	handleMetric(String resourceUrl, Class<T> type)
protected <T> T	handlePatch(T current, T updated, Class<T> type) Send an http patch and handle the response.
protected <T> T	handleReplace(T updated, Class<T> type) Replace a resource.
protected <T> T	handleReplace(T updated, Class<T> type, Map<String,String> parameters) Replace a resource, optionally performing placeholder substitution to the response.
protected <T> T	handleResponse(okhttp3.OkHttpClient client, okhttp3.Request.Builder requestBuilder, Class<T> type) Send an http request and handle the response.
protected <T> T	handleResponse(okhttp3.OkHttpClient client, okhttp3.Request.Builder requestBuilder, Class<T> type, Map<String,String> parameters) Send an http request and handle the response, optionally performing placeholder substitution to the response.
protected <T> T	handleResponse(okhttp3.Request.Builder requestBuilder, Class<T> type) Send an http request and handle the response.
protected <T> T	handleResponse(okhttp3.Request.Builder requestBuilder, Class<T> type, Map<String,String> parameters) Send an http request and handle the response, optionally performing placeholder substitution to the response.
protected io.fabric8.kubernetes.api.model.v1.Scale	handleScale(String resourceUrl, io.fabric8.kubernetes.api.model.v1.Scale scale) Replace Scale of specified Kubernetes Resource
protected <T> T	handleStatusUpdate(T updated, Class<T> type)
boolean	isResourceNamespaced()
static KubernetesClientException	requestException(okhttp3.Request request, Exception e)
static KubernetesClientException	requestFailure(okhttp3.Request request, io.fabric8.kubernetes.api.model.Status status)
protected static <T> T	unmarshal(InputStream is)
protected static <T> T	unmarshal(InputStream is, Class<T> type)
protected static <T> T	unmarshal(InputStream is, com.fasterxml.jackson.core.type.TypeReference<T> type)

Methods inherited from class java.lang.Object

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

Field Detail

JSON

public static final okhttp3.MediaType JSON

JSON_PATCH

public static final okhttp3.MediaType JSON_PATCH

JSON_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper JSON_MAPPER

YAML_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper YAML_MAPPER

context

protected OperationContext context

client

protected final okhttp3.OkHttpClient client

config

protected final Config config

resourceT

protected final String resourceT

namespace

protected String namespace

name

protected String name

apiGroupName

protected String apiGroupName

apiGroupVersion

protected String apiGroupVersion

Constructor Detail

OperationSupport

public OperationSupport()

OperationSupport

public OperationSupport(okhttp3.OkHttpClient client,
                        Config config)

OperationSupport

public OperationSupport(okhttp3.OkHttpClient client,
                        Config config,
                        String namespace)

OperationSupport

public OperationSupport(OperationContext ctx)

Method Detail

getAPIGroup

public String getAPIGroup()

getAPIVersion

public String getAPIVersion()

getResourceT

public String getResourceT()

getNamespace

public String getNamespace()

getName

public String getName()

isResourceNamespaced

public boolean isResourceNamespaced()

getRootUrl

public URL getRootUrl()

getNamespacedUrl

public URL getNamespacedUrl(String namespace)
                     throws MalformedURLException

Throws:

MalformedURLException

getNamespacedUrl

public URL getNamespacedUrl()
                     throws MalformedURLException

Throws:

MalformedURLException

getNamespacedUrl

public <T> URL getNamespacedUrl(T item)
                         throws MalformedURLException

Throws:

MalformedURLException

getResourceUrl

public URL getResourceUrl(String namespace,
                          String name)
                   throws MalformedURLException

Throws:

MalformedURLException

getResourceUrl

public URL getResourceUrl()
                   throws MalformedURLException

Throws:

MalformedURLException

checkNamespace

protected <T> String checkNamespace(T item)

checkName

protected <T> String checkName(T item)

handleMetric

protected <T> T handleMetric(String resourceUrl,
                             Class<T> type)
                      throws InterruptedException,
                             IOException,
                             ExecutionException

Throws:

InterruptedException

IOException

ExecutionException

handleDelete

protected <T> void handleDelete(T resource,
                                long gracePeriodSeconds,
                                String propagationPolicy,
                                boolean cascading)
                         throws ExecutionException,
                                InterruptedException,
                                KubernetesClientException,
                                IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handleDelete

protected void handleDelete(URL requestUrl,
                            long gracePeriodSeconds,
                            String propagationPolicy,
                            boolean cascading)
                     throws ExecutionException,
                            InterruptedException,
                            KubernetesClientException,
                            IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handleCreate

protected <T,I> T handleCreate(I resource,
                               Class<T> outputType)
                        throws ExecutionException,
                               InterruptedException,
                               KubernetesClientException,
                               IOException

Create a resource.

Type Parameters:

T - template argument for output type

I - template argument for resource

Parameters:

resource - resource provided

outputType - resource type you want as output

Returns:

returns de-serialized version of apiserver response in form of type provided

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleReplace

protected <T> T handleReplace(T updated,
                              Class<T> type)
                       throws ExecutionException,
                              InterruptedException,
                              KubernetesClientException,
                              IOException

Replace a resource.

Type Parameters:

T - template argument provided

Parameters:

updated - updated object

type - type of the object provided

Returns:

returns de-serialized version of api server response

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleReplace

protected <T> T handleReplace(T updated,
                              Class<T> type,
                              Map<String,String> parameters)
                       throws ExecutionException,
                              InterruptedException,
                              KubernetesClientException,
                              IOException

Replace a resource, optionally performing placeholder substitution to the response.

Type Parameters:

T - template argument provided

Parameters:

updated - updated object

type - type of object provided

parameters - a HashMap containing parameters for processing object

Returns:

returns de-serialized version of api server response.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleStatusUpdate

protected <T> T handleStatusUpdate(T updated,
                                   Class<T> type)
                            throws ExecutionException,
                                   InterruptedException,
                                   KubernetesClientException,
                                   IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handlePatch

protected <T> T handlePatch(T current,
                            T updated,
                            Class<T> type)
                     throws ExecutionException,
                            InterruptedException,
                            KubernetesClientException,
                            IOException

Send an http patch and handle the response.

Type Parameters:

T - template argument provided

Parameters:

current - current object

updated - updated object

type - type of object

Returns:

returns de-serialized version of api server response

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleScale

protected io.fabric8.kubernetes.api.model.v1.Scale handleScale(String resourceUrl,
                                                               io.fabric8.kubernetes.api.model.v1.Scale scale)
                                                        throws ExecutionException,
                                                               InterruptedException,
                                                               KubernetesClientException,
                                                               MalformedURLException,
                                                               com.fasterxml.jackson.core.JsonProcessingException,
                                                               IOException

Replace Scale of specified Kubernetes Resource

Parameters:

resourceUrl - Kubernetes resource URL

scale - Scale object which we want to inject

Returns:

updated Scale object

Throws:

ExecutionException - in case of any execution exception

InterruptedException - in case thread is interrupted

KubernetesClientException - in case error from Kubernetes API

MalformedURLException - in case URL formed in invalid

com.fasterxml.jackson.core.JsonProcessingException - in case Json processing fails

IOException - in some other I/O problem

handleDeploymentRollback

protected io.fabric8.kubernetes.api.model.Status handleDeploymentRollback(String resourceUrl,
                                                                          io.fabric8.kubernetes.api.model.extensions.DeploymentRollback deploymentRollback)
                                                                   throws ExecutionException,
                                                                          InterruptedException,
                                                                          KubernetesClientException,
                                                                          MalformedURLException,
                                                                          com.fasterxml.jackson.core.JsonProcessingException,
                                                                          IOException

Create rollback of a Deployment

Parameters:

resourceUrl - resource url

deploymentRollback - DeploymentRollback resource

Returns:

Status

Throws:

ExecutionException - in case of any execution exception

InterruptedException - in case thread is interrupted

KubernetesClientException - in case error from Kubernetes API

MalformedURLException - in case URL formed in invalid

com.fasterxml.jackson.core.JsonProcessingException - in case Json processing fails

IOException - in some other I/O problem

handleGet

protected <T> T handleGet(URL resourceUrl,
                          Class<T> type)
                   throws ExecutionException,
                          InterruptedException,
                          KubernetesClientException,
                          IOException

Send an http get.

Type Parameters:

T - template argument provided

Parameters:

resourceUrl - resource URL to be processed

type - type of resource

Returns:

returns a deserialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleGet

protected <T> T handleGet(URL resourceUrl,
                          Class<T> type,
                          Map<String,String> parameters)
                   throws ExecutionException,
                          InterruptedException,
                          KubernetesClientException,
                          IOException

Send an http, optionally performing placeholder substitution to the response.

Type Parameters:

T - template argument provided

Parameters:

resourceUrl - resource URL to be processed

type - type of resource

parameters - A HashMap of strings containing parameters to be passed in request

Returns:

Returns a deserialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleResponse

protected <T> T handleResponse(okhttp3.Request.Builder requestBuilder,
                               Class<T> type)
                        throws ExecutionException,
                               InterruptedException,
                               KubernetesClientException,
                               IOException

Send an http request and handle the response.

Type Parameters:

T - template argument provided

Parameters:

requestBuilder - Request Builder object

type - type of resource

Returns:

Returns a de-serialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleResponse

protected <T> T handleResponse(okhttp3.Request.Builder requestBuilder,
                               Class<T> type,
                               Map<String,String> parameters)
                        throws ExecutionException,
                               InterruptedException,
                               KubernetesClientException,
                               IOException

Send an http request and handle the response, optionally performing placeholder substitution to the response.

Type Parameters:

T - template argument provided

Parameters:

requestBuilder - request builder

type - type of object

parameters - a hashmap containing parameters

Returns:

Returns a de-serialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleResponse

protected <T> T handleResponse(okhttp3.OkHttpClient client,
                               okhttp3.Request.Builder requestBuilder,
                               Class<T> type)
                        throws ExecutionException,
                               InterruptedException,
                               KubernetesClientException,
                               IOException

Send an http request and handle the response.

Type Parameters:

T - template argument provided

Parameters:

client - OkHttp client object

requestBuilder - request builder

type - type of object

Returns:

Returns a de-serialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

handleResponse

protected <T> T handleResponse(okhttp3.OkHttpClient client,
                               okhttp3.Request.Builder requestBuilder,
                               Class<T> type,
                               Map<String,String> parameters)
                        throws ExecutionException,
                               InterruptedException,
                               KubernetesClientException,
                               IOException

Send an http request and handle the response, optionally performing placeholder substitution to the response.

Type Parameters:

T - Template argument provided

Parameters:

client - OkHttp client provided

requestBuilder - Request builder

type - Type of object provided

parameters - A hashmap containing parameters

Returns:

Returns a de-serialized object as api server response of provided type.

Throws:

ExecutionException - Execution Exception

InterruptedException - Interrupted Exception

KubernetesClientException - KubernetesClientException

IOException - IOException

assertResponseCode

protected void assertResponseCode(okhttp3.Request request,
                                  okhttp3.Response response)

Checks if the response status code is the expected and throws the appropriate KubernetesClientException if not.

Parameters:

request - The {#link Request} object.

response - The Response object.

Throws:

KubernetesClientException - When the response code is not the expected.

createStatus

public static io.fabric8.kubernetes.api.model.Status createStatus(okhttp3.Response response)

createStatus

public static io.fabric8.kubernetes.api.model.Status createStatus(int statusCode,
                                                                  String message)

requestFailure

public static KubernetesClientException requestFailure(okhttp3.Request request,
                                                       io.fabric8.kubernetes.api.model.Status status)

requestException

public static KubernetesClientException requestException(okhttp3.Request request,
                                                         Exception e)

unmarshal

protected static <T> T unmarshal(InputStream is)
                          throws KubernetesClientException

Throws:

KubernetesClientException

unmarshal

protected static <T> T unmarshal(InputStream is,
                                 Class<T> type)
                          throws KubernetesClientException

Throws:

KubernetesClientException

unmarshal

protected static <T> T unmarshal(InputStream is,
                                 com.fasterxml.jackson.core.type.TypeReference<T> type)
                          throws KubernetesClientException

Throws:

KubernetesClientException

getConfig

public Config getConfig()