Index (BellaDati Extensions API 1.1 API)

B C D E F G H I L R S U V W

B

build() - Method in interface com.belladati.extensions.obj.UserBuilder: Creates User instance

C

com.belladati.extensions - package com.belladati.extensions
com.belladati.extensions.obj - package com.belladati.extensions.obj
CookieService - Interface in com.belladati.extensions: Used by other services to obtain cookie values for the current request, or to write cookie values as part of the request.
createUser(UserBuilder, boolean) - Method in interface com.belladati.extensions.UserService: Creates new user
createUserRequest(String, UserRequestType) - Method in interface com.belladati.extensions.UserService: Creates an user request of desired type.

D

debug(Object) - Method in interface com.belladati.extensions.obj.Logger: Logs a message with debug log level.
debug(Object, Throwable) - Method in interface com.belladati.extensions.obj.Logger: Logs an error with debug log level.
deleteUser(Integer) - Method in interface com.belladati.extensions.UserService: Deletes the user
Domain - Interface in com.belladati.extensions.obj: Interface representing domain and available fields.
DomainService - Interface in com.belladati.extensions: Interface defining methods for working with domain.

E

error(Object) - Method in interface com.belladati.extensions.obj.Logger: Logs a message with error log level.
error(Object, Throwable) - Method in interface com.belladati.extensions.obj.Logger: Logs an error with error log level.
ExtensionService - Interface in com.belladati.extensions: Interface defining methods for working with current Extension instance.

F

fatal(Object) - Method in interface com.belladati.extensions.obj.Logger: Logs a message with fatal log level.
fatal(Object, Throwable) - Method in interface com.belladati.extensions.obj.Logger: Logs an error with fatal log level.

G

getActive() - Method in interface com.belladati.extensions.obj.User: Returns active status of user
getAttribute(String) - Method in interface com.belladati.extensions.HttpRequestService: Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
getAttribute(String) - Method in interface com.belladati.extensions.obj.Session: Returns the value previously stored in the session.
getAttributeNames() - Method in interface com.belladati.extensions.obj.Session: Returns a list of the names of all attributes stored in the session.
getAttributeNames(String) - Method in interface com.belladati.extensions.obj.Session: Returns a list of the names of all attributes stored in the session whose name has the provided prefix.
getAuthSource() - Method in interface com.belladati.extensions.obj.User: Returns the authentication source name
getContextPath() - Method in interface com.belladati.extensions.HttpRequestService: Returns the context path.
getCurrent() - Method in interface com.belladati.extensions.DomainService: Retrieves current domain instance present in session
getDescription() - Method in interface com.belladati.extensions.obj.UserGroup: Returns the user group's description.
getDeveloperMode() - Method in interface com.belladati.extensions.obj.User: Determines whether the developers mode is enabled for the user or not
getEmail() - Method in interface com.belladati.extensions.obj.User: Returns user's email
getExpireWhen() - Method in interface com.belladati.extensions.obj.User: Returns the LocalDateTime of user account expiration
getFirstLogin() - Method in interface com.belladati.extensions.obj.User: Returns LocalDateTime of first user login
getFirstName() - Method in interface com.belladati.extensions.obj.User: Returns user's first name
getHeader(String) - Method in interface com.belladati.extensions.HttpRequestService: Returns the named header as a string, or null if not found.
getHeaderNames() - Method in interface com.belladati.extensions.HttpRequestService: Returns the names of all headers in the request.
getId() - Method in interface com.belladati.extensions.obj.Domain: Returns internal ID of the domain
getId() - Method in interface com.belladati.extensions.obj.User: Returns internal ID of the user
getId() - Method in interface com.belladati.extensions.obj.UserGroup: Returns the user group's ID
getInfo() - Method in interface com.belladati.extensions.obj.User: Returns user's info
getJsonRole() - Method in enum com.belladati.extensions.obj.UserRole
getLastLogin() - Method in interface com.belladati.extensions.obj.User: Returns LocalDateTime of last user login
getLastName() - Method in interface com.belladati.extensions.obj.User: Returns user's last name
getLastVersion() - Method in interface com.belladati.extensions.obj.User: Returns the version of BellaDati prior to the current login
getLocale() - Method in interface com.belladati.extensions.HttpRequestService: Returns the locale of the client as determined from the request headers.
getLocale() - Method in interface com.belladati.extensions.obj.User: Returns locale string of the user
getLocalPort() - Method in interface com.belladati.extensions.HttpRequestService: Returns the Internet Protocol (IP) port number of the interface on which the request was received.
getLog() - Method in interface com.belladati.extensions.LogService: Returns the Logger instance
getMaxInactiveInterval() - Method in interface com.belladati.extensions.obj.Session: Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
getMethod() - Method in interface com.belladati.extensions.HttpRequestService: Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getName() - Method in interface com.belladati.extensions.obj.Domain: Returns name of the domain
getName() - Method in interface com.belladati.extensions.obj.UserGroup: Returns the user group's full display name.
getParameter(String) - Method in interface com.belladati.extensions.ExtensionService: Retrieve parameter value specified by name
getParameter(String) - Method in interface com.belladati.extensions.HttpRequestService: Returns the query parameter value for the given name.
getParameter(String) - Method in interface com.belladati.extensions.obj.Domain: Retrieves domain parameter specified by name
getParameterNames() - Method in interface com.belladati.extensions.ExtensionService: Retrieves the list of parameter names
getParameterNames() - Method in interface com.belladati.extensions.HttpRequestService: Returns a list of query parameter names, in alphabetical order.
getParameterNames() - Method in interface com.belladati.extensions.obj.Domain: Returns list of domain parameter names
getParameters(String) - Method in interface com.belladati.extensions.HttpRequestService: Returns the parameter values for the given name.
getPath() - Method in interface com.belladati.extensions.HttpRequestService: Returns the path portion of the request, which starts with a "/" and contains everything up to the start of the query parameters.
getPhone() - Method in interface com.belladati.extensions.obj.User: Returns user's phone
getPhotoId() - Method in interface com.belladati.extensions.obj.User: Returns internal ID of user photo
getRemoteHost() - Method in interface com.belladati.extensions.HttpRequestService: Returns the fully qualified name of the client or the last proxy that sent the request.
getServerName() - Method in interface com.belladati.extensions.HttpRequestService: Returns the host name of the server to which the request was sent.
getServerPort() - Method in interface com.belladati.extensions.HttpRequestService: Returns the port number to which the request was sent.
getSession(boolean) - Method in interface com.belladati.extensions.HttpRequestService: Gets the Session
getSidePanelOnLeft() - Method in interface com.belladati.extensions.obj.User: Determines whether the report side panel is on left or not
getTimeZone() - Method in interface com.belladati.extensions.obj.User: Returns time zone string of the user
getUserGroups() - Method in interface com.belladati.extensions.obj.User: Returns UserGroups where current user is member
getUsername() - Method in interface com.belladati.extensions.obj.User: Returns username of the user
getUsers() - Method in interface com.belladati.extensions.obj.UserGroup: Returns list of users in user group
getVersion() - Method in interface com.belladati.extensions.obj.User: Returns version of the user

H

HttpRequestService - Interface in com.belladati.extensions: Generic version of HttpServletRequest, used to encapsulate the Servlet API version, and to help bridge the differences between Servlet API and Porlet API.

I

info(Object) - Method in interface com.belladati.extensions.obj.Logger: Logs a message with info log level.
info(Object, Throwable) - Method in interface com.belladati.extensions.obj.Logger: Logs an error with info log level.
invalidate() - Method in interface com.belladati.extensions.obj.Session: Invalidates this session then unbinds any objects bound to it.
isInvalidated() - Method in interface com.belladati.extensions.obj.Session: Checks to see if the session has been invalidated.
isRequestedSessionIdValid() - Method in interface com.belladati.extensions.HttpRequestService: Checks whether the requested session ID is still valid.
isSecure() - Method in interface com.belladati.extensions.HttpRequestService: Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
isXHR() - Method in interface com.belladati.extensions.HttpRequestService: Returns true if the request originated on the client using XmlHttpRequest (the core of any Ajax behavior).

L

load(Integer) - Method in interface com.belladati.extensions.DomainService: Loads Domain specified by ID
loadUserById(Integer) - Method in interface com.belladati.extensions.UserService: Loads User specified by ID
loadUserByUsername(String) - Method in interface com.belladati.extensions.UserService: Loads User specified by username
Logger - Interface in com.belladati.extensions.obj: A simple logging interface abstracting logging APIs.
LogService - Interface in com.belladati.extensions: Interface providing Logger service

R

readCookieValue(String) - Method in interface com.belladati.extensions.CookieService: Returns the value of the first cookie whose name matches.
removeCookieValue(String) - Method in interface com.belladati.extensions.CookieService: Removes a previously written cookie, by writing a new cookie with a maxAge of 0.

S

Session - Interface in com.belladati.extensions.obj: Generic version of HttpSession, used to bridge the gaps between the Servlet API and the Portlet API.
set(User) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets user's fields from existing User instance
setActive(Boolean) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's active status.
setAttribute(String, Object) - Method in interface com.belladati.extensions.HttpRequestService: Stores an attribute in this request.
setAttribute(String, Object) - Method in interface com.belladati.extensions.obj.Session: Sets the value of an attribute.
setEmail(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's email.
setFirstName(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's time first name.
setLastName(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's time last name.
setLocale(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's locale.
setMaxInactiveInterval(int) - Method in interface com.belladati.extensions.obj.Session: Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
setTimeZone(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's time zone.
setUsername(String) - Method in interface com.belladati.extensions.obj.UserBuilder: Sets the user's username.

U

updateDomainAssociation(Integer, Integer, UserRole...) - Method in interface com.belladati.extensions.UserService: Updates user-domain association
updateUser(Integer, Long, UserBuilder) - Method in interface com.belladati.extensions.UserService: Updates user specified by ID and version
updateUserGroupAssociation(Integer, Integer...) - Method in interface com.belladati.extensions.UserService: Updates user-user group association
User - Interface in com.belladati.extensions.obj: Interface representing user and available fields.
UserBuilder - Interface in com.belladati.extensions.obj: Interface representing User builder for building User instances.
UserGroup - Interface in com.belladati.extensions.obj: Interface representing user group and available fields.
UserRequestType - Enum in com.belladati.extensions.obj: Indicates the user request type
UserRole - Enum in com.belladati.extensions.obj: Indicates the role of an user.
UserService - Interface in com.belladati.extensions: Interface defining methods for managing users - creating, updating, deleting, assigning to domains and user groups.

V

valueOf(String) - Static method in enum com.belladati.extensions.obj.UserRequestType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.belladati.extensions.obj.UserRole: Returns the enum constant of this type with the specified name.
valueOfJson(String) - Static method in enum com.belladati.extensions.obj.UserRole: Returns the attribute type matching the given string type from JSON.
values() - Static method in enum com.belladati.extensions.obj.UserRequestType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.belladati.extensions.obj.UserRole: Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(Object) - Method in interface com.belladati.extensions.obj.Logger: Logs a message with warn log level.
warn(Object, Throwable) - Method in interface com.belladati.extensions.obj.Logger: Logs an error with warn log level.
writeCookieValue(String, String) - Method in interface com.belladati.extensions.CookieService: Creates or updates a cookie value.
writeCookieValue(String, String, int) - Method in interface com.belladati.extensions.CookieService: As with CookieService.writeCookieValue(String, String) but an explicit maximum age may be set.
writeCookieValue(String, String, String) - Method in interface com.belladati.extensions.CookieService: As with CookieService.writeCookieValue(String, String) but an explicit domain may be set.
writeCookieValue(String, String, String, String) - Method in interface com.belladati.extensions.CookieService: As with CookieService.writeCookieValue(String, String) but an explicit domain and maximum age may be set.
writeDomainCookieValue(String, String, String) - Method in interface com.belladati.extensions.CookieService: As with CookieService.writeCookieValue(String, String, String) but an explicit domain and path may be set.
writeDomainCookieValue(String, String, String, int) - Method in interface com.belladati.extensions.CookieService: Removes a previously written cookie, by writing a new cookie with a maxAge of 0.

B C D E F G H I L R S U V W