xmog_jvm_loader.h

/*
 * Copyright 1999-2006 by Codemesh, Inc.  ALL RIGHTS RESERVED.
 */

#ifndef xmog_jvm_loader_inc
#define xmog_jvm_loader_inc


#include "xmog.h"
#include "xmog_jvm.h"
#include "xmog_jvm_options.h"
#include "xmog_options.h"
#include "xmog_remote_client_options.h"
#include "xmog_remote_server_options.h"



class xmog_jvm_loader_impl;




class XMOG_DECLSPEC xmog_jvm_loader : public xmog_jvm_options,
                                      public xmog_options
                                      XMOG_REMOTE_CLIENT_OPTIONS_INH
                                      XMOG_REMOTE_SERVER_OPTIONS_INH
{
public:
    typedef void (XMOG_CALLING_CONVENTION *XMOG_CONFIG_HOOK)( void * pLoader, int when );

    static void                 setConfigFile( const char * filename,
                                               XMOGVERSION vers = NULL, 
                                               XMOGCONFIG conf = NULL, 
                                               XMOGVERSION reserved0 = NULL );

    static xmog_jvm_loader &    get_jvm_loader( bool bEnvOverrides = true, 
                                                bool bDefaultJvm = true, 
                                                xmog_trace_facility fac = TraceAll, 
                                                xmog_trace_level trace_level = TraceErrors );

    static xmog_jvm_loader &    get_jvm_loader( const char * filename,
                                                XMOGVERSION vers, 
                                                XMOGCONFIG conf, 
                                                XMOGVERSION reserved0 = NULL,
                                                bool bEnvOverrides = true, 
                                                bool bDefaultJvm = true, 
                                                xmog_trace_facility fac = TraceAll, 
                                                xmog_trace_level trace_level = TraceErrors );

    static xmog_jvm_loader &    get_jvm_loader( const char * filename, 
                                                bool bEnvOverrides = true, 
                                                bool bDefaultJvm = true, 
                                                xmog_trace_facility fac = TraceAll, 
                                                xmog_trace_level trace_level = TraceErrors );


    static xmog_jvm_loader &    get_jvm_loader( int argc, 
                                                char * argv[], 
                                                bool bEnvOverrides = true, 
                                                bool bDefaultJvm = true, 
                                                xmog_trace_facility fac = TraceAll, 
                                                xmog_trace_level trace_level = TraceErrors );

    static xmog_jvm_loader &    get_jvm_loader( XMOGVERSION vers, 
                                                XMOGCONFIG conf, 
                                                XMOGVERSION reserved0 = NULL, 
                                                bool bEnvOverrides = true, 
                                                bool bDefaultJvm = true, 
                                                xmog_trace_facility fac = TraceAll, 
                                                xmog_trace_level trace_level = TraceErrors  );

    static xmog_jvm_loader *    get_jvm_loader_no_create();

    virtual xmog_jvm *          load( bool bAcceptPreloadedJvm = true );

    virtual xmog_jvm *          get_jvm();

    virtual void                set_jvm( xmog_jvm * jvm );

    jint                        getLoadResult( char ** pMsg = NULL );
    
    jint                        getLoadedJvms( xmog_jvm ** pJvms, jsize size, jsize * count );

    static const char *         getDefaultJvmPath();

    static bool                 isInShutdownMode();

    static void                 enterShutdownMode();

    virtual void                setJvmPath( const char * jvmPath );

    virtual void                read( const char * file, XMOGVERSION vers = NULL, XMOGCONFIG conf = NULL, XMOGVERSION reserved0 = NULL );

    static void                 addVersionConfig( const char * vers, const char * config );

    static void                 registerConfigurationHook( XMOG_CONFIG_HOOK configHook );

    static void                 atexit_call();

    bool                        getEnvironmentOverrides() const;


protected:

    xmog_jvm_loader( bool bEnvOverrides, bool bDefaultJvm, xmog_trace_facility fac, xmog_trace_level );

    xmog_jvm_loader( const char * filename, bool bEnvOverrides, bool bDefaultJvm, xmog_trace_facility fac, xmog_trace_level );


    xmog_jvm_loader( const char * filename, XMOGVERSION vers, XMOGCONFIG conf, XMOGVERSION reserved0, bool bEnvOverrides, bool bDefaultJvm, xmog_trace_facility fac, xmog_trace_level );


    xmog_jvm_loader( int argc, char * argv[], bool bEnvOverrides, bool bDefaultJvm, xmog_trace_facility fac, xmog_trace_level );

    xmog_jvm_loader( XMOGVERSION vers, XMOGCONFIG conf, XMOGVERSION reserved0, bool bEnvOverrides, bool bDefaultJvm, xmog_trace_facility fac, xmog_trace_level  );

    virtual ~xmog_jvm_loader();

    xmog_jvm *                  usePreloadedJvm();

    xmog_jvm *                  loadInProcess( bool bAcceptPreloadedJvm );

    xmog_jvm *                  loadOutOfProcessClient( bool bAcceptPreloadedJvm );

    xmog_jvm *                  loadOutOfProcessServer( bool bAcceptPreloadedJvm );

    xmog_jvm *                  loadOutOfProcess( bool bAcceptPreloadedJvm, bool bServer = false );

    void                        consolidateVersionConfigs();

    void                        addExtensionDirectories();

private:

    volatile xmog_jvm *         theJvm;

    volatile static bool        shutdownmode;

    static char *               fileName_;

    static XMOGVERSION          vers_;

    static XMOGCONFIG           conf_;

    static XMOGVERSION          reserved0_;

    xmog_jvm_loader_impl *      impl;

    jint                        loadResult;

    bool                        bEnvOverrides_;

    //
    // Suppress copy constructor because we only ever have one instance of
    // the loader and don't want to allow the user to inadvertently create
    // another one by accident.
    //
    xmog_jvm_loader( const xmog_jvm_loader & );

    //
    // See above.
    //
    xmog_jvm_loader &           operator = ( const xmog_jvm_loader & );
};

                                      
#endif /* xmog_jvm_loader_inc */

---