/usr/include/axis2-1.6.0/axis2_conf_ctx.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | /*
* 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_CONF_CTX_H
#define AXIS2_CONF_CTX_H
/**
* @defgroup axis2_conf_ctx configuration context
* @ingroup axis2_context
* configuration context is the holder for all the state information
* related to configuration. It holds all the service group context, service
* context and operation context that exists within an engine instance.
* An engine instance has only one configuration context associated with it
* (Singleton pattern).
* @{
*/
/**
* @file axis2_conf_ctx.h
*/
#include <axis2_defines.h>
#include <axutil_hash.h>
#include <axutil_env.h>
#include <axis2_ctx.h>
#include <axis2_svc_grp_ctx.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_conf_ctx */
typedef struct axis2_conf_ctx axis2_conf_ctx_t;
struct axis2_conf;
/**
* Creates a configuration context struct instance.
* @param env pointer to environment struct
* @param conf pointer to configuration, configuration context assumes
* ownership of the configuration
* @return pointer to newly created configuration context
*/
AXIS2_EXTERN axis2_conf_ctx_t *AXIS2_CALL
axis2_conf_ctx_create(
const axutil_env_t * env,
struct axis2_conf *conf);
/**
* Sets the configuration associated with the engine instance.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param conf pointer to configuration
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_set_conf(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
struct axis2_conf *conf);
/**
* Gets the base struct, which is of type context
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to context struct, returns a reference not a cloned
* copy
*/
AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL
axis2_conf_ctx_get_base(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Gets the configuration of the engine.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to configuration struct, returns a reference not a
* cloned copy
*/
AXIS2_EXTERN axis2_conf_t *AXIS2_CALL
axis2_conf_ctx_get_conf(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Gets the hash map of operation context instances.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to hash map containing all operation contexts
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_ctx_get_op_ctx_map(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Gets the hash map of service context instances.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to hash map containing all service contexts
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_ctx_get_svc_ctx_map(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Gets the hash map of service group context instances.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to hash map containing all service group contexts
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_ctx_get_svc_grp_ctx_map(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Registers an operation context with the given message ID.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param message_id message id related to the operation context
* @param op_ctx pointer to operation context, conf context assumes
* ownership of the operation context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_register_op_ctx(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * message_id,
axis2_op_ctx_t * op_ctx);
/**
* Gets operation context corresponding to the given message ID.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param message_id message ID related to the operation to be retrieved
* @return pointer to operation context related to the given message ID
*/
AXIS2_EXTERN axis2_op_ctx_t *AXIS2_CALL
axis2_conf_ctx_get_op_ctx(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * message_id);
/**
* Registers a service context with the given service ID.
* @param conf_ctx pointer t configuration context
* @param env pointer to environment struct
* @param svc_id ID of the service to be added
* @param svc_ctx pointer to service context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_register_svc_ctx(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * svc_id,
axis2_svc_ctx_t * svc_ctx);
/**
* Gets service context with the given service ID
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param svc_id service ID
* @return pointer to service context with the given service ID
*/
AXIS2_EXTERN struct axis2_svc_ctx *AXIS2_CALL
axis2_conf_ctx_get_svc_ctx(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * svc_id);
/**
* Registers a service group context with the given service group ID.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param svc_grp_id service group id
* @param svc_grp_ctx pointer to service group context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_register_svc_grp_ctx(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * svc_grp_id,
axis2_svc_grp_ctx_t * svc_grp_ctx);
/**
* Gets service group with the given service group ID.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param svc_grp_id service group id
* @return pointer to service group context with the given ID
*/
AXIS2_EXTERN axis2_svc_grp_ctx_t *AXIS2_CALL
axis2_conf_ctx_get_svc_grp_ctx(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * svc_grp_id);
/**
* Gets the root working directory. It is in this directory that the
* axis2.xml configuration file is located. The services and modules
* sub folders too are located in this directory.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return pointer to string containing the root folder name
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_conf_ctx_get_root_dir(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* Sets the root working directory. It is in this directory that the
* axis2.xml configuration file is located. The services and modules
* sub folders too are located in this directory.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param path string containing the path of root directory
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_set_root_dir(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * path);
/**
* Initializes the configuration context. Within this function, it would
* initialize all the service group context, service context and
* operation context instances stored within configuration context.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param conf pointer to configuration struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_init(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
axis2_conf_t * conf);
/**
* Frees configuration context struct.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_conf_ctx_free(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env);
/**
* This method fills the context hierarchy (service group, service and
* operation contexts that is) for the service and operation found in
* the given message context. If the context hierarchy is not already
* built it will create the contexts and build the context hierarchy.
* @param conf_ctx pointer to configuration context
* @param env pointer to environment struct
* @param msg_ctx pointer to message context with service and operation
* for which the context hierarchy is to be built set
* @return pointer to the service group context, which is the root of
* the context hierarchy for given service and operation
*/
AXIS2_EXTERN axis2_svc_grp_ctx_t *AXIS2_CALL
axis2_conf_ctx_fill_ctxs(
axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
axis2_msg_ctx_t * msg_ctx);
/**
* Sets a property with the given key.
* @param ctx pointer to context struct
* @param env pointer to environment struct
* @param key key string to store the property with
* @param value pointer to property to be stored, context assumes the
* ownership of the property
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_ctx_set_property(
axis2_conf_ctx_t *conf_ctx,
const axutil_env_t * env,
const axis2_char_t * key,
axutil_property_t * value);
/**
* Gets the property with the given key.
* @param ctx pointer to context struct
* @param env pointer to environment struct
* @param key key string
* @return pointer to property struct corresponding to the given key
*/
AXIS2_EXTERN axutil_property_t *AXIS2_CALL
axis2_conf_ctx_get_property(
const axis2_conf_ctx_t * conf_ctx,
const axutil_env_t * env,
const axis2_char_t * key);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_CONF_CTX_H */
|