Package com.onelogin.saml2.factory

Interface SamlMessageFactory

public interface SamlMessageFactory

Factory which can create all kind of SAML message objects.

One such factory is used by the Auth class to orchestrate login and logout operations.

Default implementations for all creation methods are provided: they create instances of the standard classes provided by the library. Any extension class may simply override the desired creation methods in order to return instances of custom extensions of those standard classes.

Method Summary

Modifier and Type	Method	Description
default AuthnRequest	createAuthnRequest(Saml2Settings settings, AuthnRequestParams params)	Creates an AuthnRequest instance.
default LogoutRequest	createIncomingLogoutRequest(Saml2Settings settings, HttpRequest request)	Creates a LogoutRequest instance for an incoming request.
default LogoutResponse	createIncomingLogoutResponse(Saml2Settings settings, HttpRequest request)	Creates a LogoutRequest instance for an incoming response.
default LogoutRequest	createOutgoingLogoutRequest(Saml2Settings settings, LogoutRequestParams params)	Creates a LogoutRequest instance for an outgoing request.
default LogoutResponse	createOutgoingLogoutResponse(Saml2Settings settings, LogoutResponseParams params)	Creates a LogoutResponse instance for an outgoing response.
default SamlResponse	createSamlResponse(Saml2Settings settings, HttpRequest request)	Creates a SamlResponse instance.

Method Detail

createAuthnRequest

default AuthnRequest createAuthnRequest(Saml2Settings settings,
                                        AuthnRequestParams params)

Creates an AuthnRequest instance.

Parameters:

settings - the settings

params - the authentication request input parameters

Returns:

the created AuthnRequest instance

createSamlResponse

default SamlResponse createSamlResponse(Saml2Settings settings,
                                        HttpRequest request)
                                 throws java.lang.Exception

Creates a SamlResponse instance.

Parameters:

settings - the settings

request - the HTTP request from which the response is to be extracted and parsed

Returns:

the created SamlResponse instance

Throws:

java.lang.Exception - in case some error occurred while trying to create the SamlResponse instance

createOutgoingLogoutRequest

default LogoutRequest createOutgoingLogoutRequest(Saml2Settings settings,
                                                  LogoutRequestParams params)

Creates a LogoutRequest instance for an outgoing request.

Parameters:

settings - the settings

params - the logout request input parameters

Returns:

the created LogoutRequest instance

createIncomingLogoutRequest

default LogoutRequest createIncomingLogoutRequest(Saml2Settings settings,
                                                  HttpRequest request)
                                           throws java.lang.Exception

Creates a LogoutRequest instance for an incoming request.

Parameters:

settings - the settings

request - the HTTP request from which the logout request is to be extracted and parsed

Returns:

the created LogoutRequest instance

Throws:

java.lang.Exception - in case some error occurred while trying to create the LogoutRequest instance

createOutgoingLogoutResponse

default LogoutResponse createOutgoingLogoutResponse(Saml2Settings settings,
                                                    LogoutResponseParams params)

Creates a LogoutResponse instance for an outgoing response.

Parameters:

settings - the settings

params - the logout response input parameters

Returns:

the created LogoutResponse instance

createIncomingLogoutResponse

default LogoutResponse createIncomingLogoutResponse(Saml2Settings settings,
                                                    HttpRequest request)
                                             throws java.lang.Exception

Creates a LogoutRequest instance for an incoming response.

Parameters:

settings - the settings

request - the HTTP request from which the logout response is to be extracted and parsed

Returns:

the created LogoutResponse instance

Throws:

java.lang.Exception - in case some error occurred while trying to create the LogoutResponse instance