clicache/src/IAuthInitialize.hpp

/*
 * 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.
 */

#pragma once


#include "geode_defs.hpp"

//#include "Properties.hpp"

using namespace System;

namespace Apache
{
  namespace Geode
  {
    namespace Client
    {

      generic<class TPropKey, class TPropValue>
      ref class Properties;

      /// <summary>
      /// Specifies the mechanism to obtain credentials for a client.
      /// It is mandantory for clients when the server is running in secure
      /// mode having a <c>security-client-authenticator</c> module specified.
      /// Implementations should register the library path as
      /// <c>security-client-auth-library</c> system property and factory
      /// function (a zero argument function returning pointer to an
      /// AuthInitialize object) as the <c>security-client-auth-factory</c>
      /// system property.
      ///
      /// For a managed class implementing <c>IAuthInitialize</c> the fully
      /// qualified name of the factory function should be provided in the
      /// form {Namespace}.{Class Name}.{Method Name} as the
      /// <c>security-client-auth-factory</c> property.
      /// </summary>
      public interface class IAuthInitialize
      {
      public:

        /// <summary>
        /// Initialize with the given set of security properties
        /// return the credentials for the client as properties.
        /// </summary>
        /// <param name="props">
        /// the set of <c>security-*</c> properties provided to the
        /// <see cref="DistributedSystem.connect"/> method
        /// </param>
        /// <param name="server">
        /// the ID of the current endpoint in the format "host:port"
        /// </param>
        /// <returns>
        /// the credentials to be used for the given server
        /// </returns>
        /// <remarks>
        /// This method can modify the given set of properties. For
        /// example it may invoke external agents or even interact with
        /// the user.
        /// </remarks>
        //generic <class TPropKey, class TPropValue>
        Properties<String^, Object^>^ GetCredentials(Properties<String^, String^>^ props, String^ server);

        /// <summary>
        /// Invoked before the cache goes down.
        /// </summary>
        void Close();

        delegate Properties<String^, Object^>^ GetCredentialsDelegate(Properties<String^, String^>^ props, String^ server);
        delegate void CloseDelegate();
      };
    }  // namespace Client
  }  // namespace Geode
}  // namespace Apache