blob: 50b5f93ba410c0131e5d9fdf62a02cbe0997bd24 [file] [log] [blame]
* 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#pragma once
#include <memory>
#include "geode/AuthInitialize.hpp"
* @file
namespace apache {
namespace geode {
namespace client {
* @class UserPasswordAuthInit Implementation UserPasswordAuthInit.hpp
* UserPasswordAuthInit API for getCredentials.
* The UserPasswordAuthInit class derives from AuthInitialize base class and
* implements the getCredential API to get the username and password.
* To use this class the <c>security-client-auth-library</c>
* property should be set to the name of the shared library (viz.
* <code>securityImpl</code>) and the <c>security-client-auth-factory</c>
* property should be set to the name of the global creation function viz.
* <code>createUserPasswordAuthInitInstance</code>.
class UserPasswordAuthInit : public AuthInitialize {
UserPasswordAuthInit() = default;
~UserPasswordAuthInit() noexcept override = default;
/**@brief initialize with the given set of security properties
* and return the credentials for the client as properties.
* @param props the set of security properties provided to the
* <code>DistributedSystem.connect</code> method
* @param server it is the ID of the current endpoint.
* The format expected is "host:port".
* @returns the credentials to be used for the given <code>server</code>
* @remarks This method can modify the given set of properties. For
* example it may invoke external agents or even interact with the user.
std::shared_ptr<Properties> getCredentials(
const std::shared_ptr<Properties>& securityprops,
const std::string& server) override;
* @brief Invoked before the cache goes down.
void close() override { return; }
* @brief private members
} // namespace client
} // namespace geode
} // namespace apache