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: StatusDetail.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $ 026 * 027 * Portions Copyrighted 2016 ForgeRock AS. 028 */ 029 030 031package com.sun.identity.saml2.protocol; 032 033import com.fasterxml.jackson.annotation.JsonTypeInfo; 034import com.sun.identity.saml2.common.SAML2Exception; 035import com.sun.identity.saml2.protocol.impl.StatusDetailImpl; 036 037/** 038 * This class represents the <code>StatusDetailType</code> complex type in 039 * SAML protocol schema. 040 * The <code>StatusDetail</code> element MAY be used to specify additional 041 * information concerning the status of the request. 042 * 043 * <pre> 044 * <complexType name="StatusDetailType"> 045 * <complexContent> 046 * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> 047 * <sequence> 048 * <any/> 049 * </sequence> 050 * </restriction> 051 * </complexContent> 052 * </complexType> 053 * </pre> 054 * 055 * @supported.all.api 056 */ 057 058@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 059 defaultImpl = StatusDetailImpl.class) 060public interface StatusDetail { 061 062 /** 063 * Returns the value of the Any property. 064 * 065 * @return A list containing objects of type <code>String</code> 066 * @see #setAny(List) 067 */ 068 public java.util.List getAny(); 069 070 /** 071 * Sets the value of the Any property. 072 * 073 * @param anyList 074 * A list containing objects of type <code>String</code> 075 * @throws SAML2Exception if the object is immutable 076 * @see #getAny 077 */ 078 public void setAny(java.util.List anyList) throws SAML2Exception; 079 080 /** 081 * Returns the <code>StatusDetail</code> in an XML document String format 082 * based on the <code>StatusDetail</code> schema described above. 083 * 084 * @return An XML String representing the <code>StatusDetail</code>. 085 * @throws SAML2Exception if some error occurs during conversion to 086 * <code>String</code>. 087 */ 088 public String toXMLString() throws SAML2Exception; 089 090 /** 091 * Returns the <code>StatusDetail</code> in an XML document String format 092 * based on the <code>StatusDetail</code> schema described above. 093 * 094 * @param includeNSPrefix Determines whether or not the namespace qualifier 095 * is prepended to the Element when converted 096 * @param declareNS Determines whether or not the namespace is declared 097 * within the Element. 098 * @return A XML String representing the <code>StatusDetail</code>. 099 * @throws SAML2Exception if some error occurs during conversion to 100 * <code>String</code>. 101 */ 102 public String toXMLString(boolean includeNSPrefix, boolean declareNS) 103 throws SAML2Exception; 104 105 /** 106 * Makes the obejct immutable 107 */ 108 public void makeImmutable(); 109 110 /** 111 * Returns true if the object is mutable false otherwise 112 * 113 * @return true if the object is mutable false otherwise 114 */ 115 public boolean isMutable(); 116}