org.wildfly.security.x500.X500DirectoryAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron
WildFly Security SPIs
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2016 Red Hat, Inc., and individual 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.wildfly.security.x500;

import java.util.Collection;
import java.util.Collections;

import org.wildfly.common.Assert;
import org.wildfly.security.asn1.ASN1Encodable;
import org.wildfly.security.asn1.ASN1Encoder;

/**
 * An X.500 directory attribute, which is comprised of an attribute type OID and zero or more values, whose types are
 * defined by the attribute type.
 *
 * @author David M. Lloyd
 */
public final class X500DirectoryAttribute implements ASN1Encodable {
    private final String attributeType;
    private final Collection values;

    private X500DirectoryAttribute(final String attributeType, final Collection values) {
        this.attributeType = attributeType;
        this.values = values;
    }

    /**
     * Construct a new instance.
     *
     * @param attributeType the attribute type OID (must not be {@code null})
     * @param values the values collection (must not be {@code null})
     * @return the directory attribute
     */
    public static X500DirectoryAttribute create(final String attributeType, final Collection values) {
        Assert.checkNotNullParam("attributeType", attributeType);
        Assert.checkNotNullParam("values", values);
        return new X500DirectoryAttribute(attributeType, values);
    }

    /**
     * Construct a new instance with no values.
     *
     * @param attributeType the attribute type OID (must not be {@code null})
     * @return the directory attribute
     */
    public static X500DirectoryAttribute create(final String attributeType) {
        return create(attributeType, Collections.emptyList());
    }

    /**
     * Construct a new instance with one value.
     *
     * @param attributeType the attribute type OID (must not be {@code null})
     * @param value the single value (must not be {@code null})
     * @return the directory attribute
     */
    public static X500DirectoryAttribute create(final String attributeType, ASN1Encodable value) {
        Assert.checkNotNullParam("value", value);
        return create(attributeType, Collections.singletonList(value));
    }

    /**
     * Construct a new instance with one UTF-8 value.
     *
     * @param attributeType the attribute type OID (must not be {@code null})
     * @param stringValue the string value (must not be {@code null})
     * @return the directory attribute
     */
    public static X500DirectoryAttribute createUtf8(final String attributeType, String stringValue) {
        Assert.checkNotNullParam("stringValue", stringValue);
        return create(attributeType, ASN1Encodable.ofUtf8String(stringValue));
    }

    /**
     * Construct a new instance with one OID value.
     *
     * @param attributeType the attribute type OID (must not be {@code null})
     * @param oid the OID (must not be {@code null})
     * @return the directory attribute
     */
    public static X500DirectoryAttribute createObjectId(final String attributeType, String oid) {
        return create(attributeType, ASN1Encodable.ofOid(oid));
    }

    public void encodeTo(final ASN1Encoder encoder) {
        encoder.startSequence();
        encoder.encodeObjectIdentifier(attributeType);
        encoder.startSet();
        for (ASN1Encodable value : values) {
            value.encodeTo(encoder);
        }
        encoder.endSet();
        encoder.endSequence();
    }
}