org.keycloak.subsystem.server.extension.KeycloakSubsystemParser クラス

org.keycloak.subsystem.server.extension.KeycloakSubsystemParser の継承関係図

org.keycloak.subsystem.server.extension.KeycloakSubsystemParser 連携図

公開メンバ関数
void	readElement (final XMLExtendedStreamReader reader, final List< ModelNode > list) throws XMLStreamException
void	writeContent (final XMLExtendedStreamWriter writer, final SubsystemMarshallingContext context) throws XMLStreamException

非公開メンバ関数
void	readProviders (final XMLExtendedStreamReader reader, ModelNode addKeycloakSub) throws XMLStreamException
void	readTheme (final List< ModelNode > list, final XMLExtendedStreamReader reader) throws XMLStreamException
void	readModules (final XMLExtendedStreamReader reader, ModelNode addThemeDefaults) throws XMLStreamException
void	readSpi (final List< ModelNode > list, final XMLExtendedStreamReader reader) throws XMLStreamException
void	readProvider (final List< ModelNode > list, String spiName, final XMLExtendedStreamReader reader) throws XMLStreamException
void	readProperties (final PropertiesAttributeDefinition attrDef, ModelNode addOp, final XMLExtendedStreamReader reader) throws XMLStreamException
int	nextTag (XMLExtendedStreamReader reader) throws XMLStreamException
void	writeThemeDefaults (XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException
void	writeSpis (XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException
void	writeProviders (XMLExtendedStreamWriter writer, ModelNode spiElements) throws XMLStreamException
void	writeWebContext (XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException
void	writeAdmin (XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException
void	writeScheduledTaskInterval (XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException
void	writeList (XMLExtendedStreamWriter writer, ModelNode context, AttributeDefinition def, String elementName) throws XMLStreamException

詳解

The subsystem parser, which uses stax to read and write to and from xml

関数詳解

nextTag()

int org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.nextTag ( XMLExtendedStreamReader  reader ) throws XMLStreamException

inlineprivate

                                                                                  {
        return reader.nextTag();
    }

readElement()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readElement ( final XMLExtendedStreamReader  reader, final List< ModelNode >  list  ) throws XMLStreamException

inline

                                                                                                                        {
        // Require no attributes
        ParseUtils.requireNoAttributes(reader);
        ModelNode addKeycloakSub = Util.createAddOperation(PathAddress.pathAddress(PATH_SUBSYSTEM));
        list.add(addKeycloakSub);

        while (reader.hasNext() && nextTag(reader) != END_ELEMENT) {
            if (reader.getLocalName().equals(WEB_CONTEXT.getXmlName())) {
                WEB_CONTEXT.parseAndSetParameter(reader.getElementText(), addKeycloakSub, reader);
            } else if (reader.getLocalName().equals(PROVIDERS.getXmlName())) {
                readProviders(reader, addKeycloakSub);
            } else if (reader.getLocalName().equals(MASTER_REALM_NAME.getXmlName())) {
                MASTER_REALM_NAME.parseAndSetParameter(reader.getElementText(), addKeycloakSub, reader);
            } else if (reader.getLocalName().equals(SCHEDULED_TASK_INTERVAL.getXmlName())) {
                SCHEDULED_TASK_INTERVAL.parseAndSetParameter(reader.getElementText(), addKeycloakSub, reader);
            } else if (reader.getLocalName().equals(ThemeResourceDefinition.TAG_NAME)) {
                readTheme(list, reader);
            } else if (reader.getLocalName().equals(SpiResourceDefinition.TAG_NAME)) {
                readSpi(list, reader);
            } else {
                throw new XMLStreamException("Unknown keycloak-server subsystem tag: " + reader.getLocalName());
            }
        }
    }

readModules()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readModules ( final XMLExtendedStreamReader  reader, ModelNode  addThemeDefaults  ) throws XMLStreamException

inlineprivate

                                                                                                                         {
        while (reader.hasNext() && nextTag(reader) != END_ELEMENT) {
            MODULES.parseAndAddParameterElement(reader.getElementText(),addThemeDefaults, reader);
        }
    }

readProperties()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readProperties ( final PropertiesAttributeDefinition  attrDef, ModelNode  addOp, final XMLExtendedStreamReader  reader  ) throws XMLStreamException

inlineprivate

                                                                                                                                                              {
        while (nextTag(reader) != END_ELEMENT) {
        int attrCount = reader.getAttributeCount();
            if (attrCount != 2) throw new XMLStreamException("Property must have only two attributes");
            String name = "";
            String value = "";
            for (int i=0 ; i < 2; i++) {
                String attrName = reader.getAttributeLocalName(i);
                String attrValue = reader.getAttributeValue(i);
                if (attrName.equals("name")) {
                    name = attrValue;
                } else if (attrName.equals("value")) {
                    value = attrValue;
                } else {
                    throw new XMLStreamException("Property can only have attributes named 'name' and 'value'");
                }
            }
            attrDef.parseAndAddParameterElement(name, value, addOp, reader);
        nextTag(reader);
        }
            }

readProvider()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readProvider ( final List< ModelNode >  list, String  spiName, final XMLExtendedStreamReader  reader  ) throws XMLStreamException

inlineprivate

                                                                                                                                          {
        String[] attributes = ParseUtils.requireAttributes(reader, "name", ENABLED.getXmlName());
        String providerName = attributes[0];
        String enabled = attributes[1];
        
        ModelNode addProvider = new ModelNode();
        addProvider.get(ModelDescriptionConstants.OP).set(ModelDescriptionConstants.ADD);
        PathAddress addr = PathAddress.pathAddress(PathElement.pathElement(ModelDescriptionConstants.SUBSYSTEM, KeycloakExtension.SUBSYSTEM_NAME),
                                                   PathElement.pathElement(SpiResourceDefinition.TAG_NAME, spiName),
                                                   PathElement.pathElement(ProviderResourceDefinition.TAG_NAME, providerName));
        addProvider.get(ModelDescriptionConstants.OP_ADDR).set(addr.toModelNode());
        addProvider.get(ENABLED.getName()).set(Boolean.valueOf(enabled));
        list.add(addProvider);
        
        while (nextTag(reader) != END_ELEMENT) {
            if (reader.getLocalName().equals(PROPERTIES.getXmlName())) {
                readProperties(PROPERTIES, addProvider, reader);
            }
        }
    }

readProviders()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readProviders ( final XMLExtendedStreamReader  reader, ModelNode  addKeycloakSub  ) throws XMLStreamException

inlineprivate

                                                                                                                         {
        while (reader.hasNext() && nextTag(reader) != END_ELEMENT) {
            PROVIDERS.parseAndAddParameterElement(reader.getElementText(),addKeycloakSub, reader);
        }
    }

readSpi()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readSpi ( final List< ModelNode >  list, final XMLExtendedStreamReader  reader  ) throws XMLStreamException

inlineprivate

                                                                                                                     {
        String spiName = ParseUtils.requireAttributes(reader, "name")[0];
        ModelNode addSpi = new ModelNode();
        addSpi.get(ModelDescriptionConstants.OP).set(ModelDescriptionConstants.ADD);
        PathAddress addr = PathAddress.pathAddress(PathElement.pathElement(ModelDescriptionConstants.SUBSYSTEM, KeycloakExtension.SUBSYSTEM_NAME),
                                                   PathElement.pathElement(SpiResourceDefinition.TAG_NAME, spiName));
        addSpi.get(ModelDescriptionConstants.OP_ADDR).set(addr.toModelNode());
        list.add(addSpi);
        
        while (reader.hasNext() && nextTag(reader) != END_ELEMENT) {
            if (reader.getLocalName().equals(DEFAULT_PROVIDER.getXmlName())) {
                DEFAULT_PROVIDER.parseAndSetParameter(reader.getElementText(), addSpi, reader);
            } else if (reader.getLocalName().equals(ProviderResourceDefinition.TAG_NAME)) {
                readProvider(list, spiName, reader);
            }
        }
    }

readTheme()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.readTheme ( final List< ModelNode >  list, final XMLExtendedStreamReader  reader  ) throws XMLStreamException

inlineprivate

                                                                                                                       {
        ModelNode addThemeDefaults = new ModelNode();
        addThemeDefaults.get(ModelDescriptionConstants.OP).set(ModelDescriptionConstants.ADD);
        PathAddress addr = PathAddress.pathAddress(PathElement.pathElement(ModelDescriptionConstants.SUBSYSTEM, KeycloakExtension.SUBSYSTEM_NAME),
                                                   PathElement.pathElement(ThemeResourceDefinition.TAG_NAME, ThemeResourceDefinition.RESOURCE_NAME));
        addThemeDefaults.get(ModelDescriptionConstants.OP_ADDR).set(addr.toModelNode());
        list.add(addThemeDefaults);
        
        while (reader.hasNext() && nextTag(reader) != END_ELEMENT) {
            String tagName = reader.getLocalName();
            if (MODULES.getName().equals(tagName)) {
                readModules(reader, addThemeDefaults);
                continue;
            }
            
            SimpleAttributeDefinition def = KeycloakExtension.THEME_DEFINITION.lookup(tagName);
            if (def == null) throw new XMLStreamException("Unknown theme tag " + tagName);
            def.parseAndSetParameter(reader.getElementText(), addThemeDefaults, reader);
        }
    }

writeAdmin()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeAdmin ( XMLExtendedStreamWriter  writer, SubsystemMarshallingContext  context  ) throws XMLStreamException

inlineprivate

                                                                                                                           {
        if (!context.getModelNode().get(MASTER_REALM_NAME.getName()).isDefined()) {
            return;
        }

        MASTER_REALM_NAME.marshallAsElement(context.getModelNode(), writer);
    }

writeContent()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeContent ( final XMLExtendedStreamWriter  writer, final SubsystemMarshallingContext  context  ) throws XMLStreamException

inline

                                                                                                                                        {
        context.startSubsystemElement(KeycloakExtension.NAMESPACE, false);
        writeWebContext(writer, context);
        writeList(writer, context.getModelNode(), PROVIDERS, "provider");
        writeAdmin(writer, context);
        writeScheduledTaskInterval(writer, context);
        writeThemeDefaults(writer, context);
        writeSpis(writer, context);
        writer.writeEndElement();
    }

writeList()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeList ( XMLExtendedStreamWriter  writer, ModelNode  context, AttributeDefinition  def, String  elementName  ) throws XMLStreamException

inlineprivate

                                                                                                                                                     {
        if (!context.get(def.getName()).isDefined()) {
            return;
        }

        writer.writeStartElement(def.getXmlName());
        ModelNode modules = context.get(def.getName());
        for (ModelNode module : modules.asList()) {
            writer.writeStartElement(elementName);
            writer.writeCharacters(module.asString());
            writer.writeEndElement();
        }
        writer.writeEndElement();
    }

writeProviders()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeProviders ( XMLExtendedStreamWriter  writer, ModelNode  spiElements  ) throws XMLStreamException

inlineprivate

                                                                                                                 {
        if (!spiElements.get(ProviderResourceDefinition.TAG_NAME).isDefined()) {
            return;
        }
        
        for (Property provider : spiElements.get(ProviderResourceDefinition.TAG_NAME).asPropertyList()) {
            writer.writeStartElement(ProviderResourceDefinition.TAG_NAME);
            writer.writeAttribute("name", provider.getName());
            ModelNode providerElements = provider.getValue();
            ENABLED.marshallAsAttribute(providerElements, writer);
            PROPERTIES.marshallAsElement(providerElements, writer);
            writer.writeEndElement();
        }
    }

writeScheduledTaskInterval()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeScheduledTaskInterval ( XMLExtendedStreamWriter  writer, SubsystemMarshallingContext  context  ) throws XMLStreamException

inlineprivate

                                                                                                                                           {
        if (!context.getModelNode().get(SCHEDULED_TASK_INTERVAL.getName()).isDefined()) {
            return;
        }

        SCHEDULED_TASK_INTERVAL.marshallAsElement(context.getModelNode(), writer);
    }

writeSpis()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeSpis ( XMLExtendedStreamWriter  writer, SubsystemMarshallingContext  context  ) throws XMLStreamException

inlineprivate

                                                                                                                          {
        if (!context.getModelNode().get(SpiResourceDefinition.TAG_NAME).isDefined()) {
            return;
        }
        
        for (Property spi : context.getModelNode().get(SpiResourceDefinition.TAG_NAME).asPropertyList()) {
            writer.writeStartElement(SpiResourceDefinition.TAG_NAME);
            writer.writeAttribute("name", spi.getName());
            ModelNode spiElements = spi.getValue();
            DEFAULT_PROVIDER.marshallAsElement(spiElements, writer);
            writeProviders(writer, spiElements);
            writer.writeEndElement();
        }
    }

writeThemeDefaults()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeThemeDefaults ( XMLExtendedStreamWriter  writer, SubsystemMarshallingContext  context  ) throws XMLStreamException

inlineprivate

                                                                                                                                   {
        if (!context.getModelNode().get(ThemeResourceDefinition.TAG_NAME).isDefined()) {
            return;
        }
        
        writer.writeStartElement(ThemeResourceDefinition.TAG_NAME);
        ModelNode themeElements = context.getModelNode().get(ThemeResourceDefinition.TAG_NAME, ThemeResourceDefinition.RESOURCE_NAME);
        for (AttributeDefinition def : ThemeResourceDefinition.ALL_ATTRIBUTES) {
            if (themeElements.hasDefined(def.getName())) {
                if (def == MODULES) {
                    ModelNode themeContext = context.getModelNode().get("theme", "defaults");
                    writeList(writer, themeContext, def, "module");
                } else {
                    def.marshallAsElement(themeElements, writer);
                }
            }
        }
        writer.writeEndElement();
    }

writeWebContext()

void org.keycloak.subsystem.server.extension.KeycloakSubsystemParser.writeWebContext ( XMLExtendedStreamWriter  writer, SubsystemMarshallingContext  context  ) throws XMLStreamException

inlineprivate

                                                                                                                                {
        if (!context.getModelNode().get(WEB_CONTEXT.getName()).isDefined()) {
            return;
        }

        WEB_CONTEXT.marshallAsElement(context.getModelNode(), writer);
    }

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/subsystem/server/extension/KeycloakSubsystemParser.java