a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: AuthnRequest.java,v 1.2 2008/06/25 05:47:56 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.Conditions;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.Subject;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>AuthnRequest</code> interface defines methods for properties
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * required by an authentication request.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic interface AuthnRequest extends RequestAbstract {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Subject</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Subject</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setSubject(Subject)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Subject</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subject the new <code>Subject</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getSubject
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setSubject(Subject subject) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>NameIDPolicy</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>NameIDPolicy</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setNameIDPolicy(NameIDPolicy)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>NameIDPolicy</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param nameIDPolicy the new <code>NameIDPolicy</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getNameIDPolicy
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNameIDPolicy(NameIDPolicy nameIDPolicy)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Conditions</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Conditions</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setConditions(Conditions)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Conditions</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param conditions the new <code>Conditions</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getConditions
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setConditions(Conditions conditions) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>RequestedAuthnContext</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>RequestAuthnContext</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setRequestedAuthnContext(RequestedAuthnContext)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public RequestedAuthnContext getRequestedAuthnContext();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>RequestedAuthnContext</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param reqAuthnContext the new <code>RequestedAuthnContext</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getRequestedAuthnContext
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setRequestedAuthnContext(RequestedAuthnContext reqAuthnContext)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Scoping</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param scoping the new <code>Scoping</code> Object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getScoping
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setScoping(Scoping scoping) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Scoping</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Scoping</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setScoping(Scoping)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns value of <code>isForceAuthn</code> attribute.
8f34520dfc1c25b9a82c9e639c7116576e2b4fabMike Jang * @return value of <code>isForceAuthn</code> attribute, or null if the attribute is not present.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>ForceAuthn</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of <code>ForceAuthn</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the <code>isPassive</code> attribute.
8f34520dfc1c25b9a82c9e639c7116576e2b4fabMike Jang * @return value of <code>isPassive</code> attribute, or null if the attribute is not present.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>IsPassive</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value Value of <code>IsPassive</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>ProtocolBinding</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param protocolBinding value of the <code>ProtocolBinding</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getProtocolBinding
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setProtocolBinding(String protocolBinding)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the <code>ProtocolBinding</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of <code>ProtocolBinding</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setProtocolBinding(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the <code>AssertionConsumerServiceURL</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of <code>AssertionConsumerServiceURL</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAssertionConsumerServiceURL(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String getAssertionConsumerServiceURL();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>AssertionConsumerServiceURL</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param url the value of <code>AssertionConsumerServiceURL</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAssertionConsumerServiceURL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAssertionConsumerServiceURL(String url) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the <code>AssertionConsumerServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return value of the <code>AssertionConsumerServiceIndex<code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAssertionConsumerServiceIndex(Integer)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Integer getAssertionConsumerServiceIndex();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>AssertionConsumerServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param index value of the <code>AssertionConsumerServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAssertionConsumerServiceIndex
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAssertionConsumerServiceIndex(Integer index)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the <code>AttributeConsumingServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return value of the <code>AttributeConsumingServiceIndex<code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAttributeConsumingServiceIndex(Integer)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Integer getAttributeConsumingServiceIndex();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>AttributeConsumingServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param index value of the <code>AttributeConsumingServiceIndex</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAttributeConsumingServiceIndex
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAttributeConsumingServiceIndex(Integer index)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>ProviderName</code> attribute value.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param providerName value of the <code>ProviderName</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getProviderName
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setProviderName(String providerName) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>ProviderName</code> attribute value.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return value of the <code>ProviderName</code> attribute value.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setProviderName(String)