com.bazaarvoice.emodb.uac.api.CreateEmoRoleRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of emodb-uac-api Show documentation

There is a newer version: 6.5.171

package com.bazaarvoice.emodb.uac.api;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.google.common.collect.ImmutableSet;

import java.util.Optional;
import java.util.Set;

import static java.util.Objects.requireNonNull;

/**
 * Request object for creating new roles.  Parameters include the key for the new role (group and ID),
 * attributes such as name and description, and the set of initial permissions for this role.  With the exception
 * of "roleKey" all other parameters are optional, although it is recommended to provide at least a user-friendly name
 * for each role.
 */
public class CreateEmoRoleRequest extends UserAccessControlRequest {
    private EmoRoleKey _roleKey;
    private String _name;
    private String _description;
    private Set _permissions = ImmutableSet.of();

    @JsonCreator
    public CreateEmoRoleRequest() {
        // empty
    }

    public CreateEmoRoleRequest(EmoRoleKey roleKey) {
        setRoleKey(roleKey);
    }

    public CreateEmoRoleRequest(String group, String id) {
        this(new EmoRoleKey(group, id));
    }

    public CreateEmoRoleRequest setRoleKey(EmoRoleKey roleKey) {
        _roleKey = requireNonNull(roleKey, "roleKey");
        return this;
    }

    @JsonIgnore
    public EmoRoleKey getRoleKey() {
        return _roleKey;
    }

    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getName() {
        return _name;
    }

    public CreateEmoRoleRequest setName(String name) {
        _name = name;
        return this;
    }

    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getDescription() {
        return _description;
    }

    public CreateEmoRoleRequest setDescription(String description) {
        _description = description;
        return this;
    }

    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    public Set getPermissions() {
        return _permissions;
    }

    public CreateEmoRoleRequest setPermissions(Set permissions) {
        _permissions = Optional.ofNullable(permissions).orElse(ImmutableSet.of());
        return this;
    }
}