org.opencastproject.security.api

Interface User

All Known Implementing Classes:

JaxbUser

public interface User

Represent a user in Opencast

Method Summary

Modifier and Type	Method and Description
String	getEmail() Gets the user's email address.
String	getName() Gets the user's name.
Organization	getOrganization() Returns the user's organization identifier.
String	getPassword() Gets this user's password, if available.
String	getProvider() Gets the provider where the user is coming from.
Set<Role>	getRoles() Gets the user's roles.
String	getUsername() Gets this user's unique account name.
boolean	hasRole(String role) Returns whether the user is in a specific role.
boolean	isManageable() Returns true if this user object can be managed by Opencast.

Method Detail

getUsername

String getUsername()

Gets this user's unique account name.

Returns:

the account name

getPassword

String getPassword()

Gets this user's password, if available.

Returns:

the password

getName

String getName()

Gets the user's name.

Returns:

the user name

getEmail

String getEmail()

Gets the user's email address.

Returns:

the user's email address

getProvider

String getProvider()

Gets the provider where the user is coming from.

Returns:

the provider where the user is coming from.

isManageable

boolean isManageable()

Returns true if this user object can be managed by Opencast.

Returns:

true if this user is manageable

getOrganization

Organization getOrganization()

Returns the user's organization identifier.

Returns:

the organization

getRoles

Set<Role> getRoles()

Gets the user's roles. For anonymous users, this will return Anonymous.

Returns:

the user's roles

hasRole

boolean hasRole(String role)

Returns whether the user is in a specific role.

Parameters:

role - the role to check

Returns:

whether the role is one of this user's roles