Savan_util


Functions

axis2_status_t savan_util_create_fault_envelope (axis2_msg_ctx_t *msg_ctx, const axutil_env_t *env, axis2_char_t *code, axis2_char_t *subcode, axis2_char_t *reason, axis2_char_t *detail)
axiom_node_t * savan_util_build_fault_msg (const axutil_env_t *env, axis2_char_t *code, axis2_char_t *subcode, axis2_char_t *reason, axis2_char_t *detail)
axis2_status_t savan_util_apply_filter (savan_subscriber_t *subscriber, const axutil_env_t *env, axiom_node_t *payload)
savan_message_types_t savan_util_get_message_type (axis2_msg_ctx_t *msg_ctx, const axutil_env_t *env)
axis2_char_t * savan_util_get_subscription_id_from_msg (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx)
savan_subscriber_t * savan_util_get_subscriber_from_msg (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, axis2_char_t *sub_id)
axutil_hash_t * savan_util_get_subscriber_store (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t savan_util_add_subscriber (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, savan_subscriber_t *subscriber)
axis2_status_t savan_util_update_subscriber (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, savan_subscriber_t *subscriber)
axis2_status_t savan_util_remove_subscriber (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, savan_subscriber_t *subscriber)
axis2_char_t * savan_util_get_expiry_time (const axutil_env_t *env)
axis2_char_t * savan_util_get_renewed_expiry_time (const axutil_env_t *env, axis2_char_t *expiry)
AXIS2_EXTERN axis2_status_t savan_util_set_store (axis2_svc_t *svc, const axutil_env_t *env, axis2_char_t *store_name)
AXIS2_EXTERN axutil_array_list_t * savan_util_get_subscriber_list_from_remote_subs_mgr (const axutil_env_t *env, axis2_char_t *topic, axis2_char_t *subs_mgr_url, void *svc_client)
AXIS2_EXTERN axis2_char_t * savan_util_get_topic_name_from_topic_url (const axutil_env_t *env, axis2_char_t *topic_url)
axutil_array_list_t * savan_util_get_topic_list_from_remote_subs_mgr (const axutil_env_t *env, axis2_char_t *subs_mgr_url, void *s_client)
savan_subscriber_t * savan_util_get_subscriber_from_remote_subs_mgr (const axutil_env_t *env, axis2_char_t *subs_id, axis2_char_t *subs_mgr_url, void *s_client)
void * savan_util_get_svc_client (const axutil_env_t *env)

Function Documentation

axis2_status_t savan_util_add_subscriber ( const axutil_env_t *  env,
axis2_msg_ctx_t *  msg_ctx,
savan_subscriber_t *  subscriber 
)

Add the subscriber to subscription manager services' store Note that if the subscription manager is a separate service from the publisher service then both SubscriptionMgrName and SubscriptionMgrURL must be set in the publishers services.xml

Parameters:
env pointer to environment struct
msg_ctx pointer to message context
subscriber 
Returns:
the store on success, else NULL

axis2_status_t savan_util_apply_filter ( savan_subscriber_t *  subscriber,
const axutil_env_t *  env,
axiom_node_t *  payload 
)

Apply the filter against the subscriber

Parameters:
subscriber,pointer to the subscriber
env,pointer to the environment
payload,pointer to the payload. returns true, if it evaluates to success. If so, send the entire msg into the sink. Else nothing is sent.

axiom_node_t* savan_util_build_fault_msg ( const axutil_env_t *  env,
axis2_char_t *  code,
axis2_char_t *  subcode,
axis2_char_t *  reason,
axis2_char_t *  detail 
)

Build a savan fault message

Parameters:
env,pointer to the environment
code,SOAP12:Sender 
subcode,fault subcode
reason,fault reason
detail,details about fault, and solution to avoid.

axis2_status_t savan_util_create_fault_envelope ( axis2_msg_ctx_t *  msg_ctx,
const axutil_env_t *  env,
axis2_char_t *  code,
axis2_char_t *  subcode,
axis2_char_t *  reason,
axis2_char_t *  detail 
)

Create the fault envelope, to be sent to the client.

Parameters:
msg_ctx msg context
env environment
code,fault code
subcode,fault sub code
reason,fault reason
detail,fault deails.

axis2_char_t* savan_util_get_expiry_time ( const axutil_env_t *  env  ) 

Calculate and return an expiry time for the subscription

Parameters:
env pointer to environment struct
Returns:
the expiry time on success, else NULL

savan_message_types_t savan_util_get_message_type ( axis2_msg_ctx_t *  msg_ctx,
const axutil_env_t *  env 
)

Set the filter template for the subscriber for filtering.

Parameters:
subscriber pointer to the subscriber
sub_processor,pointer to the sub_processor
env,pointer to the environment. returns success, if operation is successful.

axis2_char_t* savan_util_get_renewed_expiry_time ( const axutil_env_t *  env,
axis2_char_t *  expiry 
)

Calculate and return a new expiry time for the subscription based on the current expiry time.

Parameters:
env pointer to environment struct
expiry current expiry time
Returns:
the new expiry time on success, else NULL

savan_subscriber_t* savan_util_get_subscriber_from_msg ( const axutil_env_t *  env,
axis2_msg_ctx_t *  msg_ctx,
axis2_char_t *  sub_id 
)

Find the subscriber object from the store using the given messsage context.

Parameters:
env pointer to environment struct
msg_ctx pointer to message context
sub_id pointer to subscription id
Returns:
a pointer to subscriber on success, else NULL

AXIS2_EXTERN axutil_array_list_t* savan_util_get_subscriber_list_from_remote_subs_mgr ( const axutil_env_t *  env,
axis2_char_t *  topic,
axis2_char_t *  subs_mgr_url,
void *  svc_client 
)

Get the subscribers registered for a topic

Parameters:
env pointer to environment struct
topic topic for which the subscribers are registered
subs_mgr_url url of the subscription manager
Returns:
subscribers in a array list

axutil_hash_t* savan_util_get_subscriber_store ( const axutil_env_t *  env,
axis2_msg_ctx_t *  msg_ctx 
)

Get the subscriber store from the service Note that if the subscription manager is a separate service from the publisher service then both SubscriptionMgrName and SubscriptionMgrURL must be set in the publishers services.xml

Parameters:
env pointer to environment struct
msg_ctx pointer to message context
Returns:
the store on success, else NULL

axis2_char_t* savan_util_get_subscription_id_from_msg ( const axutil_env_t *  env,
axis2_msg_ctx_t *  msg_ctx 
)

Extracts the subscription ID from the given messsage context.

Parameters:
env pointer to environment struct
msg_ctx pointer to message context
Returns:
the ID on success, else NULL

axutil_array_list_t* savan_util_get_topic_list_from_remote_subs_mgr ( const axutil_env_t *  env,
axis2_char_t *  subs_mgr_url,
void *  s_client 
)

Get the topics registered in a subscription manager

Parameters:
env pointer to environment struct
subs_mgr_url url of the subscription manager
Returns:
subscribers in a array list

axis2_status_t savan_util_remove_subscriber ( const axutil_env_t *  env,
axis2_msg_ctx_t *  msg_ctx,
savan_subscriber_t *  subscriber 
)

Remove the subscriber from subscription manager services' store Note that if the subscription manager is a separate service from the publisher service then both SubscriptionMgrName and SubscriptionMgrURL must be set in the publishers services.xml

Parameters:
env pointer to environment struct
msg_ctx pointer to message context
subscriber 
Returns:
the store on success, else NULL

AXIS2_EXTERN axis2_status_t savan_util_set_store ( axis2_svc_t *  svc,
const axutil_env_t *  env,
axis2_char_t *  store_name 
)

Create storage hash and set as a service parameter.

Parameters:
env pointer to environment struct
svc subscription service
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


Generated on Sun Oct 7 14:37:10 2007 for Savan/C by  doxygen 1.5.1