C++ Client API Reference for Oracle Coherence: coherence/security/IdentityTransformer.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_IDENTITY_TRANSFORMER_HPP
00008 #define COH_IDENTITY_TRANSFORMER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/net/Service.hpp"
00013 #include "coherence/security/auth/Subject.hpp"
00014 
00015 COH_OPEN_NAMESPACE2(coherence,security)
00016 
00017 using coherence::security::auth::Subject;
00018 using coherence::net::Service;
00019 
00020 
00021 /**
00022 * IdentityTransformer transforms a Subject to a token that asserts identity.
00023 *
00024 * @author dag  2009.12.04
00025 *
00026 * @since Coherence 3.6
00027 */
00028 class COH_EXPORT IdentityTransformer
00029     : public interface_spec<IdentityTransformer>
00030     {
00031     // ----- IdentityTransformer interface ----------------------------------
00032 
00033     public:
00034         /**
00035         * Transform a Subject to a token that asserts an identity.
00036         *
00037         * @param vSubject  the Subject representing a user.
00038         * @param vService  the Service requesting an identity token
00039         *
00040         * @return the token that asserts identity.
00041         *
00042         * @throws SecurityException if the identity transformation fails.
00043         *
00044         * @since Coherence 3.7 added vService param which intentionally breaks
00045         *        compatibility with Coherence 3.6
00046         */
00047         virtual Object::View transformIdentity(Subject::View vSubject,
00048                 Service::View vService) const = 0;
00049     };
00050 
00051 COH_CLOSE_NAMESPACE2
00052 
00053 #endif // COH_IDENTITY_TRANSFORMER_HPP