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

Class ConfigMapLock

java.lang.Object

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

All Implemented Interfaces:

Lock

public class ConfigMapLock
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
ConfigMapLock(String configMapNamespace, String configMapName, 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.
String	identity() Returns the unique id of the lock holder.
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

ConfigMapLock

public ConfigMapLock(String configMapNamespace,
                     String configMapName,
                     String identity)

Method Detail

get

public LeaderElectionRecord get(KubernetesClient client)

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)
            throws LockException

Attempt to create a new LeaderElectionRecord.

Specified by:

create in interface Lock

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

Throws:

LockException - if update was not possible

update

public void update(KubernetesClient client,
                   LeaderElectionRecord leaderElectionRecord)
            throws LockException

Attempts to update the current LeaderElectionRecord.

Specified by:

update in interface Lock

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

Throws:

LockException - if update was not possible

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