com.atlassian.crowd.manager.sso

Interface ApplicationSamlConfigurationService

All Known Implementing Classes:

ApplicationSamlConfigurationServiceImpl

public interface ApplicationSamlConfigurationService

A service for managing an application's SAML SSO configuration

Since:

3.4.0

Method Summary

Modifier and Type	Method and Description
Optional<ApplicationSamlConfiguration>	findByAssertionConsumerAndAudience(String assertionConsumerServiceURL, String audience) Returns the SAML SSO configuration for the specified assertion consumer url and audience.
Optional<ApplicationSamlConfiguration>	loadConfigurationForApplication(Application application) Returns the SAML SSO configuration for the specified application
BaseApplicationSamlConfiguration	parseApplicationMetadata(InputStream metadataXml) Parses SAML SSO configuration for an application based on the provided XML metadata.
void	storeApplicationConfiguration(ApplicationSamlConfiguration configuration) Creates or updates SAML SSO configuration for an application

Method Detail

loadConfigurationForApplication

Optional<ApplicationSamlConfiguration> loadConfigurationForApplication(Application application)

Returns the SAML SSO configuration for the specified application

Parameters:

application - the application for which the configuration should be fetched

Returns:

an optional containing the configuration if present or an empty one if not

storeApplicationConfiguration

void storeApplicationConfiguration(ApplicationSamlConfiguration configuration)
                            throws InvalidApplicationSamlConfigurationException,
                                   OperationFailedException

Creates or updates SAML SSO configuration for an application

Parameters:

configuration - the configuration to save or update

Throws:

InvalidApplicationSamlConfigurationException

OperationFailedException

findByAssertionConsumerAndAudience

Optional<ApplicationSamlConfiguration> findByAssertionConsumerAndAudience(String assertionConsumerServiceURL,
                                                                          String audience)

Returns the SAML SSO configuration for the specified assertion consumer url and audience. At least one of the parameters have to be specified to get non-empty result.

Parameters:

assertionConsumerServiceURL - SSO application assertion consumer url

audience - SSO application audience

Returns:

an optional with the corresponding configuration, if any

parseApplicationMetadata

BaseApplicationSamlConfiguration parseApplicationMetadata(InputStream metadataXml)

Parses SAML SSO configuration for an application based on the provided XML metadata.

Parameters:

metadataXml - stream with XML metadata, will be closed by this method

Returns:

parsed configuration

Throws:

IllegalArgumentException - when input stream is not valid XML metadata

See Also:

Metadata for SAML