oracle.sdp.daf.action.api

Interface Action<T>

Type Parameters:

T - The configuration bean type. Must be a bean.

All Known Subinterfaces:

ConfigManipulatorAction<T>

public interface Action<T>

Action interface.

Method Summary

Modifier and Type	Method and Description
default void	destroy() Destruction.
void	init(T configuration, oracle.sdp.daf.config.ApiConfiguration apiConfiguration) Initialization.
void	process(HttpContext context) Process the request.
default void	update(T configuration, oracle.sdp.daf.config.ApiConfiguration apiConfiguration) Update.

Method Detail

init

void init(T configuration,
          oracle.sdp.daf.config.ApiConfiguration apiConfiguration)
   throws ActionConfigurationException

Initialization. The action gets called with its configuration.

Parameters:

configuration - The configuration that should be initialized in the action

apiConfiguration - The configuration of the api. A clone will be provided to the action, so changing it serves no purpose.

Throws:

ActionConfigurationException - Any configuration exception that occurred while initializing the action. Used to validate the configuration.

process

void process(HttpContext context)
      throws ActionProcessingError

Process the request.

Parameters:

context - The context

Throws:

ActionProcessingError - Exception when processing

update

default void update(T configuration,
                    oracle.sdp.daf.config.ApiConfiguration apiConfiguration)
             throws ActionConfigurationException

Update. This method gets called when configuration is changed for the action. The default method will call init function to initialize (Set configuration parameter for example). Customer can overwrite this update function.

Parameters:

configuration - The configuration that should be updated in the action

apiConfiguration - The configuration of the api. A clone will be provided to the action, so changing it serves no purpose.

Throws:

ActionConfigurationException - Exception when updating

destroy

default void destroy()

Destruction. This method gets called when the action is removed from API. The default method do nothing. Customer can overwrite this function.