| /* |
| * 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_SVC_CTX_H |
| #define AXIS2_SVC_CTX_H |
| |
| /** |
| * @defgroup axis2_svc_ctx service context |
| * @ingroup axis2_context |
| * service context represents a running "instance" of a service. |
| * service context allows instance of operations belonging to a service to be |
| * grouped. |
| * @{ |
| */ |
| |
| /** |
| * @file axis2_svc_ctx.h |
| */ |
| |
| #include <axis2_defines.h> |
| #include <axis2_env.h> |
| #include <axis2_op_ctx.h> |
| |
| #ifdef __cplusplus |
| extern "C" |
| { |
| #endif |
| |
| |
| /** Type name for struct axis2_svc_ctx_ops */ |
| typedef struct axis2_svc_ctx_ops axis2_svc_ctx_ops_t; |
| /** Type name for struct axis2_svc_ctx */ |
| typedef struct axis2_svc_ctx axis2_svc_ctx_t; |
| |
| |
| /** |
| * service context ops struct. |
| * Encapsulator struct for ops of axis2_svc_ctx. |
| */ |
| struct axis2_svc_ctx_ops |
| { |
| /** |
| * Gets base which is of type context. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return pointer to context, returns a reference, not a cloned copy |
| */ |
| axis2_ctx_t *(AXIS2_CALL * |
| get_base)( |
| const axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env); |
| |
| |
| /** |
| * Gets parent which is of type service group context. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return pointer to parent service group context |
| */ |
| struct axis2_svc_grp_ctx *(AXIS2_CALL * |
| get_parent)( |
| const axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env); |
| |
| |
| /** |
| * Frees service context instance. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| free)( |
| struct axis2_svc_ctx *svc_ctx, |
| const axis2_env_t *env); |
| |
| |
| /** |
| * Initializes service context. This method locates the corresponding |
| * service that is related to the service context from configuration |
| * using service qname and keeps a reference to it for future use. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @param conf pointer to configuration |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| init)( |
| struct axis2_svc_ctx *svc_ctx, |
| const axis2_env_t *env, |
| struct axis2_conf *conf); |
| |
| /** |
| * Gets the ID of the service that this service context is an instance |
| * of. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return service ID string. |
| */ |
| const axis2_char_t *(AXIS2_CALL * |
| get_svc_id)( |
| const axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env); |
| |
| |
| /** |
| * Gets the service that this service context represents. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return pointer to service, returns a reference, not a cloned copy |
| */ |
| struct axis2_svc *(AXIS2_CALL * |
| get_svc)( |
| const axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env); |
| |
| /** |
| * Sets the service that this service context represents. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @param svc pointer to service struct, service context does not assume |
| * the ownership of the struct |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| set_svc)( |
| axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env, |
| struct axis2_svc *svc); |
| |
| |
| /** |
| * Gets configuration context which is the super root (super most parent) |
| * of the context hierarchy to which this service context belongs. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @return pointer to configuration context |
| */ |
| struct axis2_conf_ctx *(AXIS2_CALL * |
| get_conf_ctx)( |
| const axis2_svc_ctx_t *svc_ctx, |
| const axis2_env_t *env); |
| |
| |
| /** |
| * Creates an operation context for the named operation. The named |
| * operation should be one of the operations in the service related |
| * to this service context. |
| * @param svc_ctx pointer to service context |
| * @param env pointer to environment struct |
| * @param qname pointer to qname that represents the operation name. |
| * @return pointer to operation context |
| */ |
| struct axis2_op_ctx *(AXIS2_CALL * |
| create_op_ctx)( |
| struct axis2_svc_ctx *svc_ctx, |
| const axis2_env_t *env, |
| const axis2_qname_t *qname); |
| }; |
| |
| /** |
| * service context struct. |
| */ |
| struct axis2_svc_ctx |
| { |
| /** operations of service context */ |
| axis2_svc_ctx_ops_t *ops; |
| }; |
| |
| /** |
| * Creates a service context struct that corresponds to the given service |
| * and with the given parent service group context. |
| * @param env pointer to environment struct |
| * @param svc pointer to service that this service context represents, |
| * service context does not assume the ownership of service |
| * @param svc_grp_ctx pointer to service group context, the parent of the |
| * newly created service context. service context does not assume the |
| * ownership of parent |
| * @return pointer to newly created service context |
| */ |
| AXIS2_EXTERN axis2_svc_ctx_t *AXIS2_CALL |
| axis2_svc_ctx_create( |
| const axis2_env_t *env, |
| struct axis2_svc *svc, |
| struct axis2_svc_grp_ctx *svc_grp_ctx); |
| |
| |
| /** Gets base which is of type context. |
| @sa axis2_svc_ctx_ops#get_base */ |
| #define AXIS2_SVC_CTX_GET_BASE(svc_ctx, env) \ |
| ((svc_ctx)->ops->get_base(svc_ctx, env)) |
| |
| /** Gets parent which is of type service group context. |
| @sa axis2_svc_ctx_ops#get_parent */ |
| #define AXIS2_SVC_CTX_GET_PARENT(svc_ctx, env) \ |
| ((svc_ctx)->ops->get_parent(svc_ctx, env)) |
| |
| /** Frees service context. |
| @sa axis2_svc_ctx_ops#free */ |
| #define AXIS2_SVC_CTX_FREE(svc_ctx, env) \ |
| ((svc_ctx)->ops->free(svc_ctx, env)) |
| |
| /** Initializes service context. |
| @sa axis2_svc_ctx_ops#init */ |
| #define AXIS2_SVC_CTX_INIT(svc_ctx, env, conf) \ |
| ((svc_ctx)->ops->init(svc_ctx, env, conf)) |
| |
| /** Gets service id of the related service. |
| @sa axis2_svc_ctx_ops#get_svc_id */ |
| #define AXIS2_SVC_CTX_GET_SVC_ID(svc_ctx, env) \ |
| ((svc_ctx)->ops->get_svc_id(svc_ctx, env)) |
| |
| /** Gets service that this service context is an instance of. |
| @sa axis2_svc_ctx_ops#get_svc */ |
| #define AXIS2_SVC_CTX_GET_SVC(svc_ctx, env) \ |
| ((svc_ctx)->ops->get_svc(svc_ctx, env)) |
| |
| /** Sets service that this service context is an instance of.. |
| @sa axis2_svc_ctx_ops#set_svc */ |
| #define AXIS2_SVC_CTX_SET_SVC(svc_ctx, env, svc) \ |
| ((svc_ctx)->ops->set_svc(svc_ctx, env, svc)) |
| |
| /** Gets configuration context. |
| @sa axis2_svc_ctx_ops#get_conf_ctx */ |
| #define AXIS2_SVC_CTX_GET_CONF_CTX(svc_ctx, env) \ |
| ((svc_ctx)->ops->get_conf_ctx(svc_ctx, env)) |
| |
| /** Creates operation context for the named service. |
| @sa axis2_svc_ctx_ops#create_op_ctx */ |
| #define AXIS2_SVC_CTX_CREATE_OP_CTX(svc_ctx, env, qname) \ |
| ((svc_ctx)->ops->create_op_ctx(svc_ctx, env, qname)) |
| |
| /** @} */ |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* AXIS2_SVC_CTX_H */ |