C++ Client API Reference for Oracle Coherence: coherence/security/auth/GenericSubject.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_SUBJECT_HPP
00008 #define COH_GENERIC_SUBJECT_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/security/auth/Subject.hpp"
00013 #include "coherence/util/Set.hpp"
00014 
00015 
00016 
00017 COH_OPEN_NAMESPACE3(coherence,security,auth)
00018 
00019 using coherence::util::Set;
00020 
00021 /**
00022 * A generic implementation of the subject interface.
00023 *
00024 * @author mf 2008.08.22
00025 */
00026 class COH_EXPORT GenericSubject
00027     : public cloneable_spec<GenericSubject,
00028         extends<Object>,
00029         implements<Subject> >
00030     {
00031     friend class factory<GenericSubject>;
00032 
00033     // ----- constructors ---------------------------------------------------
00034 
00035     private:
00036         /**
00037         * Construct a Subject from a Set of Principals.
00038         *
00039         * @param vSet  the principal set to copy
00040         */
00041         GenericSubject(Set::View vSetPrincipals);
00042 
00043         /**
00044         * Construct a Subject containing a single GenericPrincipal.
00045         *
00046         * @param vsName  the name for the GenericPrincipal
00047         */
00048         GenericSubject(String::View vsName);
00049 
00050         /**
00051         * Copy constructor.
00052         */
00053         GenericSubject(const GenericSubject& that);
00054 
00055 
00056     // ----- Subject interface ----------------------------------------------
00057 
00058     public:
00059         /**
00060         * {@inheritDoc}
00061         */
00062         virtual Set::View getPrincipals() const;
00063 
00064 
00065     // ----- Object interface -----------------------------------------------
00066 
00067     public:
00068         /**
00069         * {@inheritDoc}
00070         */
00071         virtual bool equals(Object::View vThat) const;
00072 
00073         /**
00074         * {@inheritDoc}
00075         */
00076         virtual size32_t hashCode() const;
00077 
00078         /**
00079         * {@inheritDoc}
00080         */
00081         virtual bool isImmutable() const;
00082 
00083         /**
00084         * {@inheritDoc}
00085         */
00086         virtual TypedHandle<const String> toString() const;
00087 
00088 
00089     // ----- data members ---------------------------------------------------
00090 
00091     private:
00092         /**
00093         * The Principal set.
00094         */
00095         FinalView<Set> f_vSetPrincipals;
00096     };
00097 
00098 COH_CLOSE_NAMESPACE3
00099 
00100 #endif // COH_GENERIC_SUBJECT_HPP