Package org.keycloak.protocol.docker.installation

Class DockerComposeYamlInstallationProvider

java.lang.Object

org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider

All Implemented Interfaces:

ClientInstallationProvider, Provider, ProviderFactory<ClientInstallationProvider>

public class DockerComposeYamlInstallationProvider
extends Object
implements ClientInstallationProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROOT_DIR

Constructor Summary

Constructors

Constructor	Description
DockerComposeYamlInstallationProvider()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
ClientInstallationProvider	create(KeycloakSession session)
jakarta.ws.rs.core.Response	generateInstallation(ZipOutputStream zipOutput, ByteArrayOutputStream byteStream, Certificate realmCert, URL realmBaseURl, String realmName, String clientName)
jakarta.ws.rs.core.Response	generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri)
String	getDisplayType()
String	getFilename()
String	getHelpText()
String	getId()
String	getMediaType()
String	getProtocol()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isDownloadOnly()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

ROOT_DIR

public static final String ROOT_DIR

See Also:

• Constant Field Values

Constructor Details

DockerComposeYamlInstallationProvider

public DockerComposeYamlInstallationProvider()

Method Details

create

public ClientInstallationProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ClientInstallationProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<ClientInstallationProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<ClientInstallationProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<ClientInstallationProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ClientInstallationProvider>

generateInstallation

public jakarta.ws.rs.core.Response generateInstallation(KeycloakSession session,
 RealmModel realm,
 ClientModel client,
 URI serverBaseUri)

Specified by:

generateInstallation in interface ClientInstallationProvider

generateInstallation

public jakarta.ws.rs.core.Response generateInstallation(ZipOutputStream zipOutput,
 ByteArrayOutputStream byteStream,
 Certificate realmCert,
 URL realmBaseURl,
 String realmName,
 String clientName)
                                                 throws IOException

Throws:

IOException

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ClientInstallationProvider

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ClientInstallationProvider

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ClientInstallationProvider

getFilename

public String getFilename()

Specified by:

getFilename in interface ClientInstallationProvider

getMediaType

public String getMediaType()

Specified by:

getMediaType in interface ClientInstallationProvider

isDownloadOnly

public boolean isDownloadOnly()

Specified by:

isDownloadOnly in interface ClientInstallationProvider