io.druid.metadata

Interface MetadataStorageActionHandler<EntryType,StatusType,LogType,LockType>

All Known Implementing Classes:

SQLMetadataStorageActionHandler

public interface MetadataStorageActionHandler<EntryType,StatusType,LogType,LockType>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addLock(String entryId, LockType lock) Add a lock to the given entry
boolean	addLog(String entryId, LogType log) Add a log to the entry with the given id.
List<com.metamx.common.Pair<EntryType,StatusType>>	getActiveEntriesWithStatus() Return all active entries with their respective status
com.google.common.base.Optional<EntryType>	getEntry(String entryId) Retrieves the entry with the given id.
List<StatusType>	getInactiveStatusesSince(org.joda.time.DateTime timestamp) Return all statuses for inactive entries created on or later than the given timestamp
Map<Long,LockType>	getLocks(String entryId) Returns the locks for the given entry
List<LogType>	getLogs(String entryId) Returns the logs for the entry with the given id.
com.google.common.base.Optional<StatusType>	getStatus(String entryId) Retrieve the status for the entry with the given id.
void	insert(String id, org.joda.time.DateTime timestamp, String dataSource, EntryType entry, boolean active, StatusType status) Creates a new entry.
boolean	removeLock(long lockId) Remove the lock with the given lock id.
boolean	setStatus(String entryId, boolean active, StatusType status) Sets or updates the status for any active entry with the given id.

Method Detail

insert

void insert(@NotNull
          String id,
          @NotNull
          org.joda.time.DateTime timestamp,
          @NotNull
          String dataSource,
          @NotNull
          EntryType entry,
          boolean active,
          @Nullable
          StatusType status)
            throws EntryExistsException

Creates a new entry.

Parameters:

id - entry id

timestamp - timestamp this entry was created

dataSource - datasource associated with this entry

entry - object representing this entry

active - active or inactive flag

status - status object associated wit this object, can be null

Throws:

EntryExistsException

setStatus

boolean setStatus(String entryId,
                boolean active,
                StatusType status)

Sets or updates the status for any active entry with the given id. Once an entry has been set inactive, its status cannot be updated anymore.

Parameters:

entryId - entry id

active - active

status - status

Returns:

true if the status was updated, false if the entry did not exist of if the entry was inactive

getEntry

com.google.common.base.Optional<EntryType> getEntry(String entryId)

Retrieves the entry with the given id.

Parameters:

entryId - entry id

Returns:

optional entry, absent if the given id does not exist

getStatus

com.google.common.base.Optional<StatusType> getStatus(String entryId)

Retrieve the status for the entry with the given id.

Parameters:

entryId - entry id

Returns:

optional status, absent if entry does not exist or status is not set

getActiveEntriesWithStatus

List<com.metamx.common.Pair<EntryType,StatusType>> getActiveEntriesWithStatus()

Return all active entries with their respective status

Returns:

list of (entry, status) pairs

getInactiveStatusesSince

List<StatusType> getInactiveStatusesSince(org.joda.time.DateTime timestamp)

Return all statuses for inactive entries created on or later than the given timestamp

Parameters:

timestamp - timestamp

Returns:

list of statuses

addLock

boolean addLock(String entryId,
              LockType lock)

Add a lock to the given entry

Parameters:

entryId - entry id

lock - lock to add

Returns:

true if the lock was added

removeLock

boolean removeLock(long lockId)

Remove the lock with the given lock id.

Parameters:

lockId - lock id

Returns:

true if the lock was removed, false if the given lock id did not exist

addLog

boolean addLog(String entryId,
             LogType log)

Add a log to the entry with the given id.

Parameters:

entryId - entry id

log - log to add

Returns:

true if the log was added

getLogs

List<LogType> getLogs(String entryId)

Returns the logs for the entry with the given id.

Parameters:

entryId - entry id

Returns:

list of logs

getLocks

Map<Long,LockType> getLocks(String entryId)

Returns the locks for the given entry

Parameters:

entryId - entry id

Returns:

map of lockId to lock