se.litsec.opensaml.saml2.common.response.ResponseStatusErrorException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation

OpenSAML 3.X utility extension library

There is a newer version: 1.4.5

/*
 * Copyright 2016-2018 Litsec 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.litsec.opensaml.saml2.common.response;

import org.opensaml.saml.saml2.core.Status;
import org.opensaml.saml.saml2.core.StatusCode;

/**
 * Exception that indicates a non-successful status code received in a Response message.
 *
 * @author Martin Lindström ([email protected])
 */
public class ResponseStatusErrorException extends Exception {

  /** For serializing. */
  private static final long serialVersionUID = -8050896611037764108L;

  /** The SAML Status. */
  private Status status;

  /** The Response ID. */
  private String responseId;

  /**
   * Constructor taking the error status and the response ID.
   * 
   * @param status
   *          status
   * @param responseId
   *          the response ID
   */
  public ResponseStatusErrorException(Status status, String responseId) {
    super(statusToString(status));
    this.status = status;
    this.responseId = responseId;
    
    if (StatusCode.SUCCESS.equals(status.getStatusCode().getValue())) {
      throw new IllegalArgumentException("Status is success - can not throw ResponseStatusErrorException");
    }
  }

  /**
   * Returns the status object.
   * 
   * @return the status object
   */
  public Status getStatus() {
    return this.status;
  }

  /**
   * Returns the ID of the Response.
   * 
   * @return the response ID
   */
  public String getResponseId() {
    return this.responseId;
  }

  /**
   * Returns a textual representation of the status.
   * 
   * @param status
   *          the Status to print
   * @return a status string
   */
  public static String statusToString(Status status) {
    StringBuffer sb = new StringBuffer("Status: ");
    sb.append(status.getStatusCode().getValue());
    if (status.getStatusCode().getStatusCode() != null) {
      sb.append(", ").append(status.getStatusCode().getStatusCode().getValue());
    }
    if (status.getStatusMessage() != null && status.getStatusMessage().getMessage() != null) {
      sb.append(" - ").append(status.getStatusMessage().getMessage());
    }
    return sb.toString();
  }

}