com.tailf.dp.annotations

Class ServiceCallbackProxy

Object

com.tailf.dp.annotations.ServiceCallbackProxy

All Implemented Interfaces:

DpServiceCallback

public class ServiceCallbackProxy
extends Object
implements DpServiceCallback

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

Field Summary

Fields inherited from interface com.tailf.dp.DpServiceCallback

M_CREATE, M_DELETE, M_POST_MODIFICATION, M_PRE_LOCK_CREATE, M_PRE_MODIFICATION, M_UPDATE

Constructor Summary

Constructors

Constructor and Description
ServiceCallbackProxy(Object backupObject, String servicePoint) Constructor for Callback proxys.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionCapability(ServiceCBType serviceCBType) 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
Properties	create(ServiceContext context, NavuNode service, NavuNode root, Properties opaque) Create callback method.
Properties	delete(ServiceContext context, NavuNode root, Properties opaque)
Object	getBackupObject() Retrieve the callback POJO
static ServiceCallbackProxy[]	getServiceCallbackProxys(Object obj) Get array of proxy objects from registered POJO callback.
String	getServicePoint() Retrieve the callback servicepoint
int	mask() Mask of flags for each method that is supported by this callback: DpServiceCallback.M_CREATE DpServiceCallback.M_UPDATE DpServiceCallback.M_DELETE DpServiceCallback.M_PRE_MODIFICATION DpServiceCallback.M_POST_MODIFICATION
Properties	postModification(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) Post modification callback If registered this method will be called after a CREATE, UPDATE or DELETE of the service.
Properties	preLockCreate(ServiceContext context, NavuNode service, NavuNode root, Properties opaque) pre lock create callback method.
Properties	preModification(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) Pre modification callback If registered this method will be called before a CREATE, UPDATE or DELETE of the service.
String	servicepoint() The name of the servicepoint
Properties	update(ServiceContext context, NavuNode service, NavuNode root, Properties opaque)

Methods inherited from class Object

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

Constructor Detail

ServiceCallbackProxy

public ServiceCallbackProxy(Object backupObject,
                    String servicePoint)

Constructor for Callback proxys. Used internally.

Parameters:

backupObject - registered callback POJO

servicePoint - string describing the servicepoint for this callback

Method Detail

addActionCapability

public void addActionCapability(ServiceCBType serviceCBType)

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

Parameters:

serviceCBType - action type

addActionMethod

public void addActionMethod(String name,
                   Method method)

Add callback action method to proxy

Parameters:

name - canonical action name

method - registered callback method

create

public Properties create(ServiceContext context,
                NavuNode service,
                NavuNode root,
                Properties opaque)
                  throws DpCallbackException

Description copied from interface: DpServiceCallback

Create callback method. This method is called when a service instance committed due to a create or update event. This method returns a opaque as a Properties object that can be null. If not null it is stored persistently by Ncs. This object is then delivered as argument to new calls of the create method for this service (fastmap algorithm). This way the user can store and later modify persistent data outside the service model that might be needed.

Specified by:

create in interface DpServiceCallback

Parameters:

context - - The current ServiceContext object

service - - The NavuNode references the service node.

root - - This NavuNode references the ncs root.

opaque - - Parameter contains a Properties object. This object may be used to transfer additional information between consecutive calls to the create callback. It is always null in the first call. I.e. when the service is first created.

Returns:

Properties the returning opaque instance

Throws:

DpCallbackException

delete

public Properties delete(ServiceContext context,
                NavuNode root,
                Properties opaque)
                  throws DpCallbackException

Throws:

DpCallbackException

getBackupObject

public Object getBackupObject()

Retrieve the callback POJO

Returns:

Object registered callback object

getServiceCallbackProxys

public static ServiceCallbackProxy[] getServiceCallbackProxys(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 ServCallbackProxy

Throws:

DpCallbackException

getServicePoint

public String getServicePoint()

Retrieve the callback servicepoint

Returns:

servicepoint string

mask

public int mask()

Description copied from interface: DpServiceCallback

Mask of flags for each method that is supported by this callback:

• DpServiceCallback.M_CREATE
• DpServiceCallback.M_UPDATE
• DpServiceCallback.M_DELETE
• DpServiceCallback.M_PRE_MODIFICATION
• DpServiceCallback.M_POST_MODIFICATION

Specified by:

mask in interface DpServiceCallback

postModification

public Properties postModification(ServiceContext context,
                          ServiceOperationType operation,
                          ConfPath path,
                          Properties opaque)
                            throws DpCallbackException

Description copied from interface: DpServiceCallback

Post modification callback If registered this method will be called after a CREATE, UPDATE or DELETE of the service. This is also called with a service context that is of the original transaction. This implies that changes written into this transaction will stay persistent outside of the fastmap algorithm. I.e. will be left untouched by the fastmap algorithm. This can be useful e.g. for allocations that should be stored and existing also when the service instance is removed.

Specified by:

postModification in interface DpServiceCallback

Parameters:

context - - The current ServiceContext object

operation - - Type of operation (CREATE,UPDATE,DELETE)

path - - ConfPath object referring to the services path

opaque - - Parameter contains a Properties object. This object may be used to transfer additional information between consecutive calls to the create callback. It is always null in the first call. I.e. when the service is first created.

Returns:

Properties - the returning opaque instance

Throws:

DpCallbackException

preLockCreate

public Properties preLockCreate(ServiceContext context,
                       NavuNode service,
                       NavuNode root,
                       Properties opaque)
                         throws DpCallbackException

Description copied from interface: DpServiceCallback

pre lock create callback method. This method is called when a service instance committed due to a create or update event in the same way as the create() callback. The difference being that this method is called outside of the transaction lock of the current transaction making it parallel to other pre_lock_create() service calls. Care must be taken by the programmer so that the preLockCreate() is designed in a thread safe manner. This method returns a opaque as a Properties object that can be null. If not null it is stored persistently by Ncs. This object is then delivered as argument to new calls of the create method for this service (fastmap algorithm). This way the user can store and later modify persistent data outside the service model that might be needed.

Specified by:

preLockCreate in interface DpServiceCallback

Parameters:

context - - The current ServiceContext object

service - - The NavuNode references the service node.

root - - This NavuNode references the ncs root.

opaque - - Parameter contains a Properties object. This object may be used to transfer additional information between consecutive calls to the create callback. It is always null in the first call. I.e. when the service is first created.

Returns:

Properties the returning opaque instance

Throws:

DpCallbackException

preModification

public Properties preModification(ServiceContext context,
                         ServiceOperationType operation,
                         ConfPath path,
                         Properties opaque)
                           throws DpCallbackException

Description copied from interface: DpServiceCallback

Pre modification callback If registered this method will be called before a CREATE, UPDATE or DELETE of the service. This is also called with a service context that is of the original transaction. This implies that changes written into this transaction will stay persistent outside of the fastmap algorithm. I.e. will be left untouched by the fastmap algorithm. This can be useful e.g. for allocations that should be stored and existing also when the service instance is removed.

Specified by:

preModification in interface DpServiceCallback

Parameters:

context - - The current ServiceContext object

operation - - Type of operation (CREATE,UPDATE,DELETE)

path - - ConfPath object referring to the services path

opaque - - Parameter contains a Properties object. This object may be used to transfer additional information between consecutive calls to the create callback. It is always null in the first call. I.e. when the service is first created.

Returns:

Properties - the returning opaque instance

Throws:

DpCallbackException

servicepoint

public String servicepoint()

Description copied from interface: DpServiceCallback

The name of the servicepoint

Specified by:

servicepoint in interface DpServiceCallback

update

public Properties update(ServiceContext context,
                NavuNode service,
                NavuNode root,
                Properties opaque)
                  throws DpCallbackException

Throws:

DpCallbackException