Index (alpine-server 2.2.3 API)

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCacheManager - Class in alpine.server.cache: AbstractCacheManager provides a per-class object cache.
AbstractCacheManager(long, TimeUnit, long) - Constructor for class alpine.server.cache.AbstractCacheManager: Constructs a new AbstractCacheManager object.
AbstractUpgradeItem - Class in alpine.server.upgrade: A base abstract UpgradeItem that all UpgradeItem's should extend (for convenience).
AbstractUpgradeItem() - Constructor for class alpine.server.upgrade.AbstractUpgradeItem
ALL - Enum constant in enum class alpine.server.health.HealthCheckType: Probes that either do not specify their type, or apply to all types.
alpine.server - package alpine.server: The base Alpine package.
alpine.server.auth - package alpine.server.auth: This package contains authentication and authorization related classes.
alpine.server.cache - package alpine.server.cache
alpine.server.filters - package alpine.server.filters: This package contains JAX-RS and Servlet filters.
alpine.server.health - package alpine.server.health
alpine.server.health.checks - package alpine.server.health.checks
alpine.server.json - package alpine.server.json: This package contains JSON specific functionality.
alpine.server.mail - package alpine.server.mail: This package contains classes related to email.
alpine.server.metrics - package alpine.server.metrics
alpine.server.persistence - package alpine.server.persistence
alpine.server.resources - package alpine.server.resources: This package contains JAX-RS resources and supporting classes used by Alpine resources.
alpine.server.servlets - package alpine.server.servlets: This package contains optional and convenience servlets for various functionality.
alpine.server.tasks - package alpine.server.tasks: This package contains tasks that may be executed by the Alpine event framework.
alpine.server.upgrade - package alpine.server.upgrade: This package contains an optional upgrade framework capable of performing database and other upgrades on startup.
alpine.server.util - package alpine.server.util: This package contains a collection of various utilities.
AlpineAuthenticationException - Exception in alpine.server.auth: An exception class that optionally holds pre-determined causes for common authentication failures.
AlpineAuthenticationException(AlpineAuthenticationException.CauseType) - Constructor for exception alpine.server.auth.AlpineAuthenticationException
AlpineAuthenticationException(AlpineAuthenticationException.CauseType, Principal) - Constructor for exception alpine.server.auth.AlpineAuthenticationException
AlpineAuthenticationException.CauseType - Enum Class in alpine.server.auth
AlpineCookie - Class in alpine.server.auth: Alpine Cookies are secure with the HttpOnly, Secure, and Samesite flags enabled.
AlpineCookie(String, String) - Constructor for class alpine.server.auth.AlpineCookie: Create a new instance.
AlpineCookie(String, String, String, String) - Constructor for class alpine.server.auth.AlpineCookie: Create a new instance.
AlpineCookie(String, String, String, String, int) - Constructor for class alpine.server.auth.AlpineCookie: Create a new instance.
AlpineCookie(String, String, String, String, int, int) - Constructor for class alpine.server.auth.AlpineCookie: Create a new instance.
AlpineResource - Class in alpine.server.resources: A value-added resource that all Alpine resources should extend from.
AlpineResource() - Constructor for class alpine.server.resources.AlpineResource
AlpineServlet - Class in alpine.server: The AlpineServlet is the main servlet which extends the Jersey ServletContainer.
AlpineServlet() - Constructor for class alpine.server.AlpineServlet
AlpineTaskScheduler - Class in alpine.server.tasks: A simple framework for scheduling events to run periodically.
AlpineTaskScheduler() - Constructor for class alpine.server.tasks.AlpineTaskScheduler
ApiFilter - Class in alpine.server.filters
ApiFilter() - Constructor for class alpine.server.filters.ApiFilter
ApiKeyAuthenticationService - Class in alpine.server.auth: Authentication service that validates API keys.
ApiKeyAuthenticationService(ContainerRequest) - Constructor for class alpine.server.auth.ApiKeyAuthenticationService: Given the specified ContainerRequest, the constructor retrieves a header named 'X-Api-Key', if it exists.
aroundReadFrom(ReaderInterceptorContext) - Method in class alpine.server.filters.GZipInterceptor
aroundWriteTo(WriterInterceptorContext) - Method in class alpine.server.filters.GZipInterceptor
attachments(File[]) - Method in class alpine.server.mail.SendMail
ATTRIBUTE_MAIL - Static variable in class alpine.server.auth.LdapConnectionWrapper
ATTRIBUTE_NAME - Static variable in class alpine.server.auth.LdapConnectionWrapper
authenticate() - Method in class alpine.server.auth.ApiKeyAuthenticationService: Authenticates the API key (if it was specified in the X-Api-Key header) and returns a Principal if authentication is successful.
authenticate() - Method in interface alpine.server.auth.AuthenticationService: Defines an authentication method which returns a Principal if authentication is successful or an AuthorizationException if not.
authenticate() - Method in class alpine.server.auth.Authenticator: Attempts to authenticate the credentials internally first and if not successful, checks to see if LDAP is enabled or not.
authenticate() - Method in class alpine.server.auth.JwtAuthenticationService: Defines an authentication method which returns a Principal if authentication is successful or an AuthorizationException if not.
authenticate() - Method in class alpine.server.auth.LdapAuthenticationService: Authenticates the username/password combo against the directory service and returns a Principal if authentication is successful.
authenticate() - Method in class alpine.server.auth.ManagedUserAuthenticationService: Authenticates the username/password combo against the directory service and returns a Principal if authentication is successful.
authenticate() - Method in class alpine.server.auth.OidcAuthenticationService: Authenticate a Principal using the provided credentials.
AuthenticationFeature - Class in alpine.server.filters: Determines if authentication is required or not (via Config.AlpineKey.ENFORCE_AUTHENTICATION and if so mandates that all resources requested are authenticated unless they are annotated with AuthenticationNotRequired.
AuthenticationFeature() - Constructor for class alpine.server.filters.AuthenticationFeature
AuthenticationFilter - Class in alpine.server.filters: A filter that ensures that all calls going through this filter are authenticated.
AuthenticationFilter() - Constructor for class alpine.server.filters.AuthenticationFilter
AuthenticationNotRequired - Annotation Interface in alpine.server.auth: An annotation that when used, indicated that a method (in a JAX-RS resource) does not require authentication (when authentication is enabled).
AuthenticationService - Interface in alpine.server.auth: Interface that defines an authentication service.
Authenticator - Class in alpine.server.auth: Class is responsible for authenticating managed users against the internal user database and optionally against a configured directory service (LDAP).
Authenticator(String, String) - Constructor for class alpine.server.auth.Authenticator: Constructs a new Authenticator object.
AuthorizationFeature - Class in alpine.server.filters: Determines if authorization is required or not (via Config.AlpineKey.ENFORCE_AUTHENTICATION and Config.AlpineKey.ENFORCE_AUTHORIZATION and if so mandates that all resources requested have the necessary permissions required to access the resource using PermissionRequired.
AuthorizationFeature() - Constructor for class alpine.server.filters.AuthorizationFeature
AuthorizationFilter - Class in alpine.server.filters: A filter that ensures that all principals making calls that are going through this filter have the necessary permissions to do so.
AuthorizationFilter() - Constructor for class alpine.server.filters.AuthorizationFilter
AuthorizationTokenCookie - Class in alpine.server.auth: An specific type of cookie designed to contain a JWT token.
AuthorizationTokenCookie(String) - Constructor for class alpine.server.auth.AuthorizationTokenCookie
AuthorizationTokenCookie(String, String) - Constructor for class alpine.server.auth.AuthorizationTokenCookie
AuthorizationTokenCookie(String, String, String) - Constructor for class alpine.server.auth.AuthorizationTokenCookie

B

BASE_DN - Static variable in class alpine.server.auth.LdapConnectionWrapper
bcc(String) - Method in class alpine.server.mail.SendMail
bcc(String[]) - Method in class alpine.server.mail.SendMail
BlacklistUrlFilter - Class in alpine.server.filters: BlacklistUrlFilter is a configurable Servlet Filter that can prevent access to specific URLs.
BlacklistUrlFilter() - Constructor for class alpine.server.filters.BlacklistUrlFilter
body(String) - Method in class alpine.server.mail.SendMail
bodyMimeType(String) - Method in class alpine.server.mail.SendMail

C

CacheManager - Class in alpine.server.cache: Provides an implementation of a per-class object cache.
call() - Method in class alpine.server.health.checks.DatabaseHealthCheck
cc(String) - Method in class alpine.server.mail.SendMail
cc(String[]) - Method in class alpine.server.mail.SendMail
ClickjackingFilter - Class in alpine.server.filters: Implements HTTP Header Field X-Frame-Options (RFC 7034).
ClickjackingFilter() - Constructor for class alpine.server.filters.ClickjackingFilter
close() - Method in class alpine.server.upgrade.UpgradeMetaProcessor: Closing a Connection object should only be done when this class creates the Connection and not when a Connection is passed to this objects constructor.
close(Connection) - Static method in class alpine.server.util.DbUtil
close(ResultSet) - Static method in class alpine.server.util.DbUtil
close(Statement) - Static method in class alpine.server.util.DbUtil
closeQuietly(DirContext) - Method in class alpine.server.auth.LdapConnectionWrapper: Closes a DirContext object without throwing any exceptions.
closeQuietly(NamingEnumeration) - Method in class alpine.server.auth.LdapConnectionWrapper: Closes a NamingEnumeration object without throwing any exceptions.
columnExists(Connection, String, String) - Static method in class alpine.server.util.DbUtil
configure(ResourceInfo, FeatureContext) - Method in class alpine.server.filters.AuthenticationFeature
configure(ResourceInfo, FeatureContext) - Method in class alpine.server.filters.AuthorizationFeature
configure(ResourceInfo, FeatureContext) - Method in class alpine.server.filters.HeaderFeature
ContentSecurityPolicyFilter - Class in alpine.server.filters: Implements W3C Content Security Policy (Level 1 and 2).
ContentSecurityPolicyFilter() - Constructor for class alpine.server.filters.ContentSecurityPolicyFilter
contextDestroyed(ServletContextEvent) - Method in class alpine.server.persistence.PersistenceInitializer
contextDestroyed(ServletContextEvent) - Method in class alpine.server.persistence.PersistenceManagerFactory
contextInitialized(ServletContextEvent) - Method in class alpine.server.metrics.MetricsInitializer
contextInitialized(ServletContextEvent) - Method in class alpine.server.persistence.PersistenceInitializer
contextInitialized(ServletContextEvent) - Method in class alpine.server.persistence.PersistenceManagerFactory
contOnValidationError(ValidationTask...) - Method in class alpine.server.resources.AlpineResource: Given one or mote ValidationTasks, this method will return a List of ValidationErrors.
contOnValidationError(Set<ConstraintViolation<Object>>...) - Method in class alpine.server.resources.AlpineResource: Accepts the result from one of the many validation methods available and returns a List of ValidationErrors.
COOKIE_NAME - Static variable in class alpine.server.auth.AuthorizationTokenCookie
createDirContext() - Method in class alpine.server.auth.LdapConnectionWrapper: Creates a DirContext with the applications configuration settings.
createHash(char[]) - Static method in class alpine.server.auth.PasswordService: Given a password to hash, this method will first prehash the password using SHA-512 thus creating a 128 character HEX representation of the password, which is then sent to BCrypt where a unique salt is generated and the prehashed password is properly hashed using the configured BCrypt work factor (determined by Config.AlpineKey.BCRYPT_ROUNDS.
createHash(char[], char[]) - Static method in class alpine.server.auth.PasswordService: Given a password to hash, this method will first prehash the password using SHA-512 thus creating a 128 character HEX representation of the password, which is then sent to BCrypt where the prehashed password is properly hashed using the specified salt and uses the configured BCrypt work factor (determined by Config.AlpineKey.BCRYPT_ROUNDS.
createLdapContext(String, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Asserts a users credentials.
createPersistenceManager() - Static method in class alpine.server.persistence.PersistenceManagerFactory: Creates a new JDO PersistenceManager.
createResponseBuilder() - Method in class alpine.server.health.HealthCheckResponseProvider
createTable(AbstractAlpineQueryManager, Class...) - Static method in class alpine.server.util.DbUtil
createToken(Principal) - Method in class alpine.server.auth.JsonWebToken: Creates a new JWT for the specified principal.
createToken(Principal, List<Permission>) - Method in class alpine.server.auth.JsonWebToken: Creates a new JWT for the specified principal.
createToken(Principal, List<Permission>, IdentityProvider) - Method in class alpine.server.auth.JsonWebToken: Creates a new JWT for the specified principal.
createToken(Map<String, Object>) - Method in class alpine.server.auth.JsonWebToken: Creates a new JWT for the specified principal.

D

DatabaseHealthCheck - Class in alpine.server.health.checks
DatabaseHealthCheck() - Constructor for class alpine.server.health.checks.DatabaseHealthCheck
DbUtil - Class in alpine.server.util
DbUtil() - Constructor for class alpine.server.util.DbUtil
debug(boolean) - Method in class alpine.server.mail.SendMail
deserialize(JsonParser, DeserializationContext) - Method in class alpine.server.json.TrimmedStringArrayDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class alpine.server.json.TrimmedStringDeserializer
destroy() - Method in class alpine.server.AlpineServlet: Overrides the servlet destroy method and shuts down the servlet.
destroy() - Method in class alpine.server.filters.BlacklistUrlFilter
destroy() - Method in class alpine.server.filters.ClickjackingFilter
destroy() - Method in class alpine.server.filters.ContentSecurityPolicyFilter
destroy() - Method in class alpine.server.filters.FqdnForwardFilter
destroy() - Method in class alpine.server.filters.HpkpFilter
destroy() - Method in class alpine.server.filters.HstsFilter
destroy() - Method in class alpine.server.filters.RequestRateThrottleFilter
destroy() - Method in class alpine.server.filters.WhitelistUrlFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.BlacklistUrlFilter: Check for denied or ignored URLs being requested.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.ClickjackingFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.ContentSecurityPolicyFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.FqdnForwardFilter: Forward requests.....
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.HpkpFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.HstsFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.RequestRateThrottleFilter: Determines if the request rate is below or has exceeded the the maximum requests per second for the given time period.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class alpine.server.filters.WhitelistUrlFilter: Check for allowed URLs being requested.
doGet(HttpServletRequest, HttpServletResponse) - Method in class alpine.server.servlets.HealthServlet
doGet(HttpServletRequest, HttpServletResponse) - Method in class alpine.server.servlets.MetricsServlet
doGet(HttpServletRequest, HttpServletResponse) - Method in class alpine.server.servlets.StaticResourceServlet
doHead(HttpServletRequest, HttpServletResponse) - Method in class alpine.server.servlets.StaticResourceServlet
dropColumn(Connection, String, String) - Static method in class alpine.server.util.DbUtil
dropTable(Connection, String) - Static method in class alpine.server.util.DbUtil

E

executeUpdate(Connection, String) - Static method in class alpine.server.util.DbUtil
executeUpgrade(AlpineQueryManager, Connection) - Method in interface alpine.server.upgrade.UpgradeItem
executeUpgrades(List<Class<? extends UpgradeItem>>) - Method in class alpine.server.upgrade.UpgradeExecutor: Performs the execution of upgrades in the order defined by the specified array.
EXPIRED_CREDENTIALS - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType

F

failOnValidationError(ValidationTask...) - Method in class alpine.server.resources.AlpineResource: Wrapper around AlpineResource.contOnValidationError(ValidationTask[]) but instead of returning a list of errors, this method will halt processing of the request by throwing a BadRequestException, setting the HTTP status to 400 (BAD REQUEST) and providing a full list of validation errors in the body of the response.
failOnValidationError(Set<ConstraintViolation<Object>>...) - Method in class alpine.server.resources.AlpineResource: Wrapper around AlpineResource.contOnValidationError(Set[]) but instead of returning a list of errors, this method will halt processing of the request by throwing a BadRequestException, setting the HTTP status to 400 (BAD REQUEST) and providing a full list of validation errors in the body of the response.
FileSystemResourceServlet - Class in alpine.server.servlets: The FileSystemResourceServlet serves StaticResources from the file system similar to a conventional web server.
FileSystemResourceServlet() - Constructor for class alpine.server.servlets.FileSystemResourceServlet
filter(ContainerRequestContext) - Method in class alpine.server.filters.ApiFilter
filter(ContainerRequestContext) - Method in class alpine.server.filters.AuthenticationFilter
filter(ContainerRequestContext) - Method in class alpine.server.filters.AuthorizationFilter
filter(ContainerRequestContext, ContainerResponseContext) - Method in class alpine.server.filters.HeaderFilter
filter(ContainerRequestContext, ContainerResponseContext) - Method in class alpine.server.filters.PrettyPrintFilter
FORCE_PASSWORD_CHANGE - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType
forName(String) - Static method in enum class alpine.server.auth.IdentityProvider: Returns an IdentityProvider that matches a given name.
FqdnForwardFilter - Class in alpine.server.filters: FqdnForwardFilter is a configurable Servlet Filter that can forward requests made to a hostname or IP address to another host via a 301 redirect.
FqdnForwardFilter() - Constructor for class alpine.server.filters.FqdnForwardFilter
from(String) - Method in class alpine.server.mail.SendMail

G

generateHash(String) - Static method in class alpine.server.util.GravatarUtil: Generates a hash value from the specified email address.
get(Class, String) - Method in class alpine.server.cache.AbstractCacheManager: Retrieves an object (of the specified class) from cache.
get(Class, String, Function) - Method in class alpine.server.cache.AbstractCacheManager: Retrieves an object (of the specified class) from cache.
getAlpineRequest() - Method in class alpine.server.resources.AlpineResource: Returns the AlpineRequest object containing pagination, order, filters, and other Alpine-specified aspects of the request.
getAttribute(Attributes, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves an attribute by its name.
getAttribute(DirContext, String, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves an attribute by its name for the specified dn.
getAttribute(SearchResult, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves an attribute by its name for the specified search result.
getCauseType() - Method in exception alpine.server.auth.AlpineAuthenticationException
getChecks() - Method in class alpine.server.health.HealthCheckRegistry
getColumnNames(Connection, String) - Static method in class alpine.server.util.DbUtil
getExpiration() - Method in class alpine.server.auth.JsonWebToken: Returns the expiration of the token.
getGravatarUrl(UserPrincipal) - Static method in class alpine.server.util.GravatarUtil: Generates a Gravatar URL for the specified principal.
getGravatarUrl(UserPrincipal, int) - Static method in class alpine.server.util.GravatarUtil: Generates a Gravatar URL for the specified principal.
getGravatarUrl(String) - Static method in class alpine.server.util.GravatarUtil: Generates a Gravatar URL for the specified email address.
getGravatarUrl(String, int) - Static method in class alpine.server.util.GravatarUtil: Generates a Gravatar URL for the specified email address.
getGroups(DirContext) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves a list of all the groups in the directory.
getGroups(DirContext, LdapUser) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves a list of all groups the user is a member of.
getIdentityProvider() - Method in class alpine.server.auth.JsonWebToken: Returns the identity provider of the token.
getInstance() - Static method in class alpine.server.auth.OidcConfigurationResolver
getInstance() - Static method in class alpine.server.cache.CacheManager
getInstance() - Static method in class alpine.server.health.HealthCheckRegistry
getIssuer() - Method in class alpine.server.auth.OidcConfiguration
getJwksUri() - Method in class alpine.server.auth.OidcConfiguration
getPersistenceManager() - Method in class alpine.server.persistence.PersistenceManagerFactory
getPrincipal() - Method in exception alpine.server.auth.AlpineAuthenticationException
getPrincipal() - Method in class alpine.server.resources.AlpineResource: Returns the principal for who initiated the request.
getRemoteAddress() - Method in class alpine.server.resources.AlpineResource: Convenience method that returns the remote IP address that made the request.
getRemoteHost() - Method in class alpine.server.resources.AlpineResource: Convenience method that returns the remote hostname that made the request.
getRequestAttribute(HttpServletRequest, String) - Static method in class alpine.server.util.HttpUtil: Returns a request attribute as the type of object stored.
getRequestContext() - Method in class alpine.server.resources.AlpineResource: Returns the ContainerRequestContext.
getSchemaVersion() - Method in interface alpine.server.upgrade.UpgradeItem
getSchemaVersion() - Method in class alpine.server.upgrade.UpgradeMetaProcessor: Retrieves the current schema version documented in the database.
getSessionAttribute(HttpSession, String) - Static method in class alpine.server.util.HttpUtil: Returns a session attribute as the type of object stored.
getStaticResource(HttpServletRequest) - Method in class alpine.server.servlets.FileSystemResourceServlet
getStaticResource(HttpServletRequest) - Method in class alpine.server.servlets.StaticResourceServlet: Returns the static resource associated with the given HTTP servlet request.
getSubject() - Method in class alpine.server.auth.JsonWebToken: Returns the subject of the token.
getTableNames(Connection) - Static method in class alpine.server.util.DbUtil
getUriInfo() - Method in class alpine.server.resources.AlpineResource: Returns the UriInfo.
getUserAgent() - Method in class alpine.server.resources.AlpineResource: Convenience method that returns the User-Agent string for the application that made the request.
getUserInfoEndpointUri() - Method in class alpine.server.auth.OidcConfiguration
getValidator() - Method in class alpine.server.resources.AlpineResource: Returns a Validator instance.
getVersion() - Method in class alpine.server.resources.VersionResource
GlobalExceptionHandler - Class in alpine.server.resources
GlobalExceptionHandler() - Constructor for class alpine.server.resources.GlobalExceptionHandler
GravatarUtil - Class in alpine.server.util: A collection of methods that help integrate user Gravatar's.
GZipInterceptor - Class in alpine.server.filters: Provides a way to gzip the response if the client can accept a gzip response.
GZipInterceptor(HttpHeaders) - Constructor for class alpine.server.filters.GZipInterceptor: Constructor.

H

hasPermission(String) - Method in class alpine.server.resources.AlpineResource: Convenience method that returns true if the principal has the specified permission, or false if not.
hasUpgradeRan(Class<? extends UpgradeItem>) - Method in class alpine.server.upgrade.UpgradeMetaProcessor: Determines if the specified upgrade already has a record of being executed previously or not.
HeaderFeature - Class in alpine.server.filters: Registers the HeaderFilter.
HeaderFeature() - Constructor for class alpine.server.filters.HeaderFeature
HeaderFilter - Class in alpine.server.filters: Adds Powered-By and cache-control headers.
HeaderFilter() - Constructor for class alpine.server.filters.HeaderFilter
HealthCheckRegistry - Class in alpine.server.health: A global registry for HealthChecks.
HealthCheckRegistry() - Constructor for class alpine.server.health.HealthCheckRegistry
HealthCheckResponseProvider - Class in alpine.server.health: Implementation of the MicroProfile Health SPI.
HealthCheckResponseProvider() - Constructor for class alpine.server.health.HealthCheckResponseProvider
HealthCheckType - Enum Class in alpine.server.health: Defines types of health checks supported by MicroProfile Health.
HealthServlet - Class in alpine.server.servlets: A HttpServlet exposing health information, following the MicroProfile Health specification.
HealthServlet() - Constructor for class alpine.server.servlets.HealthServlet
host(String) - Method in class alpine.server.mail.SendMail
HpkpFilter - Class in alpine.server.filters: Implements HTTP Public Key Pinning (RFC 7469).
HpkpFilter() - Constructor for class alpine.server.filters.HpkpFilter
HstsFilter - Class in alpine.server.filters: Implements HTTP Strict Transport Security (HSTS) (RFC 6797).
HstsFilter() - Constructor for class alpine.server.filters.HstsFilter
HttpUtil - Class in alpine.server.util: This class contains a collection of useful utility methods for various HTTP tasks.

I

IdentityProvider - Enum Class in alpine.server.auth
inform(Event) - Method in class alpine.server.tasks.LdapSyncTask
init() - Method in class alpine.server.servlets.HealthServlet
init() - Method in class alpine.server.servlets.MetricsServlet
init(FilterConfig) - Method in class alpine.server.filters.BlacklistUrlFilter: Initialize "deny" parameter from web.xml.
init(FilterConfig) - Method in class alpine.server.filters.ClickjackingFilter
init(FilterConfig) - Method in class alpine.server.filters.ContentSecurityPolicyFilter
init(FilterConfig) - Method in class alpine.server.filters.FqdnForwardFilter: Initialize "host" parameter from web.xml.
init(FilterConfig) - Method in class alpine.server.filters.HpkpFilter
init(FilterConfig) - Method in class alpine.server.filters.HstsFilter
init(FilterConfig) - Method in class alpine.server.filters.RequestRateThrottleFilter
init(FilterConfig) - Method in class alpine.server.filters.WhitelistUrlFilter: Initialize "allowUrls" parameter from web.xml.
init(ServletConfig) - Method in class alpine.server.AlpineServlet: Overrides the servlet init method and loads sets the InputStream necessary to load application.properties.
init(ServletConfig) - Method in class alpine.server.servlets.FileSystemResourceServlet: Overrides the servlet init method and loads sets the InputStream necessary to load application.properties.
initPlatformName(Connection) - Static method in class alpine.server.util.DbUtil
installUpgrade(Class<? extends UpgradeItem>, long, long) - Method in class alpine.server.upgrade.UpgradeMetaProcessor: Documents a record in the database for the specified class indicating it has been executed.
INVALID_CREDENTIALS - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType
isApiKey() - Method in class alpine.server.resources.AlpineResource
isH2() - Static method in class alpine.server.util.DbUtil
isLdapUser() - Method in class alpine.server.resources.AlpineResource
isManagedUser() - Method in class alpine.server.resources.AlpineResource
isMssql() - Static method in class alpine.server.util.DbUtil
isMysql() - Static method in class alpine.server.util.DbUtil
isOidcAvailable() - Static method in class alpine.server.util.OidcUtil: Determines whether or not the OpenID Connect integration is available.
isOidcAvailable(Config, OidcConfiguration) - Static method in class alpine.server.util.OidcUtil
isOidcUser() - Method in class alpine.server.resources.AlpineResource
isOracle() - Static method in class alpine.server.util.DbUtil
isPostgreSQL() - Static method in class alpine.server.util.DbUtil
isSpecified() - Method in class alpine.server.auth.ApiKeyAuthenticationService: Returns whether an API key was specified or not.
isSpecified() - Method in interface alpine.server.auth.AuthenticationService: Defines a method which returns if the specified piece of data, required to perform authentication is present.
isSpecified() - Method in class alpine.server.auth.JwtAuthenticationService: Defines a method which returns if the specified piece of data, required to perform authentication is present.
isSpecified() - Method in class alpine.server.auth.LdapAuthenticationService: Returns whether the username/password combo was specified or not.
isSpecified() - Method in class alpine.server.auth.ManagedUserAuthenticationService: Returns whether the username/password combo was specified or not.
isSpecified() - Method in class alpine.server.auth.OidcAuthenticationService

J

JsonWebToken - Class in alpine.server.auth: Decouples the general usage of JSON Web Tokens with the actual implementation of a JWT library All JWT usages should only go through this class and hide the actual implementation details and to avoid improper or insecure use of JWTs.
JsonWebToken() - Constructor for class alpine.server.auth.JsonWebToken: Constructs a new JsonWebToken object using the default Alpine-generated secret key.
JsonWebToken(SecretKey) - Constructor for class alpine.server.auth.JsonWebToken: Constructs a new JsonWekToken object using the specified SecretKey which can be retrieved from KeyManager.getSecretKey() to use the Alpine-generated secret key.
JwtAuthenticationService - Class in alpine.server.auth: An AuthenticationService implementation for JWTs that authenticates users based on a token presented in the request.
JwtAuthenticationService(ContainerRequest) - Constructor for class alpine.server.auth.JwtAuthenticationService: Constructs a new JwtAuthenticationService.

L

LDAP - Enum constant in enum class alpine.server.auth.IdentityProvider
LDAP_CONFIGURED - Static variable in class alpine.server.auth.LdapConnectionWrapper
LDAP_ENABLED - Static variable in class alpine.server.auth.LdapConnectionWrapper
LDAP_URL - Static variable in class alpine.server.auth.LdapConnectionWrapper
LdapAuthenticationService - Class in alpine.server.auth: Class that performs authentication against LDAP servers.
LdapAuthenticationService(String, String) - Constructor for class alpine.server.auth.LdapAuthenticationService: Authentication service validates credentials against a directory service (LDAP).
LdapConnectionWrapper - Class in alpine.server.auth: A convenience wrapper for LDAP connections and commons LDAP tasks.
LdapConnectionWrapper() - Constructor for class alpine.server.auth.LdapConnectionWrapper
LdapSyncTask - Class in alpine.server.tasks: A task to synchronize LDAP users.
LdapSyncTask() - Constructor for class alpine.server.tasks.LdapSyncTask
LIVENESS - Enum constant in enum class alpine.server.health.HealthCheckType: Liveness probes may be used by service orchestrators to evaluate whether a service instance needs to be restarted.
LOCAL - Enum constant in enum class alpine.server.auth.IdentityProvider
logSecurityEvent(Logger, Marker, String) - Method in class alpine.server.resources.AlpineResource: Logs a security event to the security audit log.

M

maintenance(Class) - Method in class alpine.server.cache.AbstractCacheManager: Performs maintenance on the cache.
ManagedUserAuthenticationService - Class in alpine.server.auth: Class that performs authentication against internally managed users.
ManagedUserAuthenticationService(String, String) - Constructor for class alpine.server.auth.ManagedUserAuthenticationService: Authentication service validates credentials against internally managed users.
MapperUtil - Class in alpine.server.util: A collection of useful ObjectMapper methods.
matches(char[], ManagedUser) - Static method in class alpine.server.auth.PasswordService: Checks the validity of the asserted password against a ManagedUsers actual hashed password.
MetricsInitializer - Class in alpine.server.metrics
MetricsInitializer() - Constructor for class alpine.server.metrics.MetricsInitializer
MetricsServlet - Class in alpine.server.servlets
MetricsServlet() - Constructor for class alpine.server.servlets.MetricsServlet

O

OidcAuthenticationService - Class in alpine.server.auth
OidcAuthenticationService(String) - Constructor for class alpine.server.auth.OidcAuthenticationService: Deprecated.
Use OidcAuthenticationService(String, String) instead
OidcAuthenticationService(String, String) - Constructor for class alpine.server.auth.OidcAuthenticationService
OidcConfiguration - Class in alpine.server.auth
OidcConfiguration() - Constructor for class alpine.server.auth.OidcConfiguration
OidcConfigurationResolver - Class in alpine.server.auth
OidcUtil - Class in alpine.server.util
OPENID_CONNECT - Enum constant in enum class alpine.server.auth.IdentityProvider
OTHER - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType

P

password(String) - Method in class alpine.server.mail.SendMail
PasswordService - Class in alpine.server.auth: Alpine PasswordService that provides a secure method of hashing and validating user passwords.
PermissionRequired - Annotation Interface in alpine.server.auth: This annotation is intended to be used in conjunction with JAX-RS resources (methods) to define what permissions are required to access the method.
PersistenceInitializer - Class in alpine.server.persistence: Initializes the embedded H2 database.
PersistenceInitializer() - Constructor for class alpine.server.persistence.PersistenceInitializer
PersistenceManagerFactory - Class in alpine.server.persistence: Initializes the JDO persistence manager on server startup.
PersistenceManagerFactory() - Constructor for class alpine.server.persistence.PersistenceManagerFactory
port(int) - Method in class alpine.server.mail.SendMail
PrettyPrintFilter - Class in alpine.server.filters: Adds the ability to optionally output pretty printed responses.
PrettyPrintFilter() - Constructor for class alpine.server.filters.PrettyPrintFilter
put(String, Object) - Method in class alpine.server.cache.AbstractCacheManager: Adds an object to cache.

R

readAsObjectOf(Class<T>, String) - Static method in class alpine.server.util.MapperUtil: Reads in a String value and returns the object for which it represents.
READINESS - Enum constant in enum class alpine.server.health.HealthCheckType: Readiness probes may be used by service orchestrators to evaluate whether a service instance is ready to accept traffic.
register(String, HealthCheck) - Method in class alpine.server.health.HealthCheckRegistry
remove(Class, String) - Method in class alpine.server.cache.AbstractCacheManager: Remove an object from cache.
RequestRateThrottleFilter - Class in alpine.server.filters: The RequestRateThrottleFilter is a Servlet filter that can place a hard limit on the number of requests per second.
RequestRateThrottleFilter() - Constructor for class alpine.server.filters.RequestRateThrottleFilter
resolve() - Method in class alpine.server.auth.OidcConfigurationResolver: Resolve the OidcConfiguration either from a remote authorization server or from cache.
rollback(Connection) - Static method in class alpine.server.util.DbUtil

S

scheduleEvent(Event, long, long) - Method in class alpine.server.tasks.AlpineTaskScheduler: Schedules a repeating Event.
search(DirContext, String, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves a list of all the entries in the directory that match the specified filter and searchTerm
searchForGroupName(DirContext, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves a list of all the groups in the directory that match the specified groupName.
searchForSingleUsername(DirContext, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Performs a search for the specified username.
searchForUsername(DirContext, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Performs a search for the specified username.
searchForUserName(DirContext, String) - Method in class alpine.server.auth.LdapConnectionWrapper: Retrieves a list of all the users in the directory that match the specified userName.
send() - Method in class alpine.server.mail.SendMail
SendMail - Class in alpine.server.mail
SendMail() - Constructor for class alpine.server.mail.SendMail
SendMailException - Exception in alpine.server.mail
SendMailException() - Constructor for exception alpine.server.mail.SendMailException: Constructs a new SendMailException with null as its detail message.
SendMailException(String) - Constructor for exception alpine.server.mail.SendMailException: Constructs a new SendMailException with the specified detail message.
SendMailException(String, Throwable) - Constructor for exception alpine.server.mail.SendMailException: Constructs a new SendMailException with the specified detail message and cause.
SendMailException(Throwable) - Constructor for exception alpine.server.mail.SendMailException: Constructs a new SendMailException with the specified cause.
setAbsolute(boolean) - Method in class alpine.server.servlets.FileSystemResourceServlet
setDirectory(String) - Method in class alpine.server.servlets.FileSystemResourceServlet
setIssuer(String) - Method in class alpine.server.auth.OidcConfiguration
setJdoPersistenceManagerFactory(JDOPersistenceManagerFactory) - Static method in class alpine.server.persistence.PersistenceManagerFactory: Set the JDOPersistenceManagerFactory to be used by PersistenceManagerFactory.
setJwksUri(URI) - Method in class alpine.server.auth.OidcConfiguration
setUserInfoEndpointUri(URI) - Method in class alpine.server.auth.OidcConfiguration
shouldRehash(char[]) - Static method in class alpine.server.auth.PasswordService: Checks the asserted BCrypt formatted hashed password and determines if the password should be rehashed or not.
shouldUpgrade(AlpineQueryManager, Connection) - Method in class alpine.server.upgrade.AbstractUpgradeItem
shouldUpgrade(AlpineQueryManager, Connection) - Method in interface alpine.server.upgrade.UpgradeItem
shutdown() - Method in class alpine.server.tasks.AlpineTaskScheduler: Shuts town the TaskScheduler by canceling all scheduled events.
smtpauth(boolean) - Method in class alpine.server.mail.SendMail
STARTUP - Enum constant in enum class alpine.server.health.HealthCheckType: Startup probes may be used by service orchestrators to evaluate whether a service instance has started.
StaticResourceServlet - Class in alpine.server.servlets: The StaticResourceServlet provides a foundation in which to serve static resources similar to a conventional web server.
StaticResourceServlet() - Constructor for class alpine.server.servlets.StaticResourceServlet
subject(String) - Method in class alpine.server.mail.SendMail
SUSPENDED - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType

T

tableExists(Connection, String) - Static method in class alpine.server.util.DbUtil
TEAM_SYNCHRONIZATION - Static variable in class alpine.server.auth.LdapConnectionWrapper
tearDown() - Static method in class alpine.server.persistence.PersistenceManagerFactory: Closes the JDOPersistenceManagerFactory and removes any reference to it.
to(String) - Method in class alpine.server.mail.SendMail
to(String[]) - Method in class alpine.server.mail.SendMail
toResponse(Exception) - Method in class alpine.server.resources.GlobalExceptionHandler
toString() - Method in class alpine.server.auth.AlpineCookie: Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
toString() - Method in class alpine.server.auth.OidcConfiguration
TOTAL_COUNT_HEADER - Static variable in class alpine.server.resources.AlpineResource
TrimmedStringArrayDeserializer - Class in alpine.server.json: This custom deserializer ensures that empty strings are deserialized as null rather than an "".
TrimmedStringArrayDeserializer() - Constructor for class alpine.server.json.TrimmedStringArrayDeserializer
TrimmedStringDeserializer - Class in alpine.server.json: This custom deserializer ensures that empty strings are deserialized as null rather than an "".
TrimmedStringDeserializer() - Constructor for class alpine.server.json.TrimmedStringDeserializer
trustCert(boolean) - Method in class alpine.server.mail.SendMail

U

UNMAPPED_ACCOUNT - Enum constant in enum class alpine.server.auth.AlpineAuthenticationException.CauseType
updateSchemaVersion(VersionComparator) - Method in class alpine.server.upgrade.UpgradeMetaProcessor: Updates the schema version in the database.
UpgradeException - Exception in alpine.server.upgrade: An exception specific to Upgrades
UpgradeException() - Constructor for exception alpine.server.upgrade.UpgradeException
UpgradeException(String) - Constructor for exception alpine.server.upgrade.UpgradeException
UpgradeException(String, Throwable) - Constructor for exception alpine.server.upgrade.UpgradeException
UpgradeException(Throwable) - Constructor for exception alpine.server.upgrade.UpgradeException
UpgradeExecutor - Class in alpine.server.upgrade: Executes upgrades by first checking if execution is necessary and if the specific upgrade has already been executed.
UpgradeExecutor(AlpineQueryManager) - Constructor for class alpine.server.upgrade.UpgradeExecutor: Constructs a new UpgradeExecutor object.
UpgradeItem - Interface in alpine.server.upgrade
UpgradeMetaProcessor - Class in alpine.server.upgrade: This class determines what upgrades (if any) have already been executed against the current database and documents upgrades that are being installed so that an audit trail of the execution history is maintained.
UpgradeMetaProcessor() - Constructor for class alpine.server.upgrade.UpgradeMetaProcessor: Constructs a new UpgradeMetaProcessor object along with a new SQL Connection object.
UpgradeMetaProcessor(Connection) - Constructor for class alpine.server.upgrade.UpgradeMetaProcessor: Constructs a new UpgradeMetaProcessor object
useNTLM(boolean) - Method in class alpine.server.mail.SendMail
USER_PROVISIONING - Static variable in class alpine.server.auth.LdapConnectionWrapper
username(String) - Method in class alpine.server.mail.SendMail
useStartTLS(boolean) - Method in class alpine.server.mail.SendMail

V

validateToken(String) - Method in class alpine.server.auth.JsonWebToken: Validates a JWT by ensuring the signature matches and validates against the SecretKey and checks the expiration date.
value() - Element in annotation interface alpine.server.auth.PermissionRequired: An array of permissions.
valueOf(String) - Static method in enum class alpine.server.auth.AlpineAuthenticationException.CauseType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class alpine.server.auth.IdentityProvider: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class alpine.server.health.HealthCheckType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class alpine.server.auth.AlpineAuthenticationException.CauseType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class alpine.server.auth.IdentityProvider: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class alpine.server.health.HealthCheckType: Returns an array containing the constants of this enum class, in the order they are declared.
VersionResource - Class in alpine.server.resources: Bundled JAX-RS resource that displays the name of the application, version, and build timestamp.
VersionResource() - Constructor for class alpine.server.resources.VersionResource

W

WhitelistUrlFilter - Class in alpine.server.filters: WhitelistUrlFilter is a configurable Servlet Filter that can prevent access to specific URLs.
WhitelistUrlFilter() - Constructor for class alpine.server.filters.WhitelistUrlFilter

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form