Return to SecurityPropertyOwner.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Config

BUG#: 9456
TITLE: Error from bug 5796. Does not include supplemental help info

DESCRIPTION: Fixed issues from this bug, added missing config property
help and matched the config property help to the rpm man file.  Note
that there are still differences in that we use terser wording in the
help and sometimes only include a shorter definition.  The cimconfig
-H is NOT a replacement for the man data.

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


//////////////////////////////////////////////////////////////////////////////
//
// This file defines the security property owner class.
//
//////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_SecurityPropertyOwner_h
#define Pegasus_SecurityPropertyOwner_h

#include <Pegasus/Config/ConfigPropertyOwner.h>
#include <Pegasus/Common/AutoPtr.h>


PEGASUS_NAMESPACE_BEGIN

///////////////////////////////////////////////////////////////////
//  SecurityPropertyOwner Class
///////////////////////////////////////////////////////////////////

/**
    This is Security property owner class that extends ConfigPropertyOwner
    class and provide implementation.
*/
class PEGASUS_CONFIG_LINKAGE SecurityPropertyOwner : public ConfigPropertyOwner
{
public:

    /** Constructor */
    SecurityPropertyOwner();

    /**
        Initialize the config properties.

        This method is expected to be called only once at the start of the
        CIMOM. It initializes the properties with the default values.
    */
    void initialize();

    /**
        Get information about the specified property.

        @param name   The name of the property.
        @param propertyInfo   List to store the property info.
        @exception UnrecognizedConfigProperty  if the property is not defined.
    */
    void getPropertyInfo(
        const String& name,
        Array<String>& propertyInfo) const;

    /**
       Supplemental help information above and beyond
       getPropertyHelp.  Overrides function in ConfigPropertyOwner
       to provide possible values.
     */
////    String getPropertyHelpSupplement(const String& name) const;

    /**
        Get default value of the specified property.

        @param  name         The name of the property.
        @return string containing the default value of the property specified.
        @exception UnrecognizedConfigProperty  if the property is not defined.
    */
    String getDefaultValue(const String& name) const;

    /**
        Get current value of the specified property.

        @param  name         The name of the property.
        @return string containing the current value of the property specified.
        @exception UnrecognizedConfigProperty  if the property is not defined.
    */
    String getCurrentValue(const String& name) const;

    /**
        Get planned value of the specified property.

        @param  name         The name of the property.
        @return string containing the planned value of the property specified.
        @exception UnrecognizedConfigProperty  if the property is not defined.
    */
    String getPlannedValue(const String& name) const;

    /**
        Init current value of the specified property to the specified value.
        This method is expected to be called only once at the start of the
        CIMOM. The property value will be initialized irrespective of whether
        the property is dynamic or not.

        @param name The name of the property.
        @param value The current value of the property.
        @exception UnrecognizedConfigProperty if the property is not defined.
        @exception InvalidPropertyValue if the property value is not valid.
    */
    void initCurrentValue(const String& name, const String& value);

    /**
        Init planned value of the specified property to the specified value.
        This method is expected to be called only once at the start of the
        CIMOM. The property value will be initialized irrespective of whether
        the property is dynamic or not.

        @param name The name of the property.
        @param value The planned value of the property.
        @exception UnrecognizedConfigProperty if the property is not defined.
        @exception InvalidPropertyValue if the property value is not valid.
    */
    void initPlannedValue(const String& name, const String& value);

    /**
        Update current value of the specified property to the specified value.
        The property value will be updated only if the property is dynamically
        updatable.

        @param name The name of the property.
        @param value The current value of the property.
        @param  userName User requesting the update.
        @param timeoutSeconds Timeout in seconds to complete the update.
        @exception NonDynamicConfigProperty if the property is not dynamic.
        @exception InvalidPropertyValue if the property value is not valid.
        @exception UnrecognizedConfigProperty if the property is not defined.
    */
    void updateCurrentValue(
        const String& name,
        const String& value,
        const String& userName,
        Uint32 timeoutSeconds);
        //throw (NonDynamicConfigProperty, InvalidPropertyValue,
        //    UnrecognizedConfigProperty);

    /**
        Update planned value of the specified property to the specified value.

        @param name The name of the property.
        @param value The planned value of the property.
        @exception UnrecognizedConfigProperty if the property is not defined.
        @exception InvalidPropertyValue if the property value is not valid.
    */
    void updatePlannedValue(const String& name, const String& value);

    /**
        Checks to see if the given value is valid or not.

        @param name The name of the property.
        @param value The value of the property to be validated.
        @return Boolean True if the specified value for the property is valid.
        @exception UnrecognizedConfigProperty if the property is not defined.
    */
    Boolean isValid(const String& name, const String& value) const;

    /**
        Checks to see if the specified property is dynamic or not.

        @param name The name of the property.
        @return Boolean True if the specified property is dynamic.
        @exception UnrecognizedConfigProperty if the property is not defined.
    */
    Boolean isDynamic(const String& name) const;

private:

    struct ConfigProperty* _lookupConfigProperty(const String& name) const;

    /**
        The security properties owned by this class
    */
    AutoPtr<struct ConfigProperty> _enableAuthentication;
    AutoPtr<struct ConfigProperty> _enableNamespaceAuthorization;
    AutoPtr<struct ConfigProperty> _httpAuthType;
    AutoPtr<struct ConfigProperty> _passwordFilePath;
    AutoPtr<struct ConfigProperty> _enableRemotePrivilegedUserAccess;
    AutoPtr<struct ConfigProperty> _certificateFilePath;
    AutoPtr<struct ConfigProperty> _keyFilePath;
    AutoPtr<struct ConfigProperty> _trustStore;
    AutoPtr<struct ConfigProperty> _crlStore;
    AutoPtr<struct ConfigProperty> _sslClientVerificationMode;
    AutoPtr<struct ConfigProperty> _sslTrustStoreUserName;
    AutoPtr<struct ConfigProperty> _enableSubscriptionsForNonprivilegedUsers;
    AutoPtr<struct ConfigProperty> _cipherSuite;

#ifdef PEGASUS_ENABLE_USERGROUP_AUTHORIZATION
    AutoPtr<struct ConfigProperty> _authorizedUserGroups;
#endif

#ifdef PEGASUS_KERBEROS_AUTHENTICATION
    AutoPtr<struct ConfigProperty> _kerberosServiceName;
#endif

#ifdef PEGASUS_OS_ZOS
    AutoPtr<struct ConfigProperty> _enableCFZAPPLID;
#endif

};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_SecurityPropertyOwner_h */