io.fabric8.kubernetes.client.extended.leaderelection.resourcelock

Class ResourceLock<T extends io.fabric8.kubernetes.api.model.HasMetadata>

java.lang.Object

io.fabric8.kubernetes.client.extended.leaderelection.resourcelock.ResourceLock<T>

All Implemented Interfaces:

Lock

Direct Known Subclasses:

ConfigMapLock, LeaseLock

public abstract class ResourceLock<T extends io.fabric8.kubernetes.api.model.HasMetadata>
extends Object
implements Lock

Field Summary

Fields inherited from interface io.fabric8.kubernetes.client.extended.leaderelection.resourcelock.Lock

LEADER_ELECTION_RECORD_ANNOTATION_KEY

Constructor Summary

Constructors

Constructor and Description
ResourceLock(io.fabric8.kubernetes.api.model.ObjectMeta meta, String identity)
ResourceLock(String namespace, String name, String identity)

Method Summary

Modifier and Type	Method and Description
void	create(KubernetesClient client, LeaderElectionRecord leaderElectionRecord) Attempt to create a new LeaderElectionRecord.
String	describe() Full description of the current lock.
LeaderElectionRecord	get(KubernetesClient client) Returns the current LeaderElectionRecord or null if none.
protected abstract Class<T>	getKind()
protected io.fabric8.kubernetes.api.model.ObjectMetaBuilder	getObjectMeta(String version)
String	identity() Returns the unique id of the lock holder.
protected abstract LeaderElectionRecord	toRecord(T resource)
protected abstract T	toResource(LeaderElectionRecord leaderElectionRecord, io.fabric8.kubernetes.api.model.ObjectMetaBuilder meta) Convert the record to a resource
void	update(KubernetesClient client, LeaderElectionRecord leaderElectionRecord) Attempts to update the current LeaderElectionRecord.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLock

public ResourceLock(String namespace,
                    String name,
                    String identity)

ResourceLock

public ResourceLock(io.fabric8.kubernetes.api.model.ObjectMeta meta,
                    String identity)

Method Detail

getKind

protected abstract Class<T> getKind()

get

public LeaderElectionRecord get(KubernetesClient client)

Description copied from interface: Lock

Returns the current LeaderElectionRecord or null if none.

Specified by:

get in interface Lock

Parameters:

client - used to retrieve the LeaderElectionRecord

Returns:

the current LeaderElectionRecord or null if none

create

public void create(KubernetesClient client,
                   LeaderElectionRecord leaderElectionRecord)

Description copied from interface: Lock

Attempt to create a new LeaderElectionRecord.

Specified by:

create in interface Lock

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

update

public void update(KubernetesClient client,
                   LeaderElectionRecord leaderElectionRecord)

Description copied from interface: Lock

Attempts to update the current LeaderElectionRecord.

Specified by:

update in interface Lock

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

toResource

protected abstract T toResource(LeaderElectionRecord leaderElectionRecord,
                                io.fabric8.kubernetes.api.model.ObjectMetaBuilder meta)

Convert the record to a resource

Parameters:

leaderElectionRecord -

meta - not null

Returns:

toRecord

protected abstract LeaderElectionRecord toRecord(T resource)

getObjectMeta

protected io.fabric8.kubernetes.api.model.ObjectMetaBuilder getObjectMeta(String version)

identity

public String identity()

Returns the unique id of the lock holder. This id is to compare ids with current LeaderElectionRecord.getHolderIdentity() to check for leadership.

Specified by:

identity in interface Lock

Returns:

unique id for the lock

describe

public String describe()

Full description of the current lock.

Specified by:

describe in interface Lock

Returns:

lock description