oracle.adf.model.connection.adfmf
Class LoginConnection

java.lang.Object
  oracle.adf.model.connection.adfmf.LoginConnection

All Implemented Interfaces:

javax.naming.Referenceable

public class LoginConnection
extends java.lang.Object
implements javax.naming.Referenceable

LoginConnection is a new ADF Connection type defined as the ADF Mobile Login Server Connection.

Field Summary

static java.lang.String	ADDR_TYPE
static java.lang.String	ATTR_NAME
static java.lang.String	ATTR_PASSWORD
static java.lang.String	ATTR_URL
static java.lang.String	ATTR_VALUE
static int	DEFAULT_IDLE_TIMEOUT
static int	DEFAULT_SESSION_TIMEOUT
static java.lang.String	ELEM_ACCESS_CONTROL
static java.lang.String	ELEM_COOKIE
static java.lang.String	ELEM_COOKIE_NAMES
static java.lang.String	ELEM_IDLE_TIMEOUT
static java.lang.String	ELEM_INJECT_COOKIES_TO_REST_HTTP_HEADER
static java.lang.String	ELEM_IS_MULTI_TENANT_AWARE
static java.lang.String	ELEM_LOGIN
static java.lang.String	ELEM_LOGOUT
static java.lang.String	ELEM_MULTI_TENANT_HEADER_NAME
static java.lang.String	ELEM_PRIVILEGE
static java.lang.String	ELEM_ROLE
static java.lang.String	ELEM_SESSION_TIMEOUT
static java.lang.String	ELEM_USER_OBJECT_FILTER

Constructor Summary

LoginConnection()
Default constructor.

LoginConnection(java.lang.String loginUrl, java.lang.String logoutUrl, int idleTimeout, int sessionTimeout, java.util.List<java.lang.String> cookieList, boolean isLoginServerCookieIncluded)
Constructor with parameters.

Method Summary

java.lang.String	getAccessControlUrl() Gets the access control URL.
java.lang.String	getConnectionId() Gets the connection Id.
java.util.List<java.lang.String>	getCookies() Gets the list of cookies.
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.lang.String	getMultiTenantHeaderName() Gets the multi-tenant header name.
java.util.List<java.lang.String>	getPrivileges() Gets the list of privileges.
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	isLoginServerCookieIncluded() Determines whether the login server cookie should be included in REST calls.
boolean	isMultiTenantAware() Checks the multi-tenant aware boolean flag.
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	setConnectionId(java.lang.String connectionId) Sets the connection Id.
void	setCookies(java.util.List<java.lang.String> cookies) Sets the list of cookies.
void	setCredKey(java.lang.String credKey) Sets the credential store key.
void	setIdleTimeout(int idleTimeout) Sets the idle timeout property.
void	setIsLoginServerCookieIncluded(boolean isLoginServerCookieIncluded) Sets the login server cookie included flag.
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	setMultiTenantHeaderName(java.lang.String multiTenantHeaderName) Sets the multi-tenant header name.
LoginConnection	setMultiTenantInfo(boolean isMultiTenantAware, java.lang.String multiTenantHeaderName) Sets the MultiTenant information.
void	setPrivileges(java.util.List<java.lang.String> privileges) Sets the list of privileges.
void	setRoles(java.util.List<java.lang.String> roles) Sets the list of roles.
void	setSessionTimeout(int sessionTimeout) Sets the session timeout property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADDR_TYPE

public static final java.lang.String ADDR_TYPE

See Also:

Constant Field Values

ELEM_LOGIN

public static final java.lang.String ELEM_LOGIN

See Also:

Constant Field Values

ELEM_LOGOUT

public static final java.lang.String ELEM_LOGOUT

See Also:

Constant Field Values

ELEM_ACCESS_CONTROL

public static final java.lang.String ELEM_ACCESS_CONTROL

See Also:

Constant Field Values

ELEM_IDLE_TIMEOUT

public static final java.lang.String ELEM_IDLE_TIMEOUT

See Also:

Constant Field Values

ELEM_SESSION_TIMEOUT

public static final java.lang.String ELEM_SESSION_TIMEOUT

See Also:

Constant Field Values

ELEM_COOKIE_NAMES

public static final java.lang.String ELEM_COOKIE_NAMES

See Also:

Constant Field Values

ELEM_COOKIE

public static final java.lang.String ELEM_COOKIE

See Also:

Constant Field Values

ELEM_USER_OBJECT_FILTER

public static final java.lang.String ELEM_USER_OBJECT_FILTER

See Also:

Constant Field Values

ELEM_ROLE

public static final java.lang.String ELEM_ROLE

See Also:

Constant Field Values

ELEM_PRIVILEGE

public static final java.lang.String ELEM_PRIVILEGE

See Also:

Constant Field Values

ELEM_IS_MULTI_TENANT_AWARE

public static final java.lang.String ELEM_IS_MULTI_TENANT_AWARE

See Also:

Constant Field Values

ELEM_MULTI_TENANT_HEADER_NAME

public static final java.lang.String ELEM_MULTI_TENANT_HEADER_NAME

See Also:

Constant Field Values

ELEM_INJECT_COOKIES_TO_REST_HTTP_HEADER

public static final java.lang.String ELEM_INJECT_COOKIES_TO_REST_HTTP_HEADER

See Also:

Constant Field Values

ATTR_VALUE

public static final java.lang.String ATTR_VALUE

See Also:

Constant Field Values

ATTR_URL

public static final java.lang.String ATTR_URL

See Also:

Constant Field Values

ATTR_NAME

public static final java.lang.String ATTR_NAME

See Also:

Constant Field Values

ATTR_PASSWORD

public static final java.lang.String ATTR_PASSWORD

See Also:

Constant Field Values

DEFAULT_IDLE_TIMEOUT

public static final int DEFAULT_IDLE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SESSION_TIMEOUT

public static final int DEFAULT_SESSION_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

LoginConnection

public LoginConnection()

Default constructor.

LoginConnection

public LoginConnection(java.lang.String loginUrl,
                       java.lang.String logoutUrl,
                       int idleTimeout,
                       int sessionTimeout,
                       java.util.List<java.lang.String> cookieList,
                       boolean isLoginServerCookieIncluded)

Constructor with parameters.

Parameters:

loginUrl - login URL property

logoutUrl - logout URL property

idleTimeout - idle timeout in seconds

sessionTimeout - session timeout in seconds

cookieList - list of cookies used to assist reading authentication responses

Method Detail

setAccessControlInfo

public 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.

Parameters:

accessControlUrl - access control server Url

roleList - a list of roles in the user filter

privilegeList - a list of privileges in the user filter

Returns:

the LoginConnection instance

setMultiTenantInfo

public LoginConnection setMultiTenantInfo(boolean isMultiTenantAware,
                                          java.lang.String multiTenantHeaderName)

Sets the MultiTenant information.

Parameters:

isMultiTenantAware - boolean value indicating whether the login server is multi-tenant aware

multiTenantHeaderName - tenant id header property

Returns:

the LoginConnection instance

getReference

public javax.naming.Reference getReference()

Gets a reference of our Login Connection type.

Specified by:

getReference in interface javax.naming.Referenceable

Returns:

the reference

setLoginUrl

public void setLoginUrl(java.lang.String loginUrl)

Sets the login URL property.

Parameters:

loginUrl - login URL

getLoginUrl

public java.lang.String getLoginUrl()

Gets the login URL property.

Returns:

the login URL

setLogoutUrl

public void setLogoutUrl(java.lang.String logoutUrl)

Sets the logout URL property.

Parameters:

logoutUrl - logout URL

getLogoutUrl

public java.lang.String getLogoutUrl()

Gets the logout URL property.

Returns:

the logout URL

setIdleTimeout

public void setIdleTimeout(int idleTimeout)

Sets the idle timeout property.

Parameters:

idleTimeout - the idle timeout value

getIdleTimeout

public int getIdleTimeout()

Gets the idle timeout property.

Returns:

the idle timeout value

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Sets the session timeout property.

Parameters:

sessionTimeout - the session timeout value

getSessionTimeout

public int getSessionTimeout()

Gets the session timeout.

Returns:

the session timeout value

setCookies

public void setCookies(java.util.List<java.lang.String> cookies)

Sets the list of cookies.

Parameters:

cookies - the list of cookies

getCookies

public java.util.List<java.lang.String> getCookies()

Gets the list of cookies.

Returns:

the list of cookies

setConnectionId

public void setConnectionId(java.lang.String connectionId)

Sets the connection Id.

Parameters:

connectionId - the connection Id

getConnectionId

public java.lang.String getConnectionId()

Gets the connection Id.

Returns:

the connection Id

setCredKey

public void setCredKey(java.lang.String credKey)

Sets the credential store key.

Parameters:

credKey - the credential store key

getCredKey

public java.lang.String getCredKey()

Gets the credential store key.

Returns:

the credential store key value

setAccessControlUrl

public void setAccessControlUrl(java.lang.String accessControlUrl)

Sets the access control URL.

Parameters:

accessControlUrl - url for the access control server

getAccessControlUrl

public java.lang.String getAccessControlUrl()

Gets the access control URL.

Returns:

the access control URL

setRoles

public void setRoles(java.util.List<java.lang.String> roles)

Sets the list of roles.

Parameters:

roles - the list of roles

getRoles

public java.util.List<java.lang.String> getRoles()

Gets the list of roles.

Returns:

the list of roles

setPrivileges

public void setPrivileges(java.util.List<java.lang.String> privileges)

Sets the list of privileges.

Parameters:

privileges - the list of privileges

getPrivileges

public java.util.List<java.lang.String> getPrivileges()

Gets the list of privileges.

Returns:

the list of privileges

setMultiTenantHeaderName

public void setMultiTenantHeaderName(java.lang.String multiTenantHeaderName)

Sets the multi-tenant header name.

Parameters:

multiTenantHeaderName - the multi-tenant header name

getMultiTenantHeaderName

public java.lang.String getMultiTenantHeaderName()

Gets the multi-tenant header name.

Returns:

the multi-tenant header name

setIsMultiTenantAware

public void setIsMultiTenantAware(boolean isMultiTenantAware)

Sets the multi-tenant aware boolean flag.

Parameters:

isMultiTenantAware - true if the login server is multi-tenant aware

isMultiTenantAware

public boolean isMultiTenantAware()

Checks the multi-tenant aware boolean flag.

Returns:

true if the login server is multi-tenant aware, false otherwise

setIsLoginServerCookieIncluded

public void setIsLoginServerCookieIncluded(boolean isLoginServerCookieIncluded)

Sets the login server cookie included flag.

Parameters:

isLoginServerCookieIncluded - true if the login server cookie should be included in REST calls. false otherwise

isLoginServerCookieIncluded

public boolean isLoginServerCookieIncluded()

Determines whether the login server cookie should be included in REST calls.

Returns:

true if the login server cookie should be included false otherwise