| /* |
| * 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_NAME_H |
| #define AXIS2_SVC_NAME_H |
| |
| /** |
| * @defgroup axis2_svc_name service name |
| * @ingroup axis2_addr |
| * service name provides a full description of the service endpoint. service |
| * name contains a QName identifying the WSDL service element that contains |
| * the definition of the endpoint being conveyed. It also contains an optional |
| * non-qualified name that identifies the specific port in the service that |
| * corresponds to the endpoint. |
| * @{ |
| */ |
| |
| /** |
| * @file axis2_svc_name.h |
| */ |
| |
| #include <axis2_defines.h> |
| #include <axis2_env.h> |
| #include <axis2_const.h> |
| #include <axis2_qname.h> |
| |
| #ifdef __cplusplus |
| extern "C" |
| { |
| #endif |
| |
| /** Type name for struct axis2_svc_name */ |
| typedef struct axis2_svc_name axis2_svc_name_t; |
| /** Type name for struct axis2_svc_name_ops */ |
| typedef struct axis2_svc_name_ops axis2_svc_name_ops_t; |
| |
| |
| /** |
| * service name ops struct. |
| */ |
| struct axis2_svc_name_ops |
| { |
| /** |
| * Gets QName. QName identifies the WSDL service element that contains |
| * the definition of the endpoint being conveyed. |
| * @param svc_name pointer to service name struct |
| * @param env pointer to environment struct |
| * @return pointer to QName struct, returns a reference, not a cloned |
| * copy |
| */ |
| const axis2_qname_t *(AXIS2_CALL * |
| get_qname)( |
| const axis2_svc_name_t *svc_name, |
| const axis2_env_t *env); |
| |
| /** |
| * Sets QName. QName identifies the WSDL service element that contains |
| * the definition of the endpoint being conveyed. |
| * @param svc_name pointer to service name struct |
| * @param env pointer to environment struct |
| * @param qname pointer to QName, service name creates a clone of QName |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| set_qname)( |
| struct axis2_svc_name *svc_name, |
| const axis2_env_t *env, |
| const axis2_qname_t *qname); |
| |
| /** |
| * Gets endpoint name. Endpoint name is a non-qualified name that |
| * identifies the specific port in the service that corresponds to |
| * the endpoint. |
| * @param svc_name pointer to service name struct |
| * @param env pointer to environment struct |
| * @return endpoint name string |
| */ |
| const axis2_char_t *(AXIS2_CALL * |
| get_endpoint_name)( |
| const axis2_svc_name_t *svc_name, |
| const axis2_env_t *env); |
| |
| /** |
| * Sets endpoint name. Endpoint name is a non-qualified name that |
| * identifies the specific port in the service that corresponds to |
| * the endpoint. |
| * @param svc_name pointer to service name struct |
| * @param env pointer to environment struct |
| * @param endpoint_name endpoint name string |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| set_endpoint_name)( |
| struct axis2_svc_name *svc_name, |
| const axis2_env_t *env, |
| const axis2_char_t *endpoint_name); |
| |
| /** |
| * Frees service name struct. |
| * @param svc_name pointer to service name struct |
| * @param env pointer to environment struct |
| * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE |
| */ |
| axis2_status_t (AXIS2_CALL * |
| free)( |
| struct axis2_svc_name *svc_name, |
| const axis2_env_t *env); |
| |
| }; |
| |
| /** |
| * service name struct. |
| */ |
| struct axis2_svc_name |
| { |
| /** service name related ops */ |
| axis2_svc_name_ops_t *ops; |
| }; |
| |
| |
| /** |
| * Creates a service name struct with given QName and endpoint name. |
| * @param env pointer to environment struct |
| * @param qname pointer to QName, this method creates a clone of QName |
| * @param endpoint_name endpoint name string |
| * @return pointer to newly create service name struct |
| */ |
| AXIS2_EXTERN axis2_svc_name_t *AXIS2_CALL |
| axis2_svc_name_create( |
| const axis2_env_t *env, |
| const axis2_qname_t *qname, |
| const axis2_char_t *endpoint_name) ; |
| |
| /** Gets qualified name. |
| @sa axis2_svc_name_ops#get_qname */ |
| #define AXIS2_SVC_NAME_GET_QNAME(svc_name, env) \ |
| ((svc_name)->ops->get_qname(svc_name, env)) |
| |
| /** Sets Qname. |
| @sa axis2_svc_name_ops#set_qname */ |
| #define AXIS2_SVC_NAME_SET_QNAME(svc_name, env, qname) \ |
| ((svc_name)->ops->set_qname(svc_name, env, qname)) |
| |
| /** Gets endpoint name. |
| @sa axis2_svc_name_ops#get_endpoint_name */ |
| #define AXIS2_SVC_NAME_GET_ENDPOINT_NAME(svc_name, env) \ |
| ((svc_name)->ops->get_endpoint_name(svc_name, env)) |
| |
| /** Sets endpoint name. |
| @sa axis2_svc_name_ops#set_endpoint_name */ |
| #define AXIS2_SVC_NAME_SET_ENDPOINT_NAME(svc_name, env, endpoint_name) \ |
| ((svc_name)->ops->set_endpoint_name(svc_name, env, endpoint_name)) |
| |
| /** Frees service name. |
| @sa axis2_svc_name_ops#free */ |
| #define AXIS2_SVC_NAME_FREE(svc_name, env) \ |
| ((svc_name)->ops->free(svc_name, env)) |
| |
| /** @} */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* AXIS2_SVC_NAME_H */ |