Skip navigation links
oracle.iam.sso.api
Interface AutoLoginProvider
-
public interface AutoLoginProvider
Method Summary |
java.util.Set |
getAuthenticationCookies(java.lang.String resourceHost, int resourcePort)
Returns the cookie Set needed do the autologin. |
java.util.Set |
getPropertyKeySet()
Provides the property key set for the respective provider |
java.lang.String |
getRedirectionURL()
Returns the re-direction url |
java.lang.String |
getToken()
Returns the session token on basis of which authentication is performed |
void |
initialize(java.util.Map properties)
Initializes the provider by connecting to the sso server Connect info to be supplied in properties |
void |
login(java.lang.String url, java.lang.String userName, java.lang.String userPassword, java.lang.String IP)
Performs a program based login to the SSO. |
void |
logout()
|
OAM_PROVIDER
static final java.lang.String OAM_PROVIDER
-
- See Also:
- Constant Field Values
initialize
void initialize(java.util.Map properties)
throws AutoLoginException
- Initializes the provider by connecting to the sso server Connect info to be supplied in properties
-
- Parameters:
properties
-
- Throws:
AutoLoginException
getPropertyKeySet
java.util.Set getPropertyKeySet()
- Provides the property key set for the respective provider
-
- Returns:
- property key set
login
void login(java.lang.String url,
java.lang.String userName,
java.lang.String userPassword,
java.lang.String IP)
throws AutoLoginException
- Performs a program based login to the SSO.
-
- Parameters:
url
- URL pattern to be accessed
userName
- Username from which login is to be performed
userPassword
- Password from which login is to be performed
clientIp
- IP Address of the client (Request source). Give an empty string if ipValidation is off.
- Throws:
AutoLoginException
logout
void logout()
throws AutoLoginException
-
- Throws:
AutoLoginException
getToken
java.lang.String getToken()
throws AutoLoginException
- Returns the session token on basis of which authentication is performed
-
- Returns:
- Throws:
AutoLoginException
getAuthenticationCookies
java.util.Set getAuthenticationCookies(java.lang.String resourceHost,
int resourcePort)
throws AutoLoginException
- Returns the cookie Set needed do the autologin. This cookie Set in the response performs the autologin functionality This function has an assumption that autologin is done by this point
-
- Parameters:
resourceHost
- Hostname of the protected resource
resourcePort
- Port of the protected resource
- Throws:
AutoLoginException
getRedirectionURL
java.lang.String getRedirectionURL()
- Returns the re-direction url
-
- Returns:
- URL to which the client/UI should re-direct
Skip navigation links
Copyright © 2014, Oracle and/or its affiliates. All rights reserved.