//%LICENSE////////////////////////////////////////////////////////////////
//
// Licensed to The Open Group (TOG) under one or more contributor license
// agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
// this work for additional information regarding copyright ownership.
// Each contributor licenses this file to you under the OpenPegasus Open
// Source License; you may not use this file except in compliance with the
// License.
//
// 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.
//
//////////////////////////////////////////////////////////////////////////
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_LocalAuthFile_h
#define Pegasus_LocalAuthFile_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/String.h>

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

PEGASUS_NAMESPACE_BEGIN


/** This class provides the required functions to create, write and delete to a
    file on the file system.
*/

class PEGASUS_SECURITY_LINKAGE LocalAuthFile
{
public:

    /** Constructor. */
    LocalAuthFile(const String& userName);


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

    /** Creates a file and writes random token in to it.
        @return a string containing the full path name of the file created if
        the file creation was successfull, null otherwise.
    */
    String create();

    /** Removes the file created.
        @return   true on successful removal of the file, false otherwise.
    */
    Boolean remove();

    /** Get the string that was created as a secret string
    */
    String getSecretString();

private:


    String  _generateRandomTokenString();

    String  _userName;

    String  _filePathName;

    String  _authFilePath;

    String  _secret;
};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_LocalAuthFile_h */
