001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: AMPostCallBackException.java,v 1.4 2008/06/25 05:41:21 qcheng Exp $ 026 * 027 */ 028 029package com.iplanet.am.sdk; 030 031import com.iplanet.sso.SSOToken; 032import com.iplanet.ums.UMSException; 033 034/** 035 * 036 * <code>AMPostCallBackException</code> is a subclass of 037 * <code>AMException </code> which is used by all implementations of 038 * <code>AMCallback</code>. This exception should be thrown by the callback 039 * plugins in the post callback methods called by SDK. This helps distinguish a 040 * post-callback exception from normal SDK exceptions and can be handled 041 * differently by any applications using the SDK, if they wish to. 042 * 043 * @deprecated As of Sun Java System Access Manager 7.1. 044 * @supported.all.api 045 */ 046public class AMPostCallBackException extends AMException { 047 048 /** 049 * Constructs a new <code>AMPostCallBackException</code> with detailed 050 * message. 051 * 052 * @param msg 053 * The detailed message. 054 * @param errorCode 055 * Matches the appropriate entry in 056 * <code>amProfile.properties</code>. 057 */ 058 public AMPostCallBackException(String msg, String errorCode) { 059 super(msg, errorCode); 060 } 061 062 /** 063 * Constructs a new <code>AMPostCallBackException</code> with detailed 064 * message. 065 * 066 * @param token 067 * A valid single sign on token of the user performing the 068 * operation. 069 * @param errorCode 070 * error code. 071 */ 072 public AMPostCallBackException(SSOToken token, String errorCode) { 073 super(token, errorCode); 074 } 075 076 /** 077 * Constructs a new <code>AMPostCallBackException</code> with detailed 078 * message. 079 * 080 * @param msg 081 * The detailed message. 082 * @param errorCode 083 * Matches the appropriate entry in 084 * <code>amProfile.properties</code>. 085 * @param ue 086 * if the root case is a <code>UMSException</code> 087 */ 088 089 public AMPostCallBackException(String msg, 090 String errorCode, UMSException ue) 091 { 092 super(msg, errorCode, ue); 093 } 094 095 /** 096 * Constructs a new <code>AMPostCallBackException</code> with detailed 097 * message. 098 * 099 * @param token 100 * a valid single sign on token of the user performing the 101 * operation. 102 * @param errorCode 103 * Matches the appropriate entry in 104 * <code>amProfile.properties</code>. 105 * @param ue 106 * if the root case is a <code>UMSException</code> 107 */ 108 109 public AMPostCallBackException(SSOToken token, String errorCode, 110 UMSException ue) { 111 super(token, errorCode, ue); 112 } 113 114 /** 115 * Constructs a new <code>AMPostCallBackException</code> with detailed 116 * message. 117 * 118 * @param msg 119 * The detailed message. 120 * @param errorCode 121 * Matches the appropriate entry in 122 * <code>amProfile.properties</code>. 123 * @param args 124 * if the error message needs specific values to be set 125 */ 126 public AMPostCallBackException(String msg, String errorCode, Object[] args) 127 { 128 super(msg, errorCode, args); 129 } 130 131 /** 132 * Constructs a new <code>AMPostCallBackException</code> with detailed 133 * message. 134 * 135 * @param msg 136 * The detailed message. 137 * @param errorCode 138 * Matches the appropriate entry in 139 * <code>amProfile.properties</code>. 140 * @param args 141 * if the error message needs specific values to be set 142 * @param ue 143 * if the root case is a <code>UMSException</code> 144 */ 145 public AMPostCallBackException(String msg, String errorCode, Object[] args, 146 UMSException ue) { 147 super(msg, errorCode, args, ue); 148 } 149 150}