From 0425aadc78680e53000fd0108b540d6eca048516 Mon Sep 17 00:00:00 2001 From: gmcdonald Date: Sat, 13 Feb 2010 01:32:03 +0000 Subject: Moving axis svn, part of TLP move INFRA-2441 git-svn-id: http://svn.apache.org/repos/asf/axis/axis2/c/core/trunk@909681 13f79535-47bb-0310-9956-ffa450edef68 --- include/axis2_phases_info.h | 238 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 include/axis2_phases_info.h (limited to 'include/axis2_phases_info.h') diff --git a/include/axis2_phases_info.h b/include/axis2_phases_info.h new file mode 100644 index 0000000..9c1a1f7 --- /dev/null +++ b/include/axis2_phases_info.h @@ -0,0 +1,238 @@ + +/* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed with +* this work for additional information regarding copyright ownership. +* The ASF licenses this file to You under the Apache License, Version 2.0 +* (the "License"); you may not use this file except in compliance with +* the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#ifndef AXIS2_PHASES_INFO_H +#define AXIS2_PHASES_INFO_H + +/** @defgroup axis2_phases_info phases information + * @ingroup axis2_deployment + * + * In deployment engine when configuration builder parse phase order elements in axis2.xml, for + * phases defined in a phase order it will create a phase name list and add it to the phases + * info. There are four phase orders. inflow, outflow, in faultflow and out faultflow. + * So configuration builder add array lists for each of this phase orders into the phases info. + * + * At the time of module engagement phase resolver call the functions here to retrieve phase + * lists for each flow for the purpose of adding handlers. When such a request come what each + * function do is, create phase instances list for corresponding phase names stored in the phase name + * list for that flow and return. + * + * @{ + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** Type name for struct axis2_phases_info */ + typedef struct axis2_phases_info axis2_phases_info_t; + + /** Deallocate memory + * @param pahses_info pointer to phases info + * @param env pointer to environment struct + * @return void + */ + AXIS2_EXTERN void AXIS2_CALL + axis2_phases_info_free( + axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * Set the inflow phase names as an array list. These phases are defined in the inflow phase + * order element defined in axis2.xml. + * + * @param phases_info pointer to phases info + * @param env pointer to environment struct + * @param in_phases inter to in phases + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_phases_info_set_in_phases( + axis2_phases_info_t * phases_info, + const axutil_env_t * env, + axutil_array_list_t * in_phases); + + /** + * Set the outflow phase names as an array list. These phases are defined in the outflow phase + * order element defined in axis2.xml. + * + * @param phases_info pointer to phases info + * @param env pointer to environment struct + * @param out_phases pointer to out phases + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_phases_info_set_out_phases( + axis2_phases_info_t * phases_info, + const axutil_env_t * env, + axutil_array_list_t * out_phases); + + /** + * Set the INfaultflow phase names as an array list. These phases are defined in the INfaultflow + * phase order element defined in axis2.xml. + * + * @param phases_info pointer to phases info + * @param env pointer to environment struct + * @param in_faultphases pionter to in fault phases + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_phases_info_set_in_faultphases( + axis2_phases_info_t * phases_info, + const axutil_env_t * env, + axutil_array_list_t * in_faultphases); + + /** + * Set the Outfaultflow phase names as an array list. These phases are defined in the + * Outfaultflow phase order element defined in axis2.xml. + * + * @param phases_info pointer to phases info + * @param env pointer to env + * @param out_faultphases pointer to out fault phases + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_phases_info_set_out_faultphases( + axis2_phases_info_t * phases_info, + const axutil_env_t * env, + axutil_array_list_t * out_faultphases); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_in_phases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_out_phases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @parma env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_in_faultphases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_out_faultphases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_op_in_phases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_op_out_phases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_op_in_faultphases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + */ + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + + axis2_phases_info_get_op_out_faultphases( + const axis2_phases_info_t * phases_info, + const axutil_env_t * env); + + /** + * @param phases_info pointer to phases info + * @param env pointer to environment struct + * @param axis2_opt pointer to axis2 opt + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_phases_info_set_op_phases( + axis2_phases_info_t * phases_info, + const axutil_env_t * env, + struct axis2_op *axis2_opt); + + /** create Phases Info struct + * @param env pointer to environment struct + * @return pointer to newly created phases info + */ + AXIS2_EXTERN axis2_phases_info_t *AXIS2_CALL + axis2_phases_info_create( + const axutil_env_t * env); + + AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL + axis2_phases_info_copy_flow( + const axutil_env_t * env, + const axutil_array_list_t * flow_to_copy); + + /** @} */ +#ifdef __cplusplus +} +#endif + +#endif /*AXIS2_PHASES_INFO_H */ -- cgit v1.1-32-gdbae