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: Statement.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
026 *
027 */
028
029
030
031package com.sun.identity.saml2.assertion;
032
033import com.sun.identity.saml2.common.SAML2Exception;
034
035/**
036 * The <code>Statement</code> element is an extension point that allows
037 * other assertion-based applications to reuse the SAML assertion framework.
038 * SAML itself derives its core statements from this extension point.
039 * Its <code>StatementAbstractType</code> complex type is abstract and is
040 * thus usable only as the base of a derived type.
041 * <p>
042 * <pre>
043 * &lt;complexType name="StatementAbstractType">
044 *   &lt;complexContent>
045 *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
046 *     &lt;/restriction>
047 *   &lt;/complexContent>
048 * &lt;/complexType>
049 * </pre>
050 * @supported.all.api
051 */
052public interface Statement {
053
054    /**
055     * Makes the object immutable.
056     */
057    public void makeImmutable();
058
059    /**
060     * Returns the mutability of the object.
061     *
062     * @return true if the object is mutable; false otherwise.
063     */
064    public boolean isMutable();
065
066    /**
067     * Returns a String representation of the element.
068     *
069     * @return A string containing the valid XML for this element.
070     *         By default name space name is prepended to the element name.
071     * @throws SAML2Exception if the object does not conform to the schema.
072     */
073    public String toXMLString()
074        throws SAML2Exception;
075
076    /**
077     * Returns a String representation of the element.
078     *
079     * @param includeNS Determines whether or not the namespace qualifier is
080     *                prepended to the Element when converted
081     * @param declareNS Determines whether or not the namespace is declared
082     *                within the Element.
083     * @return A string containing the valid XML for this element
084     * @throws SAML2Exception if the object does not conform to the schema.
085     */
086    public String toXMLString(boolean includeNS, boolean declareNS)
087        throws SAML2Exception;
088
089}
090




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.