se.idsec.signservice.integration.document.pdf.signpage.SignerNameRequirement Maven / Gradle / Ivy

Go to download

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

SignService Integration PDF Processing

There is a newer version: 2.3.0

Show newest version

/*
 * Copyright 2019-2020 IDsec Solutions AB
 *
 * 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.idsec.signservice.integration.document.pdf.signpage;

import java.util.List;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import se.idsec.signservice.integration.authentication.SignerIdentityAttribute;

/**
 * Holds the signer name requirements for a PDF sign image.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SignerNameRequirement {

  /**
   * List of name attributes included in the sign request representing the signer identity. Signer name attributes must
   * be among these attributes.
   * 
   * @param signerNameAttributeList
   *          name attributes included in the sign request representing the signer identity
   * @return name attributes included in the sign request representing the signer identity
   */
  private List signerNameAttributeList;

  /**
   * The format string determining the formatting of the signer name in the visible sign image.
   * 
   * Example "%1 %2 (%3)" causes the result "AttributeVal-1 AttriubteVal-2 (AttributeVal-3)".
   * 
   * 
   * @param formatString
   *          the format string determining the formatting of the signer name in the visible sign image.
   * @return the format string determining the formatting of the signer name in the visible sign image, or null
   */
  private String formatString;
}