449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings/*
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * The contents of this file are subject to the terms of the Common Development and
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Distribution License (the License). You may not use this file except in compliance with the
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * License.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * specific language governing permission and limitations under the License.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * When distributing Covered Software, include this CDDL Header Notice in each file and include
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Header, with the fields enclosed by brackets [] replaced by your own identifying
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * information: "Portions copyright [year] [name of copyright owner]".
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Copyright 2015 ForgeRock AS.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbingspackage com.sun.identity.saml2.profile;
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbingsimport com.sun.identity.saml2.common.SAML2Constants;
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbingsimport com.sun.identity.saml2.plugins.SAML2IdentityProviderAdapter;
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings/**
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Indicates a client fault during federated SSO.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @since 13.0.0
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbingspublic class ClientFaultException extends FederatedSSOException {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings /**
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Constructs the client fault exception with the given message code.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param messageCode the message code. May not be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings public ClientFaultException(final String messageCode) {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings super(null, messageCode, null);
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings }
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings /**
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Constructs the client fault exception with the given message code and detail message.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param messageCode the message code. May not be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param detail the detail message. May be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings public ClientFaultException(final String messageCode, final String detail) {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings super(null, messageCode, detail);
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings }
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings /**
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Constructs the client fault exception with the given IDP adapter and message code.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param idpAdapter the identity provider adapter. May be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param messageCode the message code. May not be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings public ClientFaultException(final SAML2IdentityProviderAdapter idpAdapter, final String messageCode) {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings super(idpAdapter, messageCode, null);
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings }
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings /**
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * Constructs the client fault exception with the given IDP adapter, message code, and detail message.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings *
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param idpAdapter the identity provider adapter. May be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param messageCode the message code. May not be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings * @param detail the detail message. May be null.
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings */
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings public ClientFaultException(final SAML2IdentityProviderAdapter idpAdapter, final String messageCode,
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings final String detail) {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings super(idpAdapter, messageCode, detail);
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings }
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings @Override
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings public String getFaultCode() {
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings return SAML2Constants.CLIENT_FAULT;
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings }
449854c2a07b50ea64d9d6a8b03d18d4afeeee43Ken Stubbings}