com.onelogin.saml2.authn

Class AuthnRequest

java.lang.Object

com.onelogin.saml2.authn.AuthnRequest

public class AuthnRequest
extends Object

AuthNRequest class of OneLogin's Java Toolkit. A class that implements SAML 2 Authentication Request

Constructor Summary

Constructors

Constructor and Description
AuthnRequest(Saml2Settings settings) Constructs the AuthnRequest object.
AuthnRequest(Saml2Settings settings, boolean forceAuthn, boolean isPassive, boolean setNameIdPolicy) Constructs the AuthnRequest object.
AuthnRequest(Saml2Settings settings, boolean forceAuthn, boolean isPassive, boolean setNameIdPolicy, String nameIdValueReq) Constructs the AuthnRequest object.

Method Summary

Modifier and Type	Method and Description
String	getAuthnRequestXml()
String	getEncodedAuthnRequest()
String	getEncodedAuthnRequest(Boolean deflated)
String	getId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthnRequest

public AuthnRequest(Saml2Settings settings)

Constructs the AuthnRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

AuthnRequest

public AuthnRequest(Saml2Settings settings,
                    boolean forceAuthn,
                    boolean isPassive,
                    boolean setNameIdPolicy,
                    String nameIdValueReq)

Constructs the AuthnRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

forceAuthn - When true the AuthNReuqest will set the ForceAuthn='true'

isPassive - When true the AuthNReuqest will set the IsPassive='true'

setNameIdPolicy - When true the AuthNReuqest will set a nameIdPolicy

nameIdValueReq - Indicates to the IdP the subject that should be authenticated

AuthnRequest

public AuthnRequest(Saml2Settings settings,
                    boolean forceAuthn,
                    boolean isPassive,
                    boolean setNameIdPolicy)

Constructs the AuthnRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

forceAuthn - When true the AuthNReuqest will set the ForceAuthn='true'

isPassive - When true the AuthNReuqest will set the IsPassive='true'

setNameIdPolicy - When true the AuthNReuqest will set a nameIdPolicy

Method Detail

getEncodedAuthnRequest

public String getEncodedAuthnRequest(Boolean deflated)
                              throws IOException

Parameters:

deflated - If deflated or not the encoded AuthnRequest

Returns:

the base64 encoded unsigned AuthnRequest (deflated or not)

Throws:

IOException

getEncodedAuthnRequest

public String getEncodedAuthnRequest()
                              throws IOException

Returns:

base64 encoded, unsigned AuthnRequest (deflated or not)

Throws:

IOException

getAuthnRequestXml

public String getAuthnRequestXml()

Returns:

unsigned plain-text AuthnRequest.

getId

public String getId()

Returns:

the generated id of the AuthnRequest message