|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.silverpeas.authentication.AuthenticationCredential
public class AuthenticationCredential
A credential is a set of security-related capabilities for a given user, it contains information used to authenticate him. This credential defines, among the attributes, the password, the login and the domain to which the user belongs. The domain is a repository of users having its own security policy and then its own authentication server. The login is the minimum information used in an authentication; indeed, for some security policies, the login can be a unique security token identifying uniquely a user in Silverpeas, whatever its domain, and that is known only by the user himself. For other security policies, only the login and the domain are required to authenticate the user, like in NTLM negotiation. By default, to open a WEB session with Silverpeas, the user has to authenticate himself by using both his login, his password and the domain to which he belongs. The credential may also contain data that simply enable certain security-related capabilities like, for example, the password change. These capabilities are generally set by the authentication process from the response of the authentication server related to the user domain, once the user is successfully authenticated.
Method Summary | |
---|---|
Map<String,Object> |
getCapabilities()
Gets the security-related capabilities associated with this credential. |
String |
getDomainId()
Gets the unique identifier of the domain to which the user belongs. |
String |
getLogin()
Gets the user login to use in the authentication. |
String |
getPassword()
Gets the password that is mapped with the user login. |
boolean |
isPasswordSet()
Is the password set in this credential? |
static AuthenticationCredential |
newWithAsLogin(String login)
Creates a new authentication credential with the specified login. |
void |
setDomainId(String domainId)
Sets the specified domain to this credential. |
void |
setPassword(String password)
Sets the specified password to this credential. |
AuthenticationCredential |
withAsDomainId(String domainId)
Returns this credential with its domain attribute set with the specified value. |
AuthenticationCredential |
withAsPassword(String password)
Returns this credential with its password attribute set with the specified value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static AuthenticationCredential newWithAsLogin(String login)
login
- the login of the user to authenticate
public AuthenticationCredential withAsPassword(String password)
password
- a password.
public AuthenticationCredential withAsDomainId(String domainId)
domainId
- the unique identifier of the domain to which the user belongs.
public String getLogin()
public String getPassword()
public String getDomainId()
public Map<String,Object> getCapabilities()
public void setPassword(String password)
password
- a password.public void setDomainId(String domainId)
domainId
- the unique identifier of the domain.public boolean isPasswordSet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |