MutableAuthenticationService (Alfresco 5.0.3 Public API)

Method Summary
void	createAuthentication(String userName, char[] password) Create an authentication for the given user.
void	deleteAuthentication(String userName) Delete an authentication entry
boolean	isAuthenticationCreationAllowed() Determines whether authentication creation is allowed.
boolean	isAuthenticationMutable(String userName) Determines whether this user's authentication may be mutated via the other methods.
void	setAuthentication(String userName, char[] newPassword) Set the login information for a user (typically called by an admin user)
void	setAuthenticationEnabled(String userName, boolean enabled) Enable or disable an authentication entry
void	updateAuthentication(String userName, char[] oldPassword, char[] newPassword) Update the login information for the user (typically called by the user)

Method Detail

isAuthenticationMutable

@Auditable(parameters="userName",
recordable=true)
boolean isAuthenticationMutable(String userName)

Determines whether this user's authentication may be mutated via the other methods.

Parameters:

userName - the user ID

Returns:

true if this user's authentication may be mutated via the other methods.

isAuthenticationCreationAllowed

@Auditable
boolean isAuthenticationCreationAllowed()

Determines whether authentication creation is allowed.

Returns:

true if authentication creation is allowed

createAuthentication

@Auditable(parameters={
  "userName",
  "password"
},
           recordable={
  true,
  false
})
void createAuthentication(String userName,
                          char[] password)
                   throws AuthenticationException

Create an authentication for the given user.

Parameters:

userName - String

password - char[]

Throws:

AuthenticationException

updateAuthentication

@Auditable(parameters={
  "userName",
  "oldPassword",
  "newPassword"
},
           recordable={
  true,
  false,
  false
})
void updateAuthentication(String userName,
                          char[] oldPassword,
                          char[] newPassword)
                   throws AuthenticationException

Update the login information for the user (typically called by the user)

Parameters:

userName - String

oldPassword - char[]

newPassword - char[]

Throws:

AuthenticationException

setAuthentication

@Auditable(parameters={
  "userName",
  "newPassword"
},
           recordable={
  true,
  false
})
void setAuthentication(String userName,
                       char[] newPassword)
                throws AuthenticationException

Set the login information for a user (typically called by an admin user)

Parameters:

userName - String

newPassword - char[]

Throws:

AuthenticationException

deleteAuthentication

@Auditable(parameters="userName")
void deleteAuthentication(String userName)
throws AuthenticationException

Delete an authentication entry

Parameters:

userName - String

Throws:

AuthenticationException

setAuthenticationEnabled

@Auditable(parameters={
  "userName",
  "enabled"
})
void setAuthenticationEnabled(String userName,
                              boolean enabled)
                       throws AuthenticationException

Enable or disable an authentication entry

Parameters:

userName - String

enabled - boolean

Throws:

AuthenticationException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.