# Uses of Interface
org.apache.wiki.auth.user.UserProfile

Packages that use UserProfile
Package
Description
org.apache.wiki.auth
Authentication, Authorization and the third A thing.
org.apache.wiki.auth.user
org.apache.wiki.filters
Provides page and content filtering functionality for JSPWiki.

## Uses of UserProfile in org.apache.wiki.auth

Methods in org.apache.wiki.auth that return UserProfile
Modifier and Type
Method
Description
`UserProfile`
DefaultUserManager.JSONUserModule.`getUserInfo(String uid)`
Directly returns the UserProfile object attached to an uid.
`UserProfile`
DefaultUserManager.`getUserProfile(org.apache.wiki.api.core.Session session)`
Retrieves the `UserProfile` for the user in a session.
`UserProfile`
UserManager.`getUserProfile(org.apache.wiki.api.core.Session session)`
Retrieves the `UserProfile` for the user in a session.
`UserProfile`
DefaultUserManager.`parseProfile(org.apache.wiki.api.core.Context context)`
Extracts user profile parameters from the HTTP request and populates a UserProfile with them.
`UserProfile`
UserManager.`parseProfile(org.apache.wiki.api.core.Context context)`
Extracts user profile parameters from the HTTP request and populates a UserProfile with them.
Methods in org.apache.wiki.auth with parameters of type UserProfile
Modifier and Type
Method
Description
`void`
DefaultUserManager.`setUserProfile(org.apache.wiki.api.core.Context context, UserProfile profile)`
Saves the `UserProfile` for the user in a wiki session.This method verifies that a user profile to be saved doesn't collide with existing profiles; that is, the login name or full name is already used by another profile.
`void`
UserManager.`setUserProfile(org.apache.wiki.api.core.Context context, UserProfile profile)`
Saves the `UserProfile` for the user in a wiki session.This method verifies that a user profile to be saved doesn't collide with existing profiles; that is, the login name or full name is already used by another profile.
`void`
DefaultUserManager.`startUserProfileCreationWorkflow(org.apache.wiki.api.core.Context context, UserProfile profile)`
`void`
UserManager.`startUserProfileCreationWorkflow(org.apache.wiki.api.core.Context context, UserProfile profile)`
`void`
DefaultUserManager.`validateProfile(org.apache.wiki.api.core.Context context, UserProfile profile)`
Validates a user profile, and appends any errors to the session errors list.
`void`
UserManager.`validateProfile(org.apache.wiki.api.core.Context context, UserProfile profile)`
Validates a user profile, and appends any errors to the session errors list.

## Uses of UserProfile in org.apache.wiki.auth.user

Classes in org.apache.wiki.auth.user that implement UserProfile
Modifier and Type
Class
Description
`final class`
`DefaultUserProfile`
Default implementation for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.
Methods in org.apache.wiki.auth.user that return UserProfile
Modifier and Type
Method
Description
`UserProfile`
AbstractUserDatabase.`find(String index)`
Looks up and returns the first `UserProfile` in the user database that whose login name, full name, or wiki name matches the supplied string.
`UserProfile`
UserDatabase.`find(String index)`
Deprecated.
depending on the use case, this API's usage can be dangerous.
`UserProfile`
XMLUserDatabase.`findBy(String attr, String value)`
`abstract UserProfile`
AbstractUserDatabase.`findByEmail(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given e-mail address.
`UserProfile`
DummyUserDatabase.`findByEmail(String index)`
No-op; always throws `NoSuchPrincipalException`.
`UserProfile`
JDBCUserDatabase.`findByEmail(String index)`
`UserProfile`
UserDatabase.`findByEmail(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given e-mail address.
`UserProfile`
XMLUserDatabase.`findByEmail(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given e-mail address.
`abstract UserProfile`
AbstractUserDatabase.`findByFullName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given full name.
`UserProfile`
DummyUserDatabase.`findByFullName(String index)`
No-op; always throws `NoSuchPrincipalException`.
`UserProfile`
JDBCUserDatabase.`findByFullName(String index)`
`UserProfile`
UserDatabase.`findByFullName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given full name.
`UserProfile`
XMLUserDatabase.`findByFullName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given full name.
`abstract UserProfile`
AbstractUserDatabase.`findByLoginName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given login name.
`UserProfile`
DummyUserDatabase.`findByLoginName(String index)`
No-op; always throws `NoSuchPrincipalException`.
`UserProfile`
JDBCUserDatabase.`findByLoginName(String index)`
`UserProfile`
UserDatabase.`findByLoginName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given login name.
`UserProfile`
XMLUserDatabase.`findByLoginName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given login name.
`UserProfile`
DummyUserDatabase.`findByUid(String uid)`
No-op; always throws `NoSuchPrincipalException`.
`UserProfile`
JDBCUserDatabase.`findByUid(String uid)`
`UserProfile`
UserDatabase.`findByUid(String uid)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given unique ID (uid).
`UserProfile`
XMLUserDatabase.`findByUid(String uid)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given unique ID (uid).
`abstract UserProfile`
AbstractUserDatabase.`findByWikiName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given wiki name.
`UserProfile`
DummyUserDatabase.`findByWikiName(String index)`
No-op; always throws `NoSuchPrincipalException`.
`UserProfile`
JDBCUserDatabase.`findByWikiName(String index)`
`UserProfile`
UserDatabase.`findByWikiName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given wiki name.
`UserProfile`
XMLUserDatabase.`findByWikiName(String index)`
Looks up and returns the first `UserProfile` in the user database that matches a profile having a given wiki name.
`UserProfile`
AbstractUserDatabase.`newProfile()`
Factory method that instantiates a new DefaultUserProfile with a new, distinct unique identifier.
`UserProfile`
UserDatabase.`newProfile()`
Factory method that instantiates a new user profile.
Methods in org.apache.wiki.auth.user with parameters of type UserProfile
Modifier and Type
Method
Description
`abstract void`
AbstractUserDatabase.`save(UserProfile profile)`
Saves a `UserProfile`to the user database, overwriting the existing profile if it exists.
`void`
DummyUserDatabase.`save(UserProfile profile)`
No-op.
`void`
JDBCUserDatabase.`save(UserProfile profile)`
`void`
UserDatabase.`save(UserProfile profile)`
Saves a `UserProfile`to the user database, overwriting the existing profile if it exists.
`void`
XMLUserDatabase.`save(UserProfile profile)`
Saves a `UserProfile`to the user database, overwriting the existing profile if it exists.

## Uses of UserProfile in org.apache.wiki.filters

Methods in org.apache.wiki.filters with parameters of type UserProfile
Modifier and Type
Method
Description
`boolean`
SpamFilter.`isValidUserProfile(org.apache.wiki.api.core.Context context, UserProfile profile)`
Checks whether the UserProfile matches certain checks.