public interface IDfLoginInfo
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SECURITY_MODE_NATIVE
Symbolic constant for
setSecurityMode(String) . |
static java.lang.String |
SECURITY_MODE_SECURE
Symbolic constant for
setSecurityMode(String) . |
static java.lang.String |
SECURITY_MODE_TRY_NATIVE_FIRST
Symbolic constant for
setSecurityMode(String) . |
static java.lang.String |
SECURITY_MODE_TRY_SECURE_FIRST
Symbolic constant for
setSecurityMode(String) . |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationId()
Returns the application identifier.
|
java.lang.String |
getApplicationToken()
Returns the application token.
|
java.lang.Object |
getBinaryCredential()
Returns the credential information that was passed with the
setBinaryCredential call
The credential information
could either be in the form of String or any other object that may or may not be serializable. |
java.lang.String |
getDomain()
Returns the Windows NT domain name.
|
boolean |
getForceAuthentication()
Indicates whether connection authentication should be forced even if the connection is retrieved from the pool.
|
java.lang.String |
getPassword()
Returns the password.
|
boolean |
getPeriodicAuthentication()
Indicates whether connection authentication should be performed from time to time for connections retrieved from
the pool.
|
boolean |
getPrincipalMode()
Returns the principal mode indicator.
|
java.lang.String |
getSecurityMode()
Returns the security mode.
|
java.lang.String |
getUser()
Returns the user name.
|
java.lang.String |
getUserArg1()
Returns the first optional argument used by custom server-side authentication plugins.
|
java.lang.String |
getUserArg2()
Deprecated.
a second user argument is no longer supported by the server.
|
boolean |
matches(IDfLoginInfo that)
A little bit looser variation of
equals |
void |
setApplicationId(java.lang.String identifier)
Sets the application identifier.
|
void |
setApplicationToken(java.lang.String token)
Sets the application token.
|
void |
setBinaryCredential(java.lang.Object binaryCredential)
Sets credential information in binary format that may be needed to get sessions.
|
void |
setDomain(java.lang.String domain)
Sets the Windows NT domain name.
|
void |
setForceAuthentication(boolean forceAuthentication)
Sets whether connection authentication should be forced even if the connection is retrieved from the pool.
|
void |
setPassword(java.lang.String password)
Sets the password.
|
void |
setPeriodicAuthentication(boolean periodicAuthentication)
Sets whether connection authentication should be performed from time to time for connections retrieved from the
pool.
|
void |
setPrincipalMode(boolean principalMode)
Sets the principal mode indicator.
|
void |
setSecurityMode(java.lang.String securityMode)
Sets the security mode.
|
void |
setUser(java.lang.String userName)
Sets the user name.
|
void |
setUserArg1(java.lang.String arg)
Sets the first optional argument used by custom server-side authentication plugins.
|
void |
setUserArg2(java.lang.String arg)
Deprecated.
a second user argument is no longer supported by the server.
|
static final java.lang.String SECURITY_MODE_SECURE
setSecurityMode(String)
. The user is interested in a secure
connection only. If the server default is set to 'native', the connection request fails.
If the server default is set to either 'secure' or 'dual', the command succeeds.static final java.lang.String SECURITY_MODE_NATIVE
setSecurityMode(String)
. The user is interested in a native
connection only. If the server default is set to 'secure', the connection request fails.
If the server default is set to either 'native' or 'dual', the request succeeds.static final java.lang.String SECURITY_MODE_TRY_SECURE_FIRST
setSecurityMode(String)
. The user prefers a secure connection over
a native connection. DFC tries to establish a secure connection first. If that fails,
it will try to get a native connection. The connection request fails if neither a secure
nor native connection can be established.static final java.lang.String SECURITY_MODE_TRY_NATIVE_FIRST
setSecurityMode(String)
. The user prefers a native connection
over a secure connection. DFC tries to establish a native connection first. If that fails,
it will try to get a secure connection. The connection request fails if neither a
native nor a secure connect can be established.java.lang.String getUser()
setUser(java.lang.String)
void setUser(java.lang.String userName)
userName
- the user namegetUser()
java.lang.String getPassword()
setPassword(java.lang.String)
void setPassword(java.lang.String password)
password
- the user's passwordgetPassword()
java.lang.String getDomain()
setDomain(java.lang.String)
void setDomain(java.lang.String domain)
domain
- the Windows NT domain namegetDomain()
java.lang.String getUserArg1()
setUserArg1(java.lang.String)
void setUserArg1(java.lang.String arg)
arg
- the argumentgetUserArg1()
java.lang.String getUserArg2()
setUserArg2(java.lang.String)
void setUserArg2(java.lang.String arg)
arg
- the argumentgetUserArg2()
java.lang.String getApplicationId()
setApplicationId(java.lang.String)
void setApplicationId(java.lang.String identifier)
identifier
- application IDgetApplicationId()
java.lang.String getApplicationToken()
setApplicationToken(java.lang.String)
void setApplicationToken(java.lang.String token)
token
- application tokensetApplicationToken(java.lang.String)
java.lang.String getSecurityMode()
setSecurityMode(java.lang.String)
void setSecurityMode(java.lang.String securityMode)
SECURITY_MODE_SECURE
, SECURITY_MODE_NATIVE
, SECURITY_MODE_TRY_SECURE_FIRST
, SECURITY_MODE_TRY_NATIVE_FIRST
.If security mode is not set, the request is sent to the server using the default mode defined in the dfc.properties file.
The mode requested by the client interacts with the server's default secure connection setting. For details about the interaction for each of the client options, refer to the descriptions of the valid values for this method. For information about setting the server's default, refer to the Content Server Administrator's Guide.
securityMode
- the security modegetSecurityMode()
boolean getPrincipalMode()
true
if the credential represents a principal who is known to be authentic.setPrincipalMode(boolean)
void setPrincipalMode(boolean principalMode)
principalMode
- true
if the credential represents a principal who is known to be authenticgetPrincipalMode()
boolean getForceAuthentication()
true
if authentication with the server should be forced.void setForceAuthentication(boolean forceAuthentication)
forceAuthentication
- true
if authentication with the server should be forced.boolean getPeriodicAuthentication()
true
if authentication with the server should be forced.void setPeriodicAuthentication(boolean periodicAuthentication)
periodicAuthentication
- true
if periodic authentication with the server should be performed.boolean matches(IDfLoginInfo that)
equals that allows for objects of different implementation type to be
compared for equality relative to IDfLoginInfo
. The looser comparison also ignores differences in one
or more transient fields (like forceAuthentication).
This comparison is typically used to determine if one login info is effectively the same as another when
performing session pooling operations.
void setBinaryCredential(java.lang.Object binaryCredential)
binaryCredential
- the object that represents the binary credential informationjava.lang.Object getBinaryCredential()
setBinaryCredential
call
The credential information
could either be in the form of String or any other object that may or may not be serializable.
For example if Kerberos is being used for authentication a call to this method should return
a GSSCredential
objectCopyright 1994-2023 OpenText Corporation. All rights reserved.