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