geode-client-native/src/clicache/impl/ManagedAuthInitialize.hpp

/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */

#pragma once

#include "../gf_defs.hpp"
#include <cppcache/AuthInitialize.hpp>
#include <vcclr.h>
#include "../IAuthInitialize.hpp"
#include "../PropertiesM.hpp"


namespace GemStone
{
  namespace GemFire
  {
    namespace Cache
    {
      interface class IAuthInitialize;
    }
  }
}

namespace gemfire
{

  /// <summary>
  /// Wraps the managed <see cref="GemStone.GemFire.Cache.IAuthInitialize" />
  /// object and implements the native <c>gemfire::AuthInitialize</c> interface.
  /// </summary>
  class ManagedAuthInitialize
    : public AuthInitialize
  {
  public:

    /// <summary>
    /// Constructor to initialize with the provided managed object.
    /// </summary>
    /// <param name="managedptr">
    /// The managed object.
    /// </param>
    inline ManagedAuthInitialize(
      GemStone::GemFire::Cache::IAuthInitialize^ managedptr )
      : m_managedptr( managedptr ) { }

    /// <summary>
    /// Static function to create a <c>ManagedAuthInitialize</c> using given
    /// managed assembly path and given factory function.
    /// </summary>
    /// <param name="assemblyPath">
    /// The path of the managed assembly that contains the <c>IAuthInitialize</c>
    /// factory function.
    /// </param>
    /// <param name="factoryFunctionName">
    /// The name of the factory function of the managed class for creating
    /// an object that implements <c>IAuthInitialize</c>.
    /// This should be a static function of the format
    /// {Namespace}.{Class Name}.{Method Name}.
    /// </param>
    /// <exception cref="IllegalArgumentException">
    /// If the managed library cannot be loaded or the factory function fails.
    /// </exception>
    static AuthInitialize* create( const char* assemblyPath,
      const char* factoryFunctionName );

	/// <summary>
    /// Called when the cache is going down
    /// </summary>
    /// <remarks>
    /// Implementations should clean up any external
    /// resources, such as database connections. Any runtime exceptions this method
    /// throws will be logged.
    /// <para>
    /// It is possible for this method to be called multiple times on a single
    /// callback instance, so implementations must be tolerant of this.
    /// </para>
    /// </remarks>
    /// <seealso cref="GemStone.GemFire.Cache.Cache.Close" />
    virtual void close( );

	/// <summary>
    /// Initialize with the given set of security properties and return the
	/// credentials for the given client as properties.
    /// </summary>
	/// <param name="securityprops">Given set of properties with which
	/// to initialize
	/// </param>
    /// <param name="server">It is the ID of the endpoint
	/// </param>
	virtual PropertiesPtr getCredentials(PropertiesPtr& securityprops, const char* server);

    virtual ~ManagedAuthInitialize( ) { }

    /// <summary>
    /// Returns the wrapped managed object reference.
    /// </summary>
    inline GemStone::GemFire::Cache::IAuthInitialize^ ptr( ) const
    {
      return m_managedptr;
    }


  private:

    /// <summary>
    /// Using gcroot to hold the managed delegate pointer (since it cannot be stored directly).
    /// Note: not using auto_gcroot since it will result in 'Dispose' of the ICacheLoader
    /// to be called which is not what is desired when this object is destroyed. Normally this
    /// managed object may be created by the user and will be handled automatically by the GC.
    /// </summary>
    gcroot<GemStone::GemFire::Cache::IAuthInitialize^> m_managedptr;

    // Disable the copy and assignment constructors
    ManagedAuthInitialize( const ManagedAuthInitialize& );
    ManagedAuthInitialize& operator = ( const ManagedAuthInitialize& );
  };

}