com.openshift.restclient

Interface IClient

All Superinterfaces:

IAuthorizationClient, ICapable

All Known Implementing Classes:

DefaultClient

public interface IClient
extends ICapable, IAuthorizationClient

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

Author:

Jeff Cantrill

Method Summary

Modifier and Type	Method and Description
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(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
<T extends IResource> void	delete(T resource) Deletes the given resource.
<T extends IResource> T	get(String kind, String name, String namespace)
IAuthorizationStrategy	getAuthorizationStrategy()
URL	getBaseURL()
IUser	getCurrentUser()
String	getOpenShiftAPIVersion() Returns the OpenShift API version for this client
IResourceFactory	getResourceFactory() Returns the resource factory used to create resources based on the response from the server
String	getResourceURI(IResource resource)
<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, 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
void	setAuthorizationStrategy(IAuthorizationStrategy strategy) Sets the authorization strategy for the client when making requests to the server
<T extends IResource> T	update(T resource) Updates the given resource

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

accept, getCapability, supports

Methods inherited from interface com.openshift.restclient.authorization.IAuthorizationClient

getAuthorizationDetails, getContext, setSSLCertificateCallback

Method Detail

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,
                                   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:

get

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

Parameters:

service -

name -

Returns:

Throws:

OpenShiftException - if operation not supported for resource type

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

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

getBaseURL

URL getBaseURL()

Returns:

the base URL of this endpoint

getResourceURI

String getResourceURI(IResource resource)

Parameters:

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

Returns:

Throws:

UnsupportedVersionException

{@link - UnauthorizedException}

setAuthorizationStrategy

void setAuthorizationStrategy(IAuthorizationStrategy strategy)

Sets the authorization strategy for the client when making requests to the server

Parameters:

strategy -

getAuthorizationStrategy

IAuthorizationStrategy getAuthorizationStrategy()

getResourceFactory

IResourceFactory getResourceFactory()

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

Returns:

getCurrentUser

IUser getCurrentUser()

Returns:

the user associated with the current session