Module org.snmp4j.agent

Package org.snmp4j.agent

Class MOServerLookupEvent

java.lang.Object

java.util.EventObject

org.snmp4j.agent.MOServerLookupEvent

All Implemented Interfaces:

Serializable

public class MOServerLookupEvent
extends EventObject

A MOServerLookupEvent describes a lookup of a managed object within a MOServer repository. Such an event can be used to update ManagedObjects before they are accessed and processed by a command responder (agent).

Version:

3.1.0

Author:

Frank Fock

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MOServerLookupEvent.IntendedUse

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
MOServerLookupEvent(Object source, ManagedObject<?> lookupResult, MOQuery query, MOServerLookupEvent.IntendedUse intendedUse)
MOServerLookupEvent(Object source, ManagedObject<?> lookupResult, MOQuery query, MOServerLookupEvent.IntendedUse intendedUse, boolean withCompletionCallback)

Method Summary

Modifier and Type	Method	Description
boolean	addCompletionListener(MOServerLookupListener lookupCompletionListener)
void	completedUse(Object result)
MOServerLookupEvent.IntendedUse	getIntendedUse()	Returns the intended use that triggered the lookup event.
ManagedObject<?>	getLookupResult()	Returns the ManagedObject that has been looked up.
MOQuery	getQuery()	Returns the query that has been used to lookup the managed object.
boolean	isCompletionCallbackAvailable()
boolean	removeCompletionListener(MOServerLookupListener lookupCompletionListener)
void	setLookupResult(ManagedObject<?> lookupResult)	Sets the lookup result after construction, for example, if the value is not yet known at construction time.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MOServerLookupEvent

public MOServerLookupEvent(Object source,
                           ManagedObject<?> lookupResult,
                           MOQuery query,
                           MOServerLookupEvent.IntendedUse intendedUse)

MOServerLookupEvent

public MOServerLookupEvent(Object source,
                           ManagedObject<?> lookupResult,
                           MOQuery query,
                           MOServerLookupEvent.IntendedUse intendedUse,
                           boolean withCompletionCallback)

Method Detail

getLookupResult

public ManagedObject<?> getLookupResult()

Returns the ManagedObject that has been looked up.

Returns:

a ManagedObject.

setLookupResult

public void setLookupResult(ManagedObject<?> lookupResult)

Sets the lookup result after construction, for example, if the value is not yet known at construction time.

Parameters:

lookupResult - a managed object that has been looked up by a MOServer.

Since:

3.0

getQuery

public MOQuery getQuery()

Returns the query that has been used to lookup the managed object.

Returns:

a MOQuery instance that triggered the event.

getIntendedUse

public MOServerLookupEvent.IntendedUse getIntendedUse()

Returns the intended use that triggered the lookup event.

Returns:

the intended use or MOServerLookupEvent.IntendedUse.undefined if there is no information available about the intended use of the lookup results.

Since:

3.0

isCompletionCallbackAvailable

public boolean isCompletionCallbackAvailable()

addCompletionListener

public boolean addCompletionListener(MOServerLookupListener lookupCompletionListener)

removeCompletionListener

public boolean removeCompletionListener(MOServerLookupListener lookupCompletionListener)

completedUse

public void completedUse(Object result)