Return to PasswordFile.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Security / UserManager

HP-RK API Review: Created a new ArrayInternal.h header file to hold the Pegasus internal Array functions.  Updated include statements to include this new ArrayInternal.h header file.

//%/////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,
// The Open Group, Tivoli Systems
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Sushma Fernandes, Hewlett Packard Company (sushma_fernandes@hp.com)
//
// Modified By:
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_PasswordFile_h
#define Pegasus_PasswordFile_h

#include <Pegasus/Common/String.h>
#include <Pegasus/Common/HashTable.h>
#include <Pegasus/Common/ArrayInternal.h>

#include <Pegasus/Security/UserManager/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

////////////////////////////////////////////////////////////////////////////////
// PasswordTable 
////////////////////////////////////////////////////////////////////////////////

typedef HashTable<String, String, EqualFunc<String>, HashFunc<String> > PasswordTable;

////////////////////////////////////////////////////////////////////////////////
//  PasswordFile Class
////////////////////////////////////////////////////////////////////////////////

/**
  This class provides methods to read/write from the 
  password file.
*/
class PEGASUS_USERMANAGER_LINKAGE PasswordFile
{
private:

    //
    // Contains the full path name of the password file
    //
    String    _passwordFile;

    //
    // Contains the full path name of the password backup file
    //
    String    _passwordBackupFile;

public:

    /** 
    Constructor. 

    @exception  FileNotReadable  if the specified file is not readable.
    */
    PasswordFile(const String& fileName);
        //throw (FileNotReadable);


    /** Destructor. */
    ~PasswordFile( );


    /** 
    Get the name of the password file.

    @return String    name of the password file.
    */
    const String getFileName() const {return _passwordFile;}


    /** 
    Load the username and password from the password file.

    @param     passwordTable   hash table containing the username and password.

    Note: Original code was taken from OptionManager::mergeFile() 
    */
    void load(PasswordTable& passwordTable);



    /** 
    Save the username and password to the password file.

    @param  passwordTable    hash table containing the user name and password.
    @exception  CannotRenameFile  if failed to create the backup file.
    */
    void save(PasswordTable& passwordTable);
        //throw (CannotRenameFile);

};


PEGASUS_NAMESPACE_END

#endif /* Pegasus_PasswordFile_h */