EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.helper.ConcurrencySemaphore

Field Summary

Modifier and Type	Field and Description
private String	logMessageKey
private final long	MAX_TIME_PERMIT
private int	noOfThreads
private Object	outerObject
private Semaphore	semaphore
private ThreadLocal<Boolean>	threadLocal
private final long	TIMEOUT_BETWEEN_LOG_MESSAGES

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ConcurrencySemaphore(ThreadLocal<Boolean> Thread local variable that the code to acquire a semaphore can check to make sure it does not try to acquire twice the same semaphore (e.g. in case the object building algorithm is recursive). threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore, int Max number of threads to acquire semaphore. noOfThreadsAllowedToExecuteInParallel, Semaphore Semaphore used to control. semaphoreOfThreadsAllowedToExecuteInParallel, Object Reference to outer object where is this semaphore used. outerObject, String Log message key from `org.eclipse.persistence.internal.localization.TraceLocalization` logMessageKey) Constructor to create `ConcurrencySemaphore`

public

ConcurrencySemaphore(ThreadLocal<Boolean>

Thread local variable that the code to acquire a semaphore can check to make sure it does not try to acquire twice the same semaphore (e.g. in case the object building algorithm is recursive).

threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore, int

Max number of threads to acquire semaphore.

noOfThreadsAllowedToExecuteInParallel, Semaphore

Semaphore used to control.

semaphoreOfThreadsAllowedToExecuteInParallel, Object

Reference to outer object where is this semaphore used.

outerObject, String

Log message key from org.eclipse.persistence.internal.localization.TraceLocalization

logMessageKey)

Constructor to create ConcurrencySemaphore

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public boolean	Returns: FALSE is returned if we do not want to be using the semaphore. FALSE is also returned if the current thread has acquire the semaphore in an upper level recursive stack call. TRUE is returned if and only using the semaphore is desired and we succeed acquiring the semaphore. acquireSemaphoreIfAppropriate(boolean TRUE to use semaphore, FALSE don't use it. useSemaphore) Do nothing if the semaphore has already been acquired by this thread in a higher recursive call or if the configuration to acquire the slow down semaphore is not active.
public void	releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding(boolean flag that tells us if the current thread had successfully acquired semaphore if the flag is true then the semaphore will be released and given resources again. semaphoreWasAcquired) If the call to `acquireSemaphoreIfAppropriate(boolean)` returned true implying the current thread acquire the semaphore, the same thread on the same method is mandated to release the semaphore.

public boolean

Returns:

FALSE is returned if we do not want to be using the semaphore. FALSE is also returned if the current thread has acquire the semaphore in an upper level recursive stack call. TRUE is returned if and only using the semaphore is desired and we succeed acquiring the semaphore.

acquireSemaphoreIfAppropriate(boolean

TRUE to use semaphore, FALSE don't use it.

useSemaphore)

Do nothing if the semaphore has already been acquired by this thread in a higher recursive call or if the configuration to acquire the slow down semaphore is not active.

public void

releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding(boolean

flag that tells us if the current thread had successfully acquired semaphore if the flag is true then the semaphore will be released and given resources again.

semaphoreWasAcquired)

If the call to acquireSemaphoreIfAppropriate(boolean) returned true implying the current thread acquire the semaphore, the same thread on the same method is mandated to release the semaphore.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

logMessageKey	back to summary
private String logMessageKey

MAX_TIME_PERMIT	back to summary
private final long MAX_TIME_PERMIT

noOfThreads	back to summary
private int noOfThreads

outerObject	back to summary
private Object outerObject

semaphore	back to summary
private Semaphore semaphore

threadLocal	back to summary
private ThreadLocal<Boolean> threadLocal

TIMEOUT_BETWEEN_LOG_MESSAGES	back to summary
private final long TIMEOUT_BETWEEN_LOG_MESSAGES

Constructor Detail

ConcurrencySemaphore back to summary

ConcurrencySemaphore	back to summary
public ConcurrencySemaphore(ThreadLocal<Boolean> threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore, int noOfThreadsAllowedToExecuteInParallel, Semaphore semaphoreOfThreadsAllowedToExecuteInParallel, Object outerObject, String logMessageKey) Constructor to create `ConcurrencySemaphore` Parameters threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore:ThreadLocal<Boolean> Thread local variable that the code to acquire a semaphore can check to make sure it does not try to acquire twice the same semaphore (e.g. in case the object building algorithm is recursive). noOfThreadsAllowedToExecuteInParallel:int Max number of threads to acquire semaphore. semaphoreOfThreadsAllowedToExecuteInParallel:Semaphore Semaphore used to control. outerObject:Object Reference to outer object where is this semaphore used. logMessageKey:String Log message key from `org.eclipse.persistence.internal.localization.TraceLocalization`

public ConcurrencySemaphore(ThreadLocal<Boolean> threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore, int noOfThreadsAllowedToExecuteInParallel, Semaphore semaphoreOfThreadsAllowedToExecuteInParallel, Object outerObject, String logMessageKey)

Constructor to create ConcurrencySemaphore

Parameters

threadLocalVarControlIfCurrentThreadHasAcquiredSemaphore:ThreadLocal<Boolean>: Thread local variable that the code to acquire a semaphore can check to make sure it does not try to acquire twice the same semaphore (e.g. in case the object building algorithm is recursive).
noOfThreadsAllowedToExecuteInParallel:int: Max number of threads to acquire semaphore.
semaphoreOfThreadsAllowedToExecuteInParallel:Semaphore: Semaphore used to control.
outerObject:Object: Reference to outer object where is this semaphore used.
logMessageKey:String: Log message key from org.eclipse.persistence.internal.localization.TraceLocalization

Method Detail

acquireSemaphoreIfAppropriate	back to summary
public boolean acquireSemaphoreIfAppropriate(boolean useSemaphore) Do nothing if the semaphore has already been acquired by this thread in a higher recursive call or if the configuration to acquire the slow down semaphore is not active. Otherwise, try to acquire the semaphore Parameters useSemaphore:boolean TRUE to use semaphore, FALSE don't use it. Returns:boolean FALSE is returned if we do not want to be using the semaphore. FALSE is also returned if the current thread has acquire the semaphore in an upper level recursive stack call. TRUE is returned if and only using the semaphore is desired and we succeed acquiring the semaphore.

acquireSemaphoreIfAppropriate

back to summary

public boolean acquireSemaphoreIfAppropriate(boolean useSemaphore)

Do nothing if the semaphore has already been acquired by this thread in a higher recursive call or if the configuration to acquire the slow down semaphore is not active. Otherwise, try to acquire the semaphore

Parameters

useSemaphore:boolean: TRUE to use semaphore, FALSE don't use it.

Returns:boolean

releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding back to summary

releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding	back to summary
public void releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding(boolean semaphoreWasAcquired) If the call to `acquireSemaphoreIfAppropriate(boolean)` returned true implying the current thread acquire the semaphore, the same thread on the same method is mandated to release the semaphore. Parameters semaphoreWasAcquired:boolean flag that tells us if the current thread had successfully acquired semaphore if the flag is true then the semaphore will be released and given resources again.

public void releaseSemaphoreAllowOtherThreadsToStartDoingObjectBuilding(boolean semaphoreWasAcquired)

If the call to acquireSemaphoreIfAppropriate(boolean) returned true implying the current thread acquire the semaphore, the same thread on the same method is mandated to release the semaphore.

Parameters

semaphoreWasAcquired:boolean: flag that tells us if the current thread had successfully acquired semaphore if the flag is true then the semaphore will be released and given resources again.

public Class ConcurrencySemaphore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail