com.sun.identity.saml2.protocol

Interface AuthnQuery

All Superinterfaces:

RequestAbstract, SubjectQueryAbstract

public interface AuthnQuery
extends SubjectQueryAbstract

This class represents the AuthnQueryType complex type.

The following schema fragment specifies the expected content contained within this java content object.

 <complexType name="AuthnQueryType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}SubjectQueryAbstractType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}RequestedAuthnContext" minOccurs="0"/>
       </sequence>
       <attribute name="SessionIndex" type="string" use="optional"/>
     </extension>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method and Description
RequestedAuthnContext	getRequestedAuthnContext() Returns the RequestedAuthnContext object.
String	getSessionIndex() Returns the value of the SessionIndex attribute.
void	setRequestedAuthnContext(RequestedAuthnContext requestedAuthnContext) Sets the RequestedAuthnContext object.
void	setSessionIndex(String sessionIndex) Sets the value of SessionIndex attribute.

Methods inherited from interface com.sun.identity.saml2.protocol.SubjectQueryAbstract

getSubject, setSubject

Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract

getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, toXMLString, toXMLString

Method Detail

getRequestedAuthnContext

RequestedAuthnContext getRequestedAuthnContext()

Returns the RequestedAuthnContext object.

Returns:

the RequestedAuthnContext object.

See Also:

AuthnQuery.setRequestedAuthnContext(RequestedAuthnContext)

setRequestedAuthnContext

void setRequestedAuthnContext(RequestedAuthnContext requestedAuthnContext)
                       throws SAML2Exception

Sets the RequestedAuthnContext object.

Parameters:

requestedAuthnContext - the new RequestedAuthnContext object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnQuery.getRequestedAuthnContext()

getSessionIndex

String getSessionIndex()

Returns the value of the SessionIndex attribute.

Returns:

value of SessionIndex attribute.

See Also:

AuthnQuery.setSessionIndex(String)

setSessionIndex

void setSessionIndex(String sessionIndex)
              throws SAML2Exception

Sets the value of SessionIndex attribute.

Parameters:

sessionIndex - new value of the SessionIndex attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnQuery.getSessionIndex()