org.assistments.service.util

Interface ReservedNameList

All Known Implementing Classes:

ReservedNameListImpl

public interface ReservedNameList

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESERVE_SECONDS_DEFAULT Default number of seconds to reserve a name

Method Summary

Modifier and Type	Method and Description
void	clearReservation(java.util.UUID reservation) Releases a reservation for a name.
java.lang.String	getName(java.util.UUID reservation) Returns a reserved name.
java.util.UUID	reserve(java.lang.String name) Attempts to reserve the provided name.

Field Detail

RESERVE_SECONDS_DEFAULT

static final int RESERVE_SECONDS_DEFAULT

Default number of seconds to reserve a name

See Also:

Constant Field Values

Method Detail

reserve

java.util.UUID reserve(java.lang.String name)
                throws AlreadyExistsException

Attempts to reserve the provided name.

If the name is available, returns a token representing your reservation for the name. If you obtain a reservation for a name, you must present the reservation when creating an account; otherwise account creation fails since there is a reservation for that name.

Parameters:

name - Name to reserve

Returns:

A token representing the reservation of name, if name is available. The reservation automatically expires after RESERVE_SECONDS_DEFAULT seconds.

Throws:

AlreadyExistsException - If name has an active reservation.

getName

java.lang.String getName(java.util.UUID reservation)

Returns a reserved name.

Parameters:

reservation - The reservation for a name

Returns:

The reserved name or null if there is not such reservation (does not exist or has expired).

clearReservation

void clearReservation(java.util.UUID reservation)

Releases a reservation for a name.

Parameters:

reservation - The reservation to release.