com.openshift.restclient

Interface IClient

All Superinterfaces:

Cloneable, ICapable

All Known Implementing Classes:

DefaultClient

public interface IClient
extends ICapable, Cloneable

Client is the the simplest interface for interacting with the OpenShift master server.

Method Summary

Modifier and Type	Method and Description
default <T> T	adapt(Class<T> klass) Adapt this class to the given type
IClient	clone()
Collection<IResource>	create(IList list, String namespace) Creates a list of resources in the given namespace
<T extends IResource> T	create(String kind, String namespace, String name, String subresource, IResource payload) Creates the given resource in the given namespace using the subresource
<T extends IResource> T	create(String kind, String version, String namespace, String name, String subresource, InputStream payload) Creates the given resource in the given namespace using the subresource
<T extends IResource> T	create(String kind, String version, String namespace, String name, String subresource, InputStream payload, Map<String,String> parameters) Creates the given resource in the given namespace using the subresource
<T extends IResource> T	create(T resource) Creates the given resource in the namespace defined on the resource or the default namspace if undefined
<T extends IResource> T	create(T resource, String namespace) Creates the given resource in the given namespace
void	delete(String kind, String namespace, String name) Deletes a resource of given name and kind in the given namespace.
<T extends IResource> void	delete(T resource) Deletes the given resource.
<T> T	execute(ITypeFactory factory, String httpMethod, String kind, String namespace, String name, String subresource, String subContext, JSONSerializeable payload, Map<String,String> params)
<T extends IResource> T	execute(String httpMethod, String kind, String namespace, String name, String subresource, IResource payload) Raw execution of a request
<T extends IResource> T	execute(String httpMethod, String kind, String namespace, String name, String subresource, IResource payload, Map<String,String> params) Raw execution of a request
<T extends IResource> T	execute(String httpMethod, String kind, String namespace, String name, String subresource, IResource payload, String subcontext) Raw execution of a request
<T extends IResource> T	execute(String method, String kind, String version, String namespace, String name, String subresource, InputStream payload)
<T extends IResource> T	execute(String method, String kind, String version, String namespace, String name, String subresource, InputStream payload, Map<String,String> parameters)
IList	get(String kind, String namespace)
<T extends IResource> T	get(String kind, String name, String namespace)
IAuthorizationContext	getAuthorizationContext() The authorization context for this client.
URL	getAuthorizationEndpoint()
URL	getBaseURL()
String	getKubernetesMasterVersion() Query the server to determine the Kubernetes version
String	getOpenShiftAPIVersion() Returns the OpenShift API version for this client
String	getOpenshiftMasterVersion() Query the server to determine the Openshift version
IResourceFactory	getResourceFactory() Returns the resource factory used to create resources based on the response from the server
String	getResourceURI(IResource resource)
String	getServerReadyStatus() Query the server to determine if it is ready
URL	getTokenEndpoint()
<T extends IResource> List<T>	list(String kind) Lists all possible resources of the given kind in the default namespace
<T extends IResource> List<T>	list(String kind, Map<String,String> labels) Lists the given given resource kind scoping it to a specific namespace
<T extends IResource> List<T>	list(String kind, String namespace) Lists the given given resource kind scoping it to a specific namespace
<T extends IResource> List<T>	list(String kind, String namespace, Map<String,String> labels) Lists the given given resource kind scoping it to a specific namespace
<T extends IResource> List<T>	list(String kind, String namespace, String labelQuery) Lists the given given resource kind scoping it to a specific namespace
<T extends IResource> T	update(T resource) Updates the given resource
IWatcher	watch(IOpenShiftWatchListener listener, String... kinds)
IWatcher	watch(String namespace, IOpenShiftWatchListener listener, String... kinds)

Methods inherited from interface com.openshift.restclient.capability.ICapable

accept, getCapability, supports

Method Detail

watch

IWatcher watch(String namespace,
               IOpenShiftWatchListener listener,
               String... kinds)

watch

IWatcher watch(IOpenShiftWatchListener listener,
               String... kinds)

list

<T extends IResource> List<T> list(String kind)

Lists all possible resources of the given kind in the default namespace

Parameters:

kind -

Returns:

list

<T extends IResource> List<T> list(String kind,
                                   Map<String,String> labels)

Lists the given given resource kind scoping it to a specific namespace

Parameters:

kind -

labels - The label used to filter the resource

Returns:

list

<T extends IResource> List<T> list(String kind,
                                   String namespace)

Lists the given given resource kind scoping it to a specific namespace

Parameters:

kind -

namespace - The namespace to scope the possible results of this list

Returns:

list

<T extends IResource> List<T> list(String kind,
                                   String namespace,
                                   Map<String,String> labels)

Lists the given given resource kind scoping it to a specific namespace

Parameters:

kind -

namespace - The namespace to scope the possible results of this list

labels - The label used to filter the resource

Returns:

list

<T extends IResource> List<T> list(String kind,
                                   String namespace,
                                   String labelQuery)

Lists the given given resource kind scoping it to a specific namespace

Parameters:

kind -

namespace - The namespace to scope the possible results of this list

labelQuery - The label used to filter the resource

Returns:

get

<T extends IResource> T get(String kind,
                            String name,
                            String namespace)

Parameters:

kind -

name -

namespace -

Returns:

Throws:

OpenShiftException - if operation not supported for resource type

get

IList get(String kind,
          String namespace)

Returns:

A raw list of the kind in the given namespace (e.g. ServiceList)

create

<T extends IResource> T create(T resource)

Creates the given resource in the namespace defined on the resource or the default namspace if undefined

Parameters:

resource -

Returns:

Throws:

UnsupportedOperationException - if the resource is a list

create

<T extends IResource> T create(T resource,
                               String namespace)

Creates the given resource in the given namespace

Parameters:

resource -

namespace -

Returns:

create

<T extends IResource> T create(String kind,
                               String namespace,
                               String name,
                               String subresource,
                               IResource payload)

Creates the given resource in the given namespace using the subresource

Parameters:

kind -

namespace -

name -

subresource -

payload -

Returns:

create

<T extends IResource> T create(String kind,
                               String version,
                               String namespace,
                               String name,
                               String subresource,
                               InputStream payload)

Creates the given resource in the given namespace using the subresource

Parameters:

kind -

version -

namespace -

name -

subresource -

payload -

Returns:

create

<T extends IResource> T create(String kind,
                               String version,
                               String namespace,
                               String name,
                               String subresource,
                               InputStream payload,
                               Map<String,String> parameters)

Creates the given resource in the given namespace using the subresource

Parameters:

kind -

version -

namespace -

name -

subresource -

payload -

parameters -

Returns:

create

Collection<IResource> create(IList list,
                             String namespace)

Creates a list of resources in the given namespace

Parameters:

list - The resource definitions

namespace - the namespace for the resources

Returns:

A collection of the resources created or the status instance of why the creation failed.

Throws:

OpenShiftException - if a status can not be determined from the exception

update

<T extends IResource> T update(T resource)

Updates the given resource

Parameters:

resource -

Returns:

Throws:

UnsupportedOperationException - if the resource is a list

delete

<T extends IResource> void delete(T resource)

Deletes the given resource.

Parameters:

resource -

Throws:

UnsupportedOperationException - if the resource is a list

delete

void delete(String kind,
            String namespace,
            String name)

Deletes a resource of given name and kind in the given namespace.

Parameters:

kind - the kind of resource

namespace - the namespace

name - the name of the resource

Throws:

UnsupportedOperationException - if the resource is a list

execute

<T extends IResource> T execute(String httpMethod,
                                String kind,
                                String namespace,
                                String name,
                                String subresource,
                                IResource payload)

Raw execution of a request

Parameters:

httpMethod - HttpMethod (e.g. POST)

kind -

namespace -

name -

subresource - subresource or capability

payload - the payload to sumit. only valid on non-get operations

Returns:

execute

<T extends IResource> T execute(String method,
                                String kind,
                                String version,
                                String namespace,
                                String name,
                                String subresource,
                                InputStream payload)

execute

<T extends IResource> T execute(String method,
                                String kind,
                                String version,
                                String namespace,
                                String name,
                                String subresource,
                                InputStream payload,
                                Map<String,String> parameters)

execute

<T extends IResource> T execute(String httpMethod,
                                String kind,
                                String namespace,
                                String name,
                                String subresource,
                                IResource payload,
                                Map<String,String> params)

Raw execution of a request

Parameters:

httpMethod - HttpMethod (e.g. POST)

kind -

namespace -

name -

subresource - subresource or capability

payload - the payload to sumit. only valid on non-get operations

params - map of query parameters

Returns:

execute

<T extends IResource> T execute(String httpMethod,
                                String kind,
                                String namespace,
                                String name,
                                String subresource,
                                IResource payload,
                                String subcontext)

Raw execution of a request

Parameters:

httpMethod - HttpMethod (e.g. POST)

kind -

namespace -

name -

subresource - subresource or capability

subcontext - additional subContext (e.g. jolokia endpoint) Raw execution of a request that requires consumers to handle the response

Returns:

execute

<T> T execute(ITypeFactory factory,
              String httpMethod,
              String kind,
              String namespace,
              String name,
              String subresource,
              String subContext,
              JSONSerializeable payload,
              Map<String,String> params)

Parameters:

factory - The factory to use for interpreting the response

httpMethod - HttpMethod (e.g. POST)

kind -

namespace -

name -

subresource - subresource or capability

payload - the payload to sumit. only valid on non-get operations

subContext - additional subContext

params -

Returns:

the raw payload string

getBaseURL

URL getBaseURL()

Returns:

the base URL of this endpoint

getAuthorizationEndpoint

URL getAuthorizationEndpoint()

Returns:

the authentication endpoint to be used when login

getTokenEndpoint

URL getTokenEndpoint()

Returns:

the token endpoint to be used when login

getResourceURI

String getResourceURI(IResource resource)

Returns:

the uri to the resource (e.g. for crafting webhooks)

getOpenShiftAPIVersion

String getOpenShiftAPIVersion()
                       throws UnsupportedVersionException

Returns the OpenShift API version for this client

Throws:

{@link - UnauthorizedException}

UnsupportedVersionException

getAuthorizationContext

IAuthorizationContext getAuthorizationContext()

The authorization context for this client.

Returns:

The context which will never be null

getResourceFactory

IResourceFactory getResourceFactory()

Returns the resource factory used to create resources based on the response from the server

adapt

default <T> T adapt(Class<T> klass)

Adapt this class to the given type

Returns:

an instance of the class or null if it can not

getServerReadyStatus

String getServerReadyStatus()

Query the server to determine if it is ready

getOpenshiftMasterVersion

String getOpenshiftMasterVersion()

Query the server to determine the Openshift version

getKubernetesMasterVersion

String getKubernetesMasterVersion()

Query the server to determine the Kubernetes version

clone

IClient clone()