com.openshift.internal.restclient.model

Class KubernetesResource

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

All Implemented Interfaces:

ResourcePropertyKeys, IAnnotatable, IApiVersionable, IKindable, ITypeMeta, ICapable, Annotatable, IResource, JSONSerializeable

Direct Known Subclasses:

Build, BuildConfig, BuildRequest, ConfigMap, Endpoints, ImageStream, ImageStreamImport, KubernetesEvent, LimitRange, List, Namespace, OAuthAccessToken, OAuthAuthorizeToken, OAuthClient, OAuthClientAuthorization, OpenShiftGroup, OpenShiftIdentity, OpenshiftPolicy, OpenshiftProjectRequest, OpenshiftRole, OpenShiftUser, PersistentVolume, PersistentVolumeClaim, Pod, PolicyBinding, Project, ReplicationController, ResourceQuota, RoleBinding, Route, Secret, Service, ServiceAccount, Status, Template

public class KubernetesResource
extends Object
implements IResource, ResourcePropertyKeys

Resource is an abstract representation of a Kubernetes resource

Field Summary

Fields inherited from interface com.openshift.internal.restclient.model.properties.ResourcePropertyKeys

ANNOTATIONS, APIVERSION, CREATION_TIMESTAMP, FROM, KIND, LABELS, METADATA, METADATA_NAME, METADATA_NAMESPACE, METADATA_RESOURCE_VERSION, METADATA_UID, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE

Constructor Summary

Constructors

Constructor and Description
KubernetesResource(org.jboss.dmr.ModelNode node, IClient client, Map<String,String[]> overrideProperties)

Method Summary

Modifier and Type	Method and Description
<T extends ICapability,R> R	accept(CapabilityVisitor<T,R> visitor, R unsupportedValue) Uses the given visitor to access the desired capability if it is supported
void	addLabel(String key, String value) Add or update a label;
protected boolean	asBoolean(org.jboss.dmr.ModelNode node, String property)
protected boolean	asBoolean(String property)
protected int	asInt(org.jboss.dmr.ModelNode node, String key)
protected int	asInt(String key)
protected Map<String,String>	asMap(String property)
protected Set	asSet(String property, org.jboss.dmr.ModelType type)
protected String	asString(org.jboss.dmr.ModelNode node, String subKey)
protected String	asString(String property)
boolean	equals(Object obj)
protected org.jboss.dmr.ModelNode	get(org.jboss.dmr.ModelNode node, String key)
protected org.jboss.dmr.ModelNode	get(String key)
String	getAnnotation(String key) Retrieves the annotated value for the given key
Map<String,String>	getAnnotations() Retrieves the annotations associated with the resource
String	getApiVersion() The api version of the resource as found at apiVersion
Set<Class<? extends ICapability>>	getCapabilities()
<T extends ICapability> T	getCapability(Class<T> capability) Gets the capability of the desired type
IClient	getClient()
String	getCreationTimeStamp() Returns the timestamp of when this resource was created
protected Map<String,String>	getEnvMap(String key)
String	getKind() The kind of the resource as would be found at kind
Map<String,String>	getLabels() Retrieves the labels associated with the resource
Map<String,String>	getMetadata()
protected Map<Class<? extends ICapability>,ICapability>	getModifiableCapabilities()
String	getName() Returns the identifier for this resource
INamespace	getNamespace() Return the namespace of the resource
String	getNamespaceName() Returns the scope of this resource
org.jboss.dmr.ModelNode	getNode()
protected String[]	getPath(String key)
IProject	getProject() Return the project of the resource
Map<String,String[]>	getPropertyKeys()
String	getResourceVersion()
protected boolean	has(String key)
int	hashCode()
boolean	isAnnotatedWith(String key) Returns true if the resource is annotated with the given key
void	refresh()
void	removeAnnotation(String name) Removes the resource annotation
protected void	set(org.jboss.dmr.ModelNode node, String key, boolean value)
protected void	set(org.jboss.dmr.ModelNode node, String key, int value)
protected void	set(org.jboss.dmr.ModelNode node, String key, String value)
protected void	set(String key, boolean value)
protected void	set(String key, int value)
protected void	set(String key, Map<String,String> values)
protected void	set(String property, Set<String> values)
protected void	set(String property, String... values)
protected void	set(String key, String value)
void	setAnnotation(String name, String value) Set the resource annotation
protected void	setEnvMap(String key, Map<String,String> values)
void	setName(String name)
void	setNamespace(String namespace)
void	setNode(org.jboss.dmr.ModelNode node)
boolean	supports(Class<? extends ICapability> capability) Determines if the client supports the desired capability
String	toJson() The JSON representation
String	toJson(boolean compact) The JSON representation
String	toPrettyString()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KubernetesResource

public KubernetesResource(org.jboss.dmr.ModelNode node,
                          IClient client,
                          Map<String,String[]> overrideProperties)

Parameters:

overrideProperties - the map of properties that override the defaults

Method Detail

getResourceVersion

public String getResourceVersion()

Specified by:

getResourceVersion in interface IResource

getMetadata

public Map<String,String> getMetadata()

Specified by:

getMetadata in interface IResource

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

getCapabilities

public Set<Class<? extends ICapability>> getCapabilities()

Specified by:

getCapabilities in interface IResource

Returns:

the list of capabilities supported by this resource

getModifiableCapabilities

protected Map<Class<? extends ICapability>,ICapability> getModifiableCapabilities()

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 unsupportedValue)

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

getProject

public IProject getProject()

Description copied from interface: IResource

Return the project of the resource

Specified by:

getProject in interface IResource

getNamespace

public INamespace getNamespace()

Description copied from interface: IResource

Return the namespace of the resource

Specified by:

getNamespace in interface IResource

getAnnotations

public Map<String,String> getAnnotations()

Description copied from interface: IResource

Retrieves the annotations associated with the resource

Specified by:

getAnnotations in interface IAnnotatable

Specified by:

getAnnotations in interface IResource

getAnnotation

public String getAnnotation(String key)

Description copied from interface: IResource

Retrieves the annotated value for the given key

Specified by:

getAnnotation in interface IAnnotatable

Specified by:

getAnnotation in interface IResource

setAnnotation

public void setAnnotation(String name,
                          String value)

Description copied from interface: IResource

Set the resource annotation

Specified by:

setAnnotation in interface IAnnotatable

Specified by:

setAnnotation in interface IResource

removeAnnotation

public void removeAnnotation(String name)

Description copied from interface: IResource

Removes the resource annotation

Specified by:

removeAnnotation in interface IResource

isAnnotatedWith

public boolean isAnnotatedWith(String key)

Description copied from interface: IResource

Returns true if the resource is annotated with the given key

Specified by:

isAnnotatedWith in interface IAnnotatable

Specified by:

isAnnotatedWith in interface IResource

Returns:

true if the annotation key exists

getPropertyKeys

public Map<String,String[]> getPropertyKeys()

getClient

public IClient getClient()

setNode

public void setNode(org.jboss.dmr.ModelNode node)

getNode

public org.jboss.dmr.ModelNode getNode()

refresh

public void refresh()

getKind

public String getKind()

Description copied from interface: IKindable

The kind of the resource as would be found at kind

Specified by:

getKind in interface IKindable

getApiVersion

public String getApiVersion()

Description copied from interface: IApiVersionable

The api version of the resource as found at apiVersion

Specified by:

getApiVersion in interface IApiVersionable

getCreationTimeStamp

public String getCreationTimeStamp()

Description copied from interface: IResource

Returns the timestamp of when this resource was created

Specified by:

getCreationTimeStamp in interface IResource

getName

public String getName()

Description copied from interface: IResource

Returns the identifier for this resource

Specified by:

getName in interface IResource

setName

public void setName(String name)

getNamespaceName

public String getNamespaceName()

Description copied from interface: IResource

Returns the scope of this resource

Specified by:

getNamespaceName in interface IResource

setNamespace

public void setNamespace(String namespace)

addLabel

public void addLabel(String key,
                     String value)

Description copied from interface: IResource

Add or update a label;

Specified by:

addLabel in interface IResource

getLabels

public Map<String,String> getLabels()

Description copied from interface: IResource

Retrieves the labels associated with the resource

Specified by:

getLabels in interface IResource

has

protected boolean has(String key)

get

protected org.jboss.dmr.ModelNode get(String key)

get

protected org.jboss.dmr.ModelNode get(org.jboss.dmr.ModelNode node,
                                      String key)

getEnvMap

protected Map<String,String> getEnvMap(String key)

set

protected void set(String key,
                   Map<String,String> values)

set

protected void set(String key,
                   int value)

set

protected void set(org.jboss.dmr.ModelNode node,
                   String key,
                   int value)

set

protected void set(String key,
                   String value)

set

protected void set(org.jboss.dmr.ModelNode node,
                   String key,
                   String value)

set

protected void set(String key,
                   boolean value)

set

protected void set(org.jboss.dmr.ModelNode node,
                   String key,
                   boolean value)

set

protected void set(String property,
                   Set<String> values)

set

protected void set(String property,
                   String... values)

setEnvMap

protected void setEnvMap(String key,
                         Map<String,String> values)

getPath

protected String[] getPath(String key)

asString

protected String asString(org.jboss.dmr.ModelNode node,
                          String subKey)

asString

protected String asString(String property)

asInt

protected int asInt(String key)

asInt

protected int asInt(org.jboss.dmr.ModelNode node,
                    String key)

asMap

protected Map<String,String> asMap(String property)

asBoolean

protected boolean asBoolean(org.jboss.dmr.ModelNode node,
                            String property)

asBoolean

protected boolean asBoolean(String property)

asSet

protected Set asSet(String property,
                    org.jboss.dmr.ModelType type)

toString

public String toString()

Overrides:

toString in class Object

toPrettyString

public String toPrettyString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toJson

public String toJson()

Description copied from interface: JSONSerializeable

The JSON representation

Specified by:

toJson in interface JSONSerializeable

toJson

public String toJson(boolean compact)

Description copied from interface: JSONSerializeable

The JSON representation

Specified by:

toJson in interface JSONSerializeable

Parameters:

compact - true if it should be compact; false otherwise