DefaultClient (OpenShift Java REST Client 3.0.1.Final API)

java.lang.Object
- com.openshift.internal.restclient.DefaultClient

All Implemented Interfaces:

IAuthorizationClient, ICapable, IHttpStatusCodes, IClient
```
public class DefaultClient
extends Object
implements IClient, IHttpStatusCodes
```
Author:

Jeff Cantrill

Field Summary

Fields
Modifier and Type Field and Description

static String SYSTEM_PROP_K8E_API_VERSION

static String SYSTEM_PROP_OPENSHIFT_API_VERSION
- Fields inherited from interface com.openshift.restclient.http.IHttpStatusCodes
  STATUS_BAD_REQUEST, STATUS_FORBIDDEN, STATUS_INTERNAL_SERVER_ERROR, STATUS_NOT_FOUND, STATUS_OK, STATUS_UNAUTHORIZED

Fields
Modifier and Type	Field and Description
`static String`	`SYSTEM_PROP_K8E_API_VERSION`
`static String`	`SYSTEM_PROP_OPENSHIFT_API_VERSION`

Constructor Summary

Constructors
Constructor and Description

DefaultClient(URL baseUrl, ISSLCertificateCallback sslCertCallback)

Constructors
Constructor and Description
`DefaultClient(URL baseUrl, ISSLCertificateCallback sslCertCallback)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends ICapability,R> R`	`accept(CapabilityVisitor<T,R> visitor, R unsupportedCapabililityValue)` Uses the given visitor to access the desired capability if it is supported
`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.
`boolean`	`equals(Object obj)`
`<T extends IResource> T`	`get(String kind, String name, String namespace)`
`IAuthorizationDetails`	`getAuthorizationDetails(String baseURL)` Retrieve the authorization details for a server
`IAuthorizationStrategy`	`getAuthorizationStrategy()`
`URL`	`getBaseURL()`
`<T extends ICapability> T`	`getCapability(Class<T> capability)` Gets the capability of the desired type
`IAuthorizationContext`	`getContext(String baseURL)` Retrieve a token for OpenShift.
`IUser`	`getCurrentUser()`
`String`	`getKubernetesVersion()`
`List<KubernetesAPIVersion>`	`getKubernetesVersions()`
`String`	`getOpenShiftAPIVersion()` Returns the OpenShift API version for this client
`List<OpenShiftAPIVersion>`	`getOpenShiftVersions()`
`IResourceFactory`	`getResourceFactory()` Returns the resource factory used to create resources based on the response from the server
`String`	`getResourceURI(IResource resource)`
`int`	`hashCode()`
`void`	`initializeCapabilities()`
`<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
`void`	`setSSLCertificateCallback(ISSLCertificateCallback callback)` Set the callback handler to use for certificate trust issues.
`boolean`	`supports(Class<? extends ICapability> capability)` Determines if the client supports the desired capability
`<T extends IResource> T`	`update(T resource)` Updates the given resource

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSTEM_PROP_K8E_API_VERSION
```
public static final String SYSTEM_PROP_K8E_API_VERSION
```
    See Also:
    
    Constant Field Values
  - SYSTEM_PROP_OPENSHIFT_API_VERSION
```
public static final String SYSTEM_PROP_OPENSHIFT_API_VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultClient
```
public DefaultClient(URL baseUrl,
                     ISSLCertificateCallback sslCertCallback)
```
- Method Detail
  - getResourceFactory
```
public IResourceFactory getResourceFactory()
```
    Description copied from interface: IClient
    
    Returns the resource factory used to create resources based on the response from the server
    
    Specified by:
    
    getResourceFactory in interface IClient
    
    Returns:
  - getResourceURI
```
public String getResourceURI(IResource resource)
```
    Specified by:
    
    getResourceURI in interface IClient
    
    Returns:
    
    the uri to the resource (e.g. for crafting webhooks)
  - list
```
public <T extends IResource> List<T> list(String kind)
```
    Description copied from interface: IClient
    
    Lists all possible resources of the given kind in the default namespace
    
    Specified by:
    
    list in interface IClient
    
    Returns:
  - list
```
public <T extends IResource> List<T> list(String kind,
                                          String namespace)
```
    Description copied from interface: IClient
    
    Lists the given given resource kind scoping it to a specific namespace
    
    Specified by:
    
    list in interface IClient
    
    namespace - The namespace to scope the possible results of this list
    
    Returns:
  - list
```
public <T extends IResource> List<T> list(String kind,
                                          String namespace,
                                          Map<String,String> labels)
```
    Description copied from interface: IClient
    
    Lists the given given resource kind scoping it to a specific namespace
    
    Specified by:
    
    list in interface IClient
    
    namespace - The namespace to scope the possible results of this list
    
    labels - The label used to filter the resource
    
    Returns:
  - create
```
public Collection<IResource> create(IList list,
                                    String namespace)
```
    Description copied from interface: IClient
    
    Creates a list of resources in the given namespace
    
    Specified by:
    
    create in interface IClient
    
    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.
  - create
```
public <T extends IResource> T create(T resource)
```
    Description copied from interface: IClient
    
    Creates the given resource in the namespace defined on the resource or the default namspace if undefined
    
    Specified by:
    
    create in interface IClient
    
    Returns:
  - create
```
public <T extends IResource> T create(T resource,
                                      String namespace)
```
    Description copied from interface: IClient
    
    Creates the given resource in the given namespace
    
    Specified by:
    
    create in interface IClient
    
    Returns:
  - create
```
public <T extends IResource> T create(String kind,
                                      String namespace,
                                      String name,
                                      String subresource,
                                      IResource payload)
```
    Description copied from interface: IClient
    
    Creates the given resource in the given namespace using the subresource
    
    Specified by:
    
    create in interface IClient
    
    Returns:
  - update
```
public <T extends IResource> T update(T resource)
```
    Description copied from interface: IClient
    
    Updates the given resource
    
    Specified by:
    
    update in interface IClient
    
    Returns:
  - delete
```
public <T extends IResource> void delete(T resource)
```
    Description copied from interface: IClient
    
    Deletes the given resource.
    
    Specified by:
    
    delete in interface IClient
  - get
```
public <T extends IResource> T get(String kind,
                                   String name,
                                   String namespace)
```
    Specified by:
    
    get in interface IClient
    
    Returns:
  - initializeCapabilities
```
public void initializeCapabilities()
```
  - getCapability
```
public <T extends ICapability> T getCapability(Class<T> capability)
```
    Description copied from interface: ICapable
    
    Gets the capability of the desired type
    
    Specified by:
    
    getCapability in interface ICapable
    
    Returns:
    
    an implementation of the given capability
  - supports
```
public boolean supports(Class<? extends ICapability> capability)
```
    Description copied from interface: ICapable
    
    Determines if the client supports the desired capability
    
    Specified by:
    
    supports in interface ICapable
    
    Returns:
    
    true if the client is able to offer this capability
  - accept
```
public <T extends ICapability,R> R accept(CapabilityVisitor<T,R> visitor,
                                          R unsupportedCapabililityValue)
```
    Description copied from interface: ICapable
    
    Uses the given visitor to access the desired capability if it is supported
    
    Specified by:
    
    accept in interface ICapable
    
    Type Parameters:
    
    T - visitor A capability visitor
    
    R - unsupportedCapabililityValue The value to return when the capability is not supported
    
    Parameters:
    
    visitor - A visitor looking for a given Capability type
    
    Returns:
    
    A type that is expected by the caller
  - getKubernetesVersions
```
public List<KubernetesAPIVersion> getKubernetesVersions()
```
  - getOpenShiftVersions
```
public List<OpenShiftAPIVersion> getOpenShiftVersions()
```
  - getKubernetesVersion
```
public String getKubernetesVersion()
```
  - getOpenShiftAPIVersion
```
public String getOpenShiftAPIVersion()
```
    Description copied from interface: IClient
    
    Returns the OpenShift API version for this client
    
    Specified by:
    
    getOpenShiftAPIVersion in interface IClient
    
    Returns:
  - getBaseURL
```
public URL getBaseURL()
```
    Specified by:
    
    getBaseURL in interface IClient
    
    Returns:
    
    the base URL of this endpoint
  - setAuthorizationStrategy
```
public void setAuthorizationStrategy(IAuthorizationStrategy strategy)
```
    Description copied from interface: IClient
    
    Sets the authorization strategy for the client when making requests to the server
    
    Specified by:
    
    setAuthorizationStrategy in interface IClient
  - getAuthorizationStrategy
```
public IAuthorizationStrategy getAuthorizationStrategy()
```
    Specified by:
    
    getAuthorizationStrategy in interface IClient
  - getCurrentUser
```
public IUser getCurrentUser()
```
    Specified by:
    
    getCurrentUser in interface IClient
    
    Returns:
    
    the user associated with the current session
  - getContext
```
public IAuthorizationContext getContext(String baseURL)
```
    Description copied from interface: IAuthorizationClient
    
    Retrieve a token for OpenShift.
    
    Specified by:
    
    getContext in interface IAuthorizationClient
    
    Returns:
  - getAuthorizationDetails
```
public IAuthorizationDetails getAuthorizationDetails(String baseURL)
```
    Description copied from interface: IAuthorizationClient
    
    Retrieve the authorization details for a server
    
    Specified by:
    
    getAuthorizationDetails in interface IAuthorizationClient
    
    Returns:
  - setSSLCertificateCallback
```
public void setSSLCertificateCallback(ISSLCertificateCallback callback)
```
    Description copied from interface: IAuthorizationClient
    
    Set the callback handler to use for certificate trust issues.
    
    Specified by:
    
    setSSLCertificateCallback in interface IAuthorizationClient
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class DefaultClient

Field Summary

Fields inherited from interface com.openshift.restclient.http.IHttpStatusCodes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_PROP_K8E_API_VERSION

SYSTEM_PROP_OPENSHIFT_API_VERSION

Constructor Detail

DefaultClient

Method Detail

getResourceFactory

getResourceURI

list

list

list

create

create

create

create

update

delete

get

initializeCapabilities

getCapability

supports

accept

getKubernetesVersions

getOpenShiftVersions

getKubernetesVersion

getOpenShiftAPIVersion

getBaseURL

setAuthorizationStrategy

getAuthorizationStrategy

getCurrentUser

getContext

getAuthorizationDetails

setSSLCertificateCallback

hashCode

equals