001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.security.server.graphql;
018
019import com.echothree.model.control.graphql.server.graphql.BaseEntityInstanceObject;
020import com.echothree.model.control.graphql.server.util.BaseGraphQl;
021import com.echothree.model.control.security.server.control.SecurityControl;
022import com.echothree.model.control.user.server.control.UserControl;
023import com.echothree.model.data.security.server.entity.SecurityRole;
024import com.echothree.model.data.security.server.entity.SecurityRoleDetail;
025import com.echothree.util.server.persistence.Session;
026import graphql.annotations.annotationTypes.GraphQLDescription;
027import graphql.annotations.annotationTypes.GraphQLField;
028import graphql.annotations.annotationTypes.GraphQLName;
029import graphql.annotations.annotationTypes.GraphQLNonNull;
030import graphql.schema.DataFetchingEnvironment;
031
032@GraphQLDescription("security role object")
033@GraphQLName("SecurityRole")
034public class SecurityRoleObject
035        extends BaseEntityInstanceObject {
036    
037    private final SecurityRole securityRole; // Always Present
038    
039    public SecurityRoleObject(SecurityRole securityRole) {
040        super(securityRole.getPrimaryKey());
041        
042        this.securityRole = securityRole;
043    }
044
045    private SecurityRoleDetail securityRoleDetail; // Optional, use getSecurityRoleDetail()
046    
047    private SecurityRoleDetail getSecurityRoleDetail() {
048        if(securityRoleDetail == null) {
049            securityRoleDetail = securityRole.getLastDetail();
050        }
051        
052        return securityRoleDetail;
053    }
054    
055    @GraphQLField
056    @GraphQLDescription("security role name")
057    @GraphQLNonNull
058    public String getSecurityRoleName() {
059        return getSecurityRoleDetail().getSecurityRoleName();
060    }
061
062    @GraphQLField
063    @GraphQLDescription("security role group")
064    public SecurityRoleGroupObject getSecurityRoleGroup(final DataFetchingEnvironment env) {
065        return SecuritySecurityUtils.getHasSecurityRoleGroupAccess(env) ? new SecurityRoleGroupObject(getSecurityRoleDetail().getSecurityRoleGroup()) : null;
066    }
067
068    @GraphQLField
069    @GraphQLDescription("is default")
070    @GraphQLNonNull
071    public boolean getIsDefault() {
072        return getSecurityRoleDetail().getIsDefault();
073    }
074    
075    @GraphQLField
076    @GraphQLDescription("sort order")
077    @GraphQLNonNull
078    public int getSortOrder() {
079        return getSecurityRoleDetail().getSortOrder();
080    }
081    
082    @GraphQLField
083    @GraphQLDescription("description")
084    @GraphQLNonNull
085    public String getDescription(final DataFetchingEnvironment env) {
086        var securityControl = Session.getModelController(SecurityControl.class);
087        var userControl = Session.getModelController(UserControl.class);
088
089        return securityControl.getBestSecurityRoleDescription(securityRole, userControl.getPreferredLanguageFromUserVisit(BaseGraphQl.getUserVisit(env)));
090    }
091
092}