A B C D E G H I K M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ACCESS_DENIED - org.craftercms.profile.api.exceptions.ErrorCode
- ACCESS_TOKEN_EXISTS - org.craftercms.profile.api.exceptions.ErrorCode
- AccessToken - Class in org.craftercms.profile.api
-
Access token given to applications that need to access the REST API, acting for any tenant of a list.
- AccessToken() - Constructor for class org.craftercms.profile.api.AccessToken
- AccessTokenService - Interface in org.craftercms.profile.api.services
-
Service for managing access tokens.
- ACTION_DENIED - org.craftercms.profile.api.exceptions.ErrorCode
- addAttributeDefinitions(String, Collection<AttributeDefinition>) - Method in interface org.craftercms.profile.api.services.TenantService
-
Adds the given attribute definitions to the specified tenant.
- addProfileAttachment(String, String, InputStream) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Saves a Profile Attachment
- addRoles(String, Collection<String>) - Method in interface org.craftercms.profile.api.services.TenantService
-
Adds the given roles to the specified tenant.
- addRoles(String, Collection<String>, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Assigns roles to the profile.
- ANY_APPLICATION - Static variable in class org.craftercms.profile.api.AttributePermission
- ANY_TENANT - Static variable in class org.craftercms.profile.api.TenantPermission
- application - Variable in class org.craftercms.profile.api.AttributePermission
- args - Variable in exception org.craftercms.profile.api.exceptions.I10nProfileException
- ASC - org.craftercms.profile.api.SortOrder
-
Ascending order.
- ATTRIBUTE_ALREADY_DEFINED - org.craftercms.profile.api.exceptions.ErrorCode
- ATTRIBUTE_NOT_DEFINED - org.craftercms.profile.api.exceptions.ErrorCode
- ATTRIBUTE_TYPE_KEY - Static variable in class org.craftercms.profile.api.ProfileConstants
- ATTRIBUTE_TYPE_LARGE_TEXT - Static variable in class org.craftercms.profile.api.ProfileConstants
- ATTRIBUTE_TYPE_STRING_LIST - Static variable in class org.craftercms.profile.api.ProfileConstants
- ATTRIBUTE_TYPE_TEXT - Static variable in class org.craftercms.profile.api.ProfileConstants
- AttributeAction - Enum in org.craftercms.profile.api
-
Enum with the actions that can be executed on attributes by applications.
- AttributeDefinition - Class in org.craftercms.profile.api
-
Represents the definition of an attribute in a tenant.
- AttributeDefinition() - Constructor for class org.craftercms.profile.api.AttributeDefinition
- AttributeDefinition(String) - Constructor for class org.craftercms.profile.api.AttributeDefinition
- AttributePermission - Class in org.craftercms.profile.api
-
Permission
specific for attributes. - AttributePermission() - Constructor for class org.craftercms.profile.api.AttributePermission
- AttributePermission(String) - Constructor for class org.craftercms.profile.api.AttributePermission
- authenticate(String, String, String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Authenticates the user, and returns a ticket identifying the authentication.
- AuthenticationService - Interface in org.craftercms.profile.api.services
-
Service for handling authentication for users.
B
- BAD_CREDENTIALS - org.craftercms.profile.api.exceptions.ErrorCode
- BASE_URL_ACCESS_TOKEN - Static variable in class org.craftercms.profile.api.ProfileConstants
- BASE_URL_AUTHENTICATION - Static variable in class org.craftercms.profile.api.ProfileConstants
- BASE_URL_PROFILE - Static variable in class org.craftercms.profile.api.ProfileConstants
- BASE_URL_REST_API - Static variable in class org.craftercms.profile.api.ProfileConstants
- BASE_URL_TENANT - Static variable in class org.craftercms.profile.api.ProfileConstants
C
- changePassword(String, String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Changes a profile's password, after a reset request has been sent.
- cleanseAttributes - Variable in class org.craftercms.profile.api.Tenant
- CREATE_TENANT - org.craftercms.profile.api.TenantAction
- createPersistentLogin(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Creates a persistent login, use for remember me functionality.
- createProfile(String, String, String, String, boolean, Set<String>, Map<String, Object>, String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Creates a new profile for a specific tenant name.
- createTenant(Tenant) - Method in interface org.craftercms.profile.api.services.TenantService
-
Creates the given tenant, failing if it already has been created.
- createTicket(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Create a new ticket for the specified profile.
- createToken(AccessToken) - Method in interface org.craftercms.profile.api.services.AccessTokenService
-
Creates a new access token.
- createVerificationToken(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Creates a token that can be sent to the user in an email as a link.
D
- DELETE_TENANT - org.craftercms.profile.api.TenantAction
- deletePersistentLogin(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Deletes the persistent login.
- deleteProfile(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Deletes a profile.
- deleteTenant(String) - Method in interface org.craftercms.profile.api.services.TenantService
-
Deletes a tenant.
- deleteToken(String) - Method in interface org.craftercms.profile.api.services.AccessTokenService
-
Deletes the token with the given ID.
- deleteVerificationToken(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Deletes a verification token when it's not needed anymore (not necessary to call if
ProfileService.verifyProfile(String, String...)
orProfileService.changePassword(String, String, String...)
, since they already delete the token. - DESC - org.craftercms.profile.api.SortOrder
-
Descending order
- DISABLED_PROFILE - org.craftercms.profile.api.exceptions.ErrorCode
- disableProfile(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Disables a profile.
E
- enableProfile(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Enables a profile.
- equals(Object) - Method in class org.craftercms.profile.api.AccessToken
- equals(Object) - Method in class org.craftercms.profile.api.AttributeDefinition
- equals(Object) - Method in class org.craftercms.profile.api.AttributePermission
- equals(Object) - Method in class org.craftercms.profile.api.PersistentLogin
- equals(Object) - Method in class org.craftercms.profile.api.Profile
- equals(Object) - Method in class org.craftercms.profile.api.Tenant
- equals(Object) - Method in class org.craftercms.profile.api.TenantPermission
- equals(Object) - Method in class org.craftercms.profile.api.Ticket
- equals(Object) - Method in class org.craftercms.profile.api.VerificationToken
- ERROR_BUNDLE_NAME - Static variable in exception org.craftercms.profile.api.exceptions.I10nProfileException
- ErrorCode - Enum in org.craftercms.profile.api.exceptions
-
Contains profile's error codes.
- ErrorDetails - Class in org.craftercms.profile.api.exceptions
-
Information transmitted to the client when an error occurs.
- ErrorDetails() - Constructor for class org.craftercms.profile.api.exceptions.ErrorDetails
- ErrorDetails(ErrorCode, String) - Constructor for class org.craftercms.profile.api.exceptions.ErrorDetails
G
- getAllTenants() - Method in interface org.craftercms.profile.api.services.TenantService
-
Returns a list with all the tenants.
- getAllTokens() - Method in interface org.craftercms.profile.api.services.AccessTokenService
-
Returns all the access tokens in the DB.
- getApplication() - Method in class org.craftercms.profile.api.AccessToken
-
Returns the name of the application accessing Crafter Profile.
- getApplication() - Method in class org.craftercms.profile.api.AttributePermission
- getAttribute(String) - Method in class org.craftercms.profile.api.Profile
- getAttributeDefinitions() - Method in class org.craftercms.profile.api.Tenant
-
Returns the definitions of attributes that users of this tenant can have.
- getAttributes() - Method in class org.craftercms.profile.api.Profile
- getAttributes(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the attributes of a profile.
- getAvailableRoles() - Method in class org.craftercms.profile.api.Tenant
-
Returns the available roles that can be assigned to users of this tenant.
- getContentType() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getCreatedOn() - Method in class org.craftercms.profile.api.Profile
- getDefaultValue() - Method in class org.craftercms.profile.api.AttributeDefinition
-
Returns the default value for all attributes.
- getEmail() - Method in class org.craftercms.profile.api.Profile
- getErrorCode() - Method in class org.craftercms.profile.api.exceptions.ErrorDetails
- getExpiresOn() - Method in class org.craftercms.profile.api.AccessToken
-
Returns the date of expiration of this token (when it becomes invalid)
- getFailedLoginAttempts() - Method in class org.craftercms.profile.api.Profile
- getFileName() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getFileSize() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getFileSizeBytes() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getId() - Method in class org.craftercms.profile.api.AccessToken
-
Returns the ID of the access token.
- getId() - Method in class org.craftercms.profile.api.PersistentLogin
- getId() - Method in class org.craftercms.profile.api.Profile
- getId() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getId() - Method in class org.craftercms.profile.api.Tenant
-
Returns the tenant's DB ID.
- getId() - Method in class org.craftercms.profile.api.Ticket
- getId() - Method in class org.craftercms.profile.api.VerificationToken
- getLastFailedLogin() - Method in class org.craftercms.profile.api.Profile
- getLastModified() - Method in class org.craftercms.profile.api.Profile
- getLastRequestTime() - Method in class org.craftercms.profile.api.Ticket
- getMd5() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- getMessage() - Method in class org.craftercms.profile.api.exceptions.ErrorDetails
- getMessage() - Method in exception org.craftercms.profile.api.exceptions.I10nProfileException
- getMetadata() - Method in class org.craftercms.profile.api.AttributeDefinition
-
Returns the additional metadata associated to an attribute (like label, type, etc.).
- getName() - Method in class org.craftercms.profile.api.AttributeDefinition
-
Returns the name of the attribute.
- getName() - Method in class org.craftercms.profile.api.Tenant
-
Returns the name of the tenant.
- getPassword() - Method in class org.craftercms.profile.api.Profile
- getPersistentLogin(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Returns the persistent login object for the given ID.
- getProfile(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the profile for the specified ID.
- getProfileAttachment(String, String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Given the Attachment Id and the Profile Id, gets the Actual Attachment.
- getProfileAttachmentInformation(String, String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Gets Profile attachment Information.
- getProfileAttachments(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
List all Attachments for the given profile.
- getProfileByQuery(String, String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the single profile that matches the specified query
- getProfileByTicket(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the profile for the specified ticket.
- getProfileByUsername(String, String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the user for the specified tenant and username
- getProfileCount(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the number of profiles of the specified tenant.
- getProfileCountByQuery(String, String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the number of profiles that match the query for the specified tenant.
- getProfileId() - Method in class org.craftercms.profile.api.PersistentLogin
- getProfileId() - Method in class org.craftercms.profile.api.Ticket
- getProfileId() - Method in class org.craftercms.profile.api.VerificationToken
- getProfileRange(String, String, SortOrder, Integer, Integer, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns a range of profiles for the specified tenant.
- getProfilesByAttributeValue(String, String, String, String, SortOrder, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the list of profiles that have the given attribute with the given value.
- getProfilesByExistingAttribute(String, String, String, SortOrder, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the list of profiles that have the given attribute, with any value
- getProfilesByIds(List<String>, String, SortOrder, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns a list of profiles for the specified list of IDs.
- getProfilesByQuery(String, String, String, SortOrder, Integer, Integer, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the profiles that match the specified query.
- getProfilesByRole(String, String, String, SortOrder, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns a list of profiles for a specific role and tenant.
- getResourceBundle() - Method in exception org.craftercms.profile.api.exceptions.I10nProfileException
- getRoles() - Method in class org.craftercms.profile.api.Profile
- getTenant() - Method in class org.craftercms.profile.api.PersistentLogin
- getTenant() - Method in class org.craftercms.profile.api.Profile
- getTenant() - Method in class org.craftercms.profile.api.TenantPermission
- getTenant() - Method in class org.craftercms.profile.api.Ticket
- getTenant() - Method in class org.craftercms.profile.api.VerificationToken
- getTenant(String) - Method in interface org.craftercms.profile.api.services.TenantService
-
Returns a tenant.
- getTenantCount() - Method in interface org.craftercms.profile.api.services.TenantService
-
Returns the total number of tenants.
- getTenantPermissions() - Method in class org.craftercms.profile.api.AccessToken
-
Returns the tenant permissions the application has.
- getTicket(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Returns the ticket object for the given ticket ID.
- getTimestamp() - Method in class org.craftercms.profile.api.PersistentLogin
- getTimestamp() - Method in class org.craftercms.profile.api.VerificationToken
- getToken() - Method in class org.craftercms.profile.api.PersistentLogin
- getToken(String) - Method in interface org.craftercms.profile.api.services.AccessTokenService
-
Returns the token for the given ID.
- getUsername() - Method in class org.craftercms.profile.api.Profile
- getVerificationToken(String) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Returns the verification token that corresponds to the given ID.
H
- hasAnyRole(String...) - Method in class org.craftercms.profile.api.Profile
- hasAnyRole(Collection<String>) - Method in class org.craftercms.profile.api.Profile
- hashCode() - Method in class org.craftercms.profile.api.AccessToken
- hashCode() - Method in class org.craftercms.profile.api.AttributeDefinition
- hashCode() - Method in class org.craftercms.profile.api.AttributePermission
- hashCode() - Method in class org.craftercms.profile.api.PersistentLogin
- hashCode() - Method in class org.craftercms.profile.api.Profile
- hashCode() - Method in class org.craftercms.profile.api.Tenant
- hashCode() - Method in class org.craftercms.profile.api.TenantPermission
- hashCode() - Method in class org.craftercms.profile.api.Ticket
- hashCode() - Method in class org.craftercms.profile.api.VerificationToken
- hasRole(String) - Method in class org.craftercms.profile.api.Profile
I
- I10nProfileException - Exception in org.craftercms.profile.api.exceptions
-
Localized version of
ProfileException
. - I10nProfileException() - Constructor for exception org.craftercms.profile.api.exceptions.I10nProfileException
- I10nProfileException(String, Object...) - Constructor for exception org.craftercms.profile.api.exceptions.I10nProfileException
- I10nProfileException(String, Throwable, Object...) - Constructor for exception org.craftercms.profile.api.exceptions.I10nProfileException
- I10nProfileException(Throwable) - Constructor for exception org.craftercms.profile.api.exceptions.I10nProfileException
- increaseFailedLoginAttempts() - Method in class org.craftercms.profile.api.Profile
- INVALID_EMAIL_ADDRESS - org.craftercms.profile.api.exceptions.ErrorCode
- INVALID_QUERY - org.craftercms.profile.api.exceptions.ErrorCode
- invalidateTicket(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Invalidates the ticket.
- isCleanseAttributes() - Method in class org.craftercms.profile.api.Tenant
- isEnabled() - Method in class org.craftercms.profile.api.Profile
- isMaster() - Method in class org.craftercms.profile.api.AccessToken
-
Returns true if this is a master token.
- isSsoEnabled() - Method in class org.craftercms.profile.api.Tenant
-
Returns true is single-sign on (SSO) is enabled for this tenant .
- isVerified() - Method in class org.craftercms.profile.api.Profile
- isVerifyNewProfiles() - Method in class org.craftercms.profile.api.Tenant
-
Returns true if new profiles should be verified through email by the user, for the accounts or users of this tenant.
K
- key - Variable in exception org.craftercms.profile.api.exceptions.I10nProfileException
M
- MANAGE_PROFILES - org.craftercms.profile.api.TenantAction
- MANAGE_TICKETS - org.craftercms.profile.api.TenantAction
N
- NO_ATTRIBUTE - Static variable in class org.craftercms.profile.api.ProfileConstants
-
Constant used to indicate in Profile service methods that receive an array of
attributeToReturn
, that no attribute should be returned. - NO_SUCH_ACCESS_TOKEN_ID - org.craftercms.profile.api.exceptions.ErrorCode
- NO_SUCH_PERSISTENT_LOGIN - org.craftercms.profile.api.exceptions.ErrorCode
- NO_SUCH_PROFILE - org.craftercms.profile.api.exceptions.ErrorCode
- NO_SUCH_TENANT - org.craftercms.profile.api.exceptions.ErrorCode
- NO_SUCH_TICKET - org.craftercms.profile.api.exceptions.ErrorCode
- NO_SUCH_VERIFICATION_TOKEN - org.craftercms.profile.api.exceptions.ErrorCode
O
- org.craftercms.profile.api - package org.craftercms.profile.api
- org.craftercms.profile.api.exceptions - package org.craftercms.profile.api.exceptions
- org.craftercms.profile.api.services - package org.craftercms.profile.api.services
- OTHER - org.craftercms.profile.api.exceptions.ErrorCode
P
- PARAM_ACCESS_TOKEN_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ATTRIBUTE_NAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ATTRIBUTE_TO_RETURN - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ATTRIBUTE_VALUE - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ATTRIBUTES - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_COUNT - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_DESERIALIZATION_ERROR - org.craftercms.profile.api.exceptions.ErrorCode
- PARAM_EMAIL - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ENABLED - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_FILENAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_NEW_PASSWORD - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_PASSWORD - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_PROFILE_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_QUERY - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_RESET_PASSWORD_URL - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_RESET_TOKEN_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_ROLE - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_SORT_BY - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_SORT_ORDER - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_START - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_TENANT_NAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_TICKET_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_TOKEN_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_USERNAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_VERIFICATION_TOKEN_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_VERIFICATION_URL - Static variable in class org.craftercms.profile.api.ProfileConstants
- PARAM_VERIFY - Static variable in class org.craftercms.profile.api.ProfileConstants
- PATH_VAR_ATTACHMENT - Static variable in class org.craftercms.profile.api.ProfileConstants
- PATH_VAR_ID - Static variable in class org.craftercms.profile.api.ProfileConstants
- PATH_VAR_NAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- PERMISSION_ERROR - org.craftercms.profile.api.exceptions.ErrorCode
- PersistentLogin - Class in org.craftercms.profile.api
-
Represents a persistent authentication or login, triggered by remember me functionality.
- PersistentLogin() - Constructor for class org.craftercms.profile.api.PersistentLogin
- Profile - Class in org.craftercms.profile.api
-
Representation of a user.
- Profile() - Constructor for class org.craftercms.profile.api.Profile
- PROFILE_EXISTS - org.craftercms.profile.api.exceptions.ErrorCode
- ProfileAttachment - Class in org.craftercms.profile.api.services
- ProfileAttachment() - Constructor for class org.craftercms.profile.api.services.ProfileAttachment
- ProfileConstants - Class in org.craftercms.profile.api
-
Common constants.
- ProfileException - Exception in org.craftercms.profile.api.exceptions
-
Root exception for profile.
- ProfileException() - Constructor for exception org.craftercms.profile.api.exceptions.ProfileException
- ProfileException(String) - Constructor for exception org.craftercms.profile.api.exceptions.ProfileException
- ProfileException(String, Throwable) - Constructor for exception org.craftercms.profile.api.exceptions.ProfileException
- ProfileException(Throwable) - Constructor for exception org.craftercms.profile.api.exceptions.ProfileException
- ProfileService - Interface in org.craftercms.profile.api.services
-
Service for handling profiles.
R
- READ_ATTRIBUTE - org.craftercms.profile.api.AttributeAction
- READ_TENANT - org.craftercms.profile.api.TenantAction
- refreshPersistentLoginToken(String) - Method in interface org.craftercms.profile.api.services.AuthenticationService
-
Refreshes the token of the specified persistent login.
- REMOVE_ATTRIBUTE - org.craftercms.profile.api.AttributeAction
- removeAttributeDefinitions(String, Collection<String>) - Method in interface org.craftercms.profile.api.services.TenantService
-
Removes the given attribute definitions from the specified tenant.
- removeAttributes(String, Collection<String>, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Removes a list of attributes of a profile.
- removeRoles(String, Collection<String>) - Method in interface org.craftercms.profile.api.services.TenantService
-
Removes the given roles from the specified tenant.
- removeRoles(String, Collection<String>, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Removes assigned roles from a profile.
- resetPassword(String, String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Sends an email to the profile's user to indicate that the password needs to be reset.
S
- setApplication(String) - Method in class org.craftercms.profile.api.AccessToken
-
Sets the name of the application accessing Crafter Profile.
- setAttribute(String, Object) - Method in class org.craftercms.profile.api.Profile
- setAttributeDefinitions(List<AttributeDefinition>) - Method in class org.craftercms.profile.api.Tenant
-
Sets the definitions of attributes that users of this tenant can have.
- setAttributes(Map<String, Object>) - Method in class org.craftercms.profile.api.Profile
- setAvailableRoles(Set<String>) - Method in class org.craftercms.profile.api.Tenant
-
Sets the available roles that can be assigned to users of this tenant.
- setCleanseAttributes(boolean) - Method in class org.craftercms.profile.api.Tenant
- setContentType(String) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setCreatedOn(Date) - Method in class org.craftercms.profile.api.Profile
- setDefaultValue(Object) - Method in class org.craftercms.profile.api.AttributeDefinition
-
Sets the default value of all attributes.
- setEmail(String) - Method in class org.craftercms.profile.api.Profile
- setEnabled(boolean) - Method in class org.craftercms.profile.api.Profile
- setErrorCode(ErrorCode) - Method in class org.craftercms.profile.api.exceptions.ErrorDetails
- setExpiresOn(Date) - Method in class org.craftercms.profile.api.AccessToken
-
Sets the date of expiration of this token (when it becomes invalid)
- setFailedLoginAttempts(int) - Method in class org.craftercms.profile.api.Profile
- setFailedLoginAttempts(String, int, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Sets the number of failed login attempts for the profile.
- setFileName(String) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setFileSize(String) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setFileSizeBytes(long) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setId(String) - Method in class org.craftercms.profile.api.AccessToken
-
Sets the ID of the access token.
- setId(String) - Method in class org.craftercms.profile.api.PersistentLogin
- setId(String) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setId(String) - Method in class org.craftercms.profile.api.Ticket
- setId(String) - Method in class org.craftercms.profile.api.VerificationToken
- setId(ObjectId) - Method in class org.craftercms.profile.api.Profile
- setId(ObjectId) - Method in class org.craftercms.profile.api.Tenant
-
Sets the tenant's DB ID.
- setLastFailedLogin(String, Date, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Sets the date of the last failed login for the profile.
- setLastFailedLogin(Date) - Method in class org.craftercms.profile.api.Profile
- setLastModified(Date) - Method in class org.craftercms.profile.api.Profile
- setLastRequestTime(Date) - Method in class org.craftercms.profile.api.Ticket
- setMaster(boolean) - Method in class org.craftercms.profile.api.AccessToken
-
Sets if this is a master token.
- setMd5(String) - Method in class org.craftercms.profile.api.services.ProfileAttachment
- setMessage(String) - Method in class org.craftercms.profile.api.exceptions.ErrorDetails
- setMetadata(Map<String, Object>) - Method in class org.craftercms.profile.api.AttributeDefinition
-
Sets the additional metadata associated to an attribute (like label, type, etc.).
- setName(String) - Method in class org.craftercms.profile.api.AttributeDefinition
-
Sets the attribute name.
- setName(String) - Method in class org.craftercms.profile.api.Tenant
-
Sets the name of the tenant.
- setPassword(String) - Method in class org.craftercms.profile.api.Profile
- setProfileId(String) - Method in class org.craftercms.profile.api.PersistentLogin
- setProfileId(String) - Method in class org.craftercms.profile.api.Ticket
- setProfileId(String) - Method in class org.craftercms.profile.api.VerificationToken
- setRoles(Set<String>) - Method in class org.craftercms.profile.api.Profile
- setSsoEnabled(boolean) - Method in class org.craftercms.profile.api.Tenant
-
Sets if single sign-on (SSO) should be enabled for this tenant.
- setTenant(String) - Method in class org.craftercms.profile.api.PersistentLogin
- setTenant(String) - Method in class org.craftercms.profile.api.Profile
- setTenant(String) - Method in class org.craftercms.profile.api.Ticket
- setTenant(String) - Method in class org.craftercms.profile.api.VerificationToken
- setTenantPermissions(List<TenantPermission>) - Method in class org.craftercms.profile.api.AccessToken
-
Sets the he tenant permissions the application has.
- setTimestamp(Date) - Method in class org.craftercms.profile.api.PersistentLogin
- setTimestamp(Date) - Method in class org.craftercms.profile.api.VerificationToken
- setToken(String) - Method in class org.craftercms.profile.api.PersistentLogin
- setUsername(String) - Method in class org.craftercms.profile.api.Profile
- setVerified(boolean) - Method in class org.craftercms.profile.api.Profile
- setVerifyNewProfiles(boolean) - Method in class org.craftercms.profile.api.Tenant
-
Sets if new profiles should be verified through email by the user, for the accounts or users of this tenant.
- SortOrder - Enum in org.craftercms.profile.api
-
The sort order used by services the return a list of sorted objects
T
- tenant - Variable in class org.craftercms.profile.api.TenantPermission
- Tenant - Class in org.craftercms.profile.api
-
A tenant is normally an application that shares common configuration.
- Tenant() - Constructor for class org.craftercms.profile.api.Tenant
- TENANT_EXISTS - org.craftercms.profile.api.exceptions.ErrorCode
- TenantAction - Enum in org.craftercms.profile.api
-
Enum with actions that can be executed on tenants and their user profiles by applications.
- TenantPermission - Class in org.craftercms.profile.api
-
Permission
specific for tenants. - TenantPermission() - Constructor for class org.craftercms.profile.api.TenantPermission
- TenantPermission(String) - Constructor for class org.craftercms.profile.api.TenantPermission
- TenantService - Interface in org.craftercms.profile.api.services
-
Service for managing tenants.
- Ticket - Class in org.craftercms.profile.api
-
An authentication ticket for a profile.
- Ticket() - Constructor for class org.craftercms.profile.api.Ticket
- toString() - Method in class org.craftercms.profile.api.AccessToken
- toString() - Method in class org.craftercms.profile.api.AttributeDefinition
- toString() - Method in class org.craftercms.profile.api.AttributePermission
- toString() - Method in class org.craftercms.profile.api.PersistentLogin
- toString() - Method in class org.craftercms.profile.api.Profile
- toString() - Method in class org.craftercms.profile.api.services.ProfileAttachment
- toString() - Method in class org.craftercms.profile.api.Tenant
- toString() - Method in class org.craftercms.profile.api.TenantPermission
- toString() - Method in class org.craftercms.profile.api.Ticket
- toString() - Method in class org.craftercms.profile.api.VerificationToken
U
- UPDATE_TENANT - org.craftercms.profile.api.TenantAction
- updateAttributeDefinitions(String, Collection<AttributeDefinition>) - Method in interface org.craftercms.profile.api.services.TenantService
-
Updates the given attribute definitions of the specified tenant.
- updateAttributes(String, Map<String, Object>, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Updates the attributes of a profile, by merging the specified attributes with the existing attributes.
- updateProfile(String, String, String, String, Boolean, Set<String>, Map<String, Object>, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Updates the profile's info.
- updateTenant(Tenant) - Method in interface org.craftercms.profile.api.services.TenantService
-
Updates the given tenant.
- URL_ACCESS_TOKEN_CREATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_ACCESS_TOKEN_DELETE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_ACCESS_TOKEN_GET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_ACCESS_TOKEN_GET_ALL - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_AUTHENTICATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_CREATE_PERSISTENT_LOGIN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_CREATE_TICKET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_DELETE_PERSISTENT_LOGIN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_GET_PERSISTENT_LOGIN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_GET_TICKET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_INVALIDATE_TICKET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_AUTH_REFRESH_PERSISTENT_LOGIN_TOKEN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_ADD_ROLES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_CHANGE_PASSWORD - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_CREATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_CREATE_VERIFICATION_TOKEN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_DELETE_PROFILE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_DELETE_VERIFICATION_TOKEN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_DISABLE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_ENABLE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_ATTACHMENT - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_ATTACHMENTS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_ATTACHMENTS_DETAILS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_ATTRIBUTES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_ATTRIB_VALUE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_EXISTING_ATTRIB - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_IDS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_QUERY - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_ROLE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_TICKET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_BY_USERNAME - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_COUNT - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_ONE_BY_QUERY - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_RANGE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_GET_VERIFICATION_TOKEN - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_REMOVE_ATTRIBUTES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_REMOVE_ROLES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_RESET_PASSWORD - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_UPDATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_UPDATE_ATTRIBUTES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_UPLOAD_ATTACHMENT - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_PROFILE_VERIFY - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_ADD_ATTRIBUTE_DEFINITIONS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_ADD_ROLES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_COUNT - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_COUNT_BY_QUERY - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_CREATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_DELETE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_GET - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_GET_ALL - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_REMOVE_ATTRIBUTE_DEFINITIONS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_REMOVE_ROLES - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_UPDATE - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_UPDATE_ATTRIBUTE_DEFINITIONS - Static variable in class org.craftercms.profile.api.ProfileConstants
- URL_TENANT_VERIFY_NEW_PROFILES - Static variable in class org.craftercms.profile.api.ProfileConstants
V
- valueOf(String) - Static method in enum org.craftercms.profile.api.AttributeAction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.craftercms.profile.api.exceptions.ErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.craftercms.profile.api.SortOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.craftercms.profile.api.TenantAction
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.craftercms.profile.api.AttributeAction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.craftercms.profile.api.exceptions.ErrorCode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.craftercms.profile.api.SortOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.craftercms.profile.api.TenantAction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VerificationToken - Class in org.craftercms.profile.api
-
Verification token, used for email related verification.
- VerificationToken() - Constructor for class org.craftercms.profile.api.VerificationToken
- verifyNewProfiles(String, boolean) - Method in interface org.craftercms.profile.api.services.TenantService
-
Sets if new profiles for the specified tenant should be verified or not.
- verifyProfile(String, String...) - Method in interface org.craftercms.profile.api.services.ProfileService
-
Sets the profile as verified if the verification token is valid.
W
- WRITE_ATTRIBUTE - org.craftercms.profile.api.AttributeAction
All Classes All Packages