public class LoginConnection
extends java.lang.Object
implements javax.naming.Referenceable
Constructor and Description |
---|
LoginConnection()
Default constructor.
|
LoginConnection(java.lang.String loginUrl,
java.lang.String logoutUrl,
int idleTimeout,
int sessionTimeout,
boolean isLoginServerCookieIncluded)
Constructor with parameters.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAccessControlUrl()
Gets the access control URL.
|
java.lang.String |
getAuthenticationMode()
Returns the authentication mode
|
java.lang.String |
getConnectionId()
Gets the connection Id.
|
java.lang.String |
getCredKey()
Gets the credential store key.
|
int |
getIdleTimeout()
Gets the idle timeout property.
|
java.lang.String |
getLoginUrl()
Gets the login URL property.
|
java.lang.String |
getLogoutUrl()
Gets the logout URL property.
|
java.util.List<java.lang.String> |
getPrivileges()
Gets the list of privileges.
|
java.lang.String |
getRealm()
Returns the Realm for HTTP basic authentication
|
javax.naming.Reference |
getReference()
Gets a reference of our Login Connection type.
|
java.util.List<java.lang.String> |
getRoles()
Gets the list of roles.
|
int |
getSessionTimeout()
Gets the session timeout.
|
boolean |
includeBasicAuthHeader()
Determines whether the basic authentication header needs to be incluided in HTTP request
|
boolean |
isLoginServerCookieIncluded()
Determines whether login server cookie is included
|
boolean |
isMultiTenantAware()
Determines whether multi-tenant aware flag is set
|
boolean |
isOptionToRememberPasswordEnabled()
Determines whether the option to remember password is enabled
|
boolean |
isOptionToRememberUserLoggedInEnabled()
Determines whether the option to remember user logged in is enabled
|
boolean |
isOptionToRememberUserNameEnabled()
Determines whether the option to remember user name is enabled
|
boolean |
rememberPasswordDefault()
Determines whether to remember password by default
|
boolean |
rememberUserLoggedInDefault()
Determines whether to remember user logged in by default
|
boolean |
rememberUserNameDefault()
Determines whether to remember user name by default
|
LoginConnection |
setAccessControlInfo(java.lang.String accessControlUrl,
java.util.List<java.lang.String> roleList,
java.util.List<java.lang.String> privilegeList)
Sets the Access Control informaiton.
|
void |
setAccessControlUrl(java.lang.String accessControlUrl)
Sets the access control URL.
|
void |
setAuthenticationMode(java.lang.String authenticationMode)
Sets the authentication mode
|
void |
setConnectionId(java.lang.String connectionId)
Sets the connection Id.
|
void |
setCredKey(java.lang.String credKey)
Sets the credential store key.
|
void |
setIdleTimeout(int idleTimeout)
Sets the idle timeout property.
|
void |
setIncludeBasicAuthHeader(boolean includeBasicAuthHeader)
Sets the basic authentication header flag
|
void |
setIsLoginServerCookieIncluded(boolean isLoginServerCookieIncluded)
Sets inclusion of login server cookie
|
void |
setIsMultiTenantAware(boolean isMultiTenantAware)
Sets the multi-tenant aware boolean flag.
|
void |
setLoginUrl(java.lang.String loginUrl)
Sets the login URL property.
|
void |
setLogoutUrl(java.lang.String logoutUrl)
Sets the logout URL property.
|
void |
setOptionToRememberPasswordEnabled(boolean _optionToRememberPasswordEnabled)
Sets option to remember password
|
void |
setOptionToRememberUserLoggedInEnabled(boolean _optionToRememberUserLoggedInEnabled)
Sets option to remember user logged in
|
void |
setOptionToRememberUserNameEnabled(boolean _optionToRememberUserNameEnabled)
Sets option to remember user name
|
void |
setPrivileges(java.util.List<java.lang.String> privileges)
Sets the list of privileges.
|
void |
setRealm(java.lang.String realm)
Sets the Realm for HTTP basic authentication
|
void |
setRememberPasswordDefault(boolean _rememberPassword)
Sets remember password default
|
void |
setRememberUserLoggedInDefault(boolean _rememberUserLoggedIn)
Sets remember user logged in default
|
void |
setRememberUserNameDefault(boolean _rememberUserName)
Sets remember user name default
|
void |
setRoles(java.util.List<java.lang.String> roles)
Sets the list of roles.
|
void |
setSessionTimeout(int sessionTimeout)
Sets the session timeout property.
|
public static final java.lang.String ADDR_TYPE
public static final java.lang.String ELEM_LOGIN
public static final java.lang.String ELEM_LOGOUT
public static final java.lang.String ELEM_ACCESS_CONTROL
public static final java.lang.String ELEM_IDLE_TIMEOUT
public static final java.lang.String ELEM_SESSION_TIMEOUT
public static final java.lang.String ELEM_USER_OBJECT_FILTER
public static final java.lang.String ELEM_ROLE
public static final java.lang.String ELEM_PRIVILEGE
public static final java.lang.String ELEM_INJECT_COOKIES_TO_REST_HTTP_HEADER
public static final java.lang.String ELEM_INCLUDE_BASIC_AUTH_HEADER
public static final java.lang.String ELEM_REALM
public static final java.lang.String ELEM_AUTHENTICATION_MODE
public static final java.lang.String ELEM_REMEMBER_CREDENTIALS
public static final java.lang.String ELEM_ENABLE_REMEMBER_USER_NAME
public static final java.lang.String ELEM_ENABLE_REMEMBER_PASSWORD
public static final java.lang.String ELEM_ENABLE_REMEMBER_STAY_LOGGED_IN
public static final java.lang.String ELEM_REMEMBER_USER_NAME_DEFAULT
public static final java.lang.String ELEM_REMEMBER_PASSWORD_DEFAULT
public static final java.lang.String ELEM_STAY_LOGGED_IN_DEFAULT
public static final java.lang.String ELEM_IS_MULTI_TENANT_AWARE
public static final java.lang.String ATTR_VALUE
public static final java.lang.String ATTR_URL
public static final java.lang.String ATTR_NAME
public static final java.lang.String ATTR_PASSWORD
public static final int DEFAULT_IDLE_TIMEOUT
public static final int DEFAULT_SESSION_TIMEOUT
public static final boolean DEFAULT_OPTION_TO_REMEMBER_USER_NAME
public static final boolean DEFAULT_OPTION_TO_REMEMBER_PASSWORD
public static final boolean DEFAULT_OPTION_TO_REMEMBER_USER_LOGGED_IN
public static final boolean DEFAULT_REMEMBER_USER_NAME
public static final boolean DEFAULT_REMEMBER_PASSWORD
public static final boolean DEFAULT_REMEMBER_USER_LOGGED_IN
public static final boolean DEFAULT_MULTI_TENANT_AWARE
public static final boolean DEFAULT_LOGIN_SERVER_COOKIE_INCLUDED
public static final boolean DEFAULT_BASIC_AUTH_HEADER_INCLUDED
public LoginConnection()
public LoginConnection(java.lang.String loginUrl, java.lang.String logoutUrl, int idleTimeout, int sessionTimeout, boolean isLoginServerCookieIncluded)
loginUrl
- login URL propertylogoutUrl
- logout URL propertyidleTimeout
- idle timeout in secondssessionTimeout
- session timeout in secondsisLoginServerCookieIncluded
- is login server cookie includedpublic LoginConnection setAccessControlInfo(java.lang.String accessControlUrl, java.util.List<java.lang.String> roleList, java.util.List<java.lang.String> privilegeList)
accessControlUrl
- access control server UrlroleList
- a list of roles in the user filterprivilegeList
- a list of privileges in the user filterpublic javax.naming.Reference getReference()
getReference
in interface javax.naming.Referenceable
public void setLoginUrl(java.lang.String loginUrl)
loginUrl
- login URLpublic java.lang.String getLoginUrl()
public void setLogoutUrl(java.lang.String logoutUrl)
logoutUrl
- logout URLpublic java.lang.String getLogoutUrl()
public void setIdleTimeout(int idleTimeout)
idleTimeout
- the idle timeout valuepublic int getIdleTimeout()
public void setSessionTimeout(int sessionTimeout)
sessionTimeout
- the session timeout valuepublic int getSessionTimeout()
public void setConnectionId(java.lang.String connectionId)
connectionId
- the connection Idpublic java.lang.String getConnectionId()
public void setCredKey(java.lang.String credKey)
credKey
- the credential store keypublic java.lang.String getCredKey()
public void setAccessControlUrl(java.lang.String accessControlUrl)
accessControlUrl
- url for the access control serverpublic java.lang.String getAccessControlUrl()
public void setRoles(java.util.List<java.lang.String> roles)
roles
- the list of rolespublic java.util.List<java.lang.String> getRoles()
public void setPrivileges(java.util.List<java.lang.String> privileges)
privileges
- the list of privilegespublic java.util.List<java.lang.String> getPrivileges()
public void setIsMultiTenantAware(boolean isMultiTenantAware)
isMultiTenantAware
- true if the login server is multi-tenant awarepublic boolean isMultiTenantAware()
public void setIncludeBasicAuthHeader(boolean includeBasicAuthHeader)
includeBasicAuthHeader
- detrmines if authentication header is includedpublic boolean includeBasicAuthHeader()
public void setOptionToRememberUserNameEnabled(boolean _optionToRememberUserNameEnabled)
_optionToRememberUserNameEnabled
- option to remember user namepublic boolean isOptionToRememberUserNameEnabled()
public void setOptionToRememberPasswordEnabled(boolean _optionToRememberPasswordEnabled)
_optionToRememberPasswordEnabled
- option to remember passwordpublic boolean isOptionToRememberPasswordEnabled()
public void setOptionToRememberUserLoggedInEnabled(boolean _optionToRememberUserLoggedInEnabled)
_optionToRememberUserLoggedInEnabled
- option to remember user logged inpublic boolean isOptionToRememberUserLoggedInEnabled()
public void setRememberUserNameDefault(boolean _rememberUserName)
_rememberUserName
- remember user name defaultpublic boolean rememberUserNameDefault()
public void setRememberPasswordDefault(boolean _rememberPassword)
_rememberPassword
- remember password defaultpublic boolean rememberPasswordDefault()
public void setRememberUserLoggedInDefault(boolean _rememberUserLoggedIn)
_rememberUserLoggedIn
- remember user logged in defaultpublic boolean rememberUserLoggedInDefault()
public void setRealm(java.lang.String realm)
realm
- the realmpublic java.lang.String getRealm()
public boolean isLoginServerCookieIncluded()
public void setIsLoginServerCookieIncluded(boolean isLoginServerCookieIncluded)
isLoginServerCookieIncluded
- login server cookie inclusionpublic void setAuthenticationMode(java.lang.String authenticationMode)
authenticationMode
- authentication modepublic java.lang.String getAuthenticationMode()