Skip navigation links

oracle.security.jps.service.sso
Interface SsoServiceConfig

public interface SsoServiceConfig

This interface defines APIs for managing SSO service settings specified in the JPS configuration.

Since:

11gR1+

Version:

1.0

Author:

yiwawang

Field Summary

static java.lang.String	AUTOLOGIN_TARGETURL_PROP Config property for auto-login target url.
static java.lang.String	AUTOLOGIN_TOKEN_PROP Config property for auto-login token.
static java.lang.String	LOGIN_CANCELURL_PROP Config property for login cancel url.
static java.lang.String	LOGIN_SUCCESSURL_PROP Config property for login success url.
static java.lang.String	LOGOUT_TARGETURL_PROP Config property for logout target url.

Method Summary

java.lang.String	getAutoLoginUrl(java.util.Map<java.lang.String,?> props) Gets the auto login endpoint url of the underlying SSO provider.
ExtendedProperty	getExtendedProperty() Gets the combined extended properties of an SSO ServiceInstance and ServiceProvider.
java.lang.String	getLoginUrl(java.lang.String level, java.util.Map<java.lang.String,?> props) Gets the login endpoint url of the underlying SSO provider.
java.lang.String	getLogoutUrl(java.util.Map<java.lang.String,?> props) Gets the logout endpoint url of the underlying SSO provider.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets the combined properties of an SSO ServiceInstance and ServiceProvider.
java.lang.String	getSsoProviderClassName() Gets the class name of an SSO provider.
java.lang.String	getTokenProviderClassName() Gets the class name of the oracle.security.jps.internal.sso.TokenProvider.
java.lang.String	getTokenType() Gets the type of token that allows the underlying SSO provider to establish an authenticated user and to create a user session

Field Detail

LOGIN_SUCCESSURL_PROP

static final java.lang.String LOGIN_SUCCESSURL_PROP

Config property for login success url.

See Also:

Constant Field Values

LOGIN_CANCELURL_PROP

static final java.lang.String LOGIN_CANCELURL_PROP

Config property for login cancel url.

See Also:

Constant Field Values

AUTOLOGIN_TARGETURL_PROP

static final java.lang.String AUTOLOGIN_TARGETURL_PROP

Config property for auto-login target url.

See Also:

Constant Field Values

AUTOLOGIN_TOKEN_PROP

static final java.lang.String AUTOLOGIN_TOKEN_PROP

Config property for auto-login token.

See Also:

Constant Field Values

LOGOUT_TARGETURL_PROP

static final java.lang.String LOGOUT_TARGETURL_PROP

Config property for logout target url.

See Also:

Constant Field Values

Method Detail

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Gets the combined properties of an SSO ServiceInstance and ServiceProvider.

Returns:

the combined properties of an SSO service instance and provider

getExtendedProperty

ExtendedProperty getExtendedProperty()

Gets the combined extended properties of an SSO ServiceInstance and ServiceProvider.

Returns:

the combined extended properties of an SSO service instance and provider

getSsoProviderClassName

java.lang.String getSsoProviderClassName()

Gets the class name of an SSO provider.

Returns:

the class name of an SSO provider

getTokenType

java.lang.String getTokenType()

Gets the type of token that allows the underlying SSO provider to establish an authenticated user and to create a user session

Returns:

the type of token

getTokenProviderClassName

java.lang.String getTokenProviderClassName()

Gets the class name of the oracle.security.jps.internal.sso.TokenProvider.

Returns:

the class name of the token provider.

getLoginUrl

java.lang.String getLoginUrl(java.lang.String level,
                             java.util.Map<java.lang.String,?> props)

Gets the login endpoint url of the underlying SSO provider. The login endpoint URL configured can contain a variable for application context root in the form of ${app.context}. This method will perform variable substitution with values passed via the props.

Parameters:

level - the authentication level, the configured default auth level will be used if not specified

props - carry any information relevant to the login process

Returns:

the login endpoint url of the SSO provider, null if the url not configured

getAutoLoginUrl

java.lang.String getAutoLoginUrl(java.util.Map<java.lang.String,?> props)

Gets the auto login endpoint url of the underlying SSO provider. The auto login endpoint URL configured can contain a variable for application context root in the form of ${app.context}. This method will perform variable substitution with values passed via the props.

Parameters:

props - carry any information relevant to the login process

Returns:

the auto login endpoint url of the SSO provider, null if the url not configured

getLogoutUrl

java.lang.String getLogoutUrl(java.util.Map<java.lang.String,?> props)

Gets the logout endpoint url of the underlying SSO provider. The logout endpoint URL configured can contain a variable for application context root in the form of ${app.context}. This method will perform variable substitution with values passed via the props.

Parameters:

props - carry any information relevant to the logout process

Returns:

the logout endpoint url of the SSO provider, null if the url not configured

Skip navigation links