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_ASSERTER_HPP 00008 #define COH_IDENTITY_ASSERTER_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 * IdentityAsserter validates a token in order to establish a user's identity. 00023 * The token is an identity assertion, a statement that asserts an identity. 00024 * <p> 00025 * A token is opaque to Coherence. It could be a standard type such as a SAML 00026 * Assertion or a proprietary type. 00027 * 00028 * @author dag 2009.10.30 00029 * 00030 * @since Coherence 3.6 00031 */ 00032 class COH_EXPORT IdentityAsserter 00033 : public interface_spec<IdentityAsserter> 00034 { 00035 // ----- IdentityAsserter interface ------------------------------------- 00036 00037 public: 00038 /** 00039 * Asserts an identity based on a token-based identity assertion. 00040 * 00041 * @param oToken the token that asserts identity. 00042 * @param vService the Service asserting the identity token 00043 * 00044 * @return a Subject representing the identity. 00045 * 00046 * @throws SecurityException if the identity assertion fails. 00047 * 00048 * @since Coherence 3.7 added vService param which intentionally breaks 00049 * compatibility with Coherence 3.6 00050 */ 00051 virtual Subject::View assertIdentity(Object::View vToken, 00052 Service::View vService) const = 0; 00053 }; 00054 00055 COH_CLOSE_NAMESPACE2 00056 00057 #endif // COH_IDENTITY_ASSERTER_HPP