com.tailf.dp.annotations

Class SnmpInformResponseCallbackProxy

Object

com.tailf.dp.annotations.SnmpInformResponseCallbackProxy

All Implemented Interfaces:

DpSnmpInformResponseCallback

public class SnmpInformResponseCallbackProxy
extends Object
implements DpSnmpInformResponseCallback

Callback proxy for SnmpInformResponse Callbacks. Implements the DpSnmpInformResponseCallback interface and delegates calls to the registered callback POJO with annotated methods

Since:

3.2.0

Constructor Summary

Constructors

Constructor and Description
SnmpInformResponseCallbackProxy(Object backupObject, String callPoint) Constructor for Callback proxys.

Method Summary

Modifier and Type	Method and Description
void	addActionCapability(SnmpInformResponseCBType informCBType) Add action capability from annotated callType used to register capabilities on the server
void	addActionMethod(String name, Method method) Add callback action method to proxy
Object	getBackupObject() Retrieve the callback POJO
String	getCallPoint() Retrieve the callback callpoint
static SnmpInformResponseCallbackProxy[]	getSnmpInformResponseCallbackProxys(Object obj) Get array of proxy objects from registered POJO callback.
String	id() The id of the SNMP inform callback.
int	mask()
void	result(Integer ref, ConfETuple target, Boolean gotResponse) This callback provides the application with possibility to to take actions based on the result of an inform request for a specific receiver.
void	targets(Integer ref, ConfETuple[] targets) This callback provides the application with possibility to to take actions based on the intended targets of an inform request.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnmpInformResponseCallbackProxy

public SnmpInformResponseCallbackProxy(Object backupObject,
                                       String callPoint)

Constructor for Callback proxys. Used internally.

Parameters:

backupObject - registered callback POJO

callPoint - string describing the callpoint for this callback

Method Detail

getBackupObject

public Object getBackupObject()

Retrieve the callback POJO

Returns:

Object registered callback object

getCallPoint

public String getCallPoint()

Retrieve the callback callpoint

Returns:

callpoint string

addActionMethod

public void addActionMethod(String name,
                            Method method)

Add callback action method to proxy

Parameters:

name - canonical action name

method - registered callback method

addActionCapability

public void addActionCapability(SnmpInformResponseCBType informCBType)

Add action capability from annotated callType used to register capabilities on the server

Parameters:

informCBType - action type

getSnmpInformResponseCallbackProxys

public static SnmpInformResponseCallbackProxy[] getSnmpInformResponseCallbackProxys(Object obj)
                                                                             throws DpCallbackException

Get array of proxy objects from registered POJO callback. Used internally at callback registration

Parameters:

obj - registered callback POJO

Returns:

array of SnmpInformResponseCallbackProxy

Throws:

DpCallbackException

id

public String id()

Description copied from interface: DpSnmpInformResponseCallback

The id of the SNMP inform callback.

Specified by:

id in interface DpSnmpInformResponseCallback

mask

public int mask()

Specified by:

mask in interface DpSnmpInformResponseCallback

result

public void result(Integer ref,
                   ConfETuple target,
                   Boolean gotResponse)
            throws DpCallbackException

Description copied from interface: DpSnmpInformResponseCallback

This callback provides the application with possibility to to take actions based on the result of an inform request for a specific receiver.

Specified by:

result in interface DpSnmpInformResponseCallback

Parameters:

ref - A reference assigned by the caller of the SNMP inform request @see DpSnmpNotifier.send(String, com.tailf.conf.SnmpVarbind[], Integer)

target - the receiver returning the result.

gotResponse - if we got a response or not from the target.

Throws:

DpCallbackException - Callback method failed.

targets

public void targets(Integer ref,
                    ConfETuple[] targets)
             throws DpCallbackException

Description copied from interface: DpSnmpInformResponseCallback

This callback provides the application with possibility to to take actions based on the intended targets of an inform request.

Specified by:

targets in interface DpSnmpInformResponseCallback

Parameters:

ref - A reference assigned by the

targets - the intended receivers of the inform request.

Throws:

DpCallbackException - Callback method failed.