
/*
 * 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_WS_INFO_H
#define AXIS2_WS_INFO_H

/**
 * @defgroup axis2_ws_info Ws Info
 * @ingroup axis2_deployment
 * @{
 */

/**
 * @file axis2_ws_info.h
 * @brief Axis2 Ws Info interface. ws_info construct contain file information 
 * for module or service configuration file.
 */
#include <axis2_const.h>
#include <axutil_error.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axutil_qname.h>
#include <axis2_conf.h>

#ifdef __cplusplus
extern "C"
{
#endif

    struct axis2_conf;

    /** Type name for struct axis2_ws_info */
    typedef struct axis2_ws_info axis2_ws_info_t;

    /**
     * De-allocate memory
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_ws_info_free(
        axis2_ws_info_t * ws_info,
        const axutil_env_t * env);

    /**
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axis2_ws_info_get_file_name(
        const axis2_ws_info_t * ws_info,
        const axutil_env_t * env);

    /**
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     * @param file_name pointer to file name
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_ws_info_set_file_name(
        axis2_ws_info_t * ws_info,
        const axutil_env_t * env,
        axis2_char_t * file_name);

    /**
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN long AXIS2_CALL
    axis2_ws_info_get_last_modified_date(
        const axis2_ws_info_t * ws_info,
        const axutil_env_t * env);

    /**
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     * @param modified_data pointer to modified date
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_ws_info_set_last_modified_date(
        axis2_ws_info_t * ws_info,
        const axutil_env_t * env,
        long last_modified_date);

    /**
     * @param ws_info pointer to ws info
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN int AXIS2_CALL
    axis2_ws_info_get_type(
        const axis2_ws_info_t * ws_info,
        const axutil_env_t * env);

    /**
     * Creates ws_info struct
     * @param env pointer to environment struct
     * @param file_name pointer to file name
     * @param last_modified_date pointer to last modified date
     * @return pointer to newly created ws info
     */
    AXIS2_EXTERN axis2_ws_info_t *AXIS2_CALL

    axis2_ws_info_create_with_file_name_and_last_modified_date(
        const axutil_env_t * env,
        axis2_char_t * file_name,
        long last_modified_date);

    /**
     * @param env pointer to environment struct
     * @param file_name pointer to file name
     * @param last_modifile_date last modified date
     * @param type type
     */
    AXIS2_EXTERN axis2_ws_info_t *AXIS2_CALL

    axis2_ws_info_create_with_file_name_and_last_modified_date_and_type(
        const axutil_env_t * env,
        axis2_char_t * file_name,
        long last_modified_date,
        int type);

    /** @} */

#ifdef __cplusplus
}
#endif
#endif                          /* AXIS2_WS_INFO_H */