org.keycloak.provider.ProviderFactory Maven / Gradle / Ivy
/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* 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
*
* http://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 org.keycloak.provider;
import org.keycloak.Config;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
/**
* At boot time, keycloak discovers all factories. For each discovered factory, the init() method is called. After
* all factories have been initialized, the postInit() method is called. close() is called when the server shuts down.
*
* Only one instance of a factory exists per server.
*
* @author Stian Thorgersen
*/
public interface ProviderFactory {
public T create(KeycloakSession session);
/**
* Only called once when the factory is first created. This config is pulled from keycloak_server.json
*
* @param config
*/
public void init(Config.Scope config);
/**
* Called after all provider factories have been initialized
*/
public void postInit(KeycloakSessionFactory factory);
/**
* This is called when the server shuts down.
*
*/
public void close();
public String getId();
}