org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider クラス

org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider の継承関係図

org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider 連携図

公開メンバ関数
ClientInstallationProvider	create (final KeycloakSession session)
void	init (final Config.Scope config)
void	postInit (final KeycloakSessionFactory factory)
void	close ()
String	getId ()
Response	generateInstallation (final KeycloakSession session, final RealmModel realm, final ClientModel client, final URI serverBaseUri)
Response	generateInstallation (final ZipOutputStream zipOutput, final ByteArrayOutputStream byteStream, final Certificate realmCert, final URL realmBaseURl, final String realmName, final String clientName) throws IOException
String	getProtocol ()
String	getDisplayType ()
String	getHelpText ()
String	getFilename ()
String	getMediaType ()
boolean	isDownloadOnly ()

静的公開変数類
static final String	ROOT_DIR = "keycloak-docker-compose-yaml/"

静的非公開変数類
static Logger	log = Logger.getLogger(DockerComposeYamlInstallationProvider.class)

詳解

関数詳解

close()

void org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.close ( )

inline

                        {
        // no-op
    }

create()

ClientInstallationProvider org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.create ( final KeycloakSession  session )

inline

                                                                            {
        return this;
    }

generateInstallation() [1/2]

Response org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.generateInstallation ( final KeycloakSession  session, final RealmModel  realm, final ClientModel  client, final URI  serverBaseUri  )

inline

                                                                                                                                                   {
        final ByteArrayOutputStream byteStream = new ByteArrayOutputStream();
        final ZipOutputStream zipOutput = new ZipOutputStream(byteStream);

        try {
            return generateInstallation(zipOutput, byteStream, session.keys().getActiveRsaKey(realm).getCertificate(), session.getContext().getAuthServerUrl().toURL(), realm.getName(), client.getClientId());
        } catch (final IOException e) {
            try {
                zipOutput.close();
            } catch (final IOException ex) {
                // do nothing, already in an exception
            }
            try {
                byteStream.close();
            } catch (final IOException ex) {
                // do nothing, already in an exception
            }
            throw new RuntimeException("Error occurred during attempt to generate docker-compose yaml installation files", e);
        }
    }

generateInstallation() [2/2]

Response org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.generateInstallation ( final ZipOutputStream  zipOutput, final ByteArrayOutputStream  byteStream, final Certificate  realmCert, final URL  realmBaseURl, final String  realmName, final String  clientName  ) throws IOException

inline

                                                                                                             {
        final DockerComposeZipContent zipContent = new DockerComposeZipContent(realmCert, realmBaseURl, realmName, clientName);

        zipOutput.putNextEntry(new ZipEntry(ROOT_DIR));

        // Write docker compose file
        zipOutput.putNextEntry(new ZipEntry(ROOT_DIR + "docker-compose.yaml"));
        zipOutput.write(zipContent.getYamlFile().generateDockerComposeFileBytes());
        zipOutput.closeEntry();

        // Write data directory
        zipOutput.putNextEntry(new ZipEntry(ROOT_DIR + zipContent.getDataDirectoryName() + "/"));
        zipOutput.putNextEntry(new ZipEntry(ROOT_DIR + zipContent.getDataDirectoryName() + "/.gitignore"));
        zipOutput.write("*".getBytes());
        zipOutput.closeEntry();

        // Write certificates
        final String certsDirectory = ROOT_DIR + zipContent.getCertsDirectory().getDirectoryName() + "/";
        zipOutput.putNextEntry(new ZipEntry(certsDirectory));
        zipOutput.putNextEntry(new ZipEntry(certsDirectory + zipContent.getCertsDirectory().getLocalhostCertFile().getKey()));
        zipOutput.write(zipContent.getCertsDirectory().getLocalhostCertFile().getValue());
        zipOutput.closeEntry();
        zipOutput.putNextEntry(new ZipEntry(certsDirectory + zipContent.getCertsDirectory().getLocalhostKeyFile().getKey()));
        zipOutput.write(zipContent.getCertsDirectory().getLocalhostKeyFile().getValue());
        zipOutput.closeEntry();
        zipOutput.putNextEntry(new ZipEntry(certsDirectory + zipContent.getCertsDirectory().getIdpTrustChainFile().getKey()));
        zipOutput.write(zipContent.getCertsDirectory().getIdpTrustChainFile().getValue());
        zipOutput.closeEntry();

        // Write README to .zip
        zipOutput.putNextEntry(new ZipEntry(ROOT_DIR + "README.md"));
        final String readmeContent = new BufferedReader(new InputStreamReader(DockerComposeYamlInstallationProvider.class.getResourceAsStream("/DockerComposeYamlReadme.md"))).lines().collect(Collectors.joining("\n"));
        zipOutput.write(readmeContent.getBytes());
        zipOutput.closeEntry();

        zipOutput.close();
        byteStream.close();

        return Response.ok(byteStream.toByteArray(), getMediaType()).build();
    }

getDisplayType()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getDisplayType ( )

inline

                                   {
        return "Docker Compose YAML";
    }

getFilename()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getFilename ( )

inline

                                {
        return "keycloak-docker-compose-yaml.zip";
    }

getHelpText()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getHelpText ( )

inline

                                {
        return "Produces a zip file that can be used to stand up a development registry on localhost";
    }

getId()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getId ( )

inline

                          {
        return "docker-v2-compose-yaml";
    }

getMediaType()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getMediaType ( )

inline

                                 {
        return "application/zip";
    }

getProtocol()

String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.getProtocol ( )

inline

                                {
        return DockerAuthV2Protocol.LOGIN_PROTOCOL;
    }

init()

void org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.init ( final Config.Scope  config )

inline

                                                {
        // no-op
    }

isDownloadOnly()

boolean org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.isDownloadOnly ( )

inline

                                    {
        return true;
    }

postInit()

void org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.postInit ( final KeycloakSessionFactory  factory )

inline

                                                               {
        // no-op
    }

メンバ詳解

log

Logger org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.log = Logger.getLogger(DockerComposeYamlInstallationProvider.class)

staticprivate

ROOT_DIR

final String org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider.ROOT_DIR = "keycloak-docker-compose-yaml/"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/docker/installation/DockerComposeYamlInstallationProvider.java