jk_config.h

Tomcat 4.1与WebServer集成组件的源代码包.

/* ========================================================================= *
 *                                                                           *
 *                 The Apache Software License,  Version 1.1                 *
 *                                                                           *
 *          Copyright (c) 1999-2001 The Apache Software Foundation.          *
 *                           All rights reserved.                            *
 *                                                                           *
 * ========================================================================= *
 *                                                                           *
 * Redistribution and use in source and binary forms,  with or without modi- *
 * fication, are permitted provided that the following conditions are met:   *
 *                                                                           *
 * 1. Redistributions of source code  must retain the above copyright notice *
 *    notice, this list of conditions and the following disclaimer.          *
 *                                                                           *
 * 2. Redistributions  in binary  form  must  reproduce the  above copyright *
 *    notice,  this list of conditions  and the following  disclaimer in the *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. The end-user documentation  included with the redistribution,  if any, *
 *    must include the following acknowlegement:                             *
 *                                                                           *
 *       "This product includes  software developed  by the Apache  Software *
 *        Foundation <http://www.apache.org/>."                              *
 *                                                                           *
 *    Alternately, this acknowlegement may appear in the software itself, if *
 *    and wherever such third-party acknowlegements normally appear.         *
 *                                                                           *
 * 4. The names  "The  Jakarta  Project",  "Jk",  and  "Apache  Software     *
 *    Foundation"  must not be used  to endorse or promote  products derived *
 *    from this  software without  prior  written  permission.  For  written *
 *    permission, please contact <[e-mail]>.                        *
 *                                                                           *
 * 5. Products derived from this software may not be called "Apache" nor may *
 *    "Apache" appear in their names without prior written permission of the *
 *    Apache Software Foundation.                                            *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES *
 * INCLUDING, BUT NOT LIMITED TO,  THE IMPLIED WARRANTIES OF MERCHANTABILITY *
 * AND FITNESS FOR  A PARTICULAR PURPOSE  ARE DISCLAIMED.  IN NO EVENT SHALL *
 * THE APACHE  SOFTWARE  FOUNDATION OR  ITS CONTRIBUTORS  BE LIABLE  FOR ANY *
 * DIRECT,  INDIRECT,   INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL *
 * DAMAGES (INCLUDING,  BUT NOT LIMITED TO,  PROCUREMENT OF SUBSTITUTE GOODS *
 * OR SERVICES;  LOSS OF USE,  DATA,  OR PROFITS;  OR BUSINESS INTERRUPTION) *
 * HOWEVER CAUSED AND  ON ANY  THEORY  OF  LIABILITY,  WHETHER IN  CONTRACT, *
 * STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN *
 * ANY  WAY  OUT OF  THE  USE OF  THIS  SOFTWARE,  EVEN  IF  ADVISED  OF THE *
 * POSSIBILITY OF SUCH DAMAGE.                                               *
 *                                                                           *
 * ========================================================================= *
 *                                                                           *
 * This software  consists of voluntary  contributions made  by many indivi- *
 * duals on behalf of the  Apache Software Foundation.  For more information *
 * on the Apache Software Foundation, please see <http://www.apache.org/>.   *
 *                                                                           *
 * ========================================================================= */

/** Config object. It's more-or-less independent of the config source
    or representation. 
 */

#ifndef JK_CONFIG_H
#define JK_CONFIG_H

#include "jk_global.h"
#include "jk_pool.h"
#include "jk_env.h"
#include "jk_logger.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

struct jk_pool;
struct jk_map;
struct jk_env;
struct jk_config;
typedef struct jk_config jk_config_t;

/**
 *
 */
struct jk_config {
    struct jk_bean *mbean;
    int ver;
    
    /* Parse and process a property. It'll locate the object and call the
     * setAttribute on it.
     */
    int (*setPropertyString)(struct jk_env *env, struct jk_config *cfg,
                             char *name, char *value); 

    /* Set an attribute for a jk object. This should be the
     * only method called to configure objects. The implementation
     * will update the underlying repository in addition to setting
     * the runtime value. Calling setAttribute on the object directly
     * will only set the runtime value.
     */
    int (*setProperty)(struct jk_env *env, struct jk_config *cfg,
                       struct jk_bean *target, char *name, char *value); 

    /** Write the config file. If targetFile is NULL, it'll override the
     *  file that was used for reading
    */
    int (*save)( struct jk_env *env, struct jk_config *cfg,
                 char *targetFile);

    /** Check if the config changed, and update the workers.
     */
    int (*update)( struct jk_env *env, struct jk_config *cfg, int *didReload);

    /** Process a node in config data
     */
    int (*processNode)( struct jk_env *env, struct jk_config *cfg, char *node, int didReload);

    /* Private data */
    struct jk_pool *pool;
    void *_private;
    struct jk_workerEnv *workerEnv;
    struct jk_map *map;

    char *file;
    
    char *section;
    struct jk_map *cfgData;
    /* Only one thread can update the config
     */
    struct jk_mutex *cs;
    time_t mtime;
};

int jk2_config_setProperty(struct jk_env  *env, struct jk_config *cfg,
                           struct jk_bean *mbean, char *name, char *val);

int jk2_config_setPropertyString(struct jk_env *env, struct jk_config *cfg,
                                 char *name, char *value);

int jk2_config_processConfigData(struct jk_env *env, struct jk_config *cfg,
                                 int firstTime );


char *jk2_config_replaceProperties(struct jk_env *env, struct jk_map *m,
                                   struct jk_pool *resultPool, 
                                   char *value);

int jk2_config_file_read(struct jk_env *env, struct jk_map *m,const char *file);

int jk2_config_processNode(struct jk_env *env, struct jk_config *cfg,
                           char *name, int firstTime );

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* JK_CONFIG_H */