Class ClusteredAssignment

java.lang.Object

com.oracle.coherence.concurrent.executor.ClusteredAssignment

All Implemented Interfaces:

ExternalizableLite, PortableObject, Serializable

public class ClusteredAssignment
extends Object
implements ExternalizableLite, PortableObject

Represents the state of a Task assignment to a registered Executor.

Since:

21.06

Author:

bo

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusteredAssignment.AssignmentProcessor	An InvocableMap.EntryProcessor which updates an assignment due to an assignment ExecutionPlan.Action.
static class	ClusteredAssignment.SetStateProcessor	An InvocableMap.EntryProcessor to compare and set the state of a ClusteredAssignment, returning the previous state.
static enum	ClusteredAssignment.State	The current state of the assignment.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_fRecovered	Indicates if the Task was recovered after previously being allocated to another Executor.
protected String	m_sExecutorId	The Executor identity.
protected String	m_sTaskId	The Task identity.
protected ClusteredAssignment.State	m_state	The ClusteredAssignment.State of the assignment.

Constructor Summary

Constructors

Constructor	Description
ClusteredAssignment()	Constructs a ClusteredAssignment (required for serialization).
ClusteredAssignment(String executorId, String sTaskId)	Constructs a ClusteredAssignment.

Method Summary

Modifier and Type	Method	Description
static void	cancelAssignments(String sTaskId, CacheService service)	Cancels all assignments that are currently running.
boolean	equals(Object o)
String	getCacheKey()	Obtains the NamedCache key to use for the ClusteredAssignment.
static String	getCacheKey(String sExecutorId, String sTaskId)	Obtains the NamedCache key to use for the ClusteredAssignment.
String	getExecutorId()	Obtains the Executor identity.
ClusteredAssignment.State	getState()	Obtains the ClusteredAssignment.State of the assignment.
String	getTaskId()	Obtains the Task identity.
int	hashCode()
boolean	isRecovered()	Determines if the Task was recovered from being previously assigned to a different Executor.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
static void	registerAssignments(String sTaskId, ExecutionPlan executionPlan, CacheService service)	Process a list of assignments for a task.
static void	removeAssignments(String sTaskId, CacheService service)	Remove assignments for a task.
void	setRecovered(boolean fRecovered)	Sets if the Task was previously assigned to a different Executor.
void	setState(ClusteredAssignment.State state)	Sets the ClusteredAssignment.State of the assignment.
String	toString()
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

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

Field Details

m_sExecutorId

protected String m_sExecutorId

The Executor identity.

m_sTaskId

protected String m_sTaskId

The Task identity.

m_state

protected ClusteredAssignment.State m_state

The ClusteredAssignment.State of the assignment.

m_fRecovered

protected boolean m_fRecovered

Indicates if the Task was recovered after previously being allocated to another Executor.

Constructor Details

ClusteredAssignment

public ClusteredAssignment()

Constructs a ClusteredAssignment (required for serialization).

ClusteredAssignment

public ClusteredAssignment(String executorId,
 String sTaskId)

Constructs a ClusteredAssignment.

Parameters:

executorId - the Executor identity

sTaskId - the Task identity

Method Details

readExternal

public void readExternal(DataInput in)
                  throws IOException

Description copied from interface: ExternalizableLite

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Description copied from interface: ExternalizableLite

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Description copied from interface: PortableObject

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Description copied from interface: PortableObject

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

getExecutorId

public String getExecutorId()

Obtains the Executor identity.

Returns:

the Executor identity

getTaskId

public String getTaskId()

Obtains the Task identity.

Returns:

the Task identity

getState

public ClusteredAssignment.State getState()

Obtains the ClusteredAssignment.State of the assignment.

Returns:

the ClusteredAssignment.State

setState

public void setState(ClusteredAssignment.State state)

Sets the ClusteredAssignment.State of the assignment.

Parameters:

state - the ClusteredAssignment.State

isRecovered

public boolean isRecovered()

Determines if the Task was recovered from being previously assigned to a different Executor.

Returns:

true if previously assigned to a different Executor, false otherwise

setRecovered

public void setRecovered(boolean fRecovered)

Sets if the Task was previously assigned to a different Executor.

Parameters:

fRecovered - true if previously assigned to a different Executor, false otherwise

getCacheKey

public String getCacheKey()

Obtains the NamedCache key to use for the ClusteredAssignment.

Returns:

the NamedCache key for this assignment

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getCacheKey

public static String getCacheKey(String sExecutorId,
 String sTaskId)

Obtains the NamedCache key to use for the ClusteredAssignment.

Parameters:

sExecutorId - the Executor identity

sTaskId - the Task identity

Returns:

the NamedCache key for this assignment

registerAssignments

public static void registerAssignments(String sTaskId,
 ExecutionPlan executionPlan,
 CacheService service)

Process a list of assignments for a task.

Parameters:

sTaskId - the task

executionPlan - the list of assignments

service - the CacheService

cancelAssignments

public static void cancelAssignments(String sTaskId,
 CacheService service)

Cancels all assignments that are currently running.

Parameters:

sTaskId - the task

service - the CacheService

removeAssignments

public static void removeAssignments(String sTaskId,
 CacheService service)

Remove assignments for a task.

Parameters:

sTaskId - the task

service - the CacheService