com.hp.autonomy.hod.sso.HodAuthenticationRequestService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hod-sso-spring-security Show documentation

Library to assist with using Micro Focus Haven OnDemand SSO with Spring Security

There is a newer version: 0.9.2

Show newest version

/*
 * Copyright 2015 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.hod.sso;

import com.hp.autonomy.hod.client.api.authentication.SignedRequest;
import com.hp.autonomy.hod.client.error.HodErrorException;

import java.net.URL;

/**
 * Service for producing signed requests which can be sent to HP Haven OnDemand SSO to authenticate
 */
public interface HodAuthenticationRequestService {

    /**
     * Generate a signed authenticate combined PATCH request. This can be used in the browser to create a combined SSO token.
     * @return A signed request to make from the user's browser
     * @throws HodErrorException If an error occurs authenticating with HPE Haven OnDemand
     */
    SignedRequest getCombinedPatchRequest() throws HodErrorException;

    /**
     * Generate a signed authenticate combined PATCH request to be sent from the SSO page.
     * @param redirectUrl Redirect URL for the PATCH request; must be in the allowed origins
     * @return A signed request for generating a combined SSO token
     * @throws HodErrorException If an error occurs communicating with HPE Haven OnDemand
     * @throws InvalidOriginException If the redirect URL is not in the allowed origins
     */
    SignedRequest getSsoPageCombinedPatchRequest(URL redirectUrl) throws HodErrorException, InvalidOriginException;

}