C++ Client API Reference for Oracle Coherence: coherence/security/GenericPrincipal.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_GENERIC_PRINCIPAL_HPP
00008 #define COH_GENERIC_PRINCIPAL_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/security/Principal.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,security)
00015 
00016 
00017 /**
00018 * A generic implementation of the Principal interface.
00019 *
00020 * @author mf  2008.08.22
00021 */
00022 class COH_EXPORT GenericPrincipal
00023     : public cloneable_spec<GenericPrincipal,
00024         extends<Object>,
00025         implements<Principal> >
00026     {
00027     friend class factory<GenericPrincipal>;
00028 
00029     // ----- constructors ---------------------------------------------------
00030 
00031     private:
00032         /**
00033         * Construct a new GenericPrincipal for the given name.
00034         *
00035         * @param vsName  the name of the principal
00036         */
00037         GenericPrincipal(String::View vsName);
00038 
00039         /**
00040         * Copy constructor.
00041         */
00042         GenericPrincipal(const GenericPrincipal& that);
00043 
00044 
00045     // ----- Principal interface --------------------------------------------
00046 
00047     public:
00048         /**
00049         * {@inheritDoc}
00050         */
00051         virtual String::View getName() const;
00052 
00053 
00054     // ----- Object interface -----------------------------------------------
00055 
00056     public:
00057         /**
00058         * {@inheritDoc}
00059         */
00060         virtual bool equals(Object::View vThat) const;
00061 
00062         /**
00063         * {@inheritDoc}
00064         */
00065         virtual size32_t hashCode() const;
00066 
00067         /**
00068         * {@inheritDoc}
00069         */
00070         virtual bool isImmutable() const;
00071 
00072         /**
00073         * {@inheritDoc}
00074         */
00075         virtual TypedHandle<const String> toString() const;
00076 
00077 
00078     // ----- data members ---------------------------------------------------
00079 
00080     private:
00081         /**
00082         * The principal name.
00083         */
00084         FinalView<String> f_vsName;
00085     };
00086 
00087 COH_CLOSE_NAMESPACE2
00088 
00089 #endif // COH_GENERIC_PRINCIPAL_HPP