com.linecorp.armeria.server.saml.SamlAssertionConsumerConfigBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of armeria-saml Show documentation

Asynchronous HTTP/2 RPC/REST client/server library built on top of Java 8, Netty, Thrift and gRPC (armeria-saml)

The newest version!

/*
 * Copyright 2018 LINE Corporation
 *
 * LINE Corporation licenses this file to you 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:
 *
 *   https://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 com.linecorp.armeria.server.saml;

import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;

import com.linecorp.armeria.common.annotation.Nullable;

/**
 * A builder which builds a {@link SamlAssertionConsumerConfig}.
 */
public final class SamlAssertionConsumerConfigBuilder {

    private final SamlServiceProviderBuilder parent;

    @Nullable
    private SamlEndpoint endpoint;
    private boolean isDefault;

    SamlAssertionConsumerConfigBuilder(SamlServiceProviderBuilder parent) {
        this.parent = parent;
    }

    SamlAssertionConsumerConfigBuilder(SamlServiceProviderBuilder parent, SamlEndpoint endpoint) {
        this.parent = parent;
        this.endpoint = endpoint;
    }

    /**
     * Sets an endpoint of this assertion consumer service.
     *
     * @deprecated Use {@link SamlServiceProviderBuilder#acs(SamlEndpoint)} to specify {@link SamlEndpoint} when
     *             creating this {@link SamlAssertionConsumerConfigBuilder}.
     */
    @Deprecated
    public SamlAssertionConsumerConfigBuilder endpoint(SamlEndpoint endpoint) {
        this.endpoint = requireNonNull(endpoint, "endpoint");
        return this;
    }

    /**
     * Sets this assertion consumer service as a default.
     */
    public SamlAssertionConsumerConfigBuilder asDefault() {
        isDefault = true;
        return this;
    }

    /**
     * Returns a {@link SamlServiceProvider} which is the parent of this builder.
     */
    public SamlServiceProviderBuilder and() {
        return parent;
    }

    /**
     * Builds a {@link SamlAssertionConsumerConfig}.
     */
    SamlAssertionConsumerConfig build() {
        checkState(endpoint != null, "The endpoint must not be null.");
        return new SamlAssertionConsumerConfig(endpoint, isDefault);
    }
}