com.tangosol.coherence.weblogic
Class PortalCacheProvider.FlushAgent

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.net.AbstractInvocable
          com.tangosol.coherence.weblogic.PortalCacheProvider.FlushAgent

All Implemented Interfaces:

ExternalizableLite, Invocable, InvocableInOrder, PriorityTask, java.io.Serializable, java.lang.Runnable

Enclosing class:

PortalCacheProvider

public static class PortalCacheProvider.FlushAgent
extends AbstractInvocable
implements ExternalizableLite

Invocable implementation that is used to flush a Cache instance located on one or more remote cluster nodes.

Field Summary

protected java.lang.Object	m_oKey The optional key to flush.
protected java.lang.String	m_sName The name of the Cache to flush.
protected java.lang.String	m_sScopeId The scope identifier of the CacheProvider that created this FlushAgent.

Fields inherited from interface com.tangosol.net.PriorityTask

SCHEDULE_FIRST, SCHEDULE_IMMEDIATE, SCHEDULE_STANDARD, TIMEOUT_DEFAULT, TIMEOUT_NONE

Constructor Summary

	PortalCacheProvider.FlushAgent() Default constructor necessary for ExternalizableLite support.
protected	PortalCacheProvider.FlushAgent(java.lang.String sName, java.lang.Object oKey, java.lang.String sScopeId) Create a new FlushAgent that can be used to flush the Cache with the given name.

Method Summary

protected java.lang.String	getCacheName() Return the name of the Cache to flush.
protected java.lang.String	getDescription() Return a string representation of this EntryInfo's attributes.
protected java.lang.Object	getKey() Return the optional key to flush.
protected java.lang.Object	getScopeIdentifier() Return the scope identifier of the CacheProvider that created this FlushAgent.
void	init(InvocationService service) Called by the InvocationService exactly once on this Invocable object as part of its initialization.
void	readExternal(java.io.DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object.
void	run() Called exactly once by the InvocationService to invoke this Invocable object.
java.lang.String	toString() Return a human readable description of this FlushAgent object.
void	writeExternal(java.io.DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class com.tangosol.net.AbstractInvocable

getExecutionTimeoutMillis, getRequestTimeoutMillis, getResult, getSchedulingPriority, getService, isRespondInOrder, runCanceled, setResult

Field Detail

m_sName

protected java.lang.String m_sName

The name of the Cache to flush.

m_oKey

protected java.lang.Object m_oKey

The optional key to flush.

m_sScopeId

protected java.lang.String m_sScopeId

The scope identifier of the CacheProvider that created this FlushAgent.

Constructor Detail

PortalCacheProvider.FlushAgent

public PortalCacheProvider.FlushAgent()

Default constructor necessary for ExternalizableLite support.

PortalCacheProvider.FlushAgent

protected PortalCacheProvider.FlushAgent(java.lang.String sName,
                                         java.lang.Object oKey,
                                         java.lang.String sScopeId)

Create a new FlushAgent that can be used to flush the Cache with the given name.

Parameters:

sName - the name of the Cache to flush; must not be null

oKey - an optional key; if non-null, only the Cache entry with the given key will be flushed

sScopeId - the scope identifier of the CacheProvider that is creating this FlushAgent

Method Detail

init

public void init(InvocationService service)

Called by the InvocationService exactly once on this Invocable object as part of its initialization.

Specified by:

init in interface Invocable

Overrides:

init in class AbstractInvocable

Parameters:

service - the containing InvocationService

run

public void run()

Called exactly once by the InvocationService to invoke this Invocable object.

Specified by:

run in interface Invocable

Specified by:

run in interface java.lang.Runnable

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException

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:

java.io.IOException - if an I/O exception occurs

java.io.NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException

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:

java.io.IOException - if an I/O exception occurs

toString

public java.lang.String toString()

Return a human readable description of this FlushAgent object.

Returns:

a human readable description of this FlushAgent object

getDescription

protected java.lang.String getDescription()

Return a string representation of this EntryInfo's attributes.

Returns:

a string representation of this EntryInfo's attributes

getCacheName

protected java.lang.String getCacheName()

Return the name of the Cache to flush.

Returns:

the name of the Cache

getKey

protected java.lang.Object getKey()

Return the optional key to flush.

Returns:

the optional key

getScopeIdentifier

protected java.lang.Object getScopeIdentifier()

Return the scope identifier of the CacheProvider that created this FlushAgent.

Returns:

the scope identifier