org.apache.marmotta.platform.user.api

Interface AccountService

All Known Implementing Classes:

AccountServiceImpl

public interface AccountService

Service to manage UserAccounts. UserAccounts are used to manage login and access to the LMF System.

Author:

Jakob Frank

See Also:

UserAccount

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(UserAccount account, String role) Add a single role to the roles of the given UserAccount
boolean	checkPassword(String login, String passwd) Check the credentials for the given login
boolean	checkPassword(UserAccount account, String passwd) Check the credentials for the given UserAccount
UserAccount	createAccount(String login) Create an user account
UserAccount	createAccount(String login, String firstName, String lastName) Create an user account and set first- and lastName in the user profile (foaf)
void	createDefaultAccounts() Create the default accounts, currently only admin
void	deleteAccount(UserAccount account) Deletes the given user account.
UserAccount	getAccount(org.apache.marmotta.platform.core.model.user.MarmottaUser user) Retrieve the user account for a given MarmottaUser (facaded user resource)
UserAccount	getAccount(String login) Retrieve the user account for the given login name
UserAccount	getAccount(org.openrdf.model.URI userResource) Retrieve the user account for the given (User)-Resource
Set<String>	getRoles(UserAccount account) Retrieve the roles for the given UserAccount
boolean	hasRole(UserAccount account, String role) Check whether the given UserAccount has the role in question.
List<UserAccount>	listAccounts() List all UserAccount.
List<UserAccount>	listAccounts(String role) Returns a List of UserAccount that have the given role associated.
void	removeRole(UserAccount account, String role) Remove a single role from the roles of the given UserAccount
UserAccount	setPassword(UserAccount account, String passwd) Update/Set the password for the given UserAccount
void	setRoles(UserAccount account, Set<String> roles) Set the roles for the given UserAccount

Method Detail

createAccount

UserAccount createAccount(String login)

Create an user account

Parameters:

login - the unique username/login

Returns:

the newly created UserAccount

createAccount

UserAccount createAccount(String login,
                        String firstName,
                        String lastName)

Create an user account and set first- and lastName in the user profile (foaf)

Parameters:

login - the unique username/login (also foaf:nick)

firstName - the value for foaf:firstName, may be null

lastName - the value for foaf:lastName, may be null

Returns:

the newly created UserAccount

createDefaultAccounts

void createDefaultAccounts()

Create the default accounts, currently only admin

getAccount

UserAccount getAccount(String login)

Retrieve the user account for the given login name

Parameters:

login - the login name

Returns:

the UserAccount for the given login name

getAccount

UserAccount getAccount(org.openrdf.model.URI userResource)

Retrieve the user account for the given (User)-Resource

Parameters:

userResource - the user resource (foaf:person)

Returns:

the corresponding UserAccount, or null if no account present.

getAccount

UserAccount getAccount(org.apache.marmotta.platform.core.model.user.MarmottaUser user)

Retrieve the user account for a given MarmottaUser (facaded user resource)

Parameters:

user - the MarmottaUser

Returns:

the corresponding UserAccount, of null if none present.

See Also:

getAccount(org.openrdf.model.URI)

deleteAccount

void deleteAccount(UserAccount account)

Deletes the given user account. The user will (obviously loose all access-rights to the system)

Parameters:

account - the UserAccount to delete.

setPassword

UserAccount setPassword(UserAccount account,
                      String passwd)

Update/Set the password for the given UserAccount

Parameters:

account - the UserAccount to modify

passwd - the new password

Returns:

the modified UserAccount

checkPassword

boolean checkPassword(UserAccount account,
                    String passwd)

Check the credentials for the given UserAccount

Parameters:

account - the UserAccount to authenticate

passwd - the password (plain)

Returns:

true if the password matched the password of the UserAccount

checkPassword

boolean checkPassword(String login,
                    String passwd)

Check the credentials for the given login

Parameters:

login - the login/account name/user name

passwd - the password (plain)

Returns:

true if the password matched the logins' UserAccount password

setRoles

void setRoles(UserAccount account,
            Set<String> roles)

Set the roles for the given UserAccount

Parameters:

account - the UserAccount to modify

roles - the roles (names) of the account

See Also:

UserAccount.setRoles(Set)

getRoles

Set<String> getRoles(UserAccount account)

Retrieve the roles for the given UserAccount

Parameters:

account - the UserAccount

Returns:

a Set containing the role-names of the given UserAccount

See Also:

UserAccount.getRoles()

addRole

void addRole(UserAccount account,
           String role)

Add a single role to the roles of the given UserAccount

Parameters:

account - the UserAccount to modify

role - the role(-name) to add

removeRole

void removeRole(UserAccount account,
              String role)

Remove a single role from the roles of the given UserAccount

Parameters:

account - the UserAccount to modify

role - the role(-name) to remove

hasRole

boolean hasRole(UserAccount account,
              String role)

Check whether the given UserAccount has the role in question.

Parameters:

account - the UserAccount to query

role - the role(-name) in question.

Returns:

true if the given UserAccount has the role in question

listAccounts

List<UserAccount> listAccounts(String role)

Returns a List of UserAccount that have the given role associated.

Parameters:

role - the role(-name)

Returns:

a List of UserAccount that have the given role associated.

listAccounts

List<UserAccount> listAccounts()

List all UserAccount.

Returns:

a List of all UserAccount