Package com.atlassian.bamboo.cluster.tape

Class TapePerNodeLocalQueueWithStats

java.lang.Object

com.atlassian.bamboo.cluster.tape.TapePerNodeLocalQueueWithStats

All Implemented Interfaces:

PerNodeLocalQueue

public class TapePerNodeLocalQueueWithStats
extends Object
implements PerNodeLocalQueue

Statistics for the delegate PerNodeLocalQueueManager. Contains statsTotal with statistics for queue since "the beginning" and statsSnapshot with statistics for queue since last statsSnapshot() call.

See: statsTotal() and statsSnapshot()

Since:

9.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TapePerNodeLocalQueueWithStats.QueueStats

Nested classes/interfaces inherited from interface com.atlassian.bamboo.cluster.tape.PerNodeLocalQueue

PerNodeLocalQueue.QueueId

Field Summary

Fields inherited from interface com.atlassian.bamboo.cluster.tape.PerNodeLocalQueue

NUMBER_OF_PHYSICAL_QUEUES_PER_NODE

Constructor Summary

Constructors

Constructor	Description
TapePerNodeLocalQueueWithStats(PerNodeLocalQueue delegate)

Method Summary

Modifier and Type	Method	Description
boolean	add(CrossNodesEvent data)	transactional add of CrossNodesEvent to the queue; when operation finished we "guarantee" that the CrossNodesEvent is persisted
void	backupQueue(String prefix)	Note: use with caution This method is mainly designed to handle critical state of the queue storage by backing up the current queue persistent store and recreating a new one.
void	close()	closes the queue and all resources connected with this queue (like processing thread(s), files); closing a queue is definitive - it will never be open (i.e. not-closed) again;
boolean	equals(Object o)
@NotNull Optional<Path>	getQueueFilePath()
int	hashCode()
boolean	hasPermission()
@NotNull PerNodeLocalQueue.QueueId	id()
boolean	isClosed()	Some operations (like PerNodeLocalQueue.add(CrossNodesEvent)) on a closed queue will throw a IllegalStateException.
@NotNull String	name()
void	notifyCriticalAdd()
void	notifyCriticalPeek()
void	notifyCriticalRemove()
void	notifyDroppedOnSend()
void	notifySendFailureException()
void	notifySendUnavailableException()
void	notifySendWithTime(long timeInMillis)
@Nullable CrossNodesEvent	peek()	Allows to see what's on the head of the queue without removing it.
void	remove()	Remove CrossNodesEvent from head of the queue.
int	size()
@Nullable Long	usableSpaceInBytes()

Methods inherited from class java.lang.Object

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

Constructor Detail

TapePerNodeLocalQueueWithStats

public TapePerNodeLocalQueueWithStats(PerNodeLocalQueue delegate)

Method Detail

close

public void close()

Description copied from interface: PerNodeLocalQueue

closes the queue and all resources connected with this queue (like processing thread(s), files); closing a queue is definitive - it will never be open (i.e. not-closed) again;

Specified by:

close in interface PerNodeLocalQueue

isClosed

public boolean isClosed()

Description copied from interface: PerNodeLocalQueue

Some operations (like PerNodeLocalQueue.add(CrossNodesEvent)) on a closed queue will throw a IllegalStateException. This method allows to check if the queue has not been closed.

Specified by:

isClosed in interface PerNodeLocalQueue

Returns:

true if queue is closed

name

@NotNull
public @NotNull String name()

Specified by:

name in interface PerNodeLocalQueue

Returns:

name of the queue could be useful for the user, like identifying the queue file path from logs

id

@NotNull
public @NotNull PerNodeLocalQueue.QueueId id()

Specified by:

id in interface PerNodeLocalQueue

Returns:

queue id which uniquely identifies this queue, i.e destination node and nodeQueueNumber, see PerNodeLocalQueue.QueueId

add

public boolean add(CrossNodesEvent data)
            throws IllegalStateException

Description copied from interface: PerNodeLocalQueue

transactional add of CrossNodesEvent to the queue; when operation finished we "guarantee" that the CrossNodesEvent is persisted

Specified by:

add in interface PerNodeLocalQueue

Returns:

true if message was added or false if dropped (like exceeding queue size limit)

Throws:

IllegalStateException - when queue is closed

peek

@Nullable
public @Nullable CrossNodesEvent peek()
                               throws IllegalStateException

Description copied from interface: PerNodeLocalQueue

Allows to see what's on the head of the queue without removing it.

Specified by:

peek in interface PerNodeLocalQueue

Returns:

crossNodesEvent from queue head or null when queue is empty.

Throws:

IllegalStateException - when queue is closed

remove

public void remove()
            throws NoSuchElementException,
                   IllegalStateException

Description copied from interface: PerNodeLocalQueue

Remove CrossNodesEvent from head of the queue.

Specified by:

remove in interface PerNodeLocalQueue

Throws:

NoSuchElementException - when doing a remove on an empty queue

IllegalStateException - when queue is closed

size

public int size()

Specified by:

size in interface PerNodeLocalQueue

Returns:

number of elements in this queue

backupQueue

public void backupQueue(String prefix)
                 throws IOException

Description copied from interface: PerNodeLocalQueue

Note: use with caution This method is mainly designed to handle critical state of the queue storage by backing up the current queue persistent store and recreating a new one. Renames current queue file name to [prefix]_[queue_file_name] and re-creates queue file with [queue_file_name]. If file with [prefix]_[queue_file_name] already exists it will be deleted. Note that if PerNodeLocalQueue.backupQueue(String) is called between PerNodeLocalQueue.peek() and PerNodeLocalQueue.remove() this can cause PerNodeLocalQueue.remove() to delete a different CrossNodesEvent then expected or may throw NoSuchElementException if the new queue after PerNodeLocalQueue.backupQueue(String) is empty.

Specified by:

backupQueue in interface PerNodeLocalQueue

Throws:

IOException

notifySendWithTime

public void notifySendWithTime(long timeInMillis)

notifyDroppedOnSend

public void notifyDroppedOnSend()

notifySendFailureException

public void notifySendFailureException()

notifySendUnavailableException

public void notifySendUnavailableException()

notifyCriticalAdd

public void notifyCriticalAdd()

notifyCriticalPeek

public void notifyCriticalPeek()

notifyCriticalRemove

public void notifyCriticalRemove()

usableSpaceInBytes

@Nullable
public @Nullable Long usableSpaceInBytes()

Specified by:

usableSpaceInBytes in interface PerNodeLocalQueue

Returns:

number of bytes left on device where this queue is stored or null if unable to get this value

hasPermission

public boolean hasPermission()

Specified by:

hasPermission in interface PerNodeLocalQueue

Returns:

true if it has read/write access to queue storage

getQueueFilePath

@NotNull
public @NotNull Optional<Path> getQueueFilePath()

Specified by:

getQueueFilePath in interface PerNodeLocalQueue

Returns:

the queue file path if exists, empty otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object