wwauth/Google.Solutions.WWAuth/Adapters/ITokenAdapter.cs

//
// Copyright 2022 Google LLC
//
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
// 
//   http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//

using Google.Solutions.WWAuth.Data;
using System;
using System.Threading;
using System.Threading.Tasks;

namespace Google.Solutions.WWAuth.Adapters
{
    /// <summary>
    /// Adapter for acquiring tokens.
    /// </summary>
    public interface ITokenAdapter
    {
        /// <summary>
        /// Fetch a token from the authorization server
        /// using the given network credential.
        /// </summary>
        Task<ISubjectToken> AcquireTokenAsync(
            TokenAcquisitionOptions options,
            CancellationToken cancellationToken);
    }

    [Flags]
    public enum TokenAcquisitionOptions
    {
        None,
        ExtensiveValidation
    }

    public class TokenAcquisitionException : Exception
    {
        public TokenAcquisitionException(string message)
            : base(message)
        {
        }

        public TokenAcquisitionException(
            string message,
            Exception inner)
            : base(message, inner)
        {
        }
    }
}