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: Status.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.saml2.protocol; 031 032import com.sun.identity.saml2.common.SAML2Exception; 033 034/** 035 * This class represents the <code>StatusType</code> complex type in 036 * SAML protocol schema. 037 * 038 * <pre> 039 * <complexType name="StatusType"> 040 * <complexContent> 041 * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> 042 * <sequence> 043 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode"/> 044 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusMessage" minOccurs="0"/> 045 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusDetail" minOccurs="0"/> 046 * </sequence> 047 * </restriction> 048 * </complexContent> 049 * </complexType> 050 * </pre> 051 * 052 * @supported.all.api 053 */ 054 055public interface Status { 056 057 /** 058 * Returns the value of the statusCode property. 059 * 060 * @return the value of the statusCode property 061 * @see #setStatusCode(StatusCode) 062 */ 063 public com.sun.identity.saml2.protocol.StatusCode getStatusCode(); 064 065 /** 066 * Sets the value of the statusCode property. 067 * 068 * @param value the value of the statusCode property to be set 069 * @throws SAML2Exception if the object is immutable 070 * @see #getStatusCode 071 */ 072 public void setStatusCode(com.sun.identity.saml2.protocol.StatusCode value) 073 throws SAML2Exception; 074 075 /** 076 * Returns the value of the statusMessage property. 077 * 078 * @return the value of the statusMessage property 079 * @see #setStatusMessage(String) 080 */ 081 public java.lang.String getStatusMessage(); 082 083 /** 084 * Sets the value of the statusMessage property. 085 * 086 * @param value the value of the statusMessage property to be set 087 * @throws SAML2Exception if the object is immutable 088 * @see #getStatusMessage 089 */ 090 public void setStatusMessage(java.lang.String value) 091 throws SAML2Exception; 092 093 /** 094 * Returns the value of the statusDetail property. 095 * 096 * @return the value of the statusDetail property 097 * @see #setStatusDetail(StatusDetail) 098 */ 099 public com.sun.identity.saml2.protocol.StatusDetail getStatusDetail(); 100 101 /** 102 * Sets the value of the statusDetail property. 103 * 104 * @param value the value of the statusDetail property to be set 105 * @throws SAML2Exception if the object is immutable 106 * @see #getStatusDetail 107 */ 108 public void setStatusDetail( 109 com.sun.identity.saml2.protocol.StatusDetail value) 110 throws SAML2Exception; 111 112 /** 113 * Returns the <code>Status</code> in an XML document String format 114 * based on the <code>Status</code> schema described above. 115 * 116 * @return An XML String representing the <code>Status</code>. 117 * @throws SAML2Exception if some error occurs during conversion to 118 * <code>String</code>. 119 */ 120 public String toXMLString() throws SAML2Exception; 121 122 /** 123 * Returns the <code>Status</code> in an XML document String format 124 * based on the <code>Status</code> schema described above. 125 * 126 * @param includeNSPrefix Determines whether or not the namespace qualifier 127 * is prepended to the Element when converted 128 * @param declareNS Determines whether or not the namespace is declared 129 * within the Element. 130 * @return A XML String representing the <code>Status</code>. 131 * @throws SAML2Exception if some error occurs during conversion to 132 * <code>String</code>. 133 */ 134 public String toXMLString(boolean includeNSPrefix, boolean declareNS) 135 throws SAML2Exception; 136 137 /** 138 * Makes the obejct immutable 139 */ 140 public void makeImmutable(); 141 142 /** 143 * Returns true if the object is mutable, false otherwise 144 * 145 * @return true if the object is mutable, false otherwise 146 */ 147 public boolean isMutable(); 148}
Copyright © 2010-2017, ForgeRock All Rights Reserved.