org.keycloak.protocol.saml.mappers.AttributeStatementHelper クラス

org.keycloak.protocol.saml.mappers.AttributeStatementHelper 連携図

静的公開メンバ関数
static void	addAttribute (AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, String attributeValue)
static void	addAttributes (AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, List< String > attributeValues)
static AttributeType	createAttributeType (ProtocolMapperModel mappingModel)
static void	setConfigProperties (List< ProviderConfigProperty > configProperties)
static ProtocolMapperModel	createAttributeMapper (String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, String mapperId)

静的公開変数類
static final String	SAML_ATTRIBUTE_NAME = "attribute.name"
static final String	ATTRIBUTE_STATEMENT_CATEGORY = "AttributeStatement Mapper"
static final String	FRIENDLY_NAME = "friendly.name"
static final String	FRIENDLY_NAME_LABEL = "Friendly Name"
static final String	FRIENDLY_NAME_HELP_TEXT = "Standard SAML attribute setting. An optional, more human-readable form of the attribute's name that can be provided if the actual attribute name is cryptic."
static final String	SAML_ATTRIBUTE_NAMEFORMAT = "attribute.nameformat"
static final String	BASIC = "Basic"
static final String	URI_REFERENCE = "URI Reference"
static final String	UNSPECIFIED = "Unspecified"

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addAttribute()

static void org.keycloak.protocol.saml.mappers.AttributeStatementHelper.addAttribute ( AttributeStatementType  attributeStatement, ProtocolMapperModel  mappingModel, String  attributeValue  )

inlinestatic

                                                           {
        AttributeType attribute = createAttributeType(mappingModel);
        attribute.addAttributeValue(attributeValue);
        attributeStatement.addAttribute(new AttributeStatementType.ASTChoiceType(attribute));
    }

addAttributes()

static void org.keycloak.protocol.saml.mappers.AttributeStatementHelper.addAttributes ( AttributeStatementType  attributeStatement, ProtocolMapperModel  mappingModel, List< String >  attributeValues  )

inlinestatic

                                                                  {

        AttributeType attribute = createAttributeType(mappingModel);
        attributeValues.forEach(attribute::addAttributeValue);

        attributeStatement.addAttribute(new AttributeStatementType.ASTChoiceType(attribute));
    }

createAttributeMapper()

static ProtocolMapperModel org.keycloak.protocol.saml.mappers.AttributeStatementHelper.createAttributeMapper ( String  name, String  userAttribute, String  samlAttributeName, String  nameFormat, String  friendlyName, String  mapperId  )

inlinestatic

                                                                                                                                                                                   {
        ProtocolMapperModel mapper = new ProtocolMapperModel();
        mapper.setName(name);
        mapper.setProtocolMapper(mapperId);
        mapper.setProtocol(SamlProtocol.LOGIN_PROTOCOL);
        Map<String, String> config = new HashMap<String, String>();
        if (userAttribute != null) config.put(ProtocolMapperUtils.USER_ATTRIBUTE, userAttribute);
        config.put(SAML_ATTRIBUTE_NAME, samlAttributeName);
        if (friendlyName != null) {
            config.put(FRIENDLY_NAME, friendlyName);
        }
        if (nameFormat != null) {
            config.put(SAML_ATTRIBUTE_NAMEFORMAT, nameFormat);
        }
        mapper.setConfig(config);
        return mapper;
    }

createAttributeType()

static AttributeType org.keycloak.protocol.saml.mappers.AttributeStatementHelper.createAttributeType ( ProtocolMapperModel  mappingModel )

inlinestatic

                                                                                      {
        String attributeName = mappingModel.getConfig().get(SAML_ATTRIBUTE_NAME);
        AttributeType attribute = new AttributeType(attributeName);
        String attributeType = mappingModel.getConfig().get(SAML_ATTRIBUTE_NAMEFORMAT);
        String attributeNameFormat = JBossSAMLURIConstants.ATTRIBUTE_FORMAT_BASIC.get();
        if ("URI Reference".equals(attributeType)) attributeNameFormat = JBossSAMLURIConstants.ATTRIBUTE_FORMAT_URI.get();
        else if ("Unspecified".equals(attributeType)) attributeNameFormat = "urn:oasis:names:tc:SAML2.0:attrname-format:unspecified";
        attribute.setNameFormat(attributeNameFormat);
        String friendlyName = mappingModel.getConfig().get(FRIENDLY_NAME);
        if (friendlyName != null && !friendlyName.trim().equals("")) attribute.setFriendlyName(friendlyName);
        return attribute;
    }

setConfigProperties()

static void org.keycloak.protocol.saml.mappers.AttributeStatementHelper.setConfigProperties ( List< ProviderConfigProperty >  configProperties )

inlinestatic

                                                                                          {
        ProviderConfigProperty property = new ProviderConfigProperty();
        property.setName(AttributeStatementHelper.FRIENDLY_NAME);
        property.setLabel(AttributeStatementHelper.FRIENDLY_NAME_LABEL);
        property.setHelpText(AttributeStatementHelper.FRIENDLY_NAME_HELP_TEXT);
        configProperties.add(property);
        property = new ProviderConfigProperty();
        property.setName(AttributeStatementHelper.SAML_ATTRIBUTE_NAME);
        property.setLabel("SAML Attribute Name");
        property.setHelpText("SAML Attribute Name");
        configProperties.add(property);
        property = new ProviderConfigProperty();
        property.setName(AttributeStatementHelper.SAML_ATTRIBUTE_NAMEFORMAT);
        property.setLabel("SAML Attribute NameFormat");
        property.setHelpText("SAML Attribute NameFormat.  Can be basic, URI reference, or unspecified.");
        List<String> types = new ArrayList(3);
        types.add(AttributeStatementHelper.BASIC);
        types.add(AttributeStatementHelper.URI_REFERENCE);
        types.add(AttributeStatementHelper.UNSPECIFIED);
        property.setType(ProviderConfigProperty.LIST_TYPE);
        property.setOptions(types);
        configProperties.add(property);

    }

メンバ詳解

ATTRIBUTE_STATEMENT_CATEGORY

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.ATTRIBUTE_STATEMENT_CATEGORY = "AttributeStatement Mapper"

static

BASIC

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.BASIC = "Basic"

static

FRIENDLY_NAME

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.FRIENDLY_NAME = "friendly.name"

static

FRIENDLY_NAME_HELP_TEXT

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.FRIENDLY_NAME_HELP_TEXT = "Standard SAML attribute setting. An optional, more human-readable form of the attribute's name that can be provided if the actual attribute name is cryptic."

static

FRIENDLY_NAME_LABEL

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.FRIENDLY_NAME_LABEL = "Friendly Name"

static

SAML_ATTRIBUTE_NAME

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.SAML_ATTRIBUTE_NAME = "attribute.name"

static

SAML_ATTRIBUTE_NAMEFORMAT

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.SAML_ATTRIBUTE_NAMEFORMAT = "attribute.nameformat"

static

UNSPECIFIED

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.UNSPECIFIED = "Unspecified"

static

URI_REFERENCE

final String org.keycloak.protocol.saml.mappers.AttributeStatementHelper.URI_REFERENCE = "URI Reference"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/saml/mappers/AttributeStatementHelper.java