Package me.ahoo.cosid.proxy.api

Interface MachineLeaseApi

All Known Subinterfaces:

MachineLeaseClient

@HttpExchange("machines/v2")
public interface MachineLeaseApi

Machine id leases, version 2: the MachineLeaseStore primitives of the server's backend, passed through.

Clients run the allocation algorithm themselves (MachineLeaseManager) on a ProxyMachineLeaseStore. Every now and expiredBefore must come from serverTime(), the backend store's clock.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPIRED
static final String	NEW
static final String	RELEASED
static final String	SELF	The claim kinds, as path segments.

Method Summary

Modifier and Type	Method	Description
LeaseResponse	claim(String namespace, String kind, ClaimRequest request)	Claim a machine id: kind is SELF, RELEASED, NEW or EXPIRED.
boolean	release(String namespace, ReleaseRequest request)	Release a lease.
LeaseResponse	renew(String namespace, RenewRequest request)
long	serverTime()	The backend store's clock, in milliseconds.

Field Details

SELF

static final String SELF

The claim kinds, as path segments.

See Also:

• Constant Field Values

RELEASED

static final String RELEASED

See Also:

• Constant Field Values

NEW

static final String NEW

See Also:

• Constant Field Values

EXPIRED

static final String EXPIRED

See Also:

• Constant Field Values

Method Details

serverTime

@GetExchange("time")
long serverTime()

The backend store's clock, in milliseconds.

claim

@PostExchange("{namespace}/claims/{kind}")
LeaseResponse claim(@PathVariable
 String namespace,
 @PathVariable
 String kind,
 @RequestBody
 ClaimRequest request)

Claim a machine id: kind is SELF, RELEASED, NEW or EXPIRED.

renew

@PostExchange("{namespace}/renewals")
LeaseResponse renew(@PathVariable
 String namespace,
 @RequestBody
 RenewRequest request)

release

@PostExchange("{namespace}/releases")
boolean release(@PathVariable
 String namespace,
 @RequestBody
 ReleaseRequest request)

Release a lease.

Returns:

false if the lease was taken over or changed since