Index (Eureka! Clinical Standard APIs 4.0 API)

A C D E G H I O Q R S U V

A

AbstractJpaGroupDao - Class in org.eurekaclinical.standardapis.dao: An implementation of the UserDao interface, backed by JPA entities and queries.
AbstractJpaGroupDao(Class, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.AbstractJpaGroupDao: Create an object with the give entity manager.
AbstractJpaRoleDao - Class in org.eurekaclinical.standardapis.dao: An implementation of the UserDao interface, backed by JPA entities and queries.
AbstractJpaRoleDao(Class, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.AbstractJpaRoleDao: Create an object with the give entity manager.
AbstractJpaUserDao> - Class in org.eurekaclinical.standardapis.dao: An implementation of the UserDao interface, backed by JPA entities and queries.
AbstractJpaUserDao(Class, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.AbstractJpaUserDao: Create an object with the give entity manager.
AbstractJpaUserTemplateDao> - Class in org.eurekaclinical.standardapis.dao: An implementation of the UserDao interface, backed by JPA entities and queries.
AbstractJpaUserTemplateDao(Class, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.AbstractJpaUserTemplateDao: Create an object with the give entity manager.
AbstractRolesFilter - Class in org.eurekaclinical.standardapis.filter: Base class for creating filters that add the user's roles to the request and set a session attribute, roles which will contain an array of role names.
AbstractRolesFilter() - Constructor for class org.eurekaclinical.standardapis.filter.AbstractRolesFilter
addRole(R) - Method in interface org.eurekaclinical.standardapis.entity.UserEntity
addRole(R) - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity

C

CasEurekaClinicalProperties - Class in org.eurekaclinical.standardapis.props: Base class for implementing properties for Eureka! Clinical microservices.
CasEurekaClinicalProperties(String) - Constructor for class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties: Loads the application configuration.
CasJerseyEurekaClinicalProperties - Class in org.eurekaclinical.standardapis.props: Base class for implementing properties for a Eureka! Clinical service.
CasJerseyEurekaClinicalProperties(String) - Constructor for class org.eurekaclinical.standardapis.props.CasJerseyEurekaClinicalProperties: Loads the application configuration.
create(T) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Creates (persists) the given entity in the data store.
create(T) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Creates an entity in the database.
create(E) - Method in class org.eurekaclinical.standardapis.dao.HistoricalGenericDao

D

Dao<T,PK> - Interface in org.eurekaclinical.standardapis.dao: Provides an interface for the common CRUD operations for an entity.
DaoWithUniqueName<T,PK> - Interface in org.eurekaclinical.standardapis.dao: Provides an interface for the common CRUD operations for an entity.
DatabaseSupport - Class in org.eurekaclinical.standardapis.dao
DatabaseSupport(EntityManager) - Constructor for class org.eurekaclinical.standardapis.dao.DatabaseSupport: Creates a database support instance that uses the provided entity manager to construct queries.
DatabaseSupport(Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.DatabaseSupport: Creates a database support instance that uses the provided entity manager provider to construct queries.
DatabaseSupport.SqlComparator - Enum in org.eurekaclinical.standardapis.dao: Comparators for constructing where clauses that set a threshold on a numerical value.
destroy() - Method in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter: Does nothing.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter: Sets a roles session attribute containing an array of role names for the current user principal.

E

Entity<PK> - Interface in org.eurekaclinical.standardapis.entity: A generic entity interface.
EurekaClinicalProperties - Class in org.eurekaclinical.standardapis.props
EurekaClinicalProperties(String) - Constructor for class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Loads the application configuration.

G

GenericDao<T,PK> - Class in org.eurekaclinical.standardapis.dao: Generic implementation of the Dao interface.
GenericDao(Class<T>, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.GenericDao: Creates a generic DAO that handles the given type of entity.
getAll() - Method in interface org.eurekaclinical.standardapis.dao.Dao: Retrieves a list of all the entities of the given type in the data store.
getAll(int, int) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Retrieves a list of all the entities of the given type in the data store.
getAll(Class<T>) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets every instance of the specified entity in the database.
getAll(Class<T>, int, int) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets every instance of the specified entity in the database.
getAll() - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets all of this DAO's entities.
getAll(int, int) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets all of this DAO's entities.
getAllowedWebClientUrls() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties: For API gateways, specifies the URLs of the web clients that may attempt to login to the gateway.
getAutoAuthorizationTemplate() - Method in interface org.eurekaclinical.standardapis.dao.UserTemplateDao
getByHttpServletRequest(HttpServletRequest) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaUserDao
getByHttpServletRequest(HttpServletRequest) - Method in interface org.eurekaclinical.standardapis.dao.UserDao
getByName(String) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaGroupDao
getByName(String) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaRoleDao
getByName(String) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaUserDao
getByName(String) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaUserTemplateDao
getByName(String) - Method in interface org.eurekaclinical.standardapis.dao.DaoWithUniqueName
getByPrincipal(Principal) - Method in class org.eurekaclinical.standardapis.dao.AbstractJpaUserDao
getByPrincipal(Principal) - Method in interface org.eurekaclinical.standardapis.dao.UserDao
getCasLoginGateway() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties: Whether or not to use CAS gateway mode for authentication.
getCasLoginGateway() - Method in class org.eurekaclinical.standardapis.props.CasJerseyEurekaClinicalProperties: Whether or not to use CAS gateway mode for authentication.
getCasLoginRenew() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties: Whether or not to use CAS renew mode for authentication.
getCasLoginUrl() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties
getCasLogoutUrl() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties
getCasUrl() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties
getConfigDir() - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties
getCreatedAt() - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Gets the datetime at which the first entity instance corresponding to this real-world object was created.
getCurrent(Class<T>) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets every instance of the specified historical entity in the database.
getCurrent() - Method in interface org.eurekaclinical.standardapis.dao.HistoricalDao
getCurrent() - Method in class org.eurekaclinical.standardapis.dao.HistoricalGenericDao
getCurrentByName(String) - Method in interface org.eurekaclinical.standardapis.dao.HistoricalDaoWithUniqueName: Gets the current entity with the given name, for entities that store historical state about themselves.
getCurrentListByAttribute(Class<T>, SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets every instance of the specified historical entity in the database that has the given value of the given attribute.
getCurrentUniqueByAttribute(Class<T>, SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets the instance of the specified historical entity in the database that has the given value of the given attribute.
getDatabaseSupport() - Method in class org.eurekaclinical.standardapis.dao.GenericDao
getDomainUrl() - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: A URL representing the domain in which Eureka Clinical is installed.
getEffectiveAt() - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Returns the effective datetime of this entity instance.
getEntityClass() - Method in class org.eurekaclinical.standardapis.dao.GenericDao
getEntityManager() - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Returns an entity manager that can be used to interact with the data source.
getExpiredAt() - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Returns the datetime at which this entity instance expired.
getId() - Method in interface org.eurekaclinical.standardapis.entity.Entity: Gets the primary key.
getId() - Method in interface org.eurekaclinical.standardapis.entity.GroupEntity: Get the role's identification number.
getId() - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Get the role's identification number.
getId() - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Get the user's unique identifier.
getId() - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Get the user's unique identifier.
getIntValue(String, int) - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Utility method to get an int from the properties file.
getListAsc(SingularAttribute<T, ?>) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets all of this DAO's entities ordered by the provided attribute in ascending order.
getListAsc(SingularAttribute<T, ?>, int, int) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets all of this DAO's entities ordered by the provided attribute in ascending order.
getListByAttribute(Class<T>, SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for the entities that have the specified value of the given attribute.
getListByAttribute(Class<T>, SingularAttribute<T, Y>, DatabaseSupport.SqlComparator, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for the entities that have the specified values of the given numerical attribute.
getListByAttribute(Class<T>, QueryPathProvider<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for entities that match the given path value.
getListByAttribute(SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets the entities that have the target value of the specified attribute.
getListByAttribute(QueryPathProvider<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Executes a query for all entities whose path value is the same as the given target value.
getListByAttributeIn(Class<T>, SingularAttribute<T, Y>, List<Y>) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for entities that have any of the given attribute values.
getListByAttributeIn(Class<T>, QueryPathProvider<T, Y>, List<Y>) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for entities that match the given path value.
getListByAttributeIn(SingularAttribute<T, Y>, List<Y>) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets the entities that have any of the target values of the specified attribute.
getListByAttributeIn(QueryPathProvider<T, Y>, List<Y>) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Executes a query for all entities whose path value is any of the target values.
getName() - Method in interface org.eurekaclinical.standardapis.entity.GroupEntity: Get the role's name.
getName() - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Get the role's name.
getName() - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Gets the name of the template.
getPath(Root<E>, CriteriaBuilder) - Method in interface org.eurekaclinical.standardapis.dao.QueryPathProvider: Provides a path from the entity to the target attribute.
getProxyCallbackServer() - Method in class org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties
getRoles() - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Get all the roles assigned to the user.
getRoles() - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Get all the roles assigned to the user.
getRoles(Principal, ServletRequest) - Method in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter: Gets the user's roles.
getRoles(Principal, ServletRequest) - Method in class org.eurekaclinical.standardapis.filter.RolesFromDbFilter
getRoles() - Method in class org.eurekaclinical.standardapis.filter.RolesRequestWrapper
getStage() - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties
getStatus() - Method in exception org.eurekaclinical.standardapis.exception.HttpStatusException
getStringListValue(String) - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Reads in a property value as a whitespace-delimited list of items.
getStringListValue(String, List<String>) - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Reads in a property value as a whitespace-delimited list of items.
getUniqueByAttribute(Class<T>, SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Gets the entity that has the specified value of an attribute.
getUniqueByAttribute(Class<T>, String, Y) - Method in class org.eurekaclinical.standardapis.dao.DatabaseSupport: Executes a query for the entity with the given attribute value.
getUniqueByAttribute(SingularAttribute<T, Y>, Y) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets the entity that has the target value of the specified attribute.
getUniqueByAttribute(String, Y) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Gets the entity that has the target value of the specified attribute.
getUrl() - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties
getUsername() - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Get the user's unique username.
getUserPrincipal() - Method in class org.eurekaclinical.standardapis.filter.RolesRequestWrapper: Returns the Principal that was passed into the constructor.
getValue(String) - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Returns the String value of the given property name.
getValue(String, String) - Method in class org.eurekaclinical.standardapis.props.EurekaClinicalProperties: Returns the String value of the given property name, or the given default if the given property name does not exist.
GroupDao - Interface in org.eurekaclinical.standardapis.dao: A data access object interface for working with GroupEntity objects in a data store.
GroupEntity - Interface in org.eurekaclinical.standardapis.entity

H

HistoricalDao<PK,E extends HistoricalEntity<PK>> - Interface in org.eurekaclinical.standardapis.dao: A data access object that manages an entity that maintains its historical state.
HistoricalDaoWithUniqueName<PK,T extends HistoricalEntity<PK>> - Interface in org.eurekaclinical.standardapis.dao: Interface for data access objects for managing an entity that stores rather than overwrites its previous states.
HistoricalEntity<PK> - Interface in org.eurekaclinical.standardapis.entity: Interface for entities that maintain their historical state.
HistoricalGenericDao<E extends HistoricalEntity<PK>,PK> - Class in org.eurekaclinical.standardapis.dao
HistoricalGenericDao(Class<E>, Provider<EntityManager>) - Constructor for class org.eurekaclinical.standardapis.dao.HistoricalGenericDao
HttpStatusException - Exception in org.eurekaclinical.standardapis.exception
HttpStatusException(Response.Status) - Constructor for exception org.eurekaclinical.standardapis.exception.HttpStatusException
HttpStatusException(Response.Status, String) - Constructor for exception org.eurekaclinical.standardapis.exception.HttpStatusException
HttpStatusException(Response.Status, Throwable) - Constructor for exception org.eurekaclinical.standardapis.exception.HttpStatusException
HttpStatusException(Response.Status, String, Throwable) - Constructor for exception org.eurekaclinical.standardapis.exception.HttpStatusException

I

init(FilterConfig) - Method in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter: Does nothing.
isDefaultRole() - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Is this role a default role?
isUserInRole(String) - Method in class org.eurekaclinical.standardapis.filter.RolesRequestWrapper: Checks if the given role is one of those that were passed into the constructor.

O

org.eurekaclinical.standardapis.dao - package org.eurekaclinical.standardapis.dao
org.eurekaclinical.standardapis.entity - package org.eurekaclinical.standardapis.entity
org.eurekaclinical.standardapis.exception - package org.eurekaclinical.standardapis.exception
org.eurekaclinical.standardapis.filter - package org.eurekaclinical.standardapis.filter
org.eurekaclinical.standardapis.props - package org.eurekaclinical.standardapis.props

Q

QueryPathProvider<E,P> - Interface in org.eurekaclinical.standardapis.dao: Provides an interface for the subclasses to easily perform queries without having to deal with a lot of boiler-plate code.

R

refresh(T) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Refreshes the given entity instance with latest information from the data store.
refresh(T) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Synchronizes the given entity with what is currently in the database.
remove(T) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Removes the given entity from the data store.
remove(T) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Deletes an entity from the database.
removeRole(R) - Method in interface org.eurekaclinical.standardapis.entity.UserEntity
removeRole(R) - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity
retrieve(PK) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Retrieves the entity referred to by the unique identifier from the data store.
retrieve(PK) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Selects an entity from the database.
RoleDao<E extends RoleEntity> - Interface in org.eurekaclinical.standardapis.dao: A data access object interface for working with RoleEntity objects in a data store.
RoleEntity - Interface in org.eurekaclinical.standardapis.entity
RolesFilter - Interface in org.eurekaclinical.standardapis.filter
RolesFromDbFilter - Class in org.eurekaclinical.standardapis.filter: Filter that adds the user's roles from a UserDao to the request.
RolesFromDbFilter(UserDao<? extends UserEntity<? extends RoleEntity>>) - Constructor for class org.eurekaclinical.standardapis.filter.RolesFromDbFilter
RolesRequestWrapper - Class in org.eurekaclinical.standardapis.filter: Wraps an HttpServletRequest object, so that roles for the principal can be implemented if none are populated in the request instance.
RolesRequestWrapper(HttpServletRequest, Principal, String[]) - Constructor for class org.eurekaclinical.standardapis.filter.RolesRequestWrapper: Create a wrapper with the given principal, role assigned to that principal, and the original request.

S

setCreatedAt(Date) - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Sets the datetime at which the first entity instance corresponding to this real-world object was created.
setDefaultRole(boolean) - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Set the role's default flag.
setEffectiveAt(Date) - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Sets the effective datetime of this entity instance.
setExpiredAt(Date) - Method in interface org.eurekaclinical.standardapis.entity.HistoricalEntity: Sets the timestamp at which this entity instance expired.
setId(PK) - Method in interface org.eurekaclinical.standardapis.entity.Entity: Sets the primary key.
setId(Long) - Method in interface org.eurekaclinical.standardapis.entity.GroupEntity: Set the role's identification number.
setId(Long) - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Set the role's identification number.
setId(Long) - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Set the user's unique identifier.
setId(Long) - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Set the user's unique identifier.
setName(String) - Method in interface org.eurekaclinical.standardapis.entity.GroupEntity: Set the role's name.
setName(String) - Method in interface org.eurekaclinical.standardapis.entity.RoleEntity: Set the role's name.
setName(String) - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Sets the name of the template.
setRoles(List<R>) - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Set the roles assigned to the current user.
setRoles(List<R>) - Method in interface org.eurekaclinical.standardapis.entity.UserTemplateEntity: Set the roles assigned to the current user.
setUsername(String) - Method in interface org.eurekaclinical.standardapis.entity.UserEntity: Set the user's unique username.

U

update(T) - Method in interface org.eurekaclinical.standardapis.dao.Dao: Updates the data store using the given entity.
update(T) - Method in class org.eurekaclinical.standardapis.dao.GenericDao: Updates an entity in the database.
updateCurrent(E) - Method in interface org.eurekaclinical.standardapis.dao.HistoricalDao: Updates the given entity.
updateCurrent(E) - Method in class org.eurekaclinical.standardapis.dao.HistoricalGenericDao
UserDao> - Interface in org.eurekaclinical.standardapis.dao: A data access object interface for working with UserEntity objects in a data store.
UserEntity<R extends RoleEntity> - Interface in org.eurekaclinical.standardapis.entity
UserTemplateDao<E extends UserTemplateEntity<?>> - Interface in org.eurekaclinical.standardapis.dao
UserTemplateEntity<R extends RoleEntity> - Interface in org.eurekaclinical.standardapis.entity

V

valueOf(String) - Static method in enum org.eurekaclinical.standardapis.dao.DatabaseSupport.SqlComparator: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eurekaclinical.standardapis.dao.DatabaseSupport.SqlComparator: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I O Q R S U V