001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2007 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:48:12 qcheng Exp $ 026 * 027 */ 028 029package com.sun.identity.xacml.context; 030 031import com.sun.identity.xacml.common.XACMLException; 032 033import java.util.List; 034 035/** 036 * The <code>Status</code> element is a container of 037 * one or more <code>Status</code>s issuded by authorization authority. 038 * @supported.all.api 039 * <p/> 040 * <pre> 041 * 042 * Schema: 043 * <xs:complexType name="StatusType"> 044 * <xs:sequence> 045 * <xs:element ref="xacml-context:StatusCode"/> 046 * <xs:element ref="xacml-context:StatusMessage" minOccurs="0"/> 047 * <xs:element ref="xacml-context:StatusDetail" minOccurs="0"/> 048 * <xs:sequence> 049 * <xs:complexType> 050 */ 051public interface Status { 052 053 054 055 /** 056 * Returns the <code>StatusCode</code> of this object 057 * 058 * @return the <code>StatusCode</code> of this object 059 */ 060 public StatusCode getStatusCode(); 061 062 /** 063 * Sets the <code>StatusCode</code> of this object 064 * 065 * @exception XACMLException if the object is immutable 066 */ 067 public void setStatusCode(StatusCode statusCode) throws XACMLException; 068 069 /** 070 * Returns the <code>StatusMessage</code> of this object 071 * 072 * @return the <code>StatusMessage</code> of this object 073 */ 074 public StatusMessage getStatusMessage(); 075 076 /** 077 * Sets the <code>StatusMessage</code> of this object 078 * 079 * @exception XACMLException if the object is immutable 080 */ 081 public void setStatusMessage(StatusMessage statusMessage) throws XACMLException; 082 083 /** 084 * Returns the <code>StatusDetail</code> of this object 085 * 086 * @return the <code>StatusDetail</code> of this object 087 */ 088 public StatusDetail getStatusDetail(); 089 090 /** 091 * Sets the <code>StatusDetail</code> of this object 092 * 093 * @exception XACMLException if the object is immutable 094 */ 095 public void setStatusDetail(StatusDetail statusDetail) throws XACMLException; 096 097 098 /** 099 * Returns a string representation 100 * 101 * @return a string representation 102 * @exception XACMLException if conversion fails for any reason 103 */ 104 public String toXMLString() throws XACMLException; 105 106 /** 107 * Returns a string representation 108 * @param includeNSPrefix Determines whether or not the namespace qualifier 109 * is prepended to the Element when converted 110 * @param declareNS Determines whether or not the namespace is declared 111 * within the Element. 112 * @return a string representation 113 * @exception XACMLException if conversion fails for any reason 114 */ 115 public String toXMLString(boolean includeNSPrefix, boolean declareNS) 116 throws XACMLException; 117 118 /** 119 * Checks if the object is mutable 120 * 121 * @return <code>true</code> if the object is mutable, 122 * <code>false</code> otherwise 123 */ 124 public boolean isMutable(); 125 126 /** 127 * Makes the object immutable 128 */ 129 public void makeImmutable(); 130 131}
Copyright © 2010-2017, ForgeRock All Rights Reserved.