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: ECPResponse.java,v 1.2 2008/06/25 05:47:46 qcheng Exp $
026 *
027 */
028
029package com.sun.identity.saml2.ecp;
030
031import com.sun.identity.saml2.common.SAML2Exception;
032
033/** 
034 *  The <code>ECPResponse</code> interface defines methods for properties
035 *  required by an ECP response.
036 *
037 *  @supported.all.api
038 */
039public interface ECPResponse {
040    
041    /** 
042     * Returns value of <code>mustUnderstand</code> attribute.
043     *
044     * @return value of <code>mustUnderstand</code> attribute.
045     */
046    public Boolean isMustUnderstand();
047
048    /** 
049     * Sets the value of the <code>mustUnderstand</code> attribute.
050     *
051     * @param mustUnderstand the value of <code>mustUnderstand</code>
052     *     attribute.
053     * @throws SAML2Exception if the object is immutable.
054     */
055    public void setMustUnderstand(Boolean mustUnderstand) throws SAML2Exception;
056
057    /**
058     * Returns value of <code>actor</code> attribute.
059     *
060     * @return value of <code>actor</code> attribute
061     */
062    public String getActor();
063
064    /**
065     * Sets the value of <code>actor</code> attribute.
066     *
067     * @param actor the value of <code>actor</code> attribute
068     * @throws SAML2Exception if the object is immutable.
069     */
070    public void setActor(String actor) throws SAML2Exception;
071
072    /** 
073     * Returns the value of the <code>AssertionConsumerServiceURL</code>
074     * attribute.
075     *
076     * @return the value of <code>AssertionConsumerServiceURL</code> attribute.
077     * @see #setAssertionConsumerServiceURL(String)
078     */
079    public String getAssertionConsumerServiceURL();
080
081    /** 
082     * Sets the value of the <code>AssertionConsumerServiceURL</code> 
083     * attribute.
084     *
085     * @param url the value of <code>AssertionConsumerServiceURL</code> 
086     *        attribute.
087     * @throws SAML2Exception if the object is immutable.
088     * @see #getAssertionConsumerServiceURL
089     */
090    public void setAssertionConsumerServiceURL(String url)
091        throws SAML2Exception;
092
093    /** 
094     * Returns a String representation of this Object.
095     *
096     * @return a String representation of this Object.
097     * @throws SAML2Exception if cannot create String object.
098     */
099    public String toXMLString() throws SAML2Exception;
100    
101    /** 
102     * Returns a String representation of this Object.
103     *
104     * @param includeNSPrefix determines whether or not the namespace
105     *        qualifier is prepended to the Element when converted
106     * @param declareNS determines whether or not the namespace is declared
107     *        within the Element.
108     * @return the String representation of this Object.
109     * @throws SAML2Exception if cannot create String object.
110     **/
111    
112    public String toXMLString(boolean includeNSPrefix,boolean declareNS)
113           throws SAML2Exception;
114
115    /** 
116     * Makes this object immutable. 
117     *
118     */
119    public void makeImmutable() ;
120    
121    /** 
122     * Returns  true if object is mutable.
123     *
124     * @return true if object is mutable.
125     */
126    public boolean isMutable();
127}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.