ca.nrc.cadc.auth.AuthorizationToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-util Show documentation
OpenCADC core utility library
There is a newer version: 1.11.5
/*
 ************************************************************************
 *******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
 **************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
 *
 *  (c) 2021.                            (c) 2021.
 *  Government of Canada                 Gouvernement du Canada
 *  National Research Council            Conseil national de recherches
 *  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
 *  All rights reserved                  Tous droits réservés
 *
 *  NRC disclaims any warranties,        Le CNRC dénie toute garantie
 *  expressed, implied, or               énoncée, implicite ou légale,
 *  statutory, of any kind with          de quelque nature que ce
 *  respect to the software,             soit, concernant le logiciel,
 *  including without limitation         y compris sans restriction
 *  any warranty of merchantability      toute garantie de valeur
 *  or fitness for a particular          marchande ou de pertinence
 *  purpose. NRC shall not be            pour un usage particulier.
 *  liable in any event for any          Le CNRC ne pourra en aucun cas
 *  damages, whether direct or           être tenu responsable de tout
 *  indirect, special or general,        dommage, direct ou indirect,
 *  consequential or incidental,         particulier ou général,
 *  arising from the use of the          accessoire ou fortuit, résultant
 *  software.  Neither the name          de l'utilisation du logiciel. Ni
 *  of the National Research             le nom du Conseil National de
 *  Council of Canada nor the            Recherches du Canada ni les noms
 *  names of its contributors may        de ses  participants ne peuvent
 *  be used to endorse or promote        être utilisés pour approuver ou
 *  products derived from this           promouvoir les produits dérivés
 *  software without specific prior      de ce logiciel sans autorisation
 *  written permission.                  préalable et particulière
 *                                       par écrit.
 *
 *  This file is part of the             Ce fichier fait partie du projet
 *  OpenCADC project.                    OpenCADC.
 *
 *  OpenCADC is free software:           OpenCADC est un logiciel libre ;
 *  you can redistribute it and/or       vous pouvez le redistribuer ou le
 *  modify it under the terms of         modifier suivant les termes de
 *  the GNU Affero General Public        la “GNU Affero General Public
 *  License as published by the          License” telle que publiée
 *  Free Software Foundation,            par la Free Software Foundation
 *  either version 3 of the              : soit la version 3 de cette
 *  License, or (at your option)         licence, soit (à votre gré)
 *  any later version.                   toute version ultérieure.
 *
 *  OpenCADC is distributed in the       OpenCADC est distribué
 *  hope that it will be useful,         dans l’espoir qu’il vous
 *  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
 *  without even the implied             GARANTIE : sans même la garantie
 *  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
 *  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
 *  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
 *  General Public License for           Générale Publique GNU Affero
 *  more details.                        pour plus de détails.
 *
 *  You should have received             Vous devriez avoir reçu une
 *  a copy of the GNU Affero             copie de la Licence Générale
 *  General Public License along         Publique GNU Affero avec
 *  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
 *  .      pas le cas, consultez :
 *                                       .
 *
 ************************************************************************
 */

package ca.nrc.cadc.auth;

import java.net.URI;
import java.util.List;

/**
 * Class representing an authorization token.  For example, an opaque OAuth2 token value
 * with name 'Bearer'.
 * 
 * @author majorb
 *
 */
public class AuthorizationToken {
    
    private String type;
    private String credentials;
    
    // Domain-level scope.
    private List domains;
    
    // Application-level scope.
    private URI scope;
    
    /**
     * Contructor.
     * @param type The type of the token. (eg, Bearer)
     * @param credentials The token credentials.
     */
    public AuthorizationToken(String type, String credentials, List domains) {
        this(type, credentials, domains, null);
    }
    
    /**
     * Contructor.
     * @param type The type of the token. (eg, Bearer)
     * @param credentials The token credentials.
     */
    public AuthorizationToken(String type, String credentials, List domains, URI scope) {
        if (type == null) {
            throw new IllegalArgumentException("type required");
        }
        if (credentials == null) {
            throw new IllegalArgumentException("credentials required");
        }
        if (domains == null) {
            throw new IllegalArgumentException("domains required");
        }
        this.type = type;
        this.credentials = credentials;
        this.domains = domains;
        this.scope = scope;
    }
    
    /**
     * Type getter.
     * @return The type.
     */
    public String getType() {
        return type;
    }
    
    /**
     * Credentials getter.
     * @return The credentials.
     */
    public String getCredentials() {
        return credentials;
    }
    
    /**
     * Domains getter.
     * @return The domains.
     */
    public List getDomains() {
        return domains;
    }
    
    /**
     * Scope getter.
     * @return The scope.
     */
    public URI getScope() {
        return scope;
    }
    
    /**
     * String output.
     */
    @Override
    public String toString() {
        return "AuthorizationToken[type=[" + type + "],domains=" + domains + ", scope=[" + scope + "]]";
    }

}