Index (prospecto-jaxrs 2.0.0 API)

A C D E G H I J L M N O P R S T U V W X
All Classes All Packages

A

addAll(Collection<ResourceDescriptor>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.resolver.ConfigurableUrlResolver: Adds resource descriptors to the resolver.
addAll(Collection<ResourceDescriptor>) - Method in class org.soulwing.prospecto.jaxrs.runtime.resolver.ResourceDescriptorUrlResolver: Adds resource descriptors to the resolver.
addDescriptor(ResourceDescriptor) - Method in class org.soulwing.prospecto.jaxrs.runtime.resolver.ResourceDescriptorUrlResolver
AmbiguousPathResolutionException - Exception in org.soulwing.prospecto.jaxrs.api: An exception thrown when more the model path specification of more than one resource method matches a given model path specification.
AmbiguousPathResolutionException(ModelPath, List<ResourceDescriptor>) - Constructor for exception org.soulwing.prospecto.jaxrs.api.AmbiguousPathResolutionException
ANY - org.soulwing.prospecto.jaxrs.runtime.path.ModelPath.MatchType
ANY_SEQUENCE - org.soulwing.prospecto.jaxrs.runtime.path.ModelPath.MatchType
AnyModel - Class in org.soulwing.prospecto.jaxrs.runtime.glob: An pseudo-model type that matches any model single model type in a model path.
AnyModel() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.glob.AnyModel
AnyModelSequence - Class in org.soulwing.prospecto.jaxrs.runtime.glob: A pseudo-model type that matches any sequence of model types in a path (including an empty sequence).
AnyModelSequence() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.glob.AnyModelSequence
APPLICATION_PATH - Static variable in class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider: Configuration property that provides the JAX-RS application path
asArray() - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Gets the sequence of model types in this path as an array
asList() - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Gets the sequence of model types in this path as a list.

C

concat(Class<?>...) - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Creates a new model path from this path concatenated with the given sequence of model types.
concat(List<Class<?>>) - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Creates a new model path from this path concatenated with the given sequence of model types.
concat(ModelPathSpec) - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Creates a new model path from this path concatenated with the sequence of model types on the given ModelPathSpec annotation.
ConfigurableUrlResolver - Interface in org.soulwing.prospecto.jaxrs.runtime.resolver: A configurable UrlResolver.
contextDestroyed(ServletContextEvent) - Method in class org.soulwing.prospecto.jaxrs.api.UrlResolverInitializingContextListener
contextInitialized(ServletContextEvent) - Method in class org.soulwing.prospecto.jaxrs.api.UrlResolverInitializingContextListener

D

describe(Class<?>, String, ModelPath, TemplateResolver, ReflectionService) - Method in interface org.soulwing.prospecto.jaxrs.runtime.discovery.ResourceTypeIntrospector: Describes the specified JAX-RS resource.
describe(Method, String, ModelPath, TemplateResolver, ReflectionService, ResourceTypeIntrospector) - Method in interface org.soulwing.prospecto.jaxrs.runtime.discovery.ResourceMethodIntrospector: Describes the specified JAX-RS resource to the given resolver.
descriptor() - Method in annotation type org.soulwing.prospecto.jaxrs.api.ModelPathSpec: Flag indicating whether a type annotated with this annotation should be considered a resource descriptor.
destroy() - Method in class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider
discoverResources(String, ReflectionService) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionResourceDiscoveryService
discoverResources(String, ReflectionService) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDiscoveryService: Discovers JAX-RS resources, adding appropriate descriptors to the given configurable resolver.

E

equals(Object) - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath
EXACT - org.soulwing.prospecto.jaxrs.runtime.path.ModelPath.MatchType

G

getAnnotation(Class<?>, Class<A>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets an annotation on a type.
getAnnotation(Class<?>, Class<A>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets an annotation on a type.
getAnnotation(Method, Class<A>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets an annotation on a method.
getAnnotation(Method, Class<A>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets an annotation on a method.
getMethods(Class<?>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets the public methods of the given type.
getMethods(Class<?>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets the public methods of the given type.
getResolver() - Method in class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider
getReturnType(Method) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets the return type of the given method.
getReturnType(Method) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets the return type of the given method.
getSize(View, Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.JsonViewMessageBodyWriter
getSize(View, Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.XmlViewMessageBodyWriter
getSubTypesOf(Class<T>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets the set of classes that are subtypes of a given type.
getSubTypesOf(Class<T>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets the set of classes that are subtypes of a given type.
getTypesAnnotatedWith(Class<? extends Annotation>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Gets the set of classes that have a given (type-level) annotation.
getTypesAnnotatedWith(Class<? extends Annotation>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Gets the set of classes that have a given (type-level) annotation.
GlobMatcher<T> - Class in org.soulwing.prospecto.jaxrs.runtime.glob: A type-generalized pattern matcher supporting "glob" expressions.

H

hashCode() - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath

I

inherit() - Method in annotation type org.soulwing.prospecto.jaxrs.api.ModelPathSpec: Flag indicating whether the type or method annotated with this method inherits model path.
init(Map<String, Object>) - Method in class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider
isAbstractType(Class<?>) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Tests whether the given type is an interface or abstract class.
isAbstractType(Class<?>) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ReflectionService: Tests whether the given type is an interface or abstract class.
isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.reader.JsonViewMessageBodyReader
isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.reader.XmlViewMessageBodyReader
isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.JsonViewMessageBodyWriter
isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.XmlViewMessageBodyWriter

J

JaxRsUrlResolverProvider - Class in org.soulwing.prospecto.jaxrs.runtime: A UrlResolverProvider designed for use in a web application that utilizes JAX-RS in a standard ServletContext.
JaxRsUrlResolverProvider() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider
JaxRsUrlResolverProvider(ResourceDiscoveryService) - Constructor for class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider
JsonViewMessageBodyReader - Class in org.soulwing.prospecto.jaxrs.runtime.reader: A MessageBodyReader for JSON.
JsonViewMessageBodyReader() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.reader.JsonViewMessageBodyReader
JsonViewMessageBodyWriter - Class in org.soulwing.prospecto.jaxrs.runtime.writer: A message body writer for a JSON representation of a View.
JsonViewMessageBodyWriter() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.writer.JsonViewMessageBodyWriter

L

length() - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Gets the length of this path.

M

MapPathTemplateResolver - Class in org.soulwing.prospecto.jaxrs.api: A template resolver that builds a URI from map of parameters.
MapPathTemplateResolver() - Constructor for class org.soulwing.prospecto.jaxrs.api.MapPathTemplateResolver
matches(Class<?>...) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDescriptor: Tests whether the given model path matches this method descriptor.
matches(List<T>) - Method in class org.soulwing.prospecto.jaxrs.runtime.glob.GlobMatcher: Tests the given input as a match for this pattern.
matches(ModelPath) - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDescriptor: Tests whether the given model path matches this method descriptor.
matches(T[]) - Method in class org.soulwing.prospecto.jaxrs.runtime.glob.GlobMatcher: Tests the given input as a match for this pattern.
matchTypeAt(int) - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Gets the match type of the path element at the given index.
modelPath() - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDescriptor: Gets the model path identified in a ModelPathSpec annotation on the described resource.
ModelPath - Class in org.soulwing.prospecto.jaxrs.runtime.path: An abstraction for a path of model classes.
ModelPath.MatchType - Enum in org.soulwing.prospecto.jaxrs.runtime.path
ModelPathSpec - Annotation Type in org.soulwing.prospecto.jaxrs.api: An annotation that identifies a sequence of model classes that collectively refer to a given resource.
ModelPathSpecs - Annotation Type in org.soulwing.prospecto.jaxrs.api: An annotation that acts as a container for ModelPathSpec annotations.
ModelPathUtil - Class in org.soulwing.prospecto.jaxrs.runtime.path: Static utility methods for model paths.
ModelPathUtil() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.path.ModelPathUtil

N

newDescriptor(Class<?>, String, ModelPath, PathTemplateResolver) - Method in interface org.soulwing.prospecto.jaxrs.runtime.discovery.ResourceDescriptorFactory
newDescriptor(Class<?>, String, ModelPath, PathTemplateResolver) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.SimpleResourceDescriptorFactory
newDescriptor(Method, String, ModelPath, PathTemplateResolver) - Method in interface org.soulwing.prospecto.jaxrs.runtime.discovery.ResourceDescriptorFactory
newDescriptor(Method, String, ModelPath, PathTemplateResolver) - Method in class org.soulwing.prospecto.jaxrs.runtime.discovery.SimpleResourceDescriptorFactory
newResolver(Class<? extends PathTemplateResolver>) - Static method in class org.soulwing.prospecto.jaxrs.runtime.discovery.TemplateResolverUtils

O

org.soulwing.prospecto.jaxrs.api - package org.soulwing.prospecto.jaxrs.api
org.soulwing.prospecto.jaxrs.runtime - package org.soulwing.prospecto.jaxrs.runtime: Resource location resolver API
org.soulwing.prospecto.jaxrs.runtime.discovery - package org.soulwing.prospecto.jaxrs.runtime.discovery
org.soulwing.prospecto.jaxrs.runtime.glob - package org.soulwing.prospecto.jaxrs.runtime.glob
org.soulwing.prospecto.jaxrs.runtime.path - package org.soulwing.prospecto.jaxrs.runtime.path
org.soulwing.prospecto.jaxrs.runtime.reader - package org.soulwing.prospecto.jaxrs.runtime.reader
org.soulwing.prospecto.jaxrs.runtime.resolver - package org.soulwing.prospecto.jaxrs.runtime.resolver
org.soulwing.prospecto.jaxrs.runtime.writer - package org.soulwing.prospecto.jaxrs.runtime.writer

P

path() - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDescriptor: Gets the path to this resource method relative to the deployment context path and JAX-RS application path.
PathTemplateResolver - Interface in org.soulwing.prospecto.jaxrs.api: An object that resolves placeholders in a path template to produce a path for a resource.

R

readFrom(Class<View>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in class org.soulwing.prospecto.jaxrs.runtime.reader.JsonViewMessageBodyReader
readFrom(Class<View>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in class org.soulwing.prospecto.jaxrs.runtime.reader.XmlViewMessageBodyReader
ReflectionResourceDiscoveryService - Class in org.soulwing.prospecto.jaxrs.runtime.discovery: A concrete ResourceDiscoveryService.
ReflectionResourceDiscoveryService() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionResourceDiscoveryService: Constructs a new instance that will use the default type introspector.
ReflectionService - Interface in org.soulwing.prospecto.jaxrs.runtime: A service that provides reflection (introspection) support.
ReflectionsReflectionService - Class in org.soulwing.prospecto.jaxrs.runtime.discovery: A ReflectionService that delegates to the Reflections utility and the Java Reflection API.
ReflectionsReflectionService(Reflections) - Constructor for class org.soulwing.prospecto.jaxrs.runtime.discovery.ReflectionsReflectionService: Constructs a new instance.
resolve(String, ViewContext) - Method in class org.soulwing.prospecto.jaxrs.api.MapPathTemplateResolver
resolve(String, ViewContext) - Method in interface org.soulwing.prospecto.jaxrs.api.PathTemplateResolver: Resolves placeholders in the given template to produce a path.
resolve(ViewNode, ViewContext) - Method in class org.soulwing.prospecto.jaxrs.runtime.resolver.ResourceDescriptorUrlResolver
ResourceConfigurationException - Exception in org.soulwing.prospecto.jaxrs.runtime: An exception thrown when the annotations applied to the JAX-RS resource for path resolution are incorrectly applied.
ResourceConfigurationException(String) - Constructor for exception org.soulwing.prospecto.jaxrs.runtime.ResourceConfigurationException
ResourceDescriptor - Interface in org.soulwing.prospecto.jaxrs.runtime: A descriptor for a resource method.
ResourceDescriptorFactory - Interface in org.soulwing.prospecto.jaxrs.runtime.discovery: A factory that produces ResourceDescriptor objects.
ResourceDescriptorUrlResolver - Class in org.soulwing.prospecto.jaxrs.runtime.resolver: A simple UrlResolver backed by a set of resource descriptors.
ResourceDescriptorUrlResolver() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.resolver.ResourceDescriptorUrlResolver
ResourceDiscoveryService - Interface in org.soulwing.prospecto.jaxrs.runtime: A service that discovers JAX-RS resources association model path references with resource path templates.
ResourceMethodIntrospector - Interface in org.soulwing.prospecto.jaxrs.runtime.discovery: A service that uses introspection to discover and correlate model path reference annotations with JAX-RS resource annotations on a public method in a resource class.
ResourceNotFoundException - Exception in org.soulwing.prospecto.jaxrs.runtime: An exception thrown to indicate that the path for a referenced resource could not be resolved because the resource was not found.
ResourceNotFoundException(ModelPath) - Constructor for exception org.soulwing.prospecto.jaxrs.runtime.ResourceNotFoundException
ResourceTypeIntrospector - Interface in org.soulwing.prospecto.jaxrs.runtime.discovery: A service that uses introspection to discover and correlate model path reference annotations with JAX-RS resource annotations on an JAX-RS resource type.

S

SERVLET_CONTEXT - Static variable in class org.soulwing.prospecto.jaxrs.runtime.JaxRsUrlResolverProvider: Configuration property that provides the JAX-RS ServletContext
ServletContextReflectionService - Class in org.soulwing.prospecto.jaxrs.runtime.discovery: A ReflectionService for a ServletContext.
ServletContextReflectionService(ServletContext) - Constructor for class org.soulwing.prospecto.jaxrs.runtime.discovery.ServletContextReflectionService
SimpleResourceDescriptorFactory - Class in org.soulwing.prospecto.jaxrs.runtime.discovery: A ResourceDescriptorFactory that creates descriptors using their public constructors.
SimpleResourceDescriptorFactory() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.discovery.SimpleResourceDescriptorFactory

T

templateMap(ViewContext) - Method in class org.soulwing.prospecto.jaxrs.api.MapPathTemplateResolver: Creates a map of named values used to resolve placeholders in a path template.
templateResolver() - Method in interface org.soulwing.prospecto.jaxrs.runtime.ResourceDescriptor: Gets a template resolver instance to use in resolving the path template for the described resource method.
TemplateResolver - Annotation Type in org.soulwing.prospecto.jaxrs.api: An annotation that identifies a PathTemplateResolver to be used in resolving the path template for a resource method.
TemplateResolverUtils - Class in org.soulwing.prospecto.jaxrs.runtime.discovery: Static utility method for creating a template resolver.
TemplateResolverUtils() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.discovery.TemplateResolverUtils
toString() - Method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath
toString(Class<?>[]) - Static method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPathUtil: Converts a model path to a string representation.
toString(List<Class<?>>) - Static method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPathUtil: Converts a model path to a string representation.

U

UrlResolverInitializingContextListener - Class in org.soulwing.prospecto.jaxrs.api: A ServletContextListener that initializes the UrlResolverProducer.
UrlResolverInitializingContextListener() - Constructor for class org.soulwing.prospecto.jaxrs.api.UrlResolverInitializingContextListener

V

validate() - Method in interface org.soulwing.prospecto.jaxrs.runtime.resolver.ConfigurableUrlResolver: Validates the configuration of this resolver.
validate() - Method in class org.soulwing.prospecto.jaxrs.runtime.resolver.ResourceDescriptorUrlResolver: Validates the configuration of this resolver.
value() - Method in annotation type org.soulwing.prospecto.jaxrs.api.ModelPathSpec: Sequence of model classes that reference the annotated resource method.
value() - Method in annotation type org.soulwing.prospecto.jaxrs.api.ModelPathSpecs: Array of model path specs.
value() - Method in annotation type org.soulwing.prospecto.jaxrs.api.TemplateResolver: Identifies the PathTemplateResolver to use for resolving the path template of the annotated method.
valueOf(String) - Static method in enum org.soulwing.prospecto.jaxrs.runtime.path.ModelPath.MatchType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.soulwing.prospecto.jaxrs.runtime.path.ModelPath.MatchType: Returns an array containing the constants of this enum type, in the order they are declared.

W

with(Class<?>...) - Static method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Creates a new path object with the given sequence of model types.
with(List<Class<?>>) - Static method in class org.soulwing.prospecto.jaxrs.runtime.path.ModelPath: Creates a new path object with the given sequence of model types.
with(T, T, T[]) - Static method in class org.soulwing.prospecto.jaxrs.runtime.glob.GlobMatcher
writeTo(View, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.JsonViewMessageBodyWriter
writeTo(View, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.soulwing.prospecto.jaxrs.runtime.writer.XmlViewMessageBodyWriter

X

XmlViewMessageBodyReader - Class in org.soulwing.prospecto.jaxrs.runtime.reader: A MessageBodyReader for XML.
XmlViewMessageBodyReader() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.reader.XmlViewMessageBodyReader
XmlViewMessageBodyWriter - Class in org.soulwing.prospecto.jaxrs.runtime.writer: A message body writer for an XML representation of a View.
XmlViewMessageBodyWriter() - Constructor for class org.soulwing.prospecto.jaxrs.runtime.writer.XmlViewMessageBodyWriter

A C D E G H I J L M N O P R S T U V W X
All Classes All Packages