Oracle Coherence for C++ API
Release 3.7.1.0
E22845-01

coherence/security/GenericPrincipal.hpp

/*
* GenericPrincipal.hpp
*
* Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_GENERIC_PRINCIPAL_HPP
#define COH_GENERIC_PRINCIPAL_HPP

#include "coherence/lang.ns"

#include "coherence/security/Principal.hpp"

COH_OPEN_NAMESPACE2(coherence,security)


/**
* A generic implementation of the Principal interface.
*
* @author mf  2008.08.22
*/
class COH_EXPORT GenericPrincipal
    : public cloneable_spec<GenericPrincipal,
        extends<Object>,
        implements<Principal> >
    {
    friend class factory<GenericPrincipal>;

    // ----- constructors ---------------------------------------------------

    private:
        /**
        * Construct a new GenericPrincipal for the given name.
        *
        * @param vsName  the name of the principal
        */
        GenericPrincipal(String::View vsName);

        /**
        * Copy constructor.
        */
        GenericPrincipal(const GenericPrincipal& that);


    // ----- Principal interface --------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual String::View getName() const;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View vThat) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;

        /**
        * {@inheritDoc}
        */
        virtual bool isImmutable() const;

        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- data members ---------------------------------------------------

    private:
        /**
        * The principal name.
        */
        FinalView<String> m_vsName;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_GENERIC_PRINCIPAL_HPP

Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.