io.micronaut.security.authentication.ServerAuthentication Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of micronaut-security Show documentation
Official Security Solution for Micronaut
There is a newer version: 4.10.1
/*
 * Copyright 2017-2023 original authors
 *
 * Licensed 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
 *
 * https://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.
 */
package io.micronaut.security.authentication;

import com.fasterxml.jackson.annotation.JsonValue;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.security.token.config.TokenConfiguration;
import io.micronaut.serde.annotation.Serdeable;

import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * An implementation of the {@link Authentication} interfaced intended to
 * be used on the server side to create authentication objects from
 * user data found through any means.
 *
 * @author James Kleeh
 * @since 3.0.0
 */
@Serdeable
public class ServerAuthentication implements Authentication {

    private static final String JSON_KEY_NAME = "name";
    private static final String JSON_KEY_ATTRIBUTES = "attributes";
    @NonNull
    @NotBlank
    private final String name;

    @NonNull
    @NotNull
    private final Collection roles;

    @NonNull
    @NotNull
    private final Map attributes;

    /**
     *
     * @param name The name of this principal name
     * @param roles Roles of the authenticated user
     * @param attributes Attributes of the authenticated user
     */
    public ServerAuthentication(@NonNull String name,
                                @Nullable Collection roles,
                                @Nullable Map attributes) {
        this.name = name;
        this.roles = (roles == null || roles.isEmpty()) ? new ArrayList<>() : roles;
        this.attributes = attributes == null ? Collections.emptyMap() : attributes;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    @NonNull
    public Map getAttributes() {
        return Collections.unmodifiableMap(attributes);
    }

    @Override
    @NonNull
    public Collection getRoles() {
        return Collections.unmodifiableCollection(roles);
    }

    /**
     * @return A Map to be used a JSON representation of the object
     */
    @JsonValue
    public Map toJson() {
        Map json = new HashMap<>();
        json.put(JSON_KEY_NAME, getName());
        Map jsonAttributes = new HashMap<>(getAttributes());
        jsonAttributes.putIfAbsent(TokenConfiguration.DEFAULT_ROLES_NAME, getRoles());
        json.put(JSON_KEY_ATTRIBUTES, jsonAttributes);
        return json;
    }
}