keycloak-oidc-service
公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
org.keycloak.protocol.AbstractLoginProtocolFactory クラスabstract
org.keycloak.protocol.AbstractLoginProtocolFactory の継承関係図
Inheritance graph
org.keycloak.protocol.AbstractLoginProtocolFactory 連携図
Collaboration graph

公開メンバ関数

void init (Config.Scope config)
 
void postInit (KeycloakSessionFactory factory)
 
void createDefaultClientScopes (RealmModel newRealm, boolean addScopesToExistingClients)
 
void close ()
 
Map< String, ProtocolMapperModelgetBuiltinMappers ()
 
Object createProtocolEndpoint (RealmModel realm, EventBuilder event)
 
void setupClientDefaults (ClientRepresentation rep, ClientModel newClient)
 
create (KeycloakSession session)
 
String getId ()
 
default int order ()
 

限定公開メンバ関数

abstract void createDefaultClientScopesImpl (RealmModel newRealm)
 
void addDefaultClientScopes (RealmModel realm, ClientModel newClient)
 
abstract void addDefaults (ClientModel realm)
 

詳解

著者
Bill Burke
バージョン
Revision
1

関数詳解

◆ addDefaultClientScopes()

void org.keycloak.protocol.AbstractLoginProtocolFactory.addDefaultClientScopes ( RealmModel  realm,
ClientModel  newClient 
)
inlineprotected
71  {
72  for (ClientScopeModel clientScope : realm.getDefaultClientScopes(true)) {
73  if (getId().equals(clientScope.getProtocol())) {
74  newClient.addClientScope(clientScope, true);
75  }
76  }
77  for (ClientScopeModel clientScope : realm.getDefaultClientScopes(false)) {
78  if (getId().equals(clientScope.getProtocol())) {
79  newClient.addClientScope(clientScope, false);
80  }
81  }
82  }

◆ addDefaults()

abstract void org.keycloak.protocol.AbstractLoginProtocolFactory.addDefaults ( ClientModel  realm)
abstractprotected

◆ close()

void org.keycloak.protocol.AbstractLoginProtocolFactory.close ( )
inline

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

87  {
88 
89  }

◆ create()

T org.keycloak.provider.ProviderFactory< T extends Provider >.create ( KeycloakSession  session)
inherited

org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.protocol.oidc.OIDCLoginProtocolFactory, org.keycloak.policy.BlacklistPasswordPolicyProviderFactory, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticatorFactory, org.keycloak.theme.ClasspathThemeProviderFactory, org.keycloak.connections.httpclient.DefaultHttpClientFactory, org.keycloak.executors.DefaultExecutorsProviderFactory, org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticatorFactory, org.keycloak.authentication.authenticators.x509.ValidateX509CertificateUsernameFactory, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper, org.keycloak.events.email.EmailEventListenerProviderFactory, org.keycloak.authentication.authenticators.broker.IdpReviewProfileAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.UsernamePasswordFormFactory, org.keycloak.authorization.DefaultAuthorizationProviderFactory, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticatorFactory, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.services.x509.DefaultClientCertificateLookupFactory, org.keycloak.authentication.authenticators.broker.IdpCreateUserIfUniqueAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.CookieAuthenticatorFactory, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticatorFactory, org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator, org.keycloak.theme.JarThemeProviderFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthOTPAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticatorFactory, org.keycloak.timer.basic.BasicTimerProviderFactory, org.keycloak.truststore.FileTruststoreProviderFactory, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticatorFactory, org.keycloak.events.log.JBossLoggingEventListenerProviderFactory, org.keycloak.protocol.oidc.OIDCClientDescriptionConverterFactory, org.keycloak.authentication.authenticators.broker.IdpConfirmLinkAuthenticatorFactory, org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticatorFactory, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >, org.keycloak.policy.HistoryPasswordPolicyProviderFactory, org.keycloak.transaction.JtaTransactionManagerLookup, org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticatorFactory, org.keycloak.broker.provider.AbstractIdentityProviderMapper, org.keycloak.exportimport.dir.DirExportProviderFactory, org.keycloak.exportimport.singlefile.SingleFileExportProviderFactory, org.keycloak.policy.DigitsPasswordPolicyProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.policy.LengthPasswordPolicyProviderFactory, org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory, org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory, org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderFactory, org.keycloak.exportimport.dir.DirImportProviderFactory, org.keycloak.exportimport.singlefile.SingleFileImportProviderFactory, org.keycloak.forms.account.freemarker.FreeMarkerAccountProviderFactory, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProviderFactory, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.scripting.DefaultScriptingProviderFactory, org.keycloak.authentication.authenticators.broker.IdpUsernamePasswordFormFactory, org.keycloak.authorization.config.UmaWellKnownProviderFactory, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory, org.keycloak.services.clientregistration.oidc.OIDCClientRegistrationProviderFactory, org.keycloak.services.x509.ApacheProxySslClientCertificateLookupFactory, org.keycloak.theme.ExtendingThemeManagerFactory, org.keycloak.theme.FolderThemeProviderFactory, org.keycloak.services.x509.HaProxySslClientCertificateLookupFactory, org.keycloak.policy.LowerCasePasswordPolicyProviderFactory, org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory, org.keycloak.policy.UpperCasePasswordPolicyProviderFactory, org.keycloak.protocol.oidc.AccessTokenIntrospectionProviderFactory, org.keycloak.services.managers.DefaultBruteForceProtectorFactory, org.keycloak.services.migration.DefaultMigrationProviderFactory, org.keycloak.authorization.protection.introspect.RPTIntrospectionProviderFactory, org.keycloak.crypto.ES256SignatureProviderFactory, org.keycloak.crypto.ES384SignatureProviderFactory, org.keycloak.crypto.ES512SignatureProviderFactory, org.keycloak.crypto.HS256SignatureProviderFactory, org.keycloak.crypto.HS384SignatureProviderFactory, org.keycloak.crypto.HS512SignatureProviderFactory, org.keycloak.crypto.RS256SignatureProviderFactory, org.keycloak.crypto.RS384SignatureProviderFactory, org.keycloak.crypto.RS512SignatureProviderFactory, org.keycloak.email.DefaultEmailSenderProviderFactory, org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory, org.keycloak.protocol.oidc.RefreshTokenIntrospectionProviderFactory, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProviderFactory, org.keycloak.services.clientregistration.DefaultClientRegistrationProviderFactory, org.keycloak.locale.DefaultLocaleSelectorProviderFactory, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory, org.keycloak.url.FixedHostnameProviderFactory, org.keycloak.url.RequestHostnameProviderFactory, org.keycloak.theme.DefaultThemeSelectorProviderFactory (計108項目)で実装されています。

◆ createDefaultClientScopes()

void org.keycloak.protocol.AbstractLoginProtocolFactory.createDefaultClientScopes ( RealmModel  newRealm,
boolean  addScopesToExistingClients 
)
inline

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

54  {
56 
57  // Create default client scopes for realm built-in clients too
58  if (addScopesToExistingClients) {
59  for (ClientModel client : newRealm.getClients()) {
60  addDefaultClientScopes(newRealm, client);
61  }
62  }
63  }
void addDefaultClientScopes(RealmModel realm, ClientModel newClient)
Definition: AbstractLoginProtocolFactory.java:71
abstract void createDefaultClientScopesImpl(RealmModel newRealm)

◆ createDefaultClientScopesImpl()

abstract void org.keycloak.protocol.AbstractLoginProtocolFactory.createDefaultClientScopesImpl ( RealmModel  newRealm)
abstractprotected

Impl should create default client scopes. This is called usually when new realm is created

◆ createProtocolEndpoint()

Object org.keycloak.protocol.LoginProtocolFactory.createProtocolEndpoint ( RealmModel  realm,
EventBuilder  event 
)
inherited

◆ getBuiltinMappers()

Map<String, ProtocolMapperModel> org.keycloak.protocol.LoginProtocolFactory.getBuiltinMappers ( )
inherited

List of built in protocol mappers that can be used to apply to clients.

戻り値

org.keycloak.protocol.oidc.OIDCLoginProtocolFactoryで実装されています。

◆ getId()

String org.keycloak.provider.ProviderFactory< T extends Provider >.getId ( )
inherited

org.keycloak.protocol.oidc.OIDCLoginProtocolFactory, org.keycloak.authentication.authenticators.client.JWTClientAuthenticator, org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.authenticators.client.JWTClientSecretAuthenticator, org.keycloak.authentication.authenticators.client.ClientIdAndSecretAuthenticator, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.authenticators.client.X509ClientAuthenticator, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.authentication.authenticators.directgrant.ValidateUsername, org.keycloak.authentication.authenticators.directgrant.ValidateOTP, org.keycloak.keys.GeneratedRsaKeyProviderFactory, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.policy.BlacklistPasswordPolicyProviderFactory, org.keycloak.connections.httpclient.DefaultHttpClientFactory, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapper, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.authentication.authenticators.directgrant.ValidatePassword, org.keycloak.truststore.FileTruststoreProviderFactory, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticatorFactory, org.keycloak.keys.ImportedRsaKeyProviderFactory, org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory, org.keycloak.protocol.oidc.mappers.AddressMapper, org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper, org.keycloak.executors.DefaultExecutorsProviderFactory, org.keycloak.theme.ClasspathThemeProviderFactory, org.keycloak.keys.JavaKeystoreKeyProviderFactory, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticatorFactory, org.keycloak.keys.GeneratedEcdsaKeyProviderFactory, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory, org.keycloak.protocol.oidc.mappers.UserClientRoleMappingMapper, org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicyFactory, org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper, org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory, org.keycloak.events.email.EmailEventListenerProviderFactory, org.keycloak.broker.oidc.mappers.ClaimToRoleMapper, org.keycloak.broker.oidc.mappers.UserAttributeMapper, org.keycloak.broker.provider.HardcodedAttributeMapper, org.keycloak.broker.provider.HardcodedUserSessionAttributeMapper, org.keycloak.broker.oidc.mappers.ExternalKeycloakRoleToRoleMapper, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.UsernamePasswordFormFactory, org.keycloak.protocol.oidc.mappers.RoleNameMapper, org.keycloak.services.clientregistration.policy.impl.MaxClientsClientRegistrationPolicyFactory, org.keycloak.protocol.oidc.mappers.UserAttributeMapper, org.keycloak.authentication.authenticators.browser.CookieAuthenticatorFactory, org.keycloak.broker.provider.HardcodedRoleMapper, org.keycloak.policy.LowerCasePasswordPolicyProviderFactory, org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory, org.keycloak.policy.UpperCasePasswordPolicyProviderFactory, org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.broker.oidc.mappers.UsernameTemplateMapper, org.keycloak.protocol.oidc.mappers.UserRealmRoleMappingMapper, org.keycloak.protocol.oidc.mappers.GroupMembershipMapper, org.keycloak.protocol.oidc.mappers.HardcodedClaim, org.keycloak.authentication.authenticators.broker.IdpReviewProfileAuthenticatorFactory, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticatorFactory, org.keycloak.protocol.oidc.mappers.HardcodedRole, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.authorization.DefaultAuthorizationProviderFactory, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.services.x509.DefaultClientCertificateLookupFactory, org.keycloak.authentication.authenticators.broker.IdpCreateUserIfUniqueAuthenticatorFactory, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticatorFactory, org.keycloak.timer.basic.BasicTimerProviderFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthOTPAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticatorFactory, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticatorFactory, org.keycloak.authentication.authenticators.x509.ValidateX509CertificateUsernameFactory, org.keycloak.events.log.JBossLoggingEventListenerProviderFactory, org.keycloak.protocol.oidc.mappers.UserPropertyMapper, org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper, org.keycloak.transaction.JBossJtaTransactionManagerLookup, org.keycloak.authentication.authenticators.broker.IdpConfirmLinkAuthenticatorFactory, org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticatorFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.theme.FolderThemeProviderFactory, org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticatorFactory, org.keycloak.authentication.authenticators.resetcred.ResetPassword, org.keycloak.exportimport.singlefile.SingleFileImportProviderFactory, org.keycloak.protocol.oidc.mappers.FullNameMapper, org.keycloak.protocol.oidc.OIDCClientDescriptionConverterFactory, org.keycloak.scripting.DefaultScriptingProviderFactory, org.keycloak.authentication.authenticators.resetcred.ResetOTP, org.keycloak.exportimport.dir.DirExportProviderFactory, org.keycloak.exportimport.singlefile.SingleFileExportProviderFactory, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.services.managers.DefaultBruteForceProtectorFactory, org.keycloak.theme.ExtendingThemeManagerFactory, org.keycloak.authorization.config.UmaWellKnownProviderFactory, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderFactory, org.keycloak.exportimport.dir.DirImportProviderFactory, org.keycloak.forms.account.freemarker.FreeMarkerAccountProviderFactory, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProviderFactory, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.protocol.oidc.AccessTokenIntrospectionProviderFactory, org.keycloak.services.clientregistration.policy.impl.ClientDisabledClientRegistrationPolicyFactory, org.keycloak.services.clientregistration.policy.impl.ConsentRequiredClientRegistrationPolicyFactory, org.keycloak.services.clientregistration.policy.impl.ScopeClientRegistrationPolicyFactory, org.keycloak.services.migration.DefaultMigrationProviderFactory, org.keycloak.authorization.protection.introspect.RPTIntrospectionProviderFactory, org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory, org.keycloak.services.clientregistration.oidc.OIDCClientRegistrationProviderFactory, org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory, org.keycloak.email.DefaultEmailSenderProviderFactory, org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProviderFactory, org.keycloak.services.clientregistration.DefaultClientRegistrationProviderFactory, org.keycloak.locale.DefaultLocaleSelectorProviderFactory, org.keycloak.services.x509.ApacheProxySslClientCertificateLookupFactory, org.keycloak.authentication.authenticators.broker.IdpUsernamePasswordFormFactory, org.keycloak.services.x509.HaProxySslClientCertificateLookupFactory, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.credential.CredentialProviderFactory< T extends CredentialProvider >, org.keycloak.protocol.oidc.RefreshTokenIntrospectionProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory, org.keycloak.policy.HistoryPasswordPolicyProviderFactory, org.keycloak.policy.DigitsPasswordPolicyProviderFactory, org.keycloak.policy.LengthPasswordPolicyProviderFactory, org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory, org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory, org.keycloak.url.FixedHostnameProviderFactory, org.keycloak.theme.DefaultThemeSelectorProviderFactory, org.keycloak.crypto.ES256SignatureProviderFactory, org.keycloak.crypto.ES384SignatureProviderFactory, org.keycloak.crypto.ES512SignatureProviderFactory, org.keycloak.crypto.HS256SignatureProviderFactory, org.keycloak.crypto.HS384SignatureProviderFactory, org.keycloak.crypto.HS512SignatureProviderFactory, org.keycloak.crypto.RS256SignatureProviderFactory, org.keycloak.crypto.RS384SignatureProviderFactory, org.keycloak.crypto.RS512SignatureProviderFactory, org.keycloak.url.RequestHostnameProviderFactory (計145項目)で実装されています。

◆ init()

void org.keycloak.protocol.AbstractLoginProtocolFactory.init ( Config.Scope  config)
inline

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

35  {
36  }

◆ order()

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

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

56  {
57  return 0;
58  }

◆ postInit()

void org.keycloak.protocol.AbstractLoginProtocolFactory.postInit ( KeycloakSessionFactory  factory)
inline

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

39  {
40  factory.register(new ProviderEventListener() {
41  @Override
42  public void onEvent(ProviderEvent event) {
43  if (event instanceof RealmModel.ClientCreationEvent) {
44  ClientModel client = ((RealmModel.ClientCreationEvent)event).getCreatedClient();
45  addDefaultClientScopes(client.getRealm(), client);
46  addDefaults(client);
47  }
48  }
49  });
50  }
void addDefaultClientScopes(RealmModel realm, ClientModel newClient)
Definition: AbstractLoginProtocolFactory.java:71
abstract void addDefaults(ClientModel realm)

◆ setupClientDefaults()

void org.keycloak.protocol.LoginProtocolFactory.setupClientDefaults ( ClientRepresentation  rep,
ClientModel  newClient 
)
inherited

Setup default values for new clients. This expects that the representation has already set up the client

引数
rep
newClient

org.keycloak.protocol.oidc.OIDCLoginProtocolFactoryで実装されています。


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