Package com.adobe.granite.auth.saml.spi

Interface SamlHook

public interface SamlHook

Method Summary

Modifier and Type	Method	Description
void	postSamlValidationProcess(@NotNull HttpServletRequest request, @NotNull Assertion assertion, @NotNull Message samlResponse)	This handler is executed before the synchronization of the user in OAK Repository.
void	postSyncUserProcess(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull Assertion assertion, @NotNull AuthenticationInfo authenticationInfo, @NotNull java.lang.String samlResponse)	This handler is executed after the synchronization of the user in OAK Repository.

Method Detail

postSyncUserProcess

void postSyncUserProcess(@NotNull
                         @NotNull HttpServletRequest request,
                         @NotNull
                         @NotNull HttpServletResponse response,
                         @NotNull
                         @NotNull Assertion assertion,
                         @NotNull
                         @NotNull AuthenticationInfo authenticationInfo,
                         @NotNull
                         @NotNull java.lang.String samlResponse)
                  throws SamlHookException

This handler is executed after the synchronization of the user in OAK Repository. It can be used to extend the user profile by adding/modifying attributes. If SamlHookException is thrown, the authentication of current user fails. Remark that the user created in OAK is not be deleted by SAML Authentication Handler. If cleanup is required by the hooks, it must be implemented in the same. When SamlHookException is thrown a debug message is logged in AEM. If error must be logged, then the hook must do that.

Parameters:

request -

response -

assertion -

authenticationInfo -

samlResponse -

Throws:

SamlHookException

postSamlValidationProcess

void postSamlValidationProcess(@NotNull
                               @NotNull HttpServletRequest request,
                               @NotNull
                               @NotNull Assertion assertion,
                               @NotNull
                               @NotNull Message samlResponse)
                        throws SamlHookException

This handler is executed before the synchronization of the user in OAK Repository. It can be used to perform additional check after that SAML is validated.

If SamlHookException is thrown, the authentication of current user fails. When SamlHookException is thrown a debug message is logged in AEM.

Parameters:

request -

assertion -

samlResponse -

Throws:

SamlHookException