001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2006 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: InteractionRedirectException.java,v 1.2 2008/06/25 05:47:18 qcheng Exp $ 026 * 027 */ 028 029package com.sun.identity.liberty.ws.interaction; 030 031/** 032 * Class for exception thrown by <code>InteractionManager</code>, on the 033 * <code>WSC</code> side, to indicate that the User Agent is redirected to 034 * <code>WSP</code>. 035 * 036 * @supported.all.api 037 */ 038public class InteractionRedirectException extends InteractionException { 039 040 private String messageID; 041 042 /** 043 * Constructor 044 * @param messageID <code>messageID</code> of SOAP request message that 045 * caused this exception 046 * 047 * @supported.api 048 */ 049 public InteractionRedirectException(String messageID) { 050 super(messageID); 051 this.messageID = messageID; 052 } 053 054 /** 055 * 056 * Gets <code>messageID</code> of SOAP request message that caused this 057 * exception. <code>WSC</code> could use this as a key to save any 058 * additional information that it may want to lookup when user agent 059 * is redirected back after resource owner interactions. This would 060 * be provided as a values of query parameter 061 * <code>InteractionManager.REQUEST_ID</code> 062 * when the user agent is redirected back to <code>WSC</code>. 063 * 064 * @return <code>messageID</code> of SOAP request message that caused this 065 * exception 066 * @supported.api 067 */ 068 public String getMessageID() { 069 return messageID; 070 } 071 072} 073