se.swedenconnect.opensaml.saml2.response.ResponseProcessingResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation
OpenSAML 5.X utility extension library
The newest version!
/*
 * Copyright 2016-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.opensaml.saml2.response;

import java.time.Instant;
import java.util.List;

import org.opensaml.saml.saml2.core.Assertion;
import org.opensaml.saml.saml2.core.Attribute;
import org.opensaml.saml.saml2.core.NameID;
import org.opensaml.saml.saml2.core.Response;

/**
 * Interface that describes the result of a response processing operation. It contains the actual {@link Response} and
 * {@link Assertion} objects that really holds all information, but also "easy to access" methods of the elements that
 * are of most interest.
 * 
 * Note that only successful responses are represented. Error responses are represented using the
 * {@link ResponseStatusErrorException}.
 * 
 *
 * @author Martin Lindström ([email protected])
 */
public interface ResponseProcessingResult {

  /**
   * Gets the ID of the {@code Response} message that was processed.
   *
   * @return ID of response
   */
  String getResponseId();

  /**
   * Gets the {@code InResponseTo} attribute from the response that was processed.
   *
   * @return the InResponseTo attribute from the response
   */
  String getInResponseTo();

  /**
   * Gets the issuance instant of the response.
   *
   * @return issue instant
   */
  Instant getIssueInstant();

  /**
   * Gets the actual {@link Response} object.
   *
   * @return the {@link Response}
   */
  Response getResponse();

  /**
   * Gets the {@code Assertion} from the response.
   *
   * @return the Assertion
   */
  Assertion getAssertion();

  /**
   * Gets the attributes that are part of the attribute statement of the assertion.
   *
   * @return an (unmodifiable) list of attributes
   */
  List getAttributes();

  /**
   * Gets the URI for the {@code AuthnContextClassRef} element that holds the "level of assurance" under which the
   * authentication was made.
   *
   * @return LoA URI
   */
  String getAuthnContextClassUri();

  /**
   * Gets the authentication instant.
   *
   * @return the instant at which the user authenticated
   */
  Instant getAuthnInstant();

  /**
   * Gets the entityID of the issuing IdP.
   *
   * @return entityID for the IdP
   */
  String getIssuer();

  /**
   * Gets the {@code NameID} for the subject.
   *
   * @return the nameID
   */
  NameID getSubjectNameID();

}