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: AMPreCallBackException.java,v 1.4 2008/06/25 05:41:22 qcheng Exp $ 026 * 027 */ 028 029package com.iplanet.am.sdk; 030 031import com.iplanet.sso.SSOToken; 032import com.iplanet.ums.UMSException; 033 034/** 035 * <code>AMPreCallBackException</code> is a subclass of 036 * <code>AMException</code> which is used by all implementations of 037 * <code>AMCallback</code>. This exception should be thrown by the 038 * <code>callback</code> plugins in case they want to abort the operation 039 * being performed by SDK. This helps distinguish a <code>pre-callback</code> 040 * exception from normal SDK exceptions and can be handled differently by any 041 * applications, if they wish to. 042 * 043 * @deprecated As of Sun Java System Access Manager 7.1. 044 * @supported.all.api 045 */ 046public class AMPreCallBackException extends AMException { 047 048 /** 049 * Constructs a new <code>AMPreCallBackException</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 AMPreCallBackException(String msg, String errorCode) { 059 super(msg, errorCode); 060 } 061 062 /** 063 * Constructs a new <code>AMPreCallBackException</code> with detailed 064 * message. 065 * 066 * @param token 067 * A valid SSO token of the user performing the operation 068 * @param errorCode 069 * Matches the appropriate entry in 070 * <code>amProfile.properties</code>. 071 */ 072 public AMPreCallBackException(SSOToken token, String errorCode) { 073 super(token, errorCode); 074 } 075 076 /** 077 * Constructs a new <code>AMPreCallBackException</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 cause is a <code>UMSException</code>. 087 */ 088 public AMPreCallBackException(String msg, String errorCode, UMSException ue) 089 { 090 super(msg, errorCode, ue); 091 } 092 093 /** 094 * Constructs a new <code>AMPreCallBackException</code> with detailed 095 * message. 096 * 097 * @param token 098 * a valid single sign on token of the user performing the 099 * operation. 100 * @param errorCode 101 * Matches the appropriate entry in 102 * <code>amProfile.properties</code>. 103 * @param ue 104 * if the root cause is a <code>UMSException</code>. 105 */ 106 public AMPreCallBackException(SSOToken token, String errorCode, 107 UMSException ue) { 108 super(token, errorCode, ue); 109 } 110 111 /** 112 * Constructs a new <code>AMPreCallBackException</code> with detailed 113 * message. 114 * 115 * @param msg 116 * The detailed message. 117 * @param errorCode 118 * Matches the appropriate entry in 119 * <code>amProfile.properties</code>. 120 * @param args 121 * if the error message needs specific values to be set. 122 */ 123 public AMPreCallBackException(String msg, String errorCode, Object[] args) { 124 super(msg, errorCode, args); 125 } 126 127 /** 128 * Constructs a new <code>AMPreCallBackException</code> with detailed 129 * message. 130 * 131 * @param msg 132 * The detailed message 133 * @param errorCode 134 * Matches the appropriate entry in 135 * <code>amProfile.properties</code>. 136 * @param args 137 * if the error message needs specific values to be set. 138 * @param ue 139 * if the root cause is a <code>UMSException</code>. 140 */ 141 public AMPreCallBackException(String msg, String errorCode, Object[] args, 142 UMSException ue) { 143 super(msg, errorCode, args, ue); 144 } 145}