se.swedenconnect.signservice.client.ClientConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of signservice-core Show documentation

SignService Core Library

There is a newer version: 1.1.3

/*
 * Copyright 2022-2024 Sweden Connect
 *
 * 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 se.swedenconnect.signservice.client;

import java.security.cert.X509Certificate;
import java.util.List;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;

/**
 * Representation of SignService client configuration.
 */
public interface ClientConfiguration {

  /**
   * Gets the unique client identifier.
   *
   * @return the client id
   */
  @Nonnull
  String getClientId();

  /**
   * Gets the certificate, or certificates, that we expect the client to use when signing messages.
   *
   * @return a list of certificates
   */
  @Nonnull
  List getTrustedCertificates();

  /**
   * Gets a list of registered response URL:s, i.e., URL:s which the SignService may use when sending back a signature
   * response message.
   * 
   * Note that this method may return {@code null} if the protocol states that the response URL should be supplied in a
   * signature request message.
   * 
   *
   * @return a list of registered URL:s
   */
  @Nullable
  List getResponseUrls();

}