| Package | Description |
|---|---|
| org.craftercms.profile.api.exceptions | |
| org.craftercms.profile.api.services |
| Modifier and Type | Class and Description |
|---|---|
class |
I10nProfileException
Localized version of
ProfileException. |
| Modifier and Type | Method and Description |
|---|---|
Tenant |
TenantService.addAttributeDefinitions(String tenantName,
Collection<AttributeDefinition> attributeDefinitions)
Adds the given attribute definitions to the specified tenant.
|
ProfileAttachment |
ProfileService.addProfileAttachment(String profileId,
String attachmentName,
InputStream file)
Saves a Profile Attachment
|
Tenant |
TenantService.addRoles(String tenantName,
Collection<String> roles)
Adds the given roles to the specified tenant.
|
Profile |
ProfileService.addRoles(String profileId,
Collection<String> roles,
String... attributesToReturn)
Assigns roles to the profile.
|
Ticket |
AuthenticationService.authenticate(String tenantName,
String username,
String password)
Authenticates the user, and returns a ticket identifying the authentication.
|
Profile |
ProfileService.changePassword(String resetTokenId,
String newPassword,
String... attributesToReturn)
Changes a profile's password, after a reset request has been sent.
|
PersistentLogin |
AuthenticationService.createPersistentLogin(String profileId)
Creates a persistent login, use for remember me functionality.
|
Profile |
ProfileService.createProfile(String tenantName,
String username,
String password,
String email,
boolean enabled,
Set<String> roles,
Map<String,Object> attributes,
String verificationUrl)
Creates a new profile for a specific tenant name.
|
Tenant |
TenantService.createTenant(Tenant tenant)
Creates the given tenant, failing if it already has been created.
|
Ticket |
AuthenticationService.createTicket(String profileId)
Create a new ticket for the specified profile.
|
AccessToken |
AccessTokenService.createToken(AccessToken token)
Creates a new access token.
|
VerificationToken |
ProfileService.createVerificationToken(String profileId)
Creates a token that can be sent to the user in an email as a link.
|
void |
AuthenticationService.deletePersistentLogin(String loginId)
Deletes the persistent login.
|
void |
ProfileService.deleteProfile(String profileId)
Deletes a profile.
|
void |
TenantService.deleteTenant(String name)
Deletes a tenant.
|
void |
AccessTokenService.deleteToken(String id)
Deletes the token with the given ID.
|
void |
ProfileService.deleteVerificationToken(String tokenId)
Deletes a verification token when it's not needed anymore (not necessary to call if
ProfileService.verifyProfile(String, String...) or ProfileService.changePassword(String, String, String...), since they
already delete the token. |
Profile |
ProfileService.disableProfile(String profileId,
String... attributesToReturn)
Disables a profile.
|
Profile |
ProfileService.enableProfile(String profileId,
String... attributesToReturn)
Enables a profile.
|
List<Tenant> |
TenantService.getAllTenants()
Returns a list with all the tenants.
|
List<AccessToken> |
AccessTokenService.getAllTokens()
Returns all the access tokens in the DB.
|
Map<String,Object> |
ProfileService.getAttributes(String profileId,
String... attributesToReturn)
Returns the attributes of a profile.
|
PersistentLogin |
AuthenticationService.getPersistentLogin(String loginId)
Returns the persistent login object for the given ID.
|
Profile |
ProfileService.getProfile(String profileId,
String... attributesToReturn)
Returns the profile for the specified ID.
|
InputStream |
ProfileService.getProfileAttachment(String attachmentId,
String profileId)
Given the Attachment Id and the Profile Id, gets the Actual Attachment.
|
ProfileAttachment |
ProfileService.getProfileAttachmentInformation(String profileId,
String attachmentId)
Gets Profile attachment Information.
|
List<ProfileAttachment> |
ProfileService.getProfileAttachments(String profileId)
List all Attachments for the given profile.
|
Profile |
ProfileService.getProfileByQuery(String tenantName,
String query,
String... attributesToReturn)
Returns the single profile that matches the specified query
|
Profile |
ProfileService.getProfileByTicket(String ticketId,
String... attributesToReturn)
Returns the profile for the specified ticket.
|
Profile |
ProfileService.getProfileByUsername(String tenantName,
String username,
String... attributesToReturn)
Returns the user for the specified tenant and username
|
long |
ProfileService.getProfileCount(String tenantName)
Returns the number of profiles of the specified tenant.
|
long |
ProfileService.getProfileCountByQuery(String tenantName,
String query)
Returns the number of profiles that match the query for the specified tenant.
|
List<Profile> |
ProfileService.getProfileRange(String tenantName,
String sortBy,
SortOrder sortOrder,
Integer start,
Integer count,
String... attributesToReturn)
Returns a range of profiles for the specified tenant.
|
List<Profile> |
ProfileService.getProfilesByAttributeValue(String tenantName,
String attributeName,
String attributeValue,
String sortBy,
SortOrder sortOrder,
String... attributesToReturn)
Returns the list of profiles that have the given attribute with the given value.
|
List<Profile> |
ProfileService.getProfilesByExistingAttribute(String tenantName,
String attributeName,
String sortBy,
SortOrder sortOrder,
String... attributesToReturn)
Returns the list of profiles that have the given attribute, with any value
|
List<Profile> |
ProfileService.getProfilesByIds(List<String> profileIds,
String sortBy,
SortOrder sortOrder,
String... attributesToReturn)
Returns a list of profiles for the specified list of IDs.
|
List<Profile> |
ProfileService.getProfilesByQuery(String tenantName,
String query,
String sortBy,
SortOrder sortOrder,
Integer start,
Integer count,
String... attributesToReturn)
Returns the profiles that match the specified query.
|
List<Profile> |
ProfileService.getProfilesByRole(String tenantName,
String role,
String sortBy,
SortOrder sortOrder,
String... attributesToReturn)
Returns a list of profiles for a specific role and tenant.
|
Tenant |
TenantService.getTenant(String name)
Returns a tenant.
|
long |
TenantService.getTenantCount()
Returns the total number of tenants.
|
Ticket |
AuthenticationService.getTicket(String ticketId)
Returns the ticket object for the given ticket ID.
|
AccessToken |
AccessTokenService.getToken(String id)
Returns the token for the given ID.
|
VerificationToken |
ProfileService.getVerificationToken(String tokenId)
Returns the verification token that corresponds to the given ID.
|
void |
AuthenticationService.invalidateTicket(String ticketId)
Invalidates the ticket.
|
PersistentLogin |
AuthenticationService.refreshPersistentLoginToken(String loginId)
Refreshes the token of the specified persistent login.
|
Tenant |
TenantService.removeAttributeDefinitions(String tenantName,
Collection<String> attributeNames)
Removes the given attribute definitions from the specified tenant.
|
Profile |
ProfileService.removeAttributes(String profileId,
Collection<String> attributeNames,
String... attributesToReturn)
Removes a list of attributes of a profile.
|
Tenant |
TenantService.removeRoles(String tenantName,
Collection<String> roles)
Removes the given roles from the specified tenant.
|
Profile |
ProfileService.removeRoles(String profileId,
Collection<String> roles,
String... attributesToReturn)
Removes assigned roles from a profile.
|
Profile |
ProfileService.resetPassword(String profileId,
String resetPasswordUrl,
String... attributesToReturn)
Sends an email to the profile's user to indicate that the password needs to be reset.
|
Profile |
ProfileService.setFailedAttempts(String profileId,
int failedAttempts,
String... attributesToReturn) |
Profile |
ProfileService.setLastFailedLogging(String profileId,
Date lastFailedLogging,
String... attributesToReturn) |
Tenant |
TenantService.updateAttributeDefinitions(String tenantName,
Collection<AttributeDefinition> attributeDefinitions)
Updates the given attribute definitions of the specified tenant.
|
Profile |
ProfileService.updateAttributes(String profileId,
Map<String,Object> attributes,
String... attributesToReturn)
Updates the attributes of a profile, by merging the specified attributes with the existing attributes.
|
Profile |
ProfileService.updateProfile(String profileId,
String username,
String password,
String email,
Boolean enabled,
Set<String> roles,
Map<String,Object> attributes,
String... attributesToReturn)
Updates the profile's info.
|
Tenant |
TenantService.updateTenant(Tenant tenant)
Updates the given tenant.
|
Tenant |
TenantService.verifyNewProfiles(String tenantName,
boolean verify)
Sets if new profiles for the specified tenant should be verified or not.
|
Profile |
ProfileService.verifyProfile(String verificationTokenId,
String... attributesToReturn)
Sets the profile as verified if the verification token is valid.
|
Copyright © 2015 CrafterCMS. All Rights Reserved.