org.keycloak.protocol.saml.mappers.RoleNameMapper クラス

org.keycloak.protocol.saml.mappers.RoleNameMapper の継承関係図

org.keycloak.protocol.saml.mappers.RoleNameMapper 連携図

公開メンバ関数
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
String	getDisplayType ()
String	getDisplayCategory ()
String	getHelpText ()
String	mapName (ProtocolMapperModel model, RoleModel roleModel)
String	getProtocol ()
void	close ()
void	init (Config.Scope config)
final ProtocolMapper	create (KeycloakSession session)
void	postInit (KeycloakSessionFactory factory)
default void	validateConfig (KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException
default int	order ()

静的公開メンバ関数
static ProtocolMapperModel	create (String name, String role, String newName)

静的公開変数類
static final String	ROLE_CONFIG = "role"
static String	NEW_ROLE_NAME = "new.role.name"
static final String	PROVIDER_ID = "saml-role-name-mapper"

静的関数
	[static initializer]

静的非公開変数類
static final List< ProviderConfigProperty >	configProperties = new ArrayList<ProviderConfigProperty>()

詳解

Map an assigned role to a different position and name in the token

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

org.keycloak.protocol.saml.mappers.RoleNameMapper.[static initializer] ( )

inlinestaticpackage

close()

void org.keycloak.protocol.saml.mappers.RoleNameMapper.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {
    }

create() [1/2]

static ProtocolMapperModel org.keycloak.protocol.saml.mappers.RoleNameMapper.create ( String  name, String  role, String  newName  )

inlinestatic

                                                             {
        String mapperId = PROVIDER_ID;
        ProtocolMapperModel mapper = new ProtocolMapperModel();
        mapper.setName(name);
        mapper.setProtocolMapper(mapperId);
        mapper.setProtocol(SamlProtocol.LOGIN_PROTOCOL);
        Map<String, String> config = new HashMap<String, String>();
        config.put(ROLE_CONFIG, role);
        config.put(NEW_ROLE_NAME, newName);
        mapper.setConfig(config);
        return mapper;

    }

create() [2/2]

final ProtocolMapper org.keycloak.protocol.saml.mappers.RoleNameMapper.create ( KeycloakSession  session )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                {
        throw new RuntimeException("UNSUPPORTED METHOD");
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.protocol.saml.mappers.RoleNameMapper.getConfigProperties ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                                              {
        return configProperties;
    }

getDisplayCategory()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.getDisplayCategory ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                       {
        return "Role Mapper";

    }

getDisplayType()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.getDisplayType ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                   {
        return "Role Name Mapper";
    }

getHelpText()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.getHelpText ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                {
        return "Map an assigned role to a new name";
    }

getId()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.getId ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return PROVIDER_ID;
    }

getProtocol()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.getProtocol ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                {
        return SamlProtocol.LOGIN_PROTOCOL;
    }

init()

void org.keycloak.protocol.saml.mappers.RoleNameMapper.init ( Config.Scope  config )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                          {
    }

mapName()

String org.keycloak.protocol.saml.mappers.RoleNameMapper.mapName ( ProtocolMapperModel  model, RoleModel  roleModel  )

inline

org.keycloak.protocol.saml.mappers.SAMLRoleNameMapperを実装しています。

                                                                          {
        RoleContainerModel container = roleModel.getContainer();
        ClientModel app = null;
        if (container instanceof ClientModel) {
            app = ((ClientModel) container);
        }
        String role = model.getConfig().get(ROLE_CONFIG);
        String newName = model.getConfig().get(NEW_ROLE_NAME);
        String appName = null;
        int scopeIndex = role.indexOf('.');
        if (scopeIndex > -1) {
            if (app == null) return null;
            appName = role.substring(0, scopeIndex);
            if (!app.getClientId().equals(appName)) return null;
            role = role.substring(scopeIndex + 1);
        } else {
            if (app != null) return null;
        }
        if (roleModel.getName().equals(role)) return newName;
        return null;
   }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.protocol.saml.mappers.RoleNameMapper.postInit ( KeycloakSessionFactory  factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {

    }

validateConfig()

default void org.keycloak.protocol.ProtocolMapper.validateConfig ( KeycloakSession  session, RealmModel  realm, ProtocolMapperContainerModel  client, ProtocolMapperModel  mapperModel  ) throws ProtocolMapperConfigException

inlineinherited

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

引数

session
realm
client	client or clientTemplate
mapperModel

例外

ProtocolMapperConfigException

if configuration provided in mapperModel is not valid

org.keycloak.protocol.saml.mappers.ScriptBasedMapper, org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

                                                                                                                                                                                      {
    };

メンバ詳解

configProperties

final List<ProviderConfigProperty> org.keycloak.protocol.saml.mappers.RoleNameMapper.configProperties = new ArrayList<ProviderConfigProperty>()

staticprivate

NEW_ROLE_NAME

String org.keycloak.protocol.saml.mappers.RoleNameMapper.NEW_ROLE_NAME = "new.role.name"

static

PROVIDER_ID

final String org.keycloak.protocol.saml.mappers.RoleNameMapper.PROVIDER_ID = "saml-role-name-mapper"

static

ROLE_CONFIG

final String org.keycloak.protocol.saml.mappers.RoleNameMapper.ROLE_CONFIG = "role"

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/saml/mappers/RoleNameMapper.java