public class AuthenticationInfo extends Object
AuthenticationInfo
defines the data returned from the
AuthenticationHandler.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method.Modifier and Type | Field and Description |
---|---|
static AuthenticationInfo |
DOING_AUTH
Deprecated.
This object is returned by the
AuthenticationHandler.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method to indicate an ongoing authentication transaction. |
Constructor and Description |
---|
AuthenticationInfo(String authType,
javax.jcr.Credentials credentials)
Deprecated.
Creates an instance of this class with the given authentication type and
credentials connecting to the default workspace as if the
AuthenticationInfo(String, Credentials, String) method would be
called with a null workspace name. |
AuthenticationInfo(String authType,
javax.jcr.Credentials credentials,
String workspaceName)
Deprecated.
Creates an instance of this class with the given authentication type and
credentials.
|
Modifier and Type | Method and Description |
---|---|
String |
getAuthType()
Deprecated.
Returns type of authentication provisioning.
|
javax.jcr.Credentials |
getCredentials()
Deprecated.
Returns the credentials extracted from the client request to use for
authentication.
|
String |
getWorkspaceName()
Deprecated.
Returns the name of the workspace the user contained in this instance
wishes to connect to.
|
public static final AuthenticationInfo DOING_AUTH
AuthenticationHandler.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method to indicate an ongoing authentication transaction.public AuthenticationInfo(String authType, javax.jcr.Credentials credentials)
AuthenticationInfo(String, Credentials, String)
method would be
called with a null
workspace name.authType
- The authentication type, must not be null
.credentials
- The credentials, must not be null
.getAuthType()
,
getCredentials()
public AuthenticationInfo(String authType, javax.jcr.Credentials credentials, String workspaceName)
authType
- The authentication type, must not be null
.credentials
- The credentials, must not be null
.workspaceName
- The name of the workspace to connect to, may be
null
to connect to the default workspace.getAuthType()
,
getCredentials()
public String getAuthType()
If authentication is taking place through one of the standard ways, such
as Basic or Digest, the return value is one of the predefined constants
of the HttpServletRequest
interface. Otherwise the value
may be specific to the AuthenticationHandler
implementation.
public javax.jcr.Credentials getCredentials()
public String getWorkspaceName()
null
, in which case the
user is connected to the default workspace.Copyright © 2017 The Apache Software Foundation. All rights reserved.