Hook Modules

use strict;
use warnings;

# PER QUERY GLOBAL HOOKS

# Global "start" hook.
# CALLED: After all Jarvis setup is complete.
sub hook::ExampleGlobalHook::start {
    my ($jconfig, $hook_params_href) = @_;
    return 1;
}

# Global "return_status" hook.
# CALLED: Before returning result of a "__status" request.
sub hook::ExampleGlobalHook::return_status {
    my ($jconfig, $hook_params_href, $extra_href, $return_text_aref) = @_;

    return 1;
}

# "return_fetch" hook.
# CALLED: Before returning result of a “fetch” request.
sub hook::ExampleGlobalHook::return_fetch {
    my ($jconfig, $hook_params_href, $user_args_href, $rows_aref,
                  $extra_href, $return_text_aref) = @_;
    return 1;
}

# "return_store" hook.
# CALLED: Just before returning result of a "store" request.
sub hook::ExampleGlobalHook::return_store {
    my ($jconfig, $hook_params_href, $user_args_href, $results_aref,
                  $extra_href, $return_text_aref) = @_;
    return 1;
}

# "finish" hook.
# CALLED: After Jarvis processing is complete, at cleanup time.
sub hook::ExampleGlobalHook::finish {
    my ($jconfig, $hook_params_href) = @_;
    return 1;
}

# UTILITY GLOBAL HOOKS

# "after_login" hook.
# CALLED: After first login for the session.
sub hook::ExampleGlobalHook::start {
    my ($jconfig, $hook_params_href, $additional_safe_href) = @_;
    return 1;
}

# "before_logout" hook.
# CALLED: Before explicit session logout by the client
sub hook::ExampleGlobalHook::before_logout {
    my ($jconfig, $hook_params_href) = @_;
    return 1;
}

# "pre_connect" hook.
# CALLED: Before first connecting to each database.
sub hook::ExampleGlobalHook::pre_connect {
    my ($jconfig, $dbname, $dbtype, $dbconnect_ref, $dbusername_ref,
                  $dbpassword_ref, $parameters_href) = @_;
    return 1;
}

# PER-DATASET GLOBAL HOOKS

# "dataset_pre_fetch" hook.
# CALLED: ("fetch" only) Before constructing the fetch request.
sub hook::ExampleGlobalHook:: dataset_pre_fetch {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href) = @_;
    return 1;
}

# "dataset_pre_store" hook.
# CALLED: ("store" only) Before constructing the store request.
sub hook::ExampleGlobalHook:: dataset_pre_store {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href,
                  $rows_aref) = @_;
    return 1;
}

# "before_all" hook.
# CALLED: ("store" only) After transaction begins.  Before any "before" SQL.
sub hook::ExampleGlobalHook::before_all {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href,
                  $fields_aref) = @_;
    return 1;
}

# "after_all" hook.
# CALLED: ("store" only) After any "after" SQL.  Before transaction ends.
sub hook::ExampleGlobalHook::after_all {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href, $fields_aref,
                  $results_aref) = @_;
    return 1;
}

# "dataset_fetched" hook.
# CALLED: ("fetch" only) After fetching results array for a single dataset.
sub hook::ExampleGlobalHook::dataset_fetched {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href, $rows_aref,
                  $extra_href, $column_names_aref) = @_;
    return 1;
}

# "dataset_stored" hook.
# CALLED: ("store" only) After storing results array for a single dataset.
sub hook::ExampleGlobalHook::dataset_stored {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href,
                  $results_aref, $extra_href, $success_ref, $message_ref) = @_;
    return 1;
}

# PER-ROW GLOBAL HOOKS

# "before_one" hook.
# CALLED: ("store" only) Before we execute the row insert/update/delete SQL.
sub hook::ExampleGlobalHook::before_one {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href) = @_;
    return 1;
}

# "after_one" hook.
# CALLED: ("store" only) After insert/update/delete and "returning" extraction.
sub hook::ExampleGlobalHook::after_one {
    my ($jconfig, $hook_params_href, $dsxml, $safe_params_href,
                  $row_result_href) = @_;
    return 1;
}

1;

use strict;
use warnings;

# PER-DATASET DATASET HOOKS

# Dataset "start" hook.
# CALLED: ("fetch" AND "store") Just after loading dataset config.
sub hook::ExampleGlobalHook::start {
    my ($jconfig, $hook_params_href, $dsxml) = @_;
    return 1;
}

# Others: Same as the Global Hooks of the same name.
# sub dataset_pre_fetch ()
# sub dataset_pre_store ()
# sub before_all ()
# sub after_all ()
# sub dataset_fetched ()
# sub dataset_stored ()

# PER-ROW DATASET HOOKS

# Same as the Global Hooks of the same name.
# sub before_one ()
# sub after_one ()

1;

$jconfig->{status} = '404 Not Found';
die "Hook cannot continue, moon not found in expected phase.\n";

&Jarvis::Config::add_http_headers ($jconfig, { ‘key’ => ‘value’ };