Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(String, V) - Method in class com.blackrook.small.struct.URITrie
-
Adds a path to the trie.
- add(K, V) - Method in class com.blackrook.small.struct.HashDequeMap
-
Adds a value to the end of a deque.
- addBeginningSlash(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Adds a beginning slash to the string, if no beginning slash exists.
- addCause(Throwable) - Method in exception class com.blackrook.small.exception.request.ManyRequestExceptionsException
-
Adds another cause to this exception.
- addDateHeader(String, long) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Adds a header date value.
- addDateHeader(String, Date) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Adds a header date value.
- addFirst(K, V) - Method in class com.blackrook.small.struct.HashDequeMap
-
Adds a value to the beginning of a deque.
- addHeader(String, String) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Adds a header value.
- addLast(K, V) - Method in class com.blackrook.small.struct.HashDequeMap
-
Adds a value to the end of a deque.
- addPart(Part) - Method in class com.blackrook.small.multipart.MultipartParser
-
Adds a part to the multipart parser.
- AfterConstruction - Annotation Type in com.blackrook.small.annotation.component
-
Annotates a
Componentmethod to be called after this component is constructed and its components filled. - AfterInitialize - Annotation Type in com.blackrook.small.annotation.component
-
Annotates a
Componentmethod to be called after all components are constructed. - afterOpen(EndpointConfig) - Method in class com.blackrook.small.SmallEndpoint
-
Called after the session and environment setup in the
SmallEndpoint.onOpen(Session, EndpointConfig)method happens. - allowOptions() - Method in interface com.blackrook.small.SmallConfiguration
-
Checks if the OPTIONS HTTP method is allowed for all endpoints.
- allowTrace() - Method in interface com.blackrook.small.SmallConfiguration
-
Checks if the TRACE HTTP method is allowed for all endpoints.
- allowWebSockets() - Method in interface com.blackrook.small.SmallConfiguration
-
Checks if the bootstrap should attempt to configure itself to support WebSockets.
- APPLICATION - Enum constant in enum com.blackrook.small.enums.ScopeType
-
Application (servlet context) scope.
- attachment() - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets that this response is an attachment.
- attachment(String) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets that this response is an attachment with a filename.
- Attachment - Annotation Type in com.blackrook.small.annotation.controller
-
Should be used on
EntryPath-annotated methods onController-annotated classes. - ATTACHMENT - Enum constant in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
- Attribute - Annotation Type in com.blackrook.small.annotation.dispatch
-
Annotates a controller method or method parameter for scope attribute binding.
- ATTRIBUTE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- attributeAdded(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallEnvironment
- attributeAdded(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallServlet
- attributeRemoved(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallEnvironment
- attributeRemoved(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallServlet
- attributeReplaced(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallEnvironment
- attributeReplaced(HttpSessionBindingEvent) - Method in class com.blackrook.small.SmallServlet
- AUTO - Enum constant in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
- autoParseMultipart() - Method in interface com.blackrook.small.SmallConfiguration
-
Checks if Multipart requests are auto-parsed if detected as "multipart" on POST, PUT, or PATCH requests.
- AutoTrim - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
B
- BeanCreationException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a bean could not be created.
- BeanCreationException(String) - Constructor for exception class com.blackrook.small.exception.request.BeanCreationException
-
Creates a new exception.
- BeanCreationException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.BeanCreationException
-
Creates a new exception with a message.
- BeforeDestruction - Annotation Type in com.blackrook.small.annotation.component
-
Annotates a
Componentmethod to be called before this component is removed from the environment.
C
- close() - Method in interface com.blackrook.small.SmallResponse
- close() - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
- close(AutoCloseable) - Static method in class com.blackrook.small.struct.Utils
-
Attempts to close an
AutoCloseableobject. - com.blackrook.small - package com.blackrook.small
-
This package contains the main classes and components that make up the main functions of the framework.
- com.blackrook.small.annotation - package com.blackrook.small.annotation
-
Contains the annotations used on components to alter their behavior and purpose.
- com.blackrook.small.annotation.component - package com.blackrook.small.annotation.component
-
Contains annotations for components.
- com.blackrook.small.annotation.controller - package com.blackrook.small.annotation.controller
-
Contains controller-centric annotations.
- com.blackrook.small.annotation.dispatch - package com.blackrook.small.annotation.dispatch
-
Contains dispatch component-centric annotations.
- com.blackrook.small.annotation.filter - package com.blackrook.small.annotation.filter
-
Contains filter-centric annotations.
- com.blackrook.small.annotation.parameters - package com.blackrook.small.annotation.parameters
-
Contains parameter-specific annotations.
- com.blackrook.small.dispatch - package com.blackrook.small.dispatch
-
Contains component stuff related to the dispatcher.
- com.blackrook.small.dispatch.controller - package com.blackrook.small.dispatch.controller
-
Contains controller descriptors.
- com.blackrook.small.dispatch.filter - package com.blackrook.small.dispatch.filter
-
Contains filter descriptors.
- com.blackrook.small.enums - package com.blackrook.small.enums
-
Contains sets of important enumerations.
- com.blackrook.small.exception - package com.blackrook.small.exception
-
Contains exceptions.
- com.blackrook.small.exception.request - package com.blackrook.small.exception.request
-
Contains exceptions thrown during a request.
- com.blackrook.small.exception.views - package com.blackrook.small.exception.views
-
Contains exceptions for view handling.
- com.blackrook.small.multipart - package com.blackrook.small.multipart
-
Contains the embedded multipart request parser.
- com.blackrook.small.parser - package com.blackrook.small.parser
-
Contains special parsers for request content.
- com.blackrook.small.roles - package com.blackrook.small.roles
-
Contains objects that are stereotyped in the application by parent type.
- com.blackrook.small.struct - package com.blackrook.small.struct
-
Additional helper data structures and methods.
- com.blackrook.small.util - package com.blackrook.small.util
-
Contains utility functions and classes.
- Component - Annotation Type in com.blackrook.small.annotation
-
A class annotated with this annotation is instantiated as a singleton object shared by the application context.
- ComponentConstructor - Annotation Type in com.blackrook.small.annotation
-
This annotation specifies that the annotated constructor contains parameters that should be filled with singleton instances.
- construct(Constructor, Object...) - Static method in class com.blackrook.small.struct.Utils
-
Creates a new instance of a class from a class type.
- content(Object) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets the content of the response.
- Content - Annotation Type in com.blackrook.small.annotation.controller
-
Should be used on
EntryPath-annotated methods onController-annotated classes. - CONTENT - Enum constant in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
- CONTENT - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- CONTENT_MIME_TYPE_JSON - Static variable in class com.blackrook.small.util.SmallUtils
-
MIME type for JSON
- CONTENT_MIME_TYPE_XML - Static variable in class com.blackrook.small.util.SmallUtils
-
MIME type for XML
- Controller - Annotation Type in com.blackrook.small.annotation
-
This annotation is used to signify that this object is a Controller with entry points.
- ControllerComponent - Class in com.blackrook.small.dispatch.controller
-
Creates a controller profile to assist in re-calling controllers by path and methods.
- ControllerComponent(Object) - Constructor for class com.blackrook.small.dispatch.controller.ControllerComponent
-
Creates the controller profile for a
Controllerclass. - ControllerComponent.Output - Enum in com.blackrook.small.dispatch.controller
-
Controller output handling types.
- ControllerEntryPoint - Class in com.blackrook.small.dispatch.controller
-
Method descriptor class, specifically for controllers.
- ControllerEntryPoint(ControllerComponent, Method) - Constructor for class com.blackrook.small.dispatch.controller.ControllerEntryPoint
-
Creates an entry method around a service profile instance.
- convertFromHTMLEntities(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Converts a String with HTML entities in it to one without.
- convertToHTMLEntities(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Converts a String to an HTML-safe string.
- COOKIE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- CookieParameter - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter for Cookie binding.
- create() - Method in class com.blackrook.small.struct.HashDequeMap
-
Called to create a new Deque implementation that gets stored in the table.
- create(int) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response with a default status.
- create(int, Object) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response with status and content.
- create(int, Object, String) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response with 200 OK status and a model-view driven content.
- create(SmallResponse) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response from another SmallResponse, copying the status, content, and the headers.
- create(Class) - Static method in class com.blackrook.small.struct.Utils
-
Creates a new instance of a class from a class type.
- create(Object) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response with 200 OK status and content.
- create(Object, String) - Static method in class com.blackrook.small.SmallModelView
-
Creates a new model-view container.
- create(Object, String) - Static method in interface com.blackrook.small.SmallResponse
-
Creates a new response with 200 OK status and a model-view driven content.
- create(String) - Static method in class com.blackrook.small.SmallModelView
-
Creates a new model-view container.
- createForType(Object, Class) - Static method in class com.blackrook.small.struct.Utils
-
Reflect.creates a new instance of an object for placement in a POJO or elsewhere.
- createForType(String, Object, Class) - Static method in class com.blackrook.small.struct.Utils
-
Reflect.creates a new instance of an object for placement in a POJO or elsewhere.
- createPath(String) - Static method in class com.blackrook.small.struct.Utils
-
Creates the necessary directories for a file path.
D
- dateHeader(String, long) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets a header date value.
- dateHeader(String, Date) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets a header date value.
- DEFAULT_BUFFER_SIZE - Static variable in class com.blackrook.small.SmallEndpoint
-
Default buffer size.
- DEFAULT_TOKEN - Static variable in class com.blackrook.small.struct.URITrie
-
Token content for "default" path.
- DefaultMIMETypeDriver - Class in com.blackrook.small.roles
-
Default MIME-Type driver.
- DefaultMIMETypeDriver() - Constructor for class com.blackrook.small.roles.DefaultMIMETypeDriver
- DELETE - Enum constant in enum com.blackrook.small.enums.RequestMethod
-
Standard DELETE request.
- destroy() - Method in class com.blackrook.small.SmallServlet
- DispatchComponent - Class in com.blackrook.small.dispatch
-
A component involved in HTTP request dispatching and handling.
- DispatchComponent(Object) - Constructor for class com.blackrook.small.dispatch.DispatchComponent
- DispatchEntryPoint<S> - Class in com.blackrook.small.dispatch
-
Entry method descriptor class.
- DispatchEntryPoint(S, Method) - Constructor for class com.blackrook.small.dispatch.DispatchEntryPoint
-
Creates an entry method around a service profile instance.
- DispatchEntryPoint.Source - Enum in com.blackrook.small.dispatch
-
Parameter source types.
- DispatchMVCEntryPoint<R> - Interface in com.blackrook.small.dispatch
-
Describes an entry point that is meant to handle part of the MVC call stack.
E
- encapsulateResponseContent(Object) - Static method in class com.blackrook.small.util.SmallUtils
-
Encapsulates an object in a
SmallResponseobject. - ENTITY_NAME_MAP - Static variable in class com.blackrook.small.util.SmallUtils
-
Map of entity names to characters.
- EntryPath - Annotation Type in com.blackrook.small.annotation.controller
-
Public methods with this annotation in
Controller-annotated classes are considered entry points via HTTP requests. - ExceptionHandler<E> - Interface in com.blackrook.small.roles
-
Describes a view resolution driver for Small.
F
- fail() - Static method in class com.blackrook.small.SmallFilterResult
- fail(SmallResponse) - Static method in class com.blackrook.small.SmallFilterResult
-
Returns a failing result with a SmallResponse.
- Filter - Annotation Type in com.blackrook.small.annotation
-
Annotation that is used to signify that this object is a Filter with entry points.
- FilterChain - Annotation Type in com.blackrook.small.annotation.controller
-
An annotation used to specify a filter chain to call before an
EntryPathmethod is invoked on aController. - FilterComponent - Class in com.blackrook.small.dispatch.filter
-
Creates a controller profile to assist in re-calling filters.
- FilterComponent(Object) - Constructor for class com.blackrook.small.dispatch.filter.FilterComponent
-
Creates the filter profile for a
Filterclass. - FilterEntry - Annotation Type in com.blackrook.small.annotation.filter
-
Public methods with this annotation in
Filter-annotated objects declare the filter entry point. - FilterEntryPoint - Class in com.blackrook.small.dispatch.filter
-
Filter entry method.
- FilterEntryPoint(FilterComponent, Method) - Constructor for class com.blackrook.small.dispatch.filter.FilterEntryPoint
-
Creates an entry method around a service profile instance.
- FilterExit - Annotation Type in com.blackrook.small.annotation.filter
-
Public methods with this annotation in
Filter-annotated objects declare a method to invoke when. - FilterExitPoint - Class in com.blackrook.small.dispatch.filter
-
Filter exit method.
- FilterExitPoint(FilterComponent, Method) - Constructor for class com.blackrook.small.dispatch.filter.FilterExitPoint
-
Creates an entry method around a service profile instance.
- fromJSON(Reader, Class) - Method in interface com.blackrook.small.roles.JSONDriver
-
Called when an object needs to be converted to an object from JSON.
- fromJSONString(String, Class) - Method in interface com.blackrook.small.roles.JSONDriver
-
Converts an object to a JSON string from an object.
- fromXML(Reader, Class) - Method in interface com.blackrook.small.roles.XMLDriver
-
Called when an object needs to be converted to an object from XML.
- fromXMLString(String, Class) - Method in interface com.blackrook.small.roles.XMLDriver
-
Converts an object to a XML string from an object.
G
- generateTempFile(String, File) - Method in class com.blackrook.small.multipart.MultipartParser
-
Creates a temporary file for read part data.
- GET - Enum constant in enum com.blackrook.small.enums.RequestMethod
-
Standard GET request.
- getAlias() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.FieldInfo
- getAlias() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.MethodInfo
- getAlias(Field) - Method in interface com.blackrook.small.struct.TypeProfileFactory.MemberPolicy
-
Gets an alias name for the provided field.
- getAlias(Method) - Method in interface com.blackrook.small.struct.TypeProfileFactory.MemberPolicy
-
Gets an alias name for the provided method.
- getApplicationBean(ServletContext, Class) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets and auto-casts an object bean stored at the application level.
- getApplicationBean(ServletContext, Class, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets and auto-casts an object bean stored at the application level.
- getApplicationBean(ServletContext, Class, String, boolean) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets and auto-casts an object bean stored at the application level.
- getApplicationFile(ServletContext, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets a file that is on the application path.
- getApplicationFileAsStream(ServletContext, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Opens an input stream to a resource using a path relative to the application context path.
- getApplicationFilePath(ServletContext, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets a file path that is on the application path.
- getApplicationPackageRoots() - Method in interface com.blackrook.small.SmallConfiguration
- getArrayDimensions(Class) - Static method in class com.blackrook.small.struct.Utils
-
Gets how many dimensions that this array, represented by the provided type, has.
- getArrayDimensions(Object) - Static method in class com.blackrook.small.struct.Utils
-
Gets how many array dimensions that an object (presumably an array) has.
- getArrayType(Class) - Static method in class com.blackrook.small.struct.Utils
-
Gets the class type of this array type, if this is an array type.
- getArrayType(Object) - Static method in class com.blackrook.small.struct.Utils
-
Gets the class type of this array, if this is an array.
- getAttribute(String) - Method in interface com.blackrook.small.SmallConfiguration
-
Fetches the value of an arbitrary attribute set that may be specific to the application.
- getAttribute(String, T) - Method in interface com.blackrook.small.SmallConfiguration
-
Fetches the value of an arbitrary attribute set that may be specific to the application.
- getAttributeConstructor(String) - Method in class com.blackrook.small.dispatch.DispatchComponent
-
Gets a method on this object that constructs an attribute.
- getAttributeExist(HttpSession, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience method that calls
session.getAttribute(attribName). - getAttributeExist(ServletContext, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience method that calls
context.getAttribute(attribName). - getByteData(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets the binary payload of a request.
- getCauses() - Method in exception class com.blackrook.small.exception.request.ManyRequestExceptionsException
- getClasses(String, ClassLoader) - Static method in class com.blackrook.small.struct.Utils
-
Returns the fully-qualified names of all classes beginning with a certain string.
- getClassesFromClasspath(String) - Static method in class com.blackrook.small.struct.Utils
-
Returns the fully-qualified names of all classes beginning with a certain string.
- getComponent(Class) - Method in class com.blackrook.small.SmallEndpoint
-
Returns a singleton component instantiated by Small.
- getComponent(Class) - Method in class com.blackrook.small.SmallEnvironment
-
Returns a singleton component instantiated by Small of a particular type or subtype.
- getComponentList(Class) - Method in class com.blackrook.small.SmallEnvironment
-
Returns all singleton components instantiated by Small of a particular type or subtype.
- getComponents(Class...) - Method in class com.blackrook.small.SmallEnvironment
-
Returns a new array of objects that match the provided types in the order the types are provided.
- getConfiguration(ServletContext) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience method that gets the Small Configuration stub used to start this application.
- getContent() - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
- getContent() - Method in interface com.blackrook.small.SmallResponse
- getContentData(HttpServletRequest, Class) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Get content data from the request and attempts to return it as the desired type.
- getContentType() - Method in class com.blackrook.small.multipart.Part
- getContextPath() - Method in interface com.blackrook.small.SmallConfiguration
- getEntryMethod() - Method in class com.blackrook.small.dispatch.filter.FilterComponent
- getEntryMethods() - Method in class com.blackrook.small.dispatch.controller.ControllerComponent
- getEnvironment() - Method in class com.blackrook.small.SmallEndpoint
- getEnvironment(ServletContext) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience method that gets the Small Application Environment from the servlet context.
- getEnvironment(EndpointConfig) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience method that gets the Small Application Environment from WebSocket EndpointConfig.
- getExitMethod() - Method in class com.blackrook.small.dispatch.filter.FilterComponent
- getField() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.FieldInfo
- getFieldValue(Object, Field) - Static method in class com.blackrook.small.struct.Utils
-
Gets the value of a field on an object.
- getFile() - Method in class com.blackrook.small.multipart.Part
-
Returns a handle to this file, or null if not a file.
- getFileExtension(File) - Static method in class com.blackrook.small.struct.Utils
-
Returns the extension of a file's name.
- getFileExtension(File, String) - Static method in class com.blackrook.small.struct.Utils
-
Returns the extension of a file's name.
- getFileExtension(String) - Static method in class com.blackrook.small.struct.Utils
-
Returns the extension of a filename.
- getFileExtension(String, String) - Static method in class com.blackrook.small.struct.Utils
-
Returns the extension of a filename.
- getFileName() - Method in class com.blackrook.small.multipart.Part
- getFileName(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Get the base file name parsed out of the request URI.
- getFilterChain() - Method in class com.blackrook.small.dispatch.controller.ControllerComponent
- getFilterChain() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- getGetterMethodsByAlias() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's getter methods.
- getGetterMethodsByName() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's getter methods.
- getHandledClass() - Method in interface com.blackrook.small.roles.ExceptionHandler
-
Gets the exception class that this handles.
- getHeaders() - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
- getHeaders() - Method in interface com.blackrook.small.SmallResponse
- getId() - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting this endpoint's ID.
- getInstance() - Method in class com.blackrook.small.SmallComponent
- getJSONDriver() - Method in class com.blackrook.small.SmallEndpoint
-
Gets this application's JSON converter driver.
- getJSONDriver() - Method in class com.blackrook.small.SmallEnvironment
-
Gets this application's JSON converter driver.
- getLength() - Method in class com.blackrook.small.multipart.Part
-
Returns the length of this part.
- getMethod() - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
- getMethod() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.MethodInfo
- getMimeType() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- getMIMEType(String) - Method in class com.blackrook.small.roles.DefaultMIMETypeDriver
- getMIMEType(String) - Method in interface com.blackrook.small.roles.MIMETypeDriver
-
Get the corresponding MIME-Type for a file extension.
- getMIMEType(ServletContext, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Gets the MIME type of a file (uses the provided
MIMETypeDriver). - getMIMETypeDriver() - Method in class com.blackrook.small.SmallEnvironment
-
Gets this application's MIME-Type resolver driver.
- getModel() - Method in class com.blackrook.small.SmallModelView
- getModelConstructor(String) - Method in class com.blackrook.small.dispatch.DispatchComponent
-
Gets a method on this object that constructs a model object.
- getMultipartParser(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Returns the appropriate multipart parser for a request.
- getName() - Method in class com.blackrook.small.multipart.Part
- getOutputType() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- getParameter(String) - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting a query parameter from the endpoint URI.
- getParameterBoolean(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName)and returns true or false. - getParameterBoolean(HttpServletRequest, String, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName)and returns true or false, if the string found in the request evaluates totrueValue, case-insensitively. - getParameterByte(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterByte(HttpServletRequest, String, byte) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterChar(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterChar(HttpServletRequest, String, char) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterDate(HttpServletRequest, String, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Method that parses a parameter as a date.
- getParameterDescriptors() - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
- getParameterDouble(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterDouble(HttpServletRequest, String, double) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterExist(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that checks if a parameter exists on a request.
- getParameterFloat(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterFloat(HttpServletRequest, String, float) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterInt(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterInt(HttpServletRequest, String, int) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterLong(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterLong(HttpServletRequest, String, long) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameters(String) - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting a list of query parameter values from the endpoint URI.
- getParameters(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets a group of parameters that start with a specific prefix.
- getParameterShort(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterShort(HttpServletRequest, String, short) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterString(HttpServletRequest, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getParameterString(HttpServletRequest, String, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that calls
request.getParameter(paramName). - getPartData(Part, Class) - Method in class com.blackrook.small.dispatch.DispatchComponent
-
Converts a Multipart Part to a type.
- getPartList() - Method in class com.blackrook.small.multipart.MultipartParser
- getPath() - Method in class com.blackrook.small.dispatch.controller.ControllerComponent
- getPath() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- getPath(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Get the path parsed out of the request URI.
- getPathExtension(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Get the path file extension parsed out of the request URI (includes the dot).
- getPathVariable(String) - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting a path variable from the endpoint URI.
- getPathVariables() - Method in class com.blackrook.small.struct.URITrie.Result
-
Gets the map of found path variables, if any.
- getProfile(Class) - Static method in class com.blackrook.small.struct.Utils
-
Creates a new profile for a provided type.
- getPublicFieldsByAlias() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's public fields.
- getPublicFieldsByName() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's public fields.
- getQueryString() - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting the query string from the request that created this.
- getRemainder() - Method in class com.blackrook.small.struct.URITrie.Result
-
Gets the path remainder, if this is a "default" path.
- getRequest() - Method in class com.blackrook.small.SmallFilterResult
-
Gets the replacement servlet request object.
- getRequestBean(HttpServletRequest, Class) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the request level.
- getRequestBean(HttpServletRequest, Class, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the request level.
- getRequestBean(HttpServletRequest, Class, String, boolean) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the request level.
- getRequestMethods() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- getResource(ClassLoader, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Finds a resource URL using the current thread's
ClassLoader. - getResource(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Finds a resource URL using the current thread's
ClassLoader. - getResponse() - Method in class com.blackrook.small.SmallFilterResult
-
Gets the replacement servlet response object.
- getSecureServerPort() - Method in interface com.blackrook.small.SmallConfiguration
-
Gets the port to use for secure connections.
- getServerPort() - Method in interface com.blackrook.small.SmallConfiguration
- getServiceProfile() - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
-
Gets the service profile that this belongs to.
- getServletPaths() - Method in interface com.blackrook.small.SmallConfiguration
- getSession() - Method in class com.blackrook.small.SmallEndpoint
- getSessionBean(HttpServletRequest, Class) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the session level.
- getSessionBean(HttpServletRequest, Class, String) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the session level.
- getSessionBean(HttpServletRequest, Class, String, boolean) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets and auto-casts an object bean stored at the session level.
- getSessionId(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets the current connection's session id.
- getSetterMethodsByAlias() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's setter methods.
- getSetterMethodsByName() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's setter methods.
- getSmallResponse() - Method in class com.blackrook.small.SmallFilterResult
-
Gets the SmallResponse object.
- getSmallResponse(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Convenience method that gets the SmallResponse on the request.
- getStatus() - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
- getStatus() - Method in interface com.blackrook.small.SmallResponse
- getStringData(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Gets the string data of a request.
- getTemporaryDirectory() - Method in class com.blackrook.small.SmallEndpoint
- getTemporaryDirectory() - Method in class com.blackrook.small.SmallEnvironment
- getTempPath() - Method in interface com.blackrook.small.SmallConfiguration
-
Provides the path to the temporary directory.
- getType() - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
- getType() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.FieldInfo
- getType() - Method in class com.blackrook.small.struct.TypeProfileFactory.Profile.MethodInfo
- getURI() - Method in class com.blackrook.small.SmallEndpoint
-
Convenience method for getting the URI that created this endpoint.
- getValue() - Method in class com.blackrook.small.multipart.Part
- getValue() - Method in class com.blackrook.small.struct.URITrie.Result
-
Gets the found value, if any.
- getViewName() - Method in class com.blackrook.small.SmallModelView
- getWebsocketServerContainer(ServletContext) - Static method in class com.blackrook.small.util.SmallUtils
-
Attempts to fetch the Websocket Server Container from a servlet context.
- getXMLDriver() - Method in class com.blackrook.small.SmallEndpoint
-
Gets this application's XML converter driver.
- getXMLDriver() - Method in class com.blackrook.small.SmallEnvironment
-
Gets this application's XML converter driver.
H
- handleCall(RequestMethod, HttpServletRequest, HttpServletResponse, Map, Map, HashDequeMap) - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- handleCall(RequestMethod, HttpServletRequest, HttpServletResponse, Map, Map, HashDequeMap) - Method in interface com.blackrook.small.dispatch.DispatchMVCEntryPoint
-
Handles an MVC call.
- handleCall(RequestMethod, HttpServletRequest, HttpServletResponse, Map, Map, HashDequeMap) - Method in class com.blackrook.small.dispatch.filter.FilterEntryPoint
- handleCall(RequestMethod, HttpServletRequest, HttpServletResponse, Map, Map, HashDequeMap) - Method in class com.blackrook.small.dispatch.filter.FilterExitPoint
- handleException(HttpServletRequest, HttpServletResponse, E) - Method in interface com.blackrook.small.roles.ExceptionHandler
-
Called when an exception needs handling when thrown from a controller.
- handleException(HttpServletRequest, HttpServletResponse, Throwable) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience function for forwarding exception handling to the Small Environment, re-throwing the provided if a suitable handler was not found nor invoked.
- handleException(HttpServletRequest, HttpServletResponse, T) - Method in class com.blackrook.small.SmallEnvironment
-
Attempts to find a handler for an uncaught exception.
- handleView(HttpServletRequest, HttpServletResponse, Object, String) - Method in interface com.blackrook.small.roles.ViewDriver
-
Called when a view needs to be rendered.
- handleView(HttpServletRequest, HttpServletResponse, Object, String) - Method in class com.blackrook.small.SmallEnvironment
-
Iterates through the list of views attempting to find a view handler suitable for rendering the provided view.
- handleView(HttpServletRequest, HttpServletResponse, Object, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience function for forwarding view handling to the Small Environment, throwing an exception if a suitable handler was not found nor invoked.
- HashDequeMap<K,
V> - Class in com.blackrook.small.struct -
A hash map that stores deques of a particular type.
- HashDequeMap() - Constructor for class com.blackrook.small.struct.HashDequeMap
-
Creates a new HashDequeMap that has default capacity and load factor.
- HashDequeMap(int) - Constructor for class com.blackrook.small.struct.HashDequeMap
-
Creates a new HashDequeMap that has a specific capacity and default load factor.
- HashDequeMap(int, float) - Constructor for class com.blackrook.small.struct.HashDequeMap
-
Creates a new HashDequeMap that has a specific capacity and default load factor.
- hasTokens() - Method in class com.blackrook.small.parser.RFCParser
- hasValue() - Method in class com.blackrook.small.struct.URITrie.Result
-
Checks if this result has a found value in it.
- header(String, String) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets a header value.
- Header - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter for request header value binding.
- HEADER - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- HEADER_DISPOSITION - Static variable in class com.blackrook.small.multipart.MultipartParser
-
Content-Disposition.
- HEADER_MAP - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- HEADER_TYPE - Static variable in class com.blackrook.small.multipart.MultipartParser
-
Content-Disposition.
- HeaderMap - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a request header for request header value binding.
- HTTPMethod - Class in com.blackrook.small.annotation.controller
-
The request methods that an
EntryPathuses. - HTTPMethod() - Constructor for class com.blackrook.small.annotation.controller.HTTPMethod
- HTTPMethod.DELETE - Annotation Type in com.blackrook.small.annotation.controller
- HTTPMethod.GET - Annotation Type in com.blackrook.small.annotation.controller
- HTTPMethod.PATCH - Annotation Type in com.blackrook.small.annotation.controller
- HTTPMethod.POST - Annotation Type in com.blackrook.small.annotation.controller
- HTTPMethod.PUT - Annotation Type in com.blackrook.small.annotation.controller
I
- init() - Method in class com.blackrook.small.SmallServlet
- invoke(RequestMethod, HttpServletRequest, HttpServletResponse, Map, Map, HashDequeMap) - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
- invoke(Method, Object, Object...) - Static method in class com.blackrook.small.struct.Utils
-
Invokes a method, only throwing a
RuntimeExceptionif something goes wrong (except for an actual exception thrown during execution). - invokeBlind(Method, Object, Object...) - Static method in class com.blackrook.small.struct.Utils
-
Invokes a method, only throwing a
RuntimeExceptionif something goes wrong. - isArray(Class) - Static method in class com.blackrook.small.struct.Utils
-
Tests if a class is actually an array type.
- isArray(Object) - Static method in class com.blackrook.small.struct.Utils
-
Tests if an object is actually an array type.
- isEmpty(Object) - Static method in class com.blackrook.small.struct.Utils
-
Checks if a value is "empty."
- isFile() - Method in class com.blackrook.small.multipart.Part
-
Returns if this part refers to a file.
- isFormEncoded(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Checks if this request is a regular form POST.
- isIgnored(Field) - Method in interface com.blackrook.small.struct.TypeProfileFactory.MemberPolicy
-
Checks if a field is ignored by the profile generator.
- isIgnored(Method) - Method in interface com.blackrook.small.struct.TypeProfileFactory.MemberPolicy
-
Checks if a method is ignored by the profile generator.
- isJSON(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Checks if a MIME-Type is JSON-formatted.
- isJSON(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Checks if the request is JSON-formatted.
- isMultipart(HttpServletRequest) - Static method in class com.blackrook.small.multipart.MultipartParser
-
Checks if the request is a multipart form.
- isNoCache() - Method in class com.blackrook.small.dispatch.controller.ControllerEntryPoint
- isPassing() - Method in class com.blackrook.small.SmallFilterResult
- isXML(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Checks if a MIME-Type is XML-formatted.
- isXML(HttpServletRequest) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Checks if the request is XML-formatted.
- iterator() - Method in class com.blackrook.small.multipart.MultipartParser
J
- join(String, String...) - Static method in class com.blackrook.small.struct.Utils
-
Joins a list of values into one string, placing a joiner between all of them.
- joinArrays(T[]...) - Static method in class com.blackrook.small.struct.Utils
-
Concatenates a set of arrays together, such that the contents of each array are joined into one array.
- JSONDriver - Interface in com.blackrook.small.roles
-
Describes a JSON driver for Small.
M
- ManyRequestExceptionsException - Exception Class in com.blackrook.small.exception.request
-
An exception that is an encapsulation of many exceptions in the request handling chain that will either need to be logged or reported.
- ManyRequestExceptionsException(String) - Constructor for exception class com.blackrook.small.exception.request.ManyRequestExceptionsException
-
Creates a new exception.
- ManyRequestExceptionsException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.ManyRequestExceptionsException
-
Creates a new exception with a message and primary cause.
- METHOD_TYPE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- MethodNotAllowedException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when an HTTP request method is not supported.
- MethodNotAllowedException(String) - Constructor for exception class com.blackrook.small.exception.request.MethodNotAllowedException
-
Creates a new exception.
- MethodNotAllowedException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.MethodNotAllowedException
-
Creates a new exception with a message.
- MIMETypeDriver - Interface in com.blackrook.small.roles
-
Describes a MIME-Type driver for Small.
- Model - Annotation Type in com.blackrook.small.annotation.dispatch
-
Annotates a
Controllermethod or method parameter for constructing a model for passing to a view or processing in a method. - MODEL - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- MultipartFormDataParser - Class in com.blackrook.small.multipart
-
Parser for multipart form requests.
- MultipartFormDataParser() - Constructor for class com.blackrook.small.multipart.MultipartFormDataParser
-
Creates a new form-data parser.
- MultipartParser - Class in com.blackrook.small.multipart
-
Abstract Multipart parser.
- MultipartParser() - Constructor for class com.blackrook.small.multipart.MultipartParser
-
Creates a new multipart parser.
- MultipartParserException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a multiform request is not parsed properly.
- MultipartParserException(String) - Constructor for exception class com.blackrook.small.exception.request.MultipartParserException
-
Creates a new exception.
- MultipartParserException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.MultipartParserException
-
Creates a new exception with a message and cause.
N
- NEWLINE - Variable in class com.blackrook.small.multipart.MultipartParser
-
Newline.
- NEWLINE_BYTES - Variable in class com.blackrook.small.multipart.MultipartParser
-
Newline as bytes.
- nextToken() - Method in class com.blackrook.small.parser.RFCParser
- NO_FILTERS - Static variable in class com.blackrook.small.dispatch.controller.ControllerComponent
- NoCache - Annotation Type in com.blackrook.small.annotation.controller
-
If placed on a
ControllerEntryPathmethod, headers are written in the response for hinting at the fact that the returned content should not be cached by the browser. - NoConverterException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a converter for incoming/outgoing data cannot be read.
- NoConverterException(String) - Constructor for exception class com.blackrook.small.exception.request.NoConverterException
-
Creates a new exception.
- NoConverterException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.NoConverterException
-
Creates a new exception with a message and cause.
- NotFoundException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a resource could not be found.
- NotFoundException(String) - Constructor for exception class com.blackrook.small.exception.request.NotFoundException
-
Creates a new exception.
- NotFoundException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.NotFoundException
-
Creates a new exception with a message and cause.
- NoViewDriverException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a suitable view driver for a view name could not be found.
- NoViewDriverException(String) - Constructor for exception class com.blackrook.small.exception.request.NoViewDriverException
-
Creates a new exception.
- NoViewDriverException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.NoViewDriverException
-
Creates a new exception with a message and cause.
O
- onOpen(Session, EndpointConfig) - Method in class com.blackrook.small.SmallEndpoint
-
When this is called, this gets the
SmallEnvironmentfrom the config and saves the session on this class. - openResource(ClassLoader, String) - Static method in class com.blackrook.small.util.SmallUtils
-
Opens an
InputStreamto a resource using a provided ClassLoader. - openResource(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Opens an
InputStreamto a resource using the current thread'sClassLoader.
P
- Parameter - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter for request parameter binding.
- PARAMETER - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PARAMETER_MAP - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- ParameterMap - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter for request parameter binding.
- parse(HttpServletRequest, File) - Method in class com.blackrook.small.multipart.MultipartParser
-
Parses the request content.
- parseContentType(String, Part) - Method in class com.blackrook.small.multipart.MultipartParser
- parseData(ServletInputStream, File, String, String, byte[]) - Method in class com.blackrook.small.multipart.MultipartFormDataParser
- parseData(ServletInputStream, File, String, String, byte[]) - Method in class com.blackrook.small.multipart.MultipartParser
-
Parses the servlet content and generates parts.
- parseDisposition(String, Part) - Method in class com.blackrook.small.multipart.MultipartParser
- Part - Class in com.blackrook.small.multipart
-
Multipart part that is part of a multiform request.
- Part() - Constructor for class com.blackrook.small.multipart.Part
- pass() - Static method in class com.blackrook.small.SmallFilterResult
- pass(SmallResponse) - Static method in class com.blackrook.small.SmallFilterResult
-
Returns a passing result with a SmallResponse.
- pass(HttpServletRequest) - Static method in class com.blackrook.small.SmallFilterResult
-
Returns a passing result with new request and response.
- pass(HttpServletRequest, HttpServletResponse) - Static method in class com.blackrook.small.SmallFilterResult
-
Returns a passing result with a new request and response.
- pass(HttpServletResponse) - Static method in class com.blackrook.small.SmallFilterResult
-
Returns a passing result with new request and response.
- PATCH - Enum constant in enum com.blackrook.small.enums.RequestMethod
-
Standard PATCH request.
- Path - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
- PATH - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PATH_FILE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PATH_QUERY - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PATH_REMAINDER - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PATH_VARIABLE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- PathFile - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
- pathify(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Convenience for
addBeginningSlash(removeEndingSlash(str)). - PathQuery - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
- PathRemainder - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
- PathVariable - Annotation Type in com.blackrook.small.annotation.parameters
-
Annotates a method parameter.
- peekFirst(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Returns the value at the beginning of a deque.
- peekLast(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Returns the value at the end of a deque.
- PIECE_BOUNDARY - Static variable in class com.blackrook.small.multipart.MultipartParser
-
Content type boundary piece.
- PIECE_CHARSET - Static variable in class com.blackrook.small.multipart.MultipartParser
-
Content type charset piece.
- poll(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the front of a deque.
- pollFirst(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the beginning of a deque.
- pollLast(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the end of a deque.
- pop(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the front of a deque.
- POST - Enum constant in enum com.blackrook.small.enums.RequestMethod
-
Standard POST request.
- printTo(PrintStream) - Method in class com.blackrook.small.struct.URITrie
- push(K, V) - Method in class com.blackrook.small.struct.HashDequeMap
-
Adds a value to the front of a deque.
- PUT - Enum constant in enum com.blackrook.small.enums.RequestMethod
-
Standard PUT request.
R
- relay(InputStream, OutputStream, int, int) - Static method in class com.blackrook.small.struct.Utils
-
Reads from an input stream, reading in a consistent set of data and writing it to the output stream.
- removeBeginningSlash(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Removes the beginning slashes, if any, from a string.
- removeEndingSlash(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Removes the ending slashes, if any, from a string.
- removeExtension(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Removes the path extension, or rather, the part after the last dot in a path.
- removeFirst(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the beginning of a deque.
- removeLast(K) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from the end of a deque.
- removeValue(K, V) - Method in class com.blackrook.small.struct.HashDequeMap
-
Removes a value from a deque.
- REQUEST - Enum constant in enum com.blackrook.small.enums.ScopeType
-
Request scope.
- RequestMethod - Enum in com.blackrook.small.enums
-
Enumeration of request methods for controller method invocation.
- resolve(String) - Method in class com.blackrook.small.struct.URITrie
-
Attempts to resolve a value for a given URI.
- RFCParser - Class in com.blackrook.small.parser
-
Parser for lines that are broken by RFC-standard style text lines (most HTTP headers).
- RFCParser(String) - Constructor for class com.blackrook.small.parser.RFCParser
-
Creates a new header content parser.
S
- scanDataUntilBoundary(InputStream, OutputStream, byte[]) - Method in class com.blackrook.small.multipart.MultipartParser
-
Scans an input stream into an output stream until it hits a part boundary.
- scanLine(InputStream) - Method in class com.blackrook.small.multipart.MultipartParser
-
Scans and returns the next line.
- scanMethod(Method) - Method in class com.blackrook.small.dispatch.controller.ControllerComponent
- scanMethod(Method) - Method in class com.blackrook.small.dispatch.DispatchComponent
- scanMethod(Method) - Method in class com.blackrook.small.dispatch.filter.FilterComponent
- scanMethod(Method) - Method in class com.blackrook.small.SmallComponent
-
Called to handle a single method scan for this component type.
- scope() - Element in annotation type com.blackrook.small.annotation.dispatch.Attribute
- ScopeType - Enum in com.blackrook.small.enums
-
Attribute scope type.
- sendAsyncBinary(byte[]) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, asynchronously, to the client.
- sendAsyncBinary(ByteBuffer) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, asynchronously, to the client.
- sendAsyncJSON(Object) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a JSON Object, asynchronously, to the client.
- sendAsyncText(String) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a message string, asynchronously, to the client.
- sendAsyncXML(Object) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a JSON Object, asynchronously, to the client.
- sendBinary(byte[]) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, synchronously, to the client.
- sendBinary(ByteBuffer) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, synchronously, to the client.
- sendBinaryPartial(byte[], boolean) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, synchronously, to the client, hinting that it may not be the last one in the complete message.
- sendBinaryPartial(ByteBuffer, boolean) - Method in class com.blackrook.small.SmallEndpoint
-
Sends binary data, synchronously, to the client, hinting that it may not be the last one in the complete message.
- sendContent(HttpServletRequest, HttpServletResponse, String, Object) - Static method in class com.blackrook.small.util.SmallUtils
-
Writes a content object to the client.
- sendData(InputStream) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a stream of data, synchronously, until the end of the stream.
- sendData(InputStream, int) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a stream of data, synchronously, until the end of the stream.
- sendData(HttpServletResponse, InputStream) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the entire contents of a stream out through the response.
- sendData(HttpServletResponse, InputStream, Long) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a stream out through the response.
- sendData(HttpServletResponse, String, InputStream, Long) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a stream out through the response.
- sendData(HttpServletResponse, String, String, InputStream, Long) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a stream out through the response.
- sendData(HttpServletResponse, String, String, String, InputStream, Long) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a stream out through the response.
- sendError(HttpServletResponse, int, String) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends request to the error page with a status code.
- sendFile(HttpServletResponse, String, File) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends a file to the client.
- sendFileContents(File) - Method in class com.blackrook.small.SmallEndpoint
-
Sends the contents of a file as a stream of data, synchronously, until the end of the file.
- sendFileContents(File, int) - Method in class com.blackrook.small.SmallEndpoint
-
Sends the contents of a file as a stream of data, synchronously, until the end of the file.
- sendFileContents(HttpServletResponse, String, File) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends contents of a file to the client.
- sendFileContents(HttpServletResponse, String, String, File) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a file to the client.
- sendFileContents(HttpServletResponse, String, String, String, File) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Sends the contents of a file to the client.
- sendJSON(Object) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a JSON Object, synchronously, to the client.
- sendRedirect(HttpServletResponse, String) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Forwards the client abruptly to another document or servlet (new client request).
- sendStringData(HttpServletResponse, String) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Writes string data to the response as "text/plain".
- sendStringData(HttpServletResponse, String, String) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Writes string data to the response.
- sendStringData(HttpServletResponse, String, String, String) - Static method in class com.blackrook.small.util.SmallResponseUtils
-
Writes string data to the response.
- sendText(String) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a message string, synchronously, to the client.
- sendTextPartial(String, boolean) - Method in class com.blackrook.small.SmallEndpoint
-
Sends a message string, synchronously, to the client, hinting that it may not be the last one in the complete message.
- sendXML(Object) - Method in class com.blackrook.small.SmallEndpoint
-
Sends an XML Document, synchronously, to the client.
- service(HttpServletRequest, HttpServletResponse) - Method in class com.blackrook.small.SmallServlet
- SERVLET_CONTEXT - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- SERVLET_REQUEST - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- SERVLET_RESPONSE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- SESSION - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- SESSION - Enum constant in enum com.blackrook.small.enums.ScopeType
-
Session scope.
- sessionCreated(HttpSessionEvent) - Method in class com.blackrook.small.SmallEnvironment
- sessionCreated(HttpSessionEvent) - Method in class com.blackrook.small.SmallServlet
- sessionDestroyed(HttpSessionEvent) - Method in class com.blackrook.small.SmallEnvironment
- sessionDestroyed(HttpSessionEvent) - Method in class com.blackrook.small.SmallServlet
- setContentType(String) - Method in class com.blackrook.small.multipart.Part
-
Sets the content type on this part.
- setFieldValue(Object, Field, Object) - Static method in class com.blackrook.small.struct.Utils
-
Sets the value of a field on an object.
- setFile(File) - Method in class com.blackrook.small.multipart.Part
-
Sets the file on this part.
- setFileName(String) - Method in class com.blackrook.small.multipart.Part
-
Sets the file name of this Part.
- setMIMEType(String, String) - Method in class com.blackrook.small.roles.DefaultMIMETypeDriver
-
Sets the corresponding type of an extension.
- setModelFields(HttpServletRequest, Class) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Sets the fields on a new instance of an object, using its public fields and setters, using the servlet request as a source.
- setModelFields(HttpServletRequest, T) - Static method in class com.blackrook.small.util.SmallRequestUtils
-
Sets the fields on an object, using its public fields and setters, using the servlet request as a source.
- setName(String) - Method in class com.blackrook.small.multipart.Part
-
Sets the name of this Part.
- setValue(String) - Method in class com.blackrook.small.multipart.Part
-
Sets the value of this part, if not a file.
- simulateLag(long) - Static method in class com.blackrook.small.util.SmallUtils
-
Pauses the current thread for up to
maxMillismilliseconds, used for simulating lag. - SMALL_APPLICATION_CONFIGURATION_ATTRIBUTE - Static variable in interface com.blackrook.small.SmallConstants
-
The attribute name for the application configuration object on the servlet context.
- SMALL_APPLICATION_ENVIRONMENT_ATTRIBUTE - Static variable in interface com.blackrook.small.SmallConstants
-
The attribute name for the application environment on the servlet context.
- SMALL_REQUEST_ATTRIBUTE_MULTIPART_LIST - Static variable in interface com.blackrook.small.SmallConstants
-
The attribute name for the part list on multipart requests.
- SMALL_REQUEST_ATTRIBUTE_PATH_REMAINDER - Static variable in interface com.blackrook.small.SmallConstants
-
The attribute name for the path remainder that gets set on the request context on each request (default paths only).
- SMALL_REQUEST_ATTRIBUTE_RESPONSE_OBJECT - Static variable in interface com.blackrook.small.SmallConstants
-
The attribute name for the SmallResponse that is passed around between filters and calls (may be null).
- SmallComponent - Class in com.blackrook.small
-
A single instance of an instantiated component.
- SmallComponent(Object) - Constructor for class com.blackrook.small.SmallComponent
-
Creates an entry point descriptor around an object instance.
- SmallConfiguration - Interface in com.blackrook.small
-
Small Configuration class.
- SmallConstants - Interface in com.blackrook.small
-
Small Framework Constants.
- SmallEndpoint - Class in com.blackrook.small
-
A base websocket endpoint that automatically has a connection to the Small application environment.
- SmallEndpoint() - Constructor for class com.blackrook.small.SmallEndpoint
- SmallEnvironment - Class in com.blackrook.small
-
The component application environment.
- SmallFilterResult - Class in com.blackrook.small
-
An optional return type for a
FilterEntry-annotated method on aFilterthat returns either a newHttpServletRequest, a newHttpServletResponse, both, or neither. - SmallFrameworkException - Exception Class in com.blackrook.small.exception
-
An exception that is thrown when the framework finds a problem.
- SmallFrameworkException() - Constructor for exception class com.blackrook.small.exception.SmallFrameworkException
-
Creates a new exception.
- SmallFrameworkException(String) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkException
-
Creates a new exception.
- SmallFrameworkException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkException
-
Creates a new exception with a message.
- SmallFrameworkException(Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkException
-
Creates a new exception.
- SmallFrameworkParseException - Exception Class in com.blackrook.small.exception
-
An exception that is thrown when the framework finds a problem with parsing paths for controllers.
- SmallFrameworkParseException() - Constructor for exception class com.blackrook.small.exception.SmallFrameworkParseException
-
Creates a new exception.
- SmallFrameworkParseException(String) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkParseException
-
Creates a new exception.
- SmallFrameworkParseException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkParseException
-
Creates a new exception with a message.
- SmallFrameworkParseException(Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkParseException
-
Creates a new exception.
- SmallFrameworkSetupException - Exception Class in com.blackrook.small.exception
-
An exception that is thrown when the framework finds a problem with constructing controllers or filters.
- SmallFrameworkSetupException() - Constructor for exception class com.blackrook.small.exception.SmallFrameworkSetupException
-
Creates a new exception.
- SmallFrameworkSetupException(String) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkSetupException
-
Creates a new exception.
- SmallFrameworkSetupException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkSetupException
-
Creates a new exception with a message.
- SmallFrameworkSetupException(Throwable) - Constructor for exception class com.blackrook.small.exception.SmallFrameworkSetupException
-
Creates a new exception.
- SmallModelView - Class in com.blackrook.small
-
A view model-and-view container.
- SmallRequestUtils - Class in com.blackrook.small.util
-
Utility class for
HttpServletRequestmanipulation. - SmallResponse - Interface in com.blackrook.small
-
Generic response object for Small.
- SMALLRESPONSE - Enum constant in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
- SmallResponse.GenericSmallResponse - Class in com.blackrook.small
-
Creates a generic response object for Small Responses.
- SmallResponseUtils - Class in com.blackrook.small.util
-
Utility class for
HttpServletResponsemanipulation. - SmallServlet - Class in com.blackrook.small
-
The main dispatcher servlet for the controller portion of the framework.
- SmallServlet() - Constructor for class com.blackrook.small.SmallServlet
-
Creates the dispatcher servlet.
- SmallUtils - Class in com.blackrook.small.util
-
Utility library for common or useful functions.
- status(int) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets the status on this response.
T
- toJSON(Writer, Object) - Method in interface com.blackrook.small.roles.JSONDriver
-
Called when an object needs to be converted to JSON from an object.
- toJSONString(Object) - Method in interface com.blackrook.small.roles.JSONDriver
-
Converts an object to a JSON string from an object.
- toString() - Method in class com.blackrook.small.dispatch.DispatchEntryPoint
- toString() - Method in class com.blackrook.small.SmallComponent
- toXML(Writer, Object) - Method in interface com.blackrook.small.roles.XMLDriver
-
Called when an object needs to be converted to XML from an object.
- toXMLString(Object) - Method in interface com.blackrook.small.roles.XMLDriver
-
Converts an object to a XML string from an object.
- trimSlashes(String) - Static method in class com.blackrook.small.util.SmallUtils
-
Trims slashes from the ends.
- type(String) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets the MIME-Type (content type) header for the response.
- type(String, String) - Method in class com.blackrook.small.SmallResponse.GenericSmallResponse
-
Sets the MIME-Type (content type) header for the response.
- TypeProfileFactory - Class in com.blackrook.small.struct
-
A factory that produces type profiles for POJOs and data objects.
- TypeProfileFactory.MemberPolicy - Interface in com.blackrook.small.struct
-
An interface for figuring out whether to ignore certain fields or methods on an object that a profile is being generated for (if they are already going to pass testing for includable fields).
- TypeProfileFactory.Profile<T> - Class in com.blackrook.small.struct
-
Type profile for an unknown object that has an ambiguous signature for applying values to POJOs and beans.
- TypeProfileFactory.Profile.FieldInfo - Class in com.blackrook.small.struct
-
Field information.
- TypeProfileFactory.Profile.MethodInfo - Class in com.blackrook.small.struct
-
Method signature.
U
- UNICODE_ENTITY_MAP - Static variable in class com.blackrook.small.util.SmallUtils
-
Map of characters to entity names.
- UnsupportedMediaTypeException - Exception Class in com.blackrook.small.exception.request
-
Exception thrown when a media type cannot be handled by the server.
- UnsupportedMediaTypeException(String) - Constructor for exception class com.blackrook.small.exception.request.UnsupportedMediaTypeException
-
Creates a new exception.
- UnsupportedMediaTypeException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.request.UnsupportedMediaTypeException
-
Creates a new exception with a message and cause.
- URITrie<V> - Class in com.blackrook.small.struct
-
A trie that organizes mapping URI patterns to values.
- URITrie() - Constructor for class com.blackrook.small.struct.URITrie
-
Creates a new blank URI Trie.
- URITrie.ParseException - Exception Class in com.blackrook.small.struct
-
An exception thrown when a bad URI parse happens.
- URITrie.Result<V> - Class in com.blackrook.small.struct
-
Result class after a URITrie search.
- urlUnescape(String) - Static method in class com.blackrook.small.struct.Utils
-
Decodes a URL-encoded string.
- Utils - Class in com.blackrook.small.struct
-
Utility methods.
V
- value() - Element in annotation type com.blackrook.small.annotation.controller.Attachment
-
Forced MIME-Type.
- value() - Element in annotation type com.blackrook.small.annotation.controller.Content
- value() - Element in annotation type com.blackrook.small.annotation.controller.EntryPath
-
The entry point path (after controller path resolution).
- value() - Element in annotation type com.blackrook.small.annotation.controller.FilterChain
- value() - Element in annotation type com.blackrook.small.annotation.dispatch.Attribute
- value() - Element in annotation type com.blackrook.small.annotation.dispatch.Model
-
Name of the model.
- value() - Element in annotation type com.blackrook.small.annotation.parameters.CookieParameter
- value() - Element in annotation type com.blackrook.small.annotation.parameters.Header
- value() - Element in annotation type com.blackrook.small.annotation.parameters.Parameter
- value() - Element in annotation type com.blackrook.small.annotation.parameters.PathVariable
- valueOf(String) - Static method in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.blackrook.small.enums.RequestMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.blackrook.small.enums.ScopeType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.blackrook.small.dispatch.DispatchEntryPoint.Source
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.blackrook.small.enums.RequestMethod
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.blackrook.small.enums.ScopeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- View - Annotation Type in com.blackrook.small.annotation.controller
-
Should be used on
EntryPath-annotated methods onController-annotated components. - VIEW - Enum constant in enum com.blackrook.small.dispatch.controller.ControllerComponent.Output
- VIEW_REDIRECT_PREFIX - Static variable in class com.blackrook.small.util.SmallUtils
-
View redirect prefix.
- ViewDriver - Interface in com.blackrook.small.roles
-
Describes a view resolution driver for Small.
- ViewProcessingException - Exception Class in com.blackrook.small.exception.views
-
Exception thrown when a something goes wrong in the view driver.
- ViewProcessingException(String) - Constructor for exception class com.blackrook.small.exception.views.ViewProcessingException
-
Creates a new exception.
- ViewProcessingException(String, Throwable) - Constructor for exception class com.blackrook.small.exception.views.ViewProcessingException
-
Creates a new exception with a message.
X
- XMLDriver - Interface in com.blackrook.small.roles
-
Describes an XML conversion driver for Small.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form