/usr/include/axis2-1.6.0/axis2_endpoint_ref.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 | /*
* 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_ENDPOINT_REF_H
#define AXIS2_ENDPOINT_REF_H
/**
* @defgroup axis2_endpoint_ref endpoint reference
* @ingroup axis2_addr
* endpoint reference represent an endpoint address in WS-Addressing.
* In addition to the endpoint address, it also encapsulates meta data,
* reference attributes and the service hosted at the given endpoint.
* In addition to the addressing related implementation, the endpoint reference
* struct is used across core code-base to represent endpoints.
* @{
*/
/**
* @file axis2_endpoint_ref.h
*/
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_const.h>
#include <axutil_array_list.h>
#include <axis2_any_content_type.h>
#include <axis2_svc_name.h>
#include <axiom_node.h>
#include <axiom_attribute.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_endpoint_ref */
typedef struct axis2_endpoint_ref axis2_endpoint_ref_t;
/**
* Creates endpoint reference struct.
* @param env pointer to environment struct
* @param address endpoint address string
* @return pointer to newly created endpoint reference
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_endpoint_ref_create(
const axutil_env_t * env,
const axis2_char_t * address);
/**
* Frees the endpoint_ref given as a void pointer. This method would cast the
* void parameter to an endpoint_ref pointer and then call free method.
* @param endpoint_ref pointer to endpoint_ref as a void pointer
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
void AXIS2_CALL
axis2_endpoint_ref_free_void_arg(
void *endpoint_ref,
const axutil_env_t * env);
/**
* Gets endpoint address. Address URI identifies the endpoint.
* This may be a network address or a logical address.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return endpoint address string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_endpoint_ref_get_address(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Sets endpoint address. Address URI identifies the endpoint.
* This may be a network address or a logical address.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param address address string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_set_address(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
const axis2_char_t * address);
/**
* Gets interface QName. QName represents the primary portType of
* the endpoint being conveyed.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to interface QName, returns a reference, not a cloned
* copy
*/
AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
axis2_endpoint_ref_get_interface_qname(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Sets interface QName. QName represents the primary portType of
* the endpoint being conveyed.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param interface_qname pointer to interface QName, this method creates
* a clone of the QName
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_set_interface_qname(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
const axutil_qname_t * interface_qname);
/**
* Gets reference parameter list. A reference may contain a number
* of individual parameters which are associated with the endpoint
* to facilitate a particular interaction. Reference parameters
* are element information items that are named by QName and are
* required to properly interact with the endpoint.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to array list containing all reference parameters,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_endpoint_ref_get_ref_param_list(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Gets the list of metadata. An endpoint can have different associated
* metadata such as WSDL, XML Schema, and WS-Policy policies.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to array list containing metadata, returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_endpoint_ref_get_metadata_list(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Gets the list of reference attributes.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to array list containing reference attributes,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_endpoint_ref_get_ref_attribute_list(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Gets the list of metadata attributes.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to array list containing metadata attributes,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_endpoint_ref_get_metadata_attribute_list(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Gets the list of extensions. Extensions are a mechanism to allow
* additional elements to be specified in association with the endpoint.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to array list containing extensions,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_endpoint_ref_get_extension_list(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Adds a reference parameter in the form of an AXIOM node.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param ref_param_node pointer to AXIOM node representing reference
* parameter, endpoint reference does not assume the ownership of
* the node
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_add_ref_param(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axiom_node_t * ref_param_node);
/**
* Adds metadata in the form of an AXIOM node. An endpoint can have
* different associated metadata such as WSDL, XML Schema and
* WS-Policy policies.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param metadata_node AXIOM node representing metadata,
* endpoint reference does not assume the ownership of the node
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_add_metadata(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axiom_node_t * metadata_node);
/**
* Adds a reference attribute in the form of an AXIOM attribute.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param attr AXIOM attribute representing reference attribute,
* endpoint reference does not assume the ownership of the attribute
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_add_ref_attribute(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axiom_attribute_t * attr);
/**
* Adds a meta attribute in the form of an AXIOM attribute.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param attr AXIOM attribute representing meta attribute,
* endpoint reference does not assume the ownership of the attribute
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_add_metadata_attribute(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axiom_attribute_t * attr);
/**
* Adds an extension in the form of an AXIOM node.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param extension_node pointer to AXIOM node representing extension,
* endpoint reference does not assume the ownership of the node
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_add_extension(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axiom_node_t * extension_node);
/**
* Gets service name. An endpoint in WS-Addressing has a QName
* identifying the WSDL service element that contains the definition
* of the endpoint being conveyed. The service name provides a link
* to a full description of the service endpoint.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return pointer to service name struct, returns a reference, not
* a cloned copy
*/
AXIS2_EXTERN axis2_svc_name_t *AXIS2_CALL
axis2_endpoint_ref_get_svc_name(
const axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/**
* Sets service name. An endpoint in WS-Addressing has a QName
* identifying the WSDL service element that contains the definition
* of the endpoint being conveyed. The service name provides a link
* to a full description of the service endpoint.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @param svc_name pointer to service name struct, endpoint assumes
* ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_endpoint_ref_set_svc_name(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env,
axis2_svc_name_t * svc_name);
/**
* Frees endpoint reference struct.
* @param endpoint_ref pointer to endpoint reference struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_endpoint_ref_free(
axis2_endpoint_ref_t * endpoint_ref,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_ENDPOINT_REF_H */
|