Package | Description |
---|---|
org.springframework.aop |
Core Spring AOP interfaces, built on AOP Alliance AOP interoperability interfaces.
|
org.springframework.aop.aspectj |
AspectJ integration package.
|
org.springframework.aop.aspectj.annotation |
Classes enabling AspectJ 5 @Annotated classes to be used in Spring AOP.
|
org.springframework.aop.config |
Support package for declarative AOP configuration,
with XML schema being the primary configuration format.
|
org.springframework.aop.framework |
Package containing Spring's basic AOP infrastructure, compliant with the
AOP Alliance interfaces.
|
org.springframework.aop.framework.adapter |
SPI package allowing Spring AOP framework to handle arbitrary advice types.
|
org.springframework.aop.framework.autoproxy |
Bean post-processors for use in ApplicationContexts to simplify AOP usage
by automatically creating AOP proxies without the need to use a ProxyFactoryBean.
|
org.springframework.aop.framework.autoproxy.target |
Various
TargetSourceCreator
implementations for use with Spring's AOP auto-proxying support. |
org.springframework.aop.interceptor |
Provides miscellaneous interceptor implementations.
|
org.springframework.aop.scope |
Support for AOP-based scoping of target objects, with configurable backend.
|
org.springframework.aop.support |
Convenience classes for using Spring's AOP API.
|
org.springframework.aop.support.annotation |
Annotation support for AOP pointcuts.
|
org.springframework.aop.target | |
org.springframework.aop.target.dynamic | |
org.springframework.beans |
This package contains interfaces and classes for manipulating Java beans.
|
org.springframework.beans.annotation |
Support package for beans-style handling of annotations.
|
org.springframework.beans.factory |
The core package implementing Spring's lightweight Inversion of Control (IoC) container.
|
org.springframework.beans.factory.annotation |
Support package for annotation-driven bean configuration.
|
org.springframework.beans.factory.config |
SPI interfaces and configuration-related convenience classes for bean factories.
|
org.springframework.beans.factory.parsing |
Support infrastructure for bean definition parsing.
|
org.springframework.beans.factory.serviceloader |
Support package for the Java
ServiceLoader facility. |
org.springframework.beans.factory.support |
Classes supporting the
org.springframework.beans.factory package. |
org.springframework.beans.factory.wiring |
Mechanism to determine bean wiring metadata from a bean instance.
|
org.springframework.beans.factory.xml |
Contains an abstract XML-based
BeanFactory implementation,
including a standard "spring-beans" XSD. |
org.springframework.beans.propertyeditors |
Properties editors used to convert from String values to object
types such as java.util.Properties.
|
org.springframework.beans.support |
Classes supporting the org.springframework.beans package,
such as utility classes for sorting and holding lists of beans.
|
org.springframework.cache |
Spring's generic cache abstraction.
|
org.springframework.cache.annotation |
Annotations and supporting classes for declarative cache management.
|
org.springframework.cache.caffeine |
Support classes for the open source cache in
Caffeine library,
allowing to set up Caffeine caches within Spring's cache abstraction.
|
org.springframework.cache.concurrent |
Implementation package for
java.util.concurrent based caches. |
org.springframework.cache.ehcache |
Support classes for the open source cache
EhCache 2.x,
allowing to set up an EhCache CacheManager and Caches
as beans in a Spring context.
|
org.springframework.cache.interceptor |
AOP-based solution for declarative caching demarcation.
|
org.springframework.cache.jcache |
Implementation package for JSR-107 (javax.cache aka "JCache") based caches.
|
org.springframework.cache.jcache.config |
Support package for declarative JSR-107 caching configuration.
|
org.springframework.cache.jcache.interceptor |
AOP-based solution for declarative caching demarcation using JSR-107 annotations.
|
org.springframework.cache.support |
Support classes for the org.springframework.cache package.
|
org.springframework.cache.transaction |
Transaction-aware decorators for the org.springframework.cache package.
|
org.springframework.context |
This package builds on the beans package to add support for
message sources and for the Observer design pattern, and the
ability for application objects to obtain resources using a
consistent API.
|
org.springframework.context.annotation |
Annotation support for the Application Context, including JSR-250 "common"
annotations, component-scanning, and Java-based metadata for creating
Spring-managed objects.
|
org.springframework.context.event |
Support classes for application events, like standard context events.
|
org.springframework.context.expression |
Expression parsing support within a Spring application context.
|
org.springframework.context.i18n |
Abstraction for determining the current Locale,
plus global holder that exposes a thread-bound Locale.
|
org.springframework.context.index |
Support package for reading and managing the components index.
|
org.springframework.context.support |
Classes supporting the org.springframework.context package,
such as abstract base classes for ApplicationContext
implementations and a MessageSource implementation.
|
org.springframework.context.weaving |
Load-time weaving support for a Spring application context, building on Spring's
LoadTimeWeaver abstraction. |
org.springframework.core |
Provides basic classes for exception handling and version detection,
and other core helpers that are not specific to any part of the framework.
|
org.springframework.core.annotation |
Core support package for annotations, meta-annotations, and merged
annotations with attribute overrides.
|
org.springframework.core.codec | |
org.springframework.core.convert |
Type conversion system API.
|
org.springframework.core.convert.converter |
SPI to implement Converters for the type conversion system.
|
org.springframework.core.convert.support |
Default implementation of the type conversion system.
|
org.springframework.core.env |
Spring's environment abstraction consisting of bean definition
profile and hierarchical property source support.
|
org.springframework.core.io |
Generic abstraction for (file-based) resources, used throughout the framework.
|
org.springframework.core.io.buffer |
Generic abstraction for working with byte buffer implementations.
|
org.springframework.core.io.support |
Support classes for Spring's resource abstraction.
|
org.springframework.core.log |
Useful delegates for Spring's logging conventions.
|
org.springframework.core.metrics |
Support package for recording metrics during application startup.
|
org.springframework.core.serializer |
Root package for Spring's serializer interfaces and implementations.
|
org.springframework.core.serializer.support |
Support classes for Spring's serializer abstraction.
|
org.springframework.core.style |
Support for styling values as Strings, with ToStringCreator as central class.
|
org.springframework.core.task |
This package defines Spring's core TaskExecutor abstraction,
and provides SyncTaskExecutor and SimpleAsyncTaskExecutor implementations.
|
org.springframework.core.task.support |
Support classes for Spring's TaskExecutor abstraction.
|
org.springframework.core.type |
Core support package for type introspection.
|
org.springframework.core.type.classreading |
Support classes for reading annotation and class-level metadata.
|
org.springframework.core.type.filter |
Core support package for type filtering (e.g.
|
org.springframework.dao |
Exception hierarchy enabling sophisticated error handling independent
of the data access approach in use.
|
org.springframework.dao.support |
Support classes for DAO implementations,
providing miscellaneous utility methods.
|
org.springframework.ejb.access |
This package contains classes that allow easy access to EJBs.
|
org.springframework.expression |
Core abstractions behind the Spring Expression Language.
|
org.springframework.expression.common |
Common utility classes behind the Spring Expression Language.
|
org.springframework.expression.spel |
SpEL's central implementation package.
|
org.springframework.expression.spel.ast |
SpEL's abstract syntax tree.
|
org.springframework.expression.spel.standard |
SpEL's standard parser implementation.
|
org.springframework.expression.spel.support |
SpEL's default implementations for various core abstractions.
|
org.springframework.format.datetime.joda |
Integration with Joda-Time for formatting Joda date and time types as well as standard JDK Date types.
|
org.springframework.format.datetime.standard |
Integration with the JSR-310
java.time package in JDK 8. |
org.springframework.format.support |
Support classes for the formatting package,
providing common implementations as well as adapters.
|
org.springframework.http |
Contains a basic abstraction over client/server-side HTTP.
|
org.springframework.http.client |
Contains an abstraction over client-side HTTP.
|
org.springframework.http.client.reactive |
Abstractions for reactive HTTP client support including
ClientHttpRequest and
ClientHttpResponse as well as a
ClientHttpConnector . |
org.springframework.http.client.support |
This package provides generic HTTP support classes,
to be used by higher-level classes like RestTemplate.
|
org.springframework.http.codec | |
org.springframework.http.codec.json |
JSON encoder and decoder support.
|
org.springframework.http.codec.multipart |
Multipart support.
|
org.springframework.http.codec.protobuf |
Provides an encoder and a decoder for
Google Protocol Buffers.
|
org.springframework.http.codec.xml |
XML encoder and decoder support.
|
org.springframework.http.converter |
Provides an HttpMessageConverter abstraction to convert between Java objects and HTTP input/output messages.
|
org.springframework.http.converter.json |
Provides HttpMessageConverter implementations for handling JSON.
|
org.springframework.http.converter.protobuf |
Provides an HttpMessageConverter implementation for handling
Google Protocol Buffers.
|
org.springframework.http.converter.xml |
Provides HttpMessageConverter implementations for handling XML.
|
org.springframework.http.server |
Contains an abstraction over server-side HTTP.
|
org.springframework.http.server.reactive |
Abstractions for reactive HTTP server support including a
ServerHttpRequest and
ServerHttpResponse along with an
HttpHandler for processing. |
org.springframework.instrument.classloading |
Support package for load time weaving based on class loaders,
as required by JPA providers (but not JPA-specific).
|
org.springframework.instrument.classloading.glassfish |
Support for class instrumentation on GlassFish.
|
org.springframework.instrument.classloading.jboss |
Support for class instrumentation on JBoss AS 6 and 7.
|
org.springframework.instrument.classloading.tomcat |
Support for class instrumentation on Tomcat.
|
org.springframework.instrument.classloading.weblogic |
Support for class instrumentation on BEA WebLogic 10+.
|
org.springframework.instrument.classloading.websphere |
Support for class instrumentation on IBM WebSphere Application Server 7+.
|
org.springframework.jca.cci.connection |
Provides a utility class for easy ConnectionFactory access,
a PlatformTransactionManager for local CCI transactions,
and various simple ConnectionFactory proxies/adapters.
|
org.springframework.jca.cci.core |
Provides the core JCA CCI support, based on CciTemplate
and its associated callback interfaces.
|
org.springframework.jca.cci.core.support |
Classes supporting the
org.springframework.jca.cci.core package. |
org.springframework.jca.cci.object |
The classes in this package represent EIS operations as threadsafe,
reusable objects.
|
org.springframework.jca.context |
Integration package that allows for deploying a Spring application context
as a JCA 1.7 compliant RAR file.
|
org.springframework.jca.endpoint |
This package provides a facility for generic JCA message endpoint management.
|
org.springframework.jca.support |
Provides generic support classes for JCA usage within Spring,
mainly for local setup of a JCA ResourceAdapter and/or ConnectionFactory.
|
org.springframework.jca.work |
Convenience classes for scheduling based on the JCA WorkManager facility,
as supported within ResourceAdapters.
|
org.springframework.jdbc |
The classes in this package make JDBC easier to use and
reduce the likelihood of common errors.
|
org.springframework.jdbc.core |
Provides the core JDBC framework, based on JdbcTemplate
and its associated callback interfaces and helper objects.
|
org.springframework.jdbc.core.metadata |
Context metadata abstraction for the configuration and execution
of table inserts and stored procedure calls.
|
org.springframework.jdbc.core.namedparam |
JdbcTemplate variant with named parameter support.
|
org.springframework.jdbc.core.simple |
Simplification layer for table inserts and stored procedure calls.
|
org.springframework.jdbc.core.support |
Classes supporting the
org.springframework.jdbc.core package. |
org.springframework.jdbc.datasource |
Provides a utility class for easy DataSource access,
a PlatformTransactionManager for a single DataSource,
and various simple DataSource implementations.
|
org.springframework.jdbc.datasource.embedded |
Provides extensible support for creating embedded database instances.
|
org.springframework.jdbc.datasource.init |
Provides extensible support for initializing databases through scripts.
|
org.springframework.jdbc.datasource.lookup |
Provides a strategy for looking up JDBC DataSources by name.
|
org.springframework.jdbc.object |
The classes in this package represent RDBMS queries, updates,
and stored procedures as threadsafe, reusable objects.
|
org.springframework.jdbc.support |
Support classes for the JDBC framework, used by the classes in the
jdbc.core and jdbc.object packages.
|
org.springframework.jdbc.support.lob |
Provides a strategy interface for Large OBject handling,
as well as a customizable default implementation.
|
org.springframework.jdbc.support.rowset |
Provides a convenient holder for disconnected result sets.
|
org.springframework.jdbc.support.xml |
Abstraction for handling fields of SQLXML data type.
|
org.springframework.jms |
This package contains integration classes for JMS,
allowing for Spring-style JMS access.
|
org.springframework.jms.config |
Support package for declarative messaging configuration,
with Java configuration and XML schema support.
|
org.springframework.jms.connection |
Provides a PlatformTransactionManager implementation for a single
JMS ConnectionFactory, and a SingleConnectionFactory adapter.
|
org.springframework.jms.core |
Core package of the JMS support.
|
org.springframework.jms.core.support |
Classes supporting the
org.springframework.jms.core package. |
org.springframework.jms.listener |
This package contains the base message listener container facility.
|
org.springframework.jms.listener.adapter |
Message listener adapter mechanism that delegates to target listener
methods, converting messages to appropriate message content types
(such as String or byte array) that get passed into listener methods.
|
org.springframework.jms.listener.endpoint |
This package provides JCA-based endpoint management for JMS message listeners.
|
org.springframework.jms.remoting |
Remoting classes for transparent Java-to-Java remoting via a JMS provider.
|
org.springframework.jms.support |
This package provides generic JMS support classes,
to be used by higher-level classes like JmsTemplate.
|
org.springframework.jms.support.converter |
Provides a MessageConverter abstraction to convert
between Java objects and JMS messages.
|
org.springframework.jms.support.destination |
Support classes for Spring's JMS framework.
|
org.springframework.jmx.access |
Provides support for accessing remote MBean resources.
|
org.springframework.jmx.export |
This package provides declarative creation and registration of
Spring-managed beans as JMX MBeans.
|
org.springframework.jmx.export.annotation |
Annotations for MBean exposure.
|
org.springframework.jmx.export.assembler |
Provides a strategy for MBeanInfo assembly.
|
org.springframework.jmx.export.metadata |
Provides generic JMX metadata classes and basic support for reading
JMX metadata in a provider-agnostic manner.
|
org.springframework.jmx.export.naming |
Provides a strategy for ObjectName creation.
|
org.springframework.jmx.support |
Contains support classes for connecting to local and remote
MBeanServer s
and for exposing an MBeanServer to remote clients. |
org.springframework.jndi |
The classes in this package make JNDI easier to use,
facilitating the accessing of configuration stored in JNDI,
and provide useful superclasses for JNDI access classes.
|
org.springframework.jndi.support |
Support classes for JNDI usage,
including a JNDI-based BeanFactory implementation.
|
org.springframework.mail |
Spring's generic mail infrastructure.
|
org.springframework.mail.javamail |
JavaMail support for Spring's mail infrastructure.
|
org.springframework.messaging |
Support for working with messaging APIs and protocols.
|
org.springframework.messaging.converter |
Provides support for message conversion.
|
org.springframework.messaging.core |
Defines interfaces and implementation classes for messaging templates.
|
org.springframework.messaging.handler |
Basic abstractions for working with message handler methods.
|
org.springframework.messaging.handler.annotation.reactive |
Support classes for working with annotated message-handling methods with
non-blocking, reactive contracts.
|
org.springframework.messaging.handler.annotation.support |
Support classes for working with annotated message-handling methods.
|
org.springframework.messaging.handler.invocation |
Common infrastructure for invoking message handler methods.
|
org.springframework.messaging.handler.invocation.reactive |
Common infrastructure for invoking message handler methods with non-blocking,
and reactive contracts.
|
org.springframework.messaging.rsocket |
Support for the RSocket protocol.
|
org.springframework.messaging.rsocket.annotation.support |
Support classes for working with annotated RSocket stream handling methods.
|
org.springframework.messaging.simp |
Generic support for Simple Messaging Protocols including protocols such as STOMP.
|
org.springframework.messaging.simp.annotation.support |
Support classes for handling messages from simple messaging protocols
(like STOMP).
|
org.springframework.messaging.simp.broker |
Provides a "simple" message broker implementation along with an abstract base
class and other supporting types such as a registry for subscriptions.
|
org.springframework.messaging.simp.config |
Configuration support for WebSocket messaging using higher level messaging protocols.
|
org.springframework.messaging.simp.stomp |
Generic support for simple messaging protocols (like STOMP).
|
org.springframework.messaging.simp.user |
Support for handling messages to "user" destinations (i.e.
|
org.springframework.messaging.support |
Provides implementations of
Message along with
a MessageBuilder and MessageHeaderAccessor for building and working with messages and
message headers, as well as various MessageChannel
implementations and channel interceptor support. |
org.springframework.messaging.tcp |
Contains abstractions and implementation classes for establishing TCP connections via
TcpOperations ,
handling messages via
TcpConnectionHandler ,
as well as sending messages via
TcpConnection . |
org.springframework.mock.http.server.reactive |
Mock implementations of reactive HTTP server contracts.
|
org.springframework.mock.jndi |
Deprecated as of Spring Framework 5.2 in favor of complete
solutions from third parties such as
Simple-JNDI.
|
org.springframework.mock.web |
A comprehensive set of Servlet API 4.0 mock objects, targeted at usage with
Spring's Web MVC framework.
|
org.springframework.mock.web.server |
Mock implementations of Spring's reactive server web API abstractions.
|
org.springframework.orm |
Root package for Spring's O/R Mapping integration classes.
|
org.springframework.orm.hibernate5 |
Package providing integration of
Hibernate 5.x
with Spring concepts.
|
org.springframework.orm.hibernate5.support |
Classes supporting the
org.springframework.orm.hibernate5 package. |
org.springframework.orm.jpa |
Package providing integration of JPA (Java Persistence API) with Spring concepts.
|
org.springframework.orm.jpa.persistenceunit |
Internal support for managing JPA persistence units.
|
org.springframework.orm.jpa.support |
Classes supporting the
org.springframework.orm.jpa package. |
org.springframework.orm.jpa.vendor |
Support classes for adapting to specific JPA vendors.
|
org.springframework.oxm.jaxb |
Package providing integration of JAXB
with Spring's O/X Mapping support.
|
org.springframework.oxm.jibx |
Package providing integration of JiBX
with Spring's O/X Mapping support.
|
org.springframework.oxm.mime |
Contains (un)marshallers optimized to store binary data in MIME attachments.
|
org.springframework.oxm.support |
Provides generic support classes for using Spring's O/X Mapping integration
within various scenario's.
|
org.springframework.oxm.xstream |
Package providing integration of XStream
with Spring's O/X Mapping support.
|
org.springframework.r2dbc |
The classes in this package make R2DBC easier to use and
reduce the likelihood of common errors.
|
org.springframework.r2dbc.connection |
Provides a utility class for easy ConnectionFactory access,
a ReactiveTransactionManager for a single ConnectionFactory,
and various simple ConnectionFactory implementations.
|
org.springframework.r2dbc.connection.init |
Provides extensible support for initializing databases through scripts.
|
org.springframework.r2dbc.core |
Core domain types around DatabaseClient.
|
org.springframework.r2dbc.core.binding |
Classes providing an abstraction over SQL bind markers.
|
org.springframework.remoting.caucho |
This package provides remoting classes for Caucho's Hessian protocol:
a proxy factory for accessing Hessian services, and an exporter for
making beans available to Hessian clients.
|
org.springframework.remoting.httpinvoker |
Remoting classes for transparent Java-to-Java remoting via HTTP invokers.
|
org.springframework.remoting.jaxws |
Remoting classes for Web Services via JAX-WS (the successor of JAX-RPC),
as included in Java 6 and Java EE 5.
|
org.springframework.remoting.rmi |
Remoting classes for conventional RMI and transparent remoting via
RMI invokers.
|
org.springframework.remoting.support |
Generic support classes for remoting implementations.
|
org.springframework.scheduling |
General exceptions for Spring's scheduling support,
independent of any specific scheduling system.
|
org.springframework.scheduling.annotation |
Annotation support for asynchronous method execution.
|
org.springframework.scheduling.commonj |
Convenience classes for scheduling based on the CommonJ WorkManager/TimerManager
facility, as supported by IBM WebSphere 6.0+ and BEA WebLogic 9.0+.
|
org.springframework.scheduling.concurrent |
Scheduling convenience classes for the
java.util.concurrent
and javax.enterprise.concurrent packages, allowing to set up a
ThreadPoolExecutor or ScheduledThreadPoolExecutor as a bean in a Spring
context. |
org.springframework.scheduling.config |
Support package for declarative scheduling configuration,
with XML schema being the primary configuration format.
|
org.springframework.scheduling.quartz |
Support classes for the open source scheduler
Quartz,
allowing to set up Quartz Schedulers, JobDetails and
Triggers as beans in a Spring context.
|
org.springframework.scheduling.support |
Generic support classes for scheduling.
|
org.springframework.scripting |
Core interfaces for Spring's scripting support.
|
org.springframework.scripting.bsh |
Package providing integration of
BeanShell
(and BeanShell2)
into Spring's scripting infrastructure.
|
org.springframework.scripting.groovy |
Package providing integration of
Groovy
into Spring's scripting infrastructure.
|
org.springframework.scripting.support |
Support classes for Spring's scripting package.
|
org.springframework.test.annotation |
Support classes for annotation-driven tests.
|
org.springframework.test.context |
This package contains the Spring TestContext Framework which
provides annotation-driven unit and integration testing support that is
agnostic of the actual testing framework in use.
|
org.springframework.test.context.cache |
Support for context caching within the Spring TestContext Framework.
|
org.springframework.test.context.event |
Test event support classes for the Spring TestContext Framework.
|
org.springframework.test.context.junit.jupiter |
Core support for integrating the Spring TestContext Framework
with the JUnit Jupiter extension model in JUnit 5.
|
org.springframework.test.context.junit4 |
Support classes for integrating the Spring TestContext Framework
with JUnit 4.12 or higher.
|
org.springframework.test.context.junit4.statements |
Custom JUnit 4
Statements used in the Spring TestContext Framework. |
org.springframework.test.context.support |
Support classes for the Spring TestContext Framework.
|
org.springframework.test.context.testng |
Support classes for integrating the Spring TestContext Framework
with TestNG.
|
org.springframework.test.context.transaction |
Transactional support classes for the Spring TestContext Framework.
|
org.springframework.test.context.web |
Web support classes for the Spring TestContext Framework.
|
org.springframework.test.util |
General utility classes for use in unit and integration tests.
|
org.springframework.test.web.client |
Contains client-side REST testing support.
|
org.springframework.test.web.client.match |
Contains built-in
RequestMatcher
implementations. |
org.springframework.test.web.client.response |
Contains built-in
ResponseCreator
implementations. |
org.springframework.test.web.reactive.server |
Support for testing Spring WebFlux server endpoints via
WebTestClient . |
org.springframework.test.web.servlet |
Contains server-side support for testing Spring MVC applications.
|
org.springframework.test.web.servlet.client |
Support for testing Spring MVC applications via
WebTestClient
with MockMvc for server request
handling. |
org.springframework.test.web.servlet.htmlunit |
Server-side support for testing Spring MVC applications with
MockMvc
and HtmlUnit. |
org.springframework.test.web.servlet.request |
Contains built-in
RequestBuilder
implementations. |
org.springframework.test.web.servlet.result |
Contains built-in
ResultMatcher and ResultHandler implementations. |
org.springframework.test.web.servlet.setup |
Contains built-in
MockMvcBuilder implementations. |
org.springframework.transaction |
Spring's core transaction management APIs (independent of any specific transaction
management system); an exception hierarchy for Spring's transaction infrastructure;
and transaction manager, definition, and status interfaces.
|
org.springframework.transaction.annotation |
Spring's support for annotation-based transaction demarcation.
|
org.springframework.transaction.config |
Support package for declarative transaction configuration,
with XML schema being the primary configuration format.
|
org.springframework.transaction.event |
Spring's support for listening to transaction events.
|
org.springframework.transaction.interceptor |
AOP-based solution for declarative transaction demarcation.
|
org.springframework.transaction.jta |
Transaction SPI implementation for JTA.
|
org.springframework.transaction.reactive |
Support classes for reactive transaction management.
|
org.springframework.transaction.support |
Support classes for the org.springframework.transaction package.
|
org.springframework.ui |
Generic support for UI layer concepts.
|
org.springframework.ui.context |
Contains classes defining the application context subinterface
for UI applications.
|
org.springframework.ui.context.support |
Classes supporting the org.springframework.ui.context package.
|
org.springframework.ui.freemarker |
Support classes for setting up
FreeMarker
within a Spring application context.
|
org.springframework.util |
Miscellaneous utility classes, such as utilities for working with strings,
classes, collections, reflection, etc.
|
org.springframework.util.comparator |
Useful generic
java.util.Comparator implementations,
such as an invertible comparator and a compound comparator. |
org.springframework.util.concurrent |
Useful generic
java.util.concurrent.Future extensions. |
org.springframework.util.function |
Useful generic
java.util.function helper classes. |
org.springframework.util.unit |
Useful unit data types.
|
org.springframework.util.xml |
Miscellaneous utility classes for XML parsing and transformation,
such as error handlers that log warnings via Commons Logging.
|
org.springframework.validation |
Provides data binding and validation functionality,
for usage in business and/or UI layers.
|
org.springframework.validation.annotation |
Support classes for annotation-based constraint evaluation,
e.g.
|
org.springframework.validation.beanvalidation |
Support classes for integrating a JSR-303 Bean Validation provider
(such as Hibernate Validator) into a Spring ApplicationContext
and in particular with Spring's data binding and validation APIs.
|
org.springframework.validation.support |
Support classes for handling validation results.
|
org.springframework.web |
Common, generic interfaces that define minimal boundary points
between Spring's web infrastructure and other framework modules.
|
org.springframework.web.accept |
This package contains classes used to determine the requested the media types in a request.
|
org.springframework.web.bind |
Provides web-specific data binding functionality.
|
org.springframework.web.bind.support |
Support classes for web data binding.
|
org.springframework.web.client |
Core package of the client-side web support.
|
org.springframework.web.context |
Contains a variant of the application context interface for web applications,
and the ContextLoaderListener that bootstraps a root web application context.
|
org.springframework.web.context.request |
Support for generic request context holding, in particular for
scoping of application objects per HTTP request or HTTP session.
|
org.springframework.web.context.request.async |
Support for asynchronous request processing.
|
org.springframework.web.context.support |
Classes supporting the
org.springframework.web.context package,
such as WebApplicationContext implementations and various utility classes. |
org.springframework.web.cors |
Support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor strategy. |
org.springframework.web.cors.reactive |
Reactive support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor strategy. |
org.springframework.web.filter |
Provides generic filter base classes allowing for bean-style configuration.
|
org.springframework.web.jsf |
Support classes for integrating a JSF web layer with a Spring service layer
which is hosted in a Spring root WebApplicationContext.
|
org.springframework.web.jsf.el |
ELResolvers for integrating a JSF web layer with a Spring service layer
which is hosted in a Spring root WebApplicationContext.
|
org.springframework.web.method |
Common infrastructure for handler method processing, as used by
Spring MVC's
org.springframework.web.servlet.mvc.method package. |
org.springframework.web.method.annotation |
Support classes for annotation-based handler method processing.
|
org.springframework.web.method.support |
Generic support classes for handler method processing.
|
org.springframework.web.multipart |
Multipart resolution framework for handling file uploads.
|
org.springframework.web.multipart.commons |
MultipartResolver implementation for
Apache Commons FileUpload.
|
org.springframework.web.multipart.support |
Support classes for the multipart resolution framework.
|
org.springframework.web.reactive |
Top-level package for the
spring-webflux module that contains
DispatcherHandler , the main entry
point for WebFlux server endpoint processing including key contracts used to
map requests to handlers, invoke them, and process the result. |
org.springframework.web.reactive.config |
Spring WebFlux configuration infrastructure.
|
org.springframework.web.reactive.function |
Provides a foundation for both the reactive client and server subpackages.
|
org.springframework.web.reactive.function.client |
Provides a reactive
WebClient
that builds on top of the
org.springframework.http.client.reactive reactive HTTP adapter layer. |
org.springframework.web.reactive.function.server |
Provides the types that make up Spring's functional web framework for Reactive environments.
|
org.springframework.web.reactive.function.server.support |
Classes supporting the
org.springframework.web.reactive.function.server package. |
org.springframework.web.reactive.handler |
Provides HandlerMapping implementations including abstract base classes.
|
org.springframework.web.reactive.resource |
Support classes for serving static resources.
|
org.springframework.web.reactive.result |
Support for various programming model styles including the invocation of
different types of handlers, e.g.
|
org.springframework.web.reactive.result.condition |
RequestCondition
and implementations for matching requests based on different criteria. |
org.springframework.web.reactive.result.method |
Infrastructure for handler method processing.
|
org.springframework.web.reactive.result.method.annotation |
Infrastructure for annotation-based handler method processing.
|
org.springframework.web.reactive.result.view |
Support for result handling through view resolution.
|
org.springframework.web.reactive.result.view.freemarker |
Support classes for the integration of
FreeMarker
as Spring web view technology.
|
org.springframework.web.reactive.result.view.script |
Support classes for views based on the JSR-223 script engine abstraction
(as included in Java 6+), e.g.
|
org.springframework.web.reactive.socket |
Abstractions and support classes for reactive WebSocket interactions.
|
org.springframework.web.reactive.socket.adapter |
Classes adapting Spring's Reactive WebSocket API to and from WebSocket runtimes.
|
org.springframework.web.reactive.socket.server |
Server support for WebSocket interactions.
|
org.springframework.web.reactive.socket.server.support |
Server-side support classes for WebSocket requests.
|
org.springframework.web.reactive.socket.server.upgrade |
Holds implementations of
RequestUpgradeStrategy . |
org.springframework.web.server |
Core interfaces and classes for Spring's generic, reactive web support.
|
org.springframework.web.server.adapter |
Implementations to adapt to the underlying
org.springframework.http.client.reactive reactive HTTP adapter
and HttpHandler . |
org.springframework.web.server.handler |
Provides common WebHandler implementations and a
WebHandlerDecorator . |
org.springframework.web.server.i18n |
Locale related support classes.
|
org.springframework.web.servlet |
Provides servlets that integrate with the application context
infrastructure, and the core interfaces and classes for the
Spring web MVC framework.
|
org.springframework.web.servlet.config |
Defines the XML configuration namespace for Spring MVC.
|
org.springframework.web.servlet.config.annotation |
Annotation-based setup for Spring MVC.
|
org.springframework.web.servlet.function |
Provides the types that make up Spring's functional web framework for Servlet environments.
|
org.springframework.web.servlet.function.support |
Classes supporting the
org.springframework.web.servlet.function package. |
org.springframework.web.servlet.handler |
Provides standard HandlerMapping implementations,
including abstract base classes for custom implementations.
|
org.springframework.web.servlet.i18n |
Locale support classes for Spring's web MVC framework.
|
org.springframework.web.servlet.mvc |
Standard controller implementations for the Servlet MVC framework that comes with
Spring.
|
org.springframework.web.servlet.mvc.annotation |
Support package for annotation-based Servlet MVC controllers.
|
org.springframework.web.servlet.mvc.condition |
Common MVC logic for matching incoming requests based on conditions.
|
org.springframework.web.servlet.mvc.method |
Servlet-based infrastructure for handler method processing,
building on the
org.springframework.web.method package. |
org.springframework.web.servlet.mvc.method.annotation |
MVC infrastructure for annotation-based handler method processing, building on the
org.springframework.web.method.annotation package. |
org.springframework.web.servlet.mvc.support |
Support package for MVC controllers.
|
org.springframework.web.servlet.resource |
Support classes for serving static resources.
|
org.springframework.web.servlet.support |
Support classes for Spring's web MVC framework.
|
org.springframework.web.servlet.tags |
This package contains Spring's JSP standard tag library for JSP 2.0+.
|
org.springframework.web.servlet.tags.form |
Spring's form tag library for JSP views in Spring's Web MVC framework.
|
org.springframework.web.servlet.theme |
Theme support classes for Spring's web MVC framework.
|
org.springframework.web.servlet.view |
Provides standard View and ViewResolver implementations,
including abstract base classes for custom implementations.
|
org.springframework.web.servlet.view.freemarker |
Support classes for the integration of
FreeMarker
as Spring web view technology.
|
org.springframework.web.servlet.view.json |
Support classes for providing a View implementation based on JSON serialization.
|
org.springframework.web.servlet.view.script |
Support classes for views based on the JSR-223 script engine abstraction
(as included in Java 6+), e.g.
|
org.springframework.web.servlet.view.tiles3 |
Support classes for the integration of
Tiles 3
(the standalone version of Tiles) as Spring web view technology.
|
org.springframework.web.servlet.view.xml |
Support classes for providing a View implementation based on XML Marshalling.
|
org.springframework.web.servlet.view.xslt |
Support classes for XSLT,
providing a View implementation for XSLT stylesheets.
|
org.springframework.web.socket |
Common abstractions and Spring configuration support for WebSocket applications.
|
org.springframework.web.socket.adapter |
Classes adapting Spring's WebSocket API to and from WebSocket providers.
|
org.springframework.web.socket.adapter.jetty |
Adapter classes for the Jetty WebSocket API.
|
org.springframework.web.socket.adapter.standard |
Adapter classes for the standard Java WebSocket API.
|
org.springframework.web.socket.client |
Client-side abstractions for WebSocket applications.
|
org.springframework.web.socket.client.jetty |
Client-side support for the Jetty WebSocket API.
|
org.springframework.web.socket.client.standard |
Client-side classes for use with standard Java WebSocket endpoints.
|
org.springframework.web.socket.config.annotation |
Support for annotation-based WebSocket setup in configuration classes.
|
org.springframework.web.socket.handler |
Convenient
WebSocketHandler
implementations and decorators. |
org.springframework.web.socket.messaging |
WebSocket integration for Spring's messaging module.
|
org.springframework.web.socket.server |
Server-side abstractions for WebSocket interactions.
|
org.springframework.web.socket.server.jetty |
Server-side support for the Jetty 9+ WebSocket API.
|
org.springframework.web.socket.server.standard |
Server-side classes for use with standard JSR-356 WebSocket endpoints.
|
org.springframework.web.socket.server.support |
Server-side support classes including container-specific strategies
for upgrading a request.
|
org.springframework.web.socket.sockjs |
Top-level SockJS types.
|
org.springframework.web.socket.sockjs.client |
SockJS client implementation of
WebSocketClient . |
org.springframework.web.socket.sockjs.frame |
Support classes for creating SockJS frames including the encoding and decoding
of SockJS message frames.
|
org.springframework.web.socket.sockjs.support |
Support classes for SockJS including an
AbstractSockJsService
implementation. |
org.springframework.web.socket.sockjs.transport |
Server-side support for SockJS transports including
TransportHandler implementations
for processing incoming requests, their
session
counterparts for sending messages over the various transports, and
DefaultSockJsService . |
org.springframework.web.socket.sockjs.transport.handler |
TransportHandler
implementation classes as well as a concrete
SockJsService . |
org.springframework.web.socket.sockjs.transport.session |
SockJS specific implementations of
WebSocketSession . |
org.springframework.web.util |
Miscellaneous web utility classes, such as HTML escaping and cookie handling.
|
org.springframework.web.util.pattern |
Dedicated support for matching HTTP request paths.
|
Modifier and Type | Method and Description |
---|---|
Object |
TargetSource.getTarget()
Return a target instance.
|
Class<?> |
TargetClassAware.getTargetClass()
Return the target class behind the implementing object
(typically a proxy configuration or an actual proxy).
|
Class<?> |
TargetSource.getTargetClass()
Return the type of targets returned by this
TargetSource . |
Object |
ProxyMethodInvocation.getUserAttribute(String key)
Return the value of the specified user attribute.
|
Modifier and Type | Method and Description |
---|---|
void |
AfterReturningAdvice.afterReturning(Object returnValue,
Method method,
Object[] args,
Object target)
Callback after a given method successfully returned.
|
void |
AfterReturningAdvice.afterReturning(Object returnValue,
Method method,
Object[] args,
Object target)
Callback after a given method successfully returned.
|
void |
MethodBeforeAdvice.before(Method method,
Object[] args,
Object target)
Callback before a given method is invoked.
|
void |
ProxyMethodInvocation.setUserAttribute(String key,
Object value)
Add the specified user attribute with the given value to this invocation.
|
Modifier and Type | Method and Description |
---|---|
ClassLoader |
SingletonAspectInstanceFactory.getAspectClassLoader() |
ClassLoader |
SimpleAspectInstanceFactory.getAspectClassLoader() |
ClassLoader |
AbstractAspectJAdvice.getAspectClassLoader()
Return the ClassLoader for aspect instances.
|
ClassLoader |
AspectInstanceFactory.getAspectClassLoader()
Expose the aspect class loader that this factory uses.
|
static AspectJPrecedenceInformation |
AspectJAopUtils.getAspectJPrecedenceInformationFor(Advisor anAdvisor)
Return the AspectJPrecedenceInformation provided by this advisor or its advice.
|
protected String |
AspectJExpressionPointcut.getCurrentProxiedBeanName() |
protected Type |
AbstractAspectJAdvice.getDiscoveredReturningGenericType() |
String |
AspectJExpressionPointcutAdvisor.getExpression() |
protected org.aspectj.weaver.tools.JoinPointMatch |
AbstractAspectJAdvice.getJoinPointMatch()
Get the current join point match at the join point we are being dispatched on.
|
protected org.aspectj.weaver.tools.JoinPointMatch |
AbstractAspectJAdvice.getJoinPointMatch(ProxyMethodInvocation pmi) |
String |
AspectJExpressionPointcutAdvisor.getLocation() |
String[] |
AspectJAdviceParameterNameDiscoverer.getParameterNames(Constructor<?> ctor)
An advice method can never be a constructor in Spring.
|
String[] |
AspectJAdviceParameterNameDiscoverer.getParameterNames(Method method)
Deduce the parameter names for an advice method.
|
Object |
MethodInvocationProceedingJoinPoint.getTarget()
Returns the Spring AOP target.
|
Object |
AspectJAfterThrowingAdvice.invoke(MethodInvocation mi) |
Object |
AspectJAfterAdvice.invoke(MethodInvocation mi) |
Object |
AspectJAroundAdvice.invoke(MethodInvocation mi) |
Object |
MethodInvocationProceedingJoinPoint.proceed() |
Object |
MethodInvocationProceedingJoinPoint.proceed(Object[] arguments) |
Modifier and Type | Method and Description |
---|---|
void |
AspectJAfterReturningAdvice.afterReturning(Object returnValue,
Method method,
Object[] args,
Object target) |
void |
AspectJAfterReturningAdvice.afterReturning(Object returnValue,
Method method,
Object[] args,
Object target) |
protected Object[] |
AbstractAspectJAdvice.argBinding(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Take the arguments at the method execution join point and output a set of arguments
to the advice method.
|
protected Object[] |
AbstractAspectJAdvice.argBinding(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Take the arguments at the method execution join point and output a set of arguments
to the advice method.
|
protected Object[] |
AbstractAspectJAdvice.argBinding(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Take the arguments at the method execution join point and output a set of arguments
to the advice method.
|
void |
AspectJMethodBeforeAdvice.before(Method method,
Object[] args,
Object target) |
boolean |
AspectJPointcutAdvisor.equals(Object other) |
boolean |
AspectJExpressionPointcut.equals(Object other) |
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable t) |
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable t) |
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.lang.JoinPoint jp,
org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable t) |
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Invoke the advice method.
|
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Invoke the advice method.
|
protected Object |
AbstractAspectJAdvice.invokeAdviceMethod(org.aspectj.weaver.tools.JoinPointMatch jpMatch,
Object returnValue,
Throwable ex)
Invoke the advice method.
|
void |
AspectJExpressionPointcutAdvisor.setExpression(String expression) |
void |
AspectJExpressionPointcutAdvisor.setLocation(String location) |
void |
AspectJAdviceParameterNameDiscoverer.setReturningName(String returningName)
If
afterReturning advice binds the return value, the
returning variable name must be specified. |
void |
AspectJAdviceParameterNameDiscoverer.setThrowingName(String throwingName)
If
afterThrowing advice binds the thrown value, the
throwing variable name must be specified. |
Constructor and Description |
---|
AspectJAdviceParameterNameDiscoverer(String pointcutExpression)
Create a new discoverer that attempts to discover parameter names.
|
Modifier and Type | Method and Description |
---|---|
protected static AbstractAspectJAdvisorFactory.AspectJAnnotation<?> |
AbstractAspectJAdvisorFactory.findAspectJAnnotationOnMethod(Method method)
Find and return the first AspectJ annotation on the given method
(there should only be one anyway...).
|
Advice |
ReflectiveAspectJAdvisorFactory.getAdvice(Method candidateAdviceMethod,
AspectJExpressionPointcut expressionPointcut,
MetadataAwareAspectInstanceFactory aspectInstanceFactory,
int declarationOrder,
String aspectName) |
Advice |
AspectJAdvisorFactory.getAdvice(Method candidateAdviceMethod,
AspectJExpressionPointcut expressionPointcut,
MetadataAwareAspectInstanceFactory aspectInstanceFactory,
int declarationOrder,
String aspectName)
Build a Spring AOP Advice for the given AspectJ advice method.
|
Advisor |
ReflectiveAspectJAdvisorFactory.getAdvisor(Method candidateAdviceMethod,
MetadataAwareAspectInstanceFactory aspectInstanceFactory,
int declarationOrderInAspect,
String aspectName) |
Advisor |
AspectJAdvisorFactory.getAdvisor(Method candidateAdviceMethod,
MetadataAwareAspectInstanceFactory aspectInstanceFactory,
int declarationOrder,
String aspectName)
Build a Spring AOP Advisor for the given AspectJ advice method.
|
ClassLoader |
BeanFactoryAspectInstanceFactory.getAspectClassLoader() |
ClassLoader |
LazySingletonAspectInstanceFactoryDecorator.getAspectClassLoader() |
Object |
BeanFactoryAspectInstanceFactory.getAspectCreationMutex() |
Object |
MetadataAwareAspectInstanceFactory.getAspectCreationMutex()
Get the best possible creation mutex for this factory.
|
Object |
LazySingletonAspectInstanceFactoryDecorator.getAspectCreationMutex() |
Constructor and Description |
---|
BeanFactoryAspectInstanceFactory(BeanFactory beanFactory,
String name,
Class<?> type)
Create a BeanFactoryAspectInstanceFactory, providing a type that AspectJ should
introspect to create AJType metadata.
|
ReflectiveAspectJAdvisorFactory(BeanFactory beanFactory)
Create a new
ReflectiveAspectJAdvisorFactory , propagating the given
BeanFactory to the created AspectJExpressionPointcut instances,
for bean pointcut handling as well as consistent ClassLoader resolution. |
Modifier and Type | Method and Description |
---|---|
static BeanDefinition |
AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary(BeanDefinitionRegistry registry,
Object source) |
static BeanDefinition |
AopConfigUtils.registerAspectJAutoProxyCreatorIfNecessary(BeanDefinitionRegistry registry,
Object source) |
static BeanDefinition |
AopConfigUtils.registerAutoProxyCreatorIfNecessary(BeanDefinitionRegistry registry,
Object source) |
Constructor and Description |
---|
AdvisorComponentDefinition(String advisorBeanName,
BeanDefinition advisorDefinition,
BeanDefinition pointcutDefinition) |
AspectComponentDefinition(String aspectName,
BeanDefinition[] beanDefinitions,
BeanReference[] beanReferences,
Object source) |
AspectComponentDefinition(String aspectName,
BeanDefinition[] beanDefinitions,
BeanReference[] beanReferences,
Object source) |
AspectComponentDefinition(String aspectName,
BeanDefinition[] beanDefinitions,
BeanReference[] beanReferences,
Object source) |
Modifier and Type | Field and Description |
---|---|
protected Advisor |
AbstractAdvisingBeanPostProcessor.advisor |
protected Object |
ReflectiveMethodInvocation.target |
Modifier and Type | Method and Description |
---|---|
Object |
ProxyFactoryBean.getObject()
Return a proxy.
|
Class<?> |
AbstractSingletonProxyFactoryBean.getObjectType() |
protected ClassLoader |
ProxyProcessorSupport.getProxyClassLoader()
Return the configured proxy ClassLoader for this processor.
|
static Object |
AopProxyUtils.getSingletonTarget(Object candidate)
Obtain the singleton target object behind the given proxy, if any.
|
Class<?> |
AdvisedSupport.getTargetClass() |
Object |
ReflectiveMethodInvocation.getThis() |
Object |
ReflectiveMethodInvocation.getUserAttribute(String key) |
protected Object |
ReflectiveMethodInvocation.invokeJoinpoint()
Invoke the joinpoint using reflection.
|
Object |
ReflectiveMethodInvocation.proceed() |
Modifier and Type | Method and Description |
---|---|
boolean |
AdvisedSupport.adviceIncluded(Advice advice)
Is the given advice included in any advisor within this proxy configuration?
|
int |
AdvisedSupport.countAdvicesOfType(Class<?> adviceClass)
Count advices of the given class.
|
List<Object> |
AdvisorChainFactory.getInterceptorsAndDynamicInterceptionAdvice(Advised config,
Method method,
Class<?> targetClass)
Determine a list of
MethodInterceptor objects
for the given advisor chain configuration. |
List<Object> |
DefaultAdvisorChainFactory.getInterceptorsAndDynamicInterceptionAdvice(Advised config,
Method method,
Class<?> targetClass) |
List<Object> |
AdvisedSupport.getInterceptorsAndDynamicInterceptionAdvice(Method method,
Class<?> targetClass)
Determine a list of
MethodInterceptor objects
for the given method, based on this configuration. |
Object |
AopProxy.getProxy(ClassLoader classLoader)
Create a new proxy object.
|
Object |
ProxyFactory.getProxy(ClassLoader classLoader)
Create a new proxy according to the settings in this factory.
|
void |
ProxyProcessorSupport.setProxyClassLoader(ClassLoader classLoader)
Set the ClassLoader to generate the proxy class in.
|
void |
ProxyFactoryBean.setProxyClassLoader(ClassLoader classLoader)
Set the ClassLoader to generate the proxy class in.
|
void |
AdvisedSupport.setTargetClass(Class<?> targetClass)
Set a target class to be proxied, indicating that the proxy
should be castable to the given class.
|
void |
AdvisedSupport.setTargetSource(TargetSource targetSource) |
void |
ReflectiveMethodInvocation.setUserAttribute(String key,
Object value) |
Constructor and Description |
---|
ReflectiveMethodInvocation(Object proxy,
Object target,
Method method,
Object[] arguments,
Class<?> targetClass,
List<Object> interceptorsAndDynamicMethodMatchers)
Construct a new ReflectiveMethodInvocation with the given arguments.
|
ReflectiveMethodInvocation(Object proxy,
Object target,
Method method,
Object[] arguments,
Class<?> targetClass,
List<Object> interceptorsAndDynamicMethodMatchers)
Construct a new ReflectiveMethodInvocation with the given arguments.
|
ReflectiveMethodInvocation(Object proxy,
Object target,
Method method,
Object[] arguments,
Class<?> targetClass,
List<Object> interceptorsAndDynamicMethodMatchers)
Construct a new ReflectiveMethodInvocation with the given arguments.
|
Modifier and Type | Method and Description |
---|---|
Object |
ThrowsAdviceInterceptor.invoke(MethodInvocation mi) |
Object |
MethodBeforeAdviceInterceptor.invoke(MethodInvocation mi) |
Object |
AfterReturningAdviceInterceptor.invoke(MethodInvocation mi) |
Modifier and Type | Field and Description |
---|---|
protected static Object[] |
AbstractAutoProxyCreator.DO_NOT_PROXY
Convenience constant for subclasses: Return value for "do not proxy".
|
Modifier and Type | Method and Description |
---|---|
Constructor<?>[] |
AbstractAutoProxyCreator.determineCandidateConstructors(Class<?> beanClass,
String beanName) |
static Class<?> |
AutoProxyUtils.determineTargetClass(ConfigurableListableBeanFactory beanFactory,
String beanName)
Determine the original target class for the specified bean, if possible,
otherwise falling back to a regular
getType lookup. |
protected Object[] |
AbstractAdvisorAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource targetSource) |
protected abstract Object[] |
AbstractAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource customTargetSource)
Return whether the given bean is to be proxied, what additional
advices (e.g.
|
protected Object[] |
BeanNameAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource targetSource)
Identify as a bean to proxy if the bean name matches one of the names in
the configured list of supported names.
|
String |
DefaultAdvisorAutoProxyCreator.getAdvisorBeanNamePrefix()
Return the prefix for bean names that will cause them to be included
for auto-proxying by this object.
|
protected BeanFactory |
AbstractAutoProxyCreator.getBeanFactory()
Return the owning
BeanFactory . |
static String |
ProxyCreationContext.getCurrentProxiedBeanName()
Return the name of the currently proxied bean instance.
|
protected TargetSource |
AbstractAutoProxyCreator.getCustomTargetSource(Class<?> beanClass,
String beanName)
Create a target source for bean instances.
|
TargetSource |
TargetSourceCreator.getTargetSource(Class<?> beanClass,
String beanName)
Create a special TargetSource for the given bean, if any.
|
Class<?> |
AbstractAutoProxyCreator.predictBeanType(Class<?> beanClass,
String beanName) |
Modifier and Type | Method and Description |
---|---|
protected Advisor[] |
AbstractAutoProxyCreator.buildAdvisors(String beanName,
Object[] specificInterceptors)
Determine the advisors for the given bean, including the specific interceptors
as well as the common interceptor, all adapted to the Advisor interface.
|
protected Advisor[] |
AbstractAutoProxyCreator.buildAdvisors(String beanName,
Object[] specificInterceptors)
Determine the advisors for the given bean, including the specific interceptors
as well as the common interceptor, all adapted to the Advisor interface.
|
protected Object |
AbstractAutoProxyCreator.createProxy(Class<?> beanClass,
String beanName,
Object[] specificInterceptors,
TargetSource targetSource)
Create an AOP proxy for the given bean.
|
protected Object |
AbstractAutoProxyCreator.createProxy(Class<?> beanClass,
String beanName,
Object[] specificInterceptors,
TargetSource targetSource)
Create an AOP proxy for the given bean.
|
static Class<?> |
AutoProxyUtils.determineTargetClass(ConfigurableListableBeanFactory beanFactory,
String beanName)
Determine the original target class for the specified bean, if possible,
otherwise falling back to a regular
getType lookup. |
protected Object[] |
AbstractAdvisorAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource targetSource) |
protected abstract Object[] |
AbstractAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource customTargetSource)
Return whether the given bean is to be proxied, what additional
advices (e.g.
|
protected Object[] |
BeanNameAutoProxyCreator.getAdvicesAndAdvisorsForBean(Class<?> beanClass,
String beanName,
TargetSource targetSource)
Identify as a bean to proxy if the bean name matches one of the names in
the configured list of supported names.
|
protected Object |
AbstractAutoProxyCreator.getCacheKey(Class<?> beanClass,
String beanName)
Build a cache key for the given bean class and bean name.
|
Object |
AbstractAutoProxyCreator.postProcessAfterInitialization(Object bean,
String beanName)
Create a proxy with the configured interceptors if the bean is
identified as one to proxy by the subclass.
|
void |
DefaultAdvisorAutoProxyCreator.setAdvisorBeanNamePrefix(String advisorBeanNamePrefix)
Set the prefix for bean names that will cause them to be included for
auto-proxying by this object.
|
protected boolean |
AbstractAutoProxyCreator.shouldProxyTargetClass(Class<?> beanClass,
String beanName)
Determine whether the given bean should be proxied with its target class rather than its interfaces.
|
static boolean |
AutoProxyUtils.shouldProxyTargetClass(ConfigurableListableBeanFactory beanFactory,
String beanName)
Determine whether the given bean should be proxied with its target
class rather than its interfaces.
|
Modifier and Type | Method and Description |
---|---|
protected abstract AbstractBeanFactoryBasedTargetSource |
AbstractBeanFactoryBasedTargetSourceCreator.createBeanFactoryBasedTargetSource(Class<?> beanClass,
String beanName)
Subclasses must implement this method to return a new AbstractPrototypeBasedTargetSource
if they wish to create a custom TargetSource for this bean, or
null if they are
not interested it in, in which case no special target source will be created. |
protected AbstractBeanFactoryBasedTargetSource |
QuickTargetSourceCreator.createBeanFactoryBasedTargetSource(Class<?> beanClass,
String beanName) |
protected AbstractBeanFactoryBasedTargetSource |
LazyInitTargetSourceCreator.createBeanFactoryBasedTargetSource(Class<?> beanClass,
String beanName) |
TargetSource |
AbstractBeanFactoryBasedTargetSourceCreator.getTargetSource(Class<?> beanClass,
String beanName) |
Modifier and Type | Field and Description |
---|---|
protected Log |
AbstractTraceInterceptor.defaultLogger
The default
Log instance used to write trace messages. |
Modifier and Type | Method and Description |
---|---|
protected AsyncTaskExecutor |
AsyncExecutionAspectSupport.determineAsyncExecutor(Method method)
Determine the specific executor to use when executing the given method.
|
protected Object |
AsyncExecutionAspectSupport.doSubmit(Callable<Object> task,
AsyncTaskExecutor executor,
Class<?> returnType)
Delegate for actually executing the given task with the chosen executor.
|
protected Executor |
AsyncExecutionAspectSupport.findQualifiedExecutor(BeanFactory beanFactory,
String qualifier)
Retrieve a target executor for the given qualifier.
|
protected Executor |
AsyncExecutionInterceptor.getDefaultExecutor(BeanFactory beanFactory)
This implementation searches for a unique
TaskExecutor
bean in the context, or for an Executor bean named "taskExecutor" otherwise. |
protected Executor |
AsyncExecutionAspectSupport.getDefaultExecutor(BeanFactory beanFactory)
Retrieve or build a default executor for this advice instance.
|
protected String |
AsyncExecutionInterceptor.getExecutorQualifier(Method method)
This implementation is a no-op for compatibility in Spring 3.1.2.
|
protected abstract String |
AsyncExecutionAspectSupport.getExecutorQualifier(Method method)
Return the qualifier or bean name of the executor to be used when executing the
given async method, typically specified in the form of an annotation attribute.
|
Object |
DebugInterceptor.invoke(MethodInvocation invocation) |
Object |
AsyncExecutionInterceptor.invoke(MethodInvocation invocation)
Intercept the given method invocation, submit the actual calling of the method to
the correct task executor and return immediately to the caller.
|
Object |
AbstractTraceInterceptor.invoke(MethodInvocation invocation)
Determines whether logging is enabled for the particular
MethodInvocation . |
Object |
ConcurrencyThrottleInterceptor.invoke(MethodInvocation methodInvocation) |
Object |
ExposeInvocationInterceptor.invoke(MethodInvocation mi) |
protected abstract Object |
AbstractTraceInterceptor.invokeUnderTrace(MethodInvocation invocation,
Log logger)
Subclasses must override this method to perform any tracing around the
supplied
MethodInvocation . |
Modifier and Type | Method and Description |
---|---|
void |
AsyncExecutionAspectSupport.configure(Supplier<Executor> defaultExecutor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Configure this aspect with the given executor and exception handler suppliers,
applying the corresponding default if a supplier is not resolvable.
|
void |
AsyncExecutionAspectSupport.configure(Supplier<Executor> defaultExecutor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Configure this aspect with the given executor and exception handler suppliers,
applying the corresponding default if a supplier is not resolvable.
|
protected Executor |
AsyncExecutionAspectSupport.findQualifiedExecutor(BeanFactory beanFactory,
String qualifier)
Retrieve a target executor for the given qualifier.
|
protected Executor |
AsyncExecutionInterceptor.getDefaultExecutor(BeanFactory beanFactory)
This implementation searches for a unique
TaskExecutor
bean in the context, or for an Executor bean named "taskExecutor" otherwise. |
protected Executor |
AsyncExecutionAspectSupport.getDefaultExecutor(BeanFactory beanFactory)
Retrieve or build a default executor for this advice instance.
|
protected String |
CustomizableTraceInterceptor.replacePlaceholders(String message,
MethodInvocation methodInvocation,
Object returnValue,
Throwable throwable,
long invocationTime)
Replace the placeholders in the given message with the supplied values,
or values derived from those supplied.
|
protected String |
CustomizableTraceInterceptor.replacePlaceholders(String message,
MethodInvocation methodInvocation,
Object returnValue,
Throwable throwable,
long invocationTime)
Replace the placeholders in the given message with the supplied values,
or values derived from those supplied.
|
void |
AbstractMonitoringInterceptor.setPrefix(String prefix)
Set the text that will get appended to the trace data.
|
void |
AbstractMonitoringInterceptor.setSuffix(String suffix)
Set the text that will get prepended to the trace data.
|
protected void |
AbstractTraceInterceptor.writeToLog(Log logger,
String message,
Throwable ex)
Write the supplied trace message and
Throwable to the
supplied Log instance. |
Constructor and Description |
---|
AsyncExecutionAspectSupport(Executor defaultExecutor)
Create a new instance with a default
AsyncUncaughtExceptionHandler . |
AsyncExecutionAspectSupport(Executor defaultExecutor,
AsyncUncaughtExceptionHandler exceptionHandler)
Create a new
AsyncExecutionAspectSupport with the given exception handler. |
AsyncExecutionInterceptor(Executor defaultExecutor)
Create a new instance with a default
AsyncUncaughtExceptionHandler . |
AsyncExecutionInterceptor(Executor defaultExecutor,
AsyncUncaughtExceptionHandler exceptionHandler)
Create a new
AsyncExecutionInterceptor . |
Modifier and Type | Method and Description |
---|---|
static String |
ScopedProxyUtils.getOriginalBeanName(String targetBeanName)
Get the original bean name for the provided target bean name.
|
static boolean |
ScopedProxyUtils.isScopedTarget(String beanName)
Determine if the
beanName is the name of a bean that references
the target bean within a scoped proxy. |
Modifier and Type | Method and Description |
---|---|
protected Object |
DelegatePerTargetObjectIntroductionInterceptor.doProceed(MethodInvocation mi)
Proceed with the supplied
MethodInterceptor . |
protected Object |
DelegatingIntroductionInterceptor.doProceed(MethodInvocation mi)
Proceed with the supplied
MethodInterceptor . |
String |
AbstractBeanFactoryPointcutAdvisor.getAdviceBeanName()
Return the name of the advice bean that this advisor refers to, if any.
|
String |
ExpressionPointcut.getExpression()
Return the String expression for this pointcut.
|
String |
AbstractExpressionPointcut.getExpression()
Return this pointcut's expression.
|
String |
AbstractExpressionPointcut.getLocation()
Return location information about the pointcut expression
if available.
|
Object |
DelegatePerTargetObjectIntroductionInterceptor.invoke(MethodInvocation mi)
Subclasses may need to override this if they want to perform custom
behaviour in around advice.
|
Object |
DelegatingIntroductionInterceptor.invoke(MethodInvocation mi)
Subclasses may need to override this if they want to perform custom
behaviour in around advice.
|
static Object |
AopUtils.invokeJoinpointUsingReflection(Object target,
Method method,
Object[] args)
Invoke the given target via reflection, as part of an AOP method invocation.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractRegexpMethodPointcut.equals(Object other) |
boolean |
DefaultIntroductionAdvisor.equals(Object other) |
boolean |
ControlFlowPointcut.equals(Object other) |
boolean |
AbstractPointcutAdvisor.equals(Object other) |
boolean |
ComposablePointcut.equals(Object other) |
boolean |
NameMatchMethodPointcut.equals(Object other) |
static Method |
AopUtils.getMostSpecificMethod(Method method,
Class<?> targetClass)
Given a method, which may come from an interface, and a target class used
in the current AOP invocation, find the corresponding target method if there
is one.
|
static Object |
AopUtils.invokeJoinpointUsingReflection(Object target,
Method method,
Object[] args)
Invoke the given target via reflection, as part of an AOP method invocation.
|
static boolean |
AopUtils.isAopProxy(Object object)
Check whether the given object is a JDK dynamic proxy or a CGLIB proxy.
|
static boolean |
AopUtils.isCglibProxy(Object object)
Check whether the given object is a CGLIB proxy.
|
static boolean |
AopUtils.isEqualsMethod(Method method)
Determine whether the given method is an "equals" method.
|
static boolean |
AopUtils.isFinalizeMethod(Method method)
Determine whether the given method is a "finalize" method.
|
static boolean |
AopUtils.isHashCodeMethod(Method method)
Determine whether the given method is a "hashCode" method.
|
static boolean |
AopUtils.isJdkDynamicProxy(Object object)
Check whether the given object is a JDK dynamic proxy.
|
static boolean |
AopUtils.isToStringMethod(Method method)
Determine whether the given method is a "toString" method.
|
protected void |
AbstractExpressionPointcut.onSetExpression(String expression)
Called when a new pointcut expression is set.
|
static Method |
AopUtils.selectInvocableMethod(Method method,
Class<?> targetType)
Select an invocable method on the target type: either the given method itself
if actually exposed on the target type, or otherwise a corresponding method
on one of the target type's interfaces or on the target type itself.
|
void |
AbstractBeanFactoryPointcutAdvisor.setAdviceBeanName(String adviceBeanName)
Specify the name of the advice bean that this advisor should refer to.
|
void |
AbstractExpressionPointcut.setExpression(String expression) |
void |
AbstractExpressionPointcut.setLocation(String location)
Set the location for debugging.
|
void |
DefaultPointcutAdvisor.setPointcut(Pointcut pointcut)
Specify the pointcut targeting the advice.
|
void |
DefaultBeanFactoryPointcutAdvisor.setPointcut(Pointcut pointcut)
Specify the pointcut targeting the advice.
|
Constructor and Description |
---|
ControlFlowPointcut(Class<?> clazz,
String methodName)
Construct a new pointcut that matches all calls below the given method
in the given class.
|
DefaultIntroductionAdvisor(Advice advice,
IntroductionInfo introductionInfo)
Create a DefaultIntroductionAdvisor for the given advice.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AnnotationClassFilter.equals(Object other) |
boolean |
AnnotationMatchingPointcut.equals(Object other) |
boolean |
AnnotationMethodMatcher.equals(Object other) |
Constructor and Description |
---|
AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType,
Class<? extends Annotation> methodAnnotationType)
Create a new AnnotationMatchingPointcut for the given annotation types.
|
AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType,
Class<? extends Annotation> methodAnnotationType)
Create a new AnnotationMatchingPointcut for the given annotation types.
|
AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType,
Class<? extends Annotation> methodAnnotationType,
boolean checkInherited)
Create a new AnnotationMatchingPointcut for the given annotation types.
|
AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType,
Class<? extends Annotation> methodAnnotationType,
boolean checkInherited)
Create a new AnnotationMatchingPointcut for the given annotation types.
|
Modifier and Type | Method and Description |
---|---|
abstract Object |
AbstractPoolingTargetSource.getTarget()
Acquire an object from the pool.
|
Object |
EmptyTargetSource.getTarget()
Always returns
null . |
Object |
LazyInitTargetSource.getTarget() |
Class<?> |
AbstractBeanFactoryBasedTargetSource.getTargetClass() |
Class<?> |
AbstractLazyCreationTargetSource.getTargetClass()
This default implementation returns
null if the
target is null (it is hasn't yet been initialized),
or the target class if the target has already been initialized. |
Class<?> |
EmptyTargetSource.getTargetClass()
Always returns the specified target Class, or
null if none. |
Modifier and Type | Method and Description |
---|---|
static EmptyTargetSource |
EmptyTargetSource.forClass(Class<?> targetClass)
Return an EmptyTargetSource for the given target Class.
|
static EmptyTargetSource |
EmptyTargetSource.forClass(Class<?> targetClass,
boolean isStatic)
Return an EmptyTargetSource for the given target Class.
|
Modifier and Type | Field and Description |
---|---|
protected Object |
AbstractRefreshableTargetSource.targetObject |
Modifier and Type | Method and Description |
---|---|
Object |
AbstractRefreshableTargetSource.getTarget() |
Modifier and Type | Field and Description |
---|---|
String[] |
AbstractNestablePropertyAccessor.PropertyTokenHolder.keys |
Modifier and Type | Method and Description |
---|---|
static String[] |
PropertyAccessorUtils.canonicalPropertyNames(String[] propertyNames)
Determine the canonical names for the given property paths.
|
Object |
BeanWrapperImpl.convertForProperty(Object value,
String propertyName)
Convert the given value for the specified property to the latter's type.
|
protected Object |
AbstractNestablePropertyAccessor.convertForProperty(String propertyName,
Object oldValue,
Object newValue,
TypeDescriptor td) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
Field field)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
default <T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor)
Convert the value to the required type (if necessary from a String).
|
PropertyEditor |
PropertyEditorRegistry.findCustomEditor(Class<?> requiredType,
String propertyPath)
Find a custom property editor for the given type and property.
|
PropertyEditor |
PropertyEditorRegistrySupport.findCustomEditor(Class<?> requiredType,
String propertyPath) |
static Method |
BeanUtils.findDeclaredMethod(Class<?> clazz,
String methodName,
Class<?>... paramTypes)
Find a method with the given method name and the given parameter types,
declared on the given class or one of its superclasses.
|
static Method |
BeanUtils.findDeclaredMethodWithMinimalParameters(Class<?> clazz,
String methodName)
Find a method with the given method name and minimal parameters (best case: none),
declared on the given class or one of its superclasses.
|
static PropertyEditor |
BeanUtils.findEditorByConvention(Class<?> targetType)
Find a JavaBeans PropertyEditor following the 'Editor' suffix convention
(e.g.
|
static Method |
BeanUtils.findMethod(Class<?> clazz,
String methodName,
Class<?>... paramTypes)
Find a method with the given method name and the given parameter types,
declared on the given class or one of its superclasses.
|
static Method |
BeanUtils.findMethodWithMinimalParameters(Class<?> clazz,
String methodName)
Find a method with the given method name and minimal parameters (best case: none),
declared on the given class or one of its superclasses.
|
static Method |
BeanUtils.findMethodWithMinimalParameters(Method[] methods,
String methodName)
Find a method with the given method name and minimal parameters (best case: none)
in the given list of methods.
|
static <T> Constructor<T> |
BeanUtils.findPrimaryConstructor(Class<T> clazz)
Return the primary constructor of the provided class.
|
static PropertyDescriptor |
BeanUtils.findPropertyForMethod(Method method)
Find a JavaBeans
PropertyDescriptor for the given method,
with the method either being the read method or the write method for
that bean property. |
static PropertyDescriptor |
BeanUtils.findPropertyForMethod(Method method,
Class<?> clazz)
Find a JavaBeans
PropertyDescriptor for the given method,
with the method either being the read method or the write method for
that bean property. |
Object |
MutablePropertyValues.get(String propertyName)
Get the raw property value, if any.
|
Object |
BeanMetadataAttributeAccessor.getAttribute(String name) |
BeanInfo |
ExtendedBeanInfoFactory.getBeanInfo(Class<?> beanClass)
Return an
ExtendedBeanInfo for the given bean class, if applicable. |
BeanInfo |
BeanInfoFactory.getBeanInfo(Class<?> beanClass)
Return the bean info for the given class, if supported.
|
Class<?> |
AbstractNestablePropertyAccessor.PropertyHandler.getCollectionType(int nestingLevel) |
Method |
BeanInstantiationException.getConstructingMethod()
Return the delegate for bean construction purposes, if known.
|
Constructor<?> |
BeanInstantiationException.getConstructor()
Return the offending constructor, if known.
|
ConversionService |
ConfigurablePropertyAccessor.getConversionService()
Return the associated ConversionService, if any.
|
ConversionService |
PropertyEditorRegistrySupport.getConversionService()
Return the associated ConversionService, if any.
|
Object |
PropertyValue.getConvertedValue()
Return the converted value of this property value,
after processed type conversion.
|
PropertyEditor |
PropertyEditorRegistrySupport.getDefaultEditor(Class<?> requiredType)
Retrieve the default editor for the given property type, if any.
|
protected org.springframework.beans.BeanWrapperImpl.BeanPropertyHandler |
BeanWrapperImpl.getLocalPropertyHandler(String propertyName) |
protected abstract AbstractNestablePropertyAccessor.PropertyHandler |
AbstractNestablePropertyAccessor.getLocalPropertyHandler(String propertyName)
Return a
AbstractNestablePropertyAccessor.PropertyHandler for the specified local propertyName . |
protected org.springframework.beans.DirectFieldAccessor.FieldPropertyHandler |
DirectFieldAccessor.getLocalPropertyHandler(String propertyName) |
Class<?> |
AbstractNestablePropertyAccessor.PropertyHandler.getMapKeyType(int nestingLevel) |
Class<?> |
AbstractNestablePropertyAccessor.PropertyHandler.getMapValueType(int nestingLevel) |
BeanMetadataAttribute |
BeanMetadataAttributeAccessor.getMetadataAttribute(String name)
Look up the given BeanMetadataAttribute in this accessor's set of attributes.
|
String[] |
NotWritablePropertyException.getPossibleMatches()
Return suggestions for actual bean property names that closely match
the invalid property name, if any.
|
PropertyAccessException |
PropertyBatchUpdateException.getPropertyAccessException(String propertyName)
Return the exception for this field, or
null if there isn't any. |
PropertyChangeEvent |
PropertyAccessException.getPropertyChangeEvent()
Return the PropertyChangeEvent that resulted in the problem.
|
static PropertyDescriptor |
BeanUtils.getPropertyDescriptor(Class<?> clazz,
String propertyName)
Retrieve the JavaBeans
PropertyDescriptors for the given property. |
protected AbstractNestablePropertyAccessor.PropertyHandler |
AbstractNestablePropertyAccessor.getPropertyHandler(String propertyName)
Return the
AbstractNestablePropertyAccessor.PropertyHandler for the specified propertyName , navigating
if necessary. |
String |
PropertyAccessException.getPropertyName()
Return the name of the affected property, if available.
|
String |
TypeMismatchException.getPropertyName()
Return the name of the affected property, if available.
|
Class<?> |
AbstractNestablePropertyAccessor.PropertyHandler.getPropertyType() |
Class<?> |
AbstractPropertyAccessor.getPropertyType(String propertyPath) |
protected Class<?> |
PropertyEditorRegistrySupport.getPropertyType(String propertyPath)
Determine the property type for the given property path.
|
Class<?> |
PropertyAccessor.getPropertyType(String propertyName)
Determine the property type for the specified property,
either checking the property descriptor or checking the value
in case of an indexed or mapped element.
|
Class<?> |
AbstractNestablePropertyAccessor.getPropertyType(String propertyName) |
TypeDescriptor |
PropertyAccessor.getPropertyTypeDescriptor(String propertyName)
Return a type descriptor for the specified property:
preferably from the read method, falling back to the write method.
|
TypeDescriptor |
AbstractNestablePropertyAccessor.getPropertyTypeDescriptor(String propertyName) |
protected Object |
AbstractNestablePropertyAccessor.getPropertyValue(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens) |
PropertyValue |
MutablePropertyValues.getPropertyValue(String propertyName) |
PropertyValue |
PropertyValues.getPropertyValue(String propertyName)
Return the property value with the given name, if any.
|
abstract Object |
AbstractPropertyAccessor.getPropertyValue(String propertyName)
Actually get the value of a property.
|
Object |
PropertyAccessor.getPropertyValue(String propertyName)
Get the current value of the specified property.
|
Object |
AbstractNestablePropertyAccessor.getPropertyValue(String propertyName) |
Class<?> |
TypeMismatchException.getRequiredType()
Return the required target type, if any.
|
AccessControlContext |
BeanWrapperImpl.getSecurityContext()
Return the security context used during the invocation of the wrapped instance methods.
|
Object |
BeanMetadataAttribute.getSource() |
default Object |
BeanMetadataElement.getSource()
Return the configuration source
Object for this metadata element
(may be null ). |
Object |
BeanMetadataAttributeAccessor.getSource() |
Object |
BeanMetadataAttribute.getValue()
Return the value of the attribute.
|
Object |
PropertyAccessException.getValue()
Return the affected value that was about to be set, if any.
|
Object |
TypeMismatchException.getValue()
Return the offending value (may be
null ). |
Object |
PropertyValue.getValue()
Return the value of the property.
|
abstract Object |
AbstractNestablePropertyAccessor.PropertyHandler.getValue() |
protected Class<?> |
PropertyEditorRegistrySupport.guessPropertyTypeFromEditors(String propertyName)
Guess the property type of the specified property from the registered
custom editors (provided that they were registered for a specific type).
|
abstract TypeDescriptor |
AbstractNestablePropertyAccessor.PropertyHandler.nested(int level) |
Object |
BeanMetadataAttributeAccessor.removeAttribute(String name) |
static Method |
BeanUtils.resolveSignature(String signature,
Class<?> clazz)
Parse a method signature in the form
methodName[([arg_list])] ,
where arg_list is an optional, comma-separated list of fully-qualified
type names, and attempts to resolve that signature against the supplied Class . |
Modifier and Type | Method and Description |
---|---|
static void |
CachedIntrospectionResults.acceptClassLoader(ClassLoader classLoader)
Accept the given ClassLoader as cache-safe, even if its classes would
not qualify as cache-safe in this CachedIntrospectionResults class.
|
MutablePropertyValues |
MutablePropertyValues.add(String propertyName,
Object propertyValue)
Add a PropertyValue object, replacing any existing one for the
corresponding property or getting merged with it (if applicable).
|
MutablePropertyValues |
MutablePropertyValues.addPropertyValues(Map<?,?> other)
Add all property values from the given Map.
|
MutablePropertyValues |
MutablePropertyValues.addPropertyValues(PropertyValues other)
Copy all given PropertyValues into this object.
|
static String |
PropertyAccessorUtils.canonicalPropertyName(String propertyName)
Determine the canonical name for the given property path.
|
static String[] |
PropertyAccessorUtils.canonicalPropertyNames(String[] propertyNames)
Determine the canonical names for the given property paths.
|
static void |
CachedIntrospectionResults.clearClassLoader(ClassLoader classLoader)
Clear the introspection cache for the given ClassLoader, removing the
introspection results for all classes underneath that ClassLoader, and
removing the ClassLoader (and its children) from the acceptance list.
|
boolean |
PropertyBatchUpdateException.contains(Class<?> exType) |
Object |
BeanWrapperImpl.convertForProperty(Object value,
String propertyName)
Convert the given value for the specified property to the latter's type.
|
protected Object |
AbstractNestablePropertyAccessor.convertForProperty(String propertyName,
Object oldValue,
Object newValue,
TypeDescriptor td) |
protected Object |
AbstractNestablePropertyAccessor.convertForProperty(String propertyName,
Object oldValue,
Object newValue,
TypeDescriptor td) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
Field field)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
Field field)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
Field field)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam)
Convert the value to the required type (if necessary from a String).
|
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
<T> T |
TypeConverterSupport.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
default <T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor)
Convert the value to the required type (if necessary from a String).
|
default <T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor)
Convert the value to the required type (if necessary from a String).
|
default <T> T |
TypeConverter.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor)
Convert the value to the required type (if necessary from a String).
|
protected void |
PropertyEditorRegistrySupport.copyCustomEditorsTo(PropertyEditorRegistry target,
String nestedProperty)
Copy the custom editors registered in this instance to the given target registry.
|
boolean |
BeanMetadataAttribute.equals(Object other) |
boolean |
MutablePropertyValues.equals(Object other) |
boolean |
PropertyValue.equals(Object other) |
PropertyEditor |
PropertyEditorRegistry.findCustomEditor(Class<?> requiredType,
String propertyPath)
Find a custom property editor for the given type and property.
|
PropertyEditor |
PropertyEditorRegistry.findCustomEditor(Class<?> requiredType,
String propertyPath)
Find a custom property editor for the given type and property.
|
PropertyEditor |
PropertyEditorRegistrySupport.findCustomEditor(Class<?> requiredType,
String propertyPath) |
PropertyEditor |
PropertyEditorRegistrySupport.findCustomEditor(Class<?> requiredType,
String propertyPath) |
static PropertyEditor |
BeanUtils.findEditorByConvention(Class<?> targetType)
Find a JavaBeans PropertyEditor following the 'Editor' suffix convention
(e.g.
|
static Class<?> |
BeanUtils.findPropertyType(String propertyName,
Class<?>... beanClasses)
Determine the bean property type for the given property from the
given classes/interfaces, if possible.
|
boolean |
PropertyEditorRegistrySupport.hasCustomEditorForElement(Class<?> elementType,
String propertyPath)
Determine whether this registry contains a custom editor
for the specified array/collection element.
|
boolean |
PropertyEditorRegistrySupport.hasCustomEditorForElement(Class<?> elementType,
String propertyPath)
Determine whether this registry contains a custom editor
for the specified array/collection element.
|
static boolean |
PropertyAccessorUtils.isNestedOrIndexedProperty(String propertyPath)
Check whether the given property path indicates an indexed or nested property.
|
Object |
Mergeable.merge(Object parent)
Merge the current value set with that of the supplied object.
|
void |
PropertyEditorRegistry.registerCustomEditor(Class<?> requiredType,
String propertyPath,
PropertyEditor propertyEditor)
Register the given custom property editor for the given type and
property, or for all properties of the given type.
|
void |
PropertyEditorRegistry.registerCustomEditor(Class<?> requiredType,
String propertyPath,
PropertyEditor propertyEditor)
Register the given custom property editor for the given type and
property, or for all properties of the given type.
|
void |
PropertyEditorRegistrySupport.registerCustomEditor(Class<?> requiredType,
String propertyPath,
PropertyEditor propertyEditor) |
void |
PropertyEditorRegistrySupport.registerCustomEditor(Class<?> requiredType,
String propertyPath,
PropertyEditor propertyEditor) |
void |
BeanMetadataAttributeAccessor.setAttribute(String name,
Object value) |
void |
ConfigurablePropertyAccessor.setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting
property values, as an alternative to JavaBeans PropertyEditors.
|
void |
PropertyEditorRegistrySupport.setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting
property values, as an alternative to JavaBeans PropertyEditors.
|
void |
PropertyValue.setConvertedValue(Object value)
Set the converted value of this property value,
after processed type conversion.
|
abstract void |
AbstractPropertyAccessor.setPropertyValue(String propertyName,
Object value)
Actually set a property value.
|
void |
PropertyAccessor.setPropertyValue(String propertyName,
Object value)
Set the specified value as current property value.
|
void |
AbstractNestablePropertyAccessor.setPropertyValue(String propertyName,
Object value) |
void |
BeanWrapperImpl.setSecurityContext(AccessControlContext acc)
Set the security context used during the invocation of the wrapped instance methods.
|
void |
BeanMetadataAttribute.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
BeanMetadataAttributeAccessor.setSource(Object source)
Set the configuration source
Object for this metadata element. |
abstract void |
AbstractNestablePropertyAccessor.PropertyHandler.setValue(Object value) |
void |
BeanWrapperImpl.setWrappedInstance(Object object,
String nestedPath,
Object rootObject) |
void |
BeanWrapperImpl.setWrappedInstance(Object object,
String nestedPath,
Object rootObject) |
void |
AbstractNestablePropertyAccessor.setWrappedInstance(Object object,
String nestedPath,
Object rootObject)
Switch the target object, replacing the cached introspection results only
if the class of the new object is different to that of the replaced object.
|
void |
AbstractNestablePropertyAccessor.setWrappedInstance(Object object,
String nestedPath,
Object rootObject)
Switch the target object, replacing the cached introspection results only
if the class of the new object is different to that of the replaced object.
|
Constructor and Description |
---|
BeanInstantiationException(Class<?> beanClass,
String msg,
Throwable cause)
Create a new BeanInstantiationException.
|
BeanInstantiationException(Constructor<?> constructor,
String msg,
Throwable cause)
Create a new BeanInstantiationException.
|
BeanInstantiationException(Method constructingMethod,
String msg,
Throwable cause)
Create a new BeanInstantiationException.
|
BeanMetadataAttribute(String name,
Object value)
Create a new AttributeValue instance.
|
BeansException(String msg,
Throwable cause)
Create a new BeansException with the specified message
and root cause.
|
BeansException(String msg,
Throwable cause)
Create a new BeansException with the specified message
and root cause.
|
ConversionNotSupportedException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new ConversionNotSupportedException.
|
ConversionNotSupportedException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new ConversionNotSupportedException.
|
ConversionNotSupportedException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new ConversionNotSupportedException.
|
ConversionNotSupportedException(PropertyChangeEvent propertyChangeEvent,
Class<?> requiredType,
Throwable cause)
Create a new ConversionNotSupportedException.
|
ConversionNotSupportedException(PropertyChangeEvent propertyChangeEvent,
Class<?> requiredType,
Throwable cause)
Create a new ConversionNotSupportedException.
|
FatalBeanException(String msg,
Throwable cause)
Create a new FatalBeanException with the specified message
and root cause.
|
InvalidPropertyException(Class<?> beanClass,
String propertyName,
String msg,
Throwable cause)
Create a new InvalidPropertyException.
|
MutablePropertyValues(List<PropertyValue> propertyValueList)
Construct a new MutablePropertyValues object using the given List of
PropertyValue objects as-is.
|
MutablePropertyValues(Map<?,?> original)
Construct a new MutablePropertyValues object from a Map.
|
MutablePropertyValues(PropertyValues original)
Deep copy constructor.
|
PropertyAccessException(PropertyChangeEvent propertyChangeEvent,
String msg,
Throwable cause)
Create a new PropertyAccessException.
|
PropertyAccessException(String msg,
Throwable cause)
Create a new PropertyAccessException without PropertyChangeEvent.
|
PropertyHandler(Class<?> propertyType,
boolean readable,
boolean writable) |
PropertyValue(PropertyValue original,
Object newValue)
Constructor that exposes a new value for an original value holder.
|
PropertyValue(String name,
Object value)
Create a new PropertyValue instance.
|
TypeMismatchException(Object value,
Class<?> requiredType)
Create a new
TypeMismatchException without a PropertyChangeEvent . |
TypeMismatchException(Object value,
Class<?> requiredType)
Create a new
TypeMismatchException without a PropertyChangeEvent . |
TypeMismatchException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new
TypeMismatchException without a PropertyChangeEvent . |
TypeMismatchException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new
TypeMismatchException without a PropertyChangeEvent . |
TypeMismatchException(Object value,
Class<?> requiredType,
Throwable cause)
Create a new
TypeMismatchException without a PropertyChangeEvent . |
TypeMismatchException(PropertyChangeEvent propertyChangeEvent,
Class<?> requiredType,
Throwable cause)
Create a new
TypeMismatchException . |
TypeMismatchException(PropertyChangeEvent propertyChangeEvent,
Class<?> requiredType,
Throwable cause)
Create a new
TypeMismatchException . |
Modifier and Type | Method and Description |
---|---|
static void |
AnnotationBeanUtils.copyPropertiesToBean(Annotation ann,
Object bean,
StringValueResolver valueResolver,
String... excludedProperties)
Deprecated.
Copy the properties of the supplied
Annotation to the supplied target bean. |
Modifier and Type | Field and Description |
---|---|
protected Field |
InjectionPoint.field |
protected MethodParameter |
InjectionPoint.methodParameter |
Modifier and Type | Method and Description |
---|---|
<A extends Annotation> |
ListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType)
Find an
Annotation of annotationType on the specified bean,
traversing its interfaces and superclasses if no annotation can be found on
the given class itself, as well as checking the bean's factory method (if any). |
<A extends Annotation> |
ListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType,
boolean allowFactoryBeanInit)
Find an
Annotation of annotationType on the specified bean,
traversing its interfaces and superclasses if no annotation can be found on
the given class itself, as well as checking the bean's factory method (if any). |
<A extends Annotation> |
InjectionPoint.getAnnotation(Class<A> annotationType)
Retrieve a field/parameter annotation of the given type, if any.
|
String |
CannotLoadBeanClassException.getBeanClassName()
Return the name of the class we were trying to load.
|
String |
NoSuchBeanDefinitionException.getBeanName()
Return the name of the missing bean, if it was a lookup by name that failed.
|
String |
BeanCreationException.getBeanName()
Return the name of the bean requested, if any.
|
String |
BeanDefinitionStoreException.getBeanName()
Return the name of the bean, if available.
|
Collection<String> |
NoUniqueBeanDefinitionException.getBeanNamesFound()
Return the names of all beans found when only one matching bean was expected.
|
Class<?> |
NoSuchBeanDefinitionException.getBeanType()
Return the required type of the missing bean, if it was a lookup by type
that failed.
|
Field |
InjectionPoint.getField()
Return the wrapped Field, if any.
|
T |
ObjectProvider.getIfAvailable()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
T |
ObjectProvider.getIfUnique()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
InjectionPoint |
UnsatisfiedDependencyException.getInjectionPoint()
Return the injection point (field or method/constructor parameter), if known.
|
MethodParameter |
InjectionPoint.getMethodParameter()
Return the wrapped MethodParameter, if any.
|
T |
FactoryBean.getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
Class<?> |
FactoryBean.getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
BeanFactory |
HierarchicalBeanFactory.getParentBeanFactory()
Return the parent bean factory, or
null if there is none. |
Throwable[] |
BeanCreationException.getRelatedCauses()
Return the related causes, if any.
|
ResolvableType |
NoSuchBeanDefinitionException.getResolvableType()
Return the required
ResolvableType of the missing bean, if it was a lookup
by type that failed. |
String |
CannotLoadBeanClassException.getResourceDescription()
Return the description of the resource that the bean
definition came from.
|
String |
BeanCreationException.getResourceDescription()
Return the description of the resource that the bean
definition came from, if any.
|
String |
BeanDefinitionStoreException.getResourceDescription()
Return the description of the resource that the bean definition came from, if available.
|
Class<?> |
BeanFactory.getType(String name)
Determine the type of the bean with the given name.
|
Class<?> |
BeanFactory.getType(String name,
boolean allowFactoryBeanInit)
Determine the type of the bean with the given name.
|
Modifier and Type | Method and Description |
---|---|
boolean |
BeanCreationException.contains(Class<?> exClass) |
boolean |
InjectionPoint.equals(Object other) |
String[] |
ListableBeanFactory.getBeanNamesForType(Class<?> type)
Return the names of beans matching the given type (including subclasses),
judging from either bean definitions or the value of
getObjectType
in the case of FactoryBeans. |
String[] |
ListableBeanFactory.getBeanNamesForType(Class<?> type,
boolean includeNonSingletons,
boolean allowEagerInit)
Return the names of beans matching the given type (including subclasses),
judging from either bean definitions or the value of
getObjectType
in the case of FactoryBeans. |
<T> Map<String,T> |
ListableBeanFactory.getBeansOfType(Class<T> type)
Return the bean instances that match the given object type (including
subclasses), judging from either bean definitions or the value of
getObjectType in the case of FactoryBeans. |
<T> Map<String,T> |
ListableBeanFactory.getBeansOfType(Class<T> type,
boolean includeNonSingletons,
boolean allowEagerInit)
Return the bean instances that match the given object type (including
subclasses), judging from either bean definitions or the value of
getObjectType in the case of FactoryBeans. |
static boolean |
BeanFactoryUtils.isFactoryDereference(String name)
Return whether the given name is a factory dereference
(beginning with the factory dereference prefix).
|
static boolean |
BeanFactoryUtils.isGeneratedBeanName(String name)
Return whether the given name is a bean name which has been generated
by the default naming strategy (containing a "#..." part).
|
Constructor and Description |
---|
BeanCreationException(String resourceDescription,
String beanName,
String msg)
Create a new BeanCreationException.
|
BeanCreationException(String resourceDescription,
String beanName,
String msg)
Create a new BeanCreationException.
|
BeanCreationException(String resourceDescription,
String beanName,
String msg,
Throwable cause)
Create a new BeanCreationException.
|
BeanDefinitionStoreException(String resourceDescription,
String msg)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String resourceDescription,
String beanName,
String msg)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String resourceDescription,
String beanName,
String msg,
Throwable cause)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String resourceDescription,
String beanName,
String msg,
Throwable cause)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String resourceDescription,
String msg,
Throwable cause)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String resourceDescription,
String msg,
Throwable cause)
Create a new BeanDefinitionStoreException.
|
BeanDefinitionStoreException(String msg,
Throwable cause)
Create a new BeanDefinitionStoreException.
|
CannotLoadBeanClassException(String resourceDescription,
String beanName,
String beanClassName,
ClassNotFoundException cause)
Create a new CannotLoadBeanClassException.
|
CannotLoadBeanClassException(String resourceDescription,
String beanName,
String beanClassName,
ClassNotFoundException cause)
Create a new CannotLoadBeanClassException.
|
CannotLoadBeanClassException(String resourceDescription,
String beanName,
String beanClassName,
LinkageError cause)
Create a new CannotLoadBeanClassException.
|
CannotLoadBeanClassException(String resourceDescription,
String beanName,
String beanClassName,
LinkageError cause)
Create a new CannotLoadBeanClassException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
BeansException ex)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
BeansException ex)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
BeansException ex)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
String msg)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
String msg)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
InjectionPoint injectionPoint,
String msg)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
String propertyName,
BeansException ex)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
String propertyName,
BeansException ex)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
String propertyName,
String msg)
Create a new UnsatisfiedDependencyException.
|
UnsatisfiedDependencyException(String resourceDescription,
String beanName,
String propertyName,
String msg)
Create a new UnsatisfiedDependencyException.
|
Modifier and Type | Field and Description |
---|---|
protected PropertyDescriptor |
InjectionMetadata.InjectedElement.pd |
protected Boolean |
InjectionMetadata.InjectedElement.skip |
Modifier and Type | Method and Description |
---|---|
Constructor<?>[] |
AutowiredAnnotationBeanPostProcessor.determineCandidateConstructors(Class<?> beanClass,
String beanName) |
protected Object |
QualifierAnnotationAutowireCandidateResolver.findValue(Annotation[] annotationsToSearch)
Determine a suggested value from any of the given candidate annotations.
|
protected Annotation |
QualifierAnnotationAutowireCandidateResolver.getFactoryMethodAnnotation(RootBeanDefinition bd,
Class<? extends Annotation> type) |
MethodMetadata |
AnnotatedGenericBeanDefinition.getFactoryMethodMetadata() |
MethodMetadata |
AnnotatedBeanDefinition.getFactoryMethodMetadata()
Obtain metadata for this bean definition's factory method, if any.
|
protected Annotation |
QualifierAnnotationAutowireCandidateResolver.getQualifiedElementAnnotation(RootBeanDefinition bd,
Class<? extends Annotation> type) |
protected Object |
InjectionMetadata.InjectedElement.getResourceToInject(Object target,
String requestingBeanName)
Either this or
InjectionMetadata.InjectedElement.inject(java.lang.Object, java.lang.String, org.springframework.beans.PropertyValues) needs to be overridden. |
Object |
QualifierAnnotationAutowireCandidateResolver.getSuggestedValue(DependencyDescriptor descriptor)
Determine whether the given dependency declares a value annotation.
|
static Object |
ParameterResolutionDelegate.resolveDependency(Parameter parameter,
int parameterIndex,
Class<?> containingClass,
AutowireCapableBeanFactory beanFactory)
Resolve the dependency for the supplied
Parameter from the
supplied AutowireCapableBeanFactory . |
BeanWiringInfo |
AnnotationBeanWiringInfoResolver.resolveWiringInfo(Object beanInstance) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
InjectionMetadata.InjectedElement.checkPropertySkipping(PropertyValues pvs)
Check whether this injector's property needs to be skipped due to
an explicit property value having been specified.
|
void |
InjectionMetadata.clear(PropertyValues pvs)
Clear property skipping for the contained elements.
|
protected void |
InjectionMetadata.InjectedElement.clearPropertySkipping(PropertyValues pvs)
Clear property skipping for this element.
|
boolean |
InjectionMetadata.InjectedElement.equals(Object other) |
protected Object |
InjectionMetadata.InjectedElement.getResourceToInject(Object target,
String requestingBeanName)
Either this or
InjectionMetadata.InjectedElement.inject(java.lang.Object, java.lang.String, org.springframework.beans.PropertyValues) needs to be overridden. |
void |
InjectionMetadata.inject(Object target,
String beanName,
PropertyValues pvs) |
void |
InjectionMetadata.inject(Object target,
String beanName,
PropertyValues pvs) |
protected void |
InjectionMetadata.InjectedElement.inject(Object target,
String requestingBeanName,
PropertyValues pvs)
Either this or
InjectionMetadata.InjectedElement.getResourceToInject(java.lang.Object, java.lang.String) needs to be overridden. |
protected void |
InjectionMetadata.InjectedElement.inject(Object target,
String requestingBeanName,
PropertyValues pvs)
Either this or
InjectionMetadata.InjectedElement.getResourceToInject(java.lang.Object, java.lang.String) needs to be overridden. |
static boolean |
BeanFactoryAnnotationUtils.isQualifierMatch(Predicate<String> qualifier,
String beanName,
BeanFactory beanFactory)
Check whether the named bean declares a qualifier of the given name.
|
static boolean |
InjectionMetadata.needsRefresh(InjectionMetadata metadata,
Class<?> clazz)
Check whether the given injection metadata needs to be refreshed.
|
void |
CustomAutowireConfigurer.setBeanClassLoader(ClassLoader beanClassLoader) |
protected boolean |
RequiredAnnotationBeanPostProcessor.shouldSkip(ConfigurableListableBeanFactory beanFactory,
String beanName)
Deprecated.
Check whether the given bean definition is not subject to the annotation-based
required property check as performed by this post-processor.
|
Constructor and Description |
---|
InjectedElement(Member member,
PropertyDescriptor pd) |
Modifier and Type | Field and Description |
---|---|
protected String |
PlaceholderConfigurerSupport.nullValue |
protected String |
PlaceholderConfigurerSupport.valueSeparator
Defaults to ":".
|
Modifier and Type | Method and Description |
---|---|
default Constructor<?>[] |
SmartInstantiationAwareBeanPostProcessor.determineCandidateConstructors(Class<?> beanClass,
String beanName)
Determine the candidate constructors to use for the given bean.
|
Object |
BeanExpressionResolver.evaluate(String value,
BeanExpressionContext beanExpressionContext)
Evaluate the given value as an expression, if applicable;
return the value as-is otherwise.
|
String[] |
BeanDefinitionHolder.getAliases()
Return the alias names for the bean, as specified directly for the bean definition.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType,
String requiredName)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ClassLoader |
ConfigurableBeanFactory.getBeanClassLoader()
Return this factory's class loader for loading bean classes
(only
null if even the system ClassLoader isn't accessible). |
String |
BeanDefinition.getBeanClassName()
Return the current bean class name of this bean definition.
|
BeanExpressionResolver |
ConfigurableBeanFactory.getBeanExpressionResolver()
Return the resolution strategy for expressions in bean definition values.
|
protected BeanFactory |
AbstractFactoryBean.getBeanFactory()
Return the BeanFactory that this bean runs in.
|
Class<?> |
RuntimeBeanReference.getBeanType()
Return the requested bean type if resolution by type is demanded.
|
String |
Scope.getConversationId()
Return the conversation ID for the current underlying scope, if any.
|
ConversionService |
ConfigurableBeanFactory.getConversionService()
Return the associated ConversionService, if any.
|
Object |
ConstructorArgumentValues.ValueHolder.getConvertedValue()
Return the converted value of the constructor argument,
after processed type conversion.
|
String |
DependencyDescriptor.getDependencyName()
Determine the name of the wrapped parameter/field.
|
String[] |
BeanDefinition.getDependsOn()
Return the bean names that this bean depends on.
|
String |
BeanDefinition.getDescription()
Return a human-readable description of this bean definition.
|
String |
BeanDefinition.getDestroyMethodName()
Return the name of the destroy method.
|
protected Class<?>[] |
AbstractFactoryBean.getEarlySingletonInterfaces()
Return an array of interfaces that a singleton object exposed by this
FactoryBean is supposed to implement, for use with an 'early singleton
proxy' that will be exposed in case of a circular reference.
|
String |
BeanDefinition.getFactoryBeanName()
Return the factory bean name, if any.
|
String |
BeanDefinition.getFactoryMethodName()
Return a factory method, if any.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType)
Look for a generic argument value that matches the given type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType,
String requiredName)
Look for a generic argument value that matches the given type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for the next generic argument value that matches the given type,
ignoring argument values that have already been used in the current
resolution process.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getIndexedArgumentValue(int index,
Class<?> requiredType)
Get argument value for the given index in the constructor argument list.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getIndexedArgumentValue(int index,
Class<?> requiredType,
String requiredName)
Get argument value for the given index in the constructor argument list.
|
String |
BeanDefinition.getInitMethodName()
Return the name of the initializer method.
|
String |
ConstructorArgumentValues.ValueHolder.getName()
Return the name of the constructor argument.
|
Object |
FieldRetrievingFactoryBean.getObject() |
Map<String,Object> |
YamlMapFactoryBean.getObject() |
Properties |
YamlPropertiesFactoryBean.getObject() |
Object |
MethodInvokingFactoryBean.getObject()
Returns the same value each time if the singleton property is set
to "true", otherwise returns the value returned from invoking the
specified method on the fly.
|
Object |
ServiceLocatorFactoryBean.getObject() |
Properties |
PropertiesFactoryBean.getObject() |
Object |
PropertyPathFactoryBean.getObject() |
Object |
BeanExpressionContext.getObject(String key) |
abstract Class<?> |
AbstractFactoryBean.getObjectType()
This abstract method declaration mirrors the method in the FactoryBean
interface, for a consistent offering of abstract template methods.
|
BeanDefinition |
BeanDefinition.getOriginatingBeanDefinition()
Return the originating BeanDefinition, or
null if none. |
String |
BeanDefinition.getParentName()
Return the name of the parent definition of this bean definition, if any.
|
Scope |
ConfigurableBeanFactory.getRegisteredScope(String scopeName)
Return the Scope implementation for the given scope name, if any.
|
String |
BeanDefinition.getResourceDescription()
Return a description of the resource that this bean definition
came from (for the purpose of showing context in case of errors).
|
Scope |
BeanExpressionContext.getScope() |
String |
BeanDefinition.getScope()
Return the name of the current target scope for this bean,
or
null if not known yet. |
Object |
SingletonBeanRegistry.getSingleton(String beanName)
Return the (raw) singleton object registered under the given name.
|
Object |
BeanDefinitionHolder.getSource()
Expose the bean definition's source object.
|
Object |
TypedStringValue.getSource() |
Object |
RuntimeBeanNameReference.getSource() |
Object |
ConstructorArgumentValues.ValueHolder.getSource() |
Object |
RuntimeBeanReference.getSource() |
String |
TypedStringValue.getSpecifiedTypeName()
Return the type name as actually specified for this particular value, if any.
|
Class<?> |
FieldRetrievingFactoryBean.getTargetClass()
Return the target class on which the field is defined.
|
String |
FieldRetrievingFactoryBean.getTargetField()
Return the name of the field to be retrieved.
|
Object |
FieldRetrievingFactoryBean.getTargetObject()
Return the target object on which the field is defined.
|
String |
TypedStringValue.getTargetTypeName()
Return the type to convert to.
|
ClassLoader |
ConfigurableBeanFactory.getTempClassLoader()
Return the temporary ClassLoader to use for type matching purposes,
if any.
|
String |
ConstructorArgumentValues.ValueHolder.getType()
Return the type of the constructor argument.
|
String |
TypedStringValue.getValue()
Return the String value.
|
Object |
ConstructorArgumentValues.ValueHolder.getValue()
Return the value for the constructor argument.
|
protected Object |
MethodInvokingBean.invokeWithTargetException()
Perform the invocation and convert InvocationTargetException
into the underlying target exception.
|
default Object |
BeanPostProcessor.postProcessAfterInitialization(Object bean,
String beanName)
Apply this
BeanPostProcessor to the given new bean instance after any bean
initialization callbacks (like InitializingBean's afterPropertiesSet
or a custom init-method). |
default Object |
BeanPostProcessor.postProcessBeforeInitialization(Object bean,
String beanName)
Apply this
BeanPostProcessor to the given new bean instance before any bean
initialization callbacks (like InitializingBean's afterPropertiesSet
or a custom init-method). |
default Object |
InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(Class<?> beanClass,
String beanName)
Apply this BeanPostProcessor before the target bean gets instantiated.
|
default PropertyValues |
InstantiationAwareBeanPostProcessor.postProcessProperties(PropertyValues pvs,
Object bean,
String beanName)
Post-process the given property values before the factory applies them
to the given bean, without any need for property descriptors.
|
default PropertyValues |
InstantiationAwareBeanPostProcessor.postProcessPropertyValues(PropertyValues pvs,
PropertyDescriptor[] pds,
Object bean,
String beanName)
Deprecated.
as of 5.1, in favor of
InstantiationAwareBeanPostProcessor.postProcessProperties(PropertyValues, Object, String) |
default Class<?> |
SmartInstantiationAwareBeanPostProcessor.predictBeanType(Class<?> beanClass,
String beanName)
Predict the type of the bean to be eventually returned from this
processor's
InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String) callback. |
Object |
Scope.remove(String name)
Remove the object with the given
name from the underlying scope. |
Object |
Scope.resolveContextualObject(String key)
Resolve the contextual object for the given key, if any.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName)
Resolve the specified dependency against the beans defined in this factory.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter)
Resolve the specified dependency against the beans defined in this factory.
|
String |
ConfigurableBeanFactory.resolveEmbeddedValue(String value)
Resolve the given embedded value, e.g.
|
Object |
DependencyDescriptor.resolveNotUnique(Class<?> type,
Map<String,Object> matchingBeans)
Deprecated.
as of 5.1, in favor of
DependencyDescriptor.resolveNotUnique(ResolvableType, Map) |
Object |
DependencyDescriptor.resolveNotUnique(ResolvableType type,
Map<String,Object> matchingBeans)
Resolve the specified not-unique scenario: by default,
throwing a
NoUniqueBeanDefinitionException . |
protected String |
PropertyPlaceholderConfigurer.resolvePlaceholder(String placeholder,
Properties props)
Deprecated.
Resolve the given placeholder using the given properties.
|
protected String |
PropertyPlaceholderConfigurer.resolvePlaceholder(String placeholder,
Properties props,
int systemPropertiesMode)
Deprecated.
Resolve the given placeholder using the given properties, performing
a system properties check according to the given mode.
|
protected String |
PreferencesPlaceholderConfigurer.resolvePlaceholder(String path,
String key,
Preferences preferences)
Deprecated.
Resolve the given path and key against the given Preferences.
|
Object |
DependencyDescriptor.resolveShortcut(BeanFactory beanFactory)
Resolve a shortcut for this dependency against the given factory, for example
taking some pre-resolved information into account.
|
protected String |
BeanDefinitionVisitor.resolveStringValue(String strVal)
Resolve the given String value, for example parsing placeholders.
|
String |
EmbeddedValueResolver.resolveStringValue(String strVal) |
protected String |
PropertyPlaceholderConfigurer.resolveSystemProperty(String key)
Deprecated.
Resolve the given key as JVM system property, and optionally also as
system environment variable if no matching system property has been found.
|
Class<?> |
TypedStringValue.resolveTargetType(ClassLoader classLoader)
Determine the type to convert to, resolving it from a specified class name
if necessary.
|
protected Object |
BeanDefinitionVisitor.resolveValue(Object value) |
Modifier and Type | Method and Description |
---|---|
void |
ConstructorArgumentValues.addArgumentValues(ConstructorArgumentValues other)
Copy all given argument values into this object, using separate holder
instances to keep the values independent of the original object.
|
void |
ConstructorArgumentValues.addIndexedArgumentValue(int index,
Object value)
Add an argument value for the given index in the constructor argument list.
|
void |
ConstructorArgumentValues.addIndexedArgumentValue(int index,
Object value,
String type)
Add an argument value for the given index in the constructor argument list.
|
protected void |
AbstractFactoryBean.destroyInstance(T instance)
Callback for destroying a singleton instance.
|
boolean |
BeanDefinitionHolder.equals(Object other) |
boolean |
AutowiredPropertyMarker.equals(Object obj) |
boolean |
TypedStringValue.equals(Object other) |
boolean |
RuntimeBeanNameReference.equals(Object other) |
boolean |
BeanExpressionContext.equals(Object other) |
boolean |
DependencyDescriptor.equals(Object other) |
boolean |
ConstructorArgumentValues.equals(Object other) |
boolean |
RuntimeBeanReference.equals(Object other) |
Object |
BeanExpressionResolver.evaluate(String value,
BeanExpressionContext beanExpressionContext)
Evaluate the given value as an expression, if applicable;
return the value as-is otherwise.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getArgumentValue(int index,
Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for an argument value that either corresponds to the given index
in the constructor argument list or generically matches by type.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for the next generic argument value that matches the given type,
ignoring argument values that have already been used in the current
resolution process.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for the next generic argument value that matches the given type,
ignoring argument values that have already been used in the current
resolution process.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getGenericArgumentValue(Class<?> requiredType,
String requiredName,
Set<ConstructorArgumentValues.ValueHolder> usedValueHolders)
Look for the next generic argument value that matches the given type,
ignoring argument values that have already been used in the current
resolution process.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getIndexedArgumentValue(int index,
Class<?> requiredType)
Get argument value for the given index in the constructor argument list.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getIndexedArgumentValue(int index,
Class<?> requiredType,
String requiredName)
Get argument value for the given index in the constructor argument list.
|
ConstructorArgumentValues.ValueHolder |
ConstructorArgumentValues.getIndexedArgumentValue(int index,
Class<?> requiredType,
String requiredName)
Get argument value for the given index in the constructor argument list.
|
void |
DependencyDescriptor.initParameterNameDiscovery(ParameterNameDiscoverer parameterNameDiscoverer)
Initialize parameter name discovery for the underlying method parameter, if any.
|
boolean |
BeanDefinitionHolder.matchesName(String candidateName)
Determine whether the given candidate name matches the bean name
or the aliases stored in this bean definition.
|
void |
ConfigurableListableBeanFactory.registerResolvableDependency(Class<?> dependencyType,
Object autowiredValue)
Register a special dependency type with corresponding autowired value.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName)
Resolve the specified dependency against the beans defined in this factory.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter)
Resolve the specified dependency against the beans defined in this factory.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter)
Resolve the specified dependency against the beans defined in this factory.
|
Object |
AutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter)
Resolve the specified dependency against the beans defined in this factory.
|
protected String |
PreferencesPlaceholderConfigurer.resolvePlaceholder(String path,
String key,
Preferences preferences)
Deprecated.
Resolve the given path and key against the given Preferences.
|
Class<?> |
TypedStringValue.resolveTargetType(ClassLoader classLoader)
Determine the type to convert to, resolving it from a specified class name
if necessary.
|
protected Object |
BeanDefinitionVisitor.resolveValue(Object value) |
void |
CustomScopeConfigurer.setBeanClassLoader(ClassLoader beanClassLoader) |
void |
ConfigurableBeanFactory.setBeanClassLoader(ClassLoader beanClassLoader)
Set the class loader to use for loading bean classes.
|
void |
BeanDefinition.setBeanClassName(String beanClassName)
Specify the bean class name of this bean definition.
|
void |
ConfigurableBeanFactory.setBeanExpressionResolver(BeanExpressionResolver resolver)
Specify the resolution strategy for expressions in bean definition values.
|
void |
AbstractFactoryBean.setBeanFactory(BeanFactory beanFactory) |
void |
ConfigurableBeanFactory.setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting
property values, as an alternative to JavaBeans PropertyEditors.
|
void |
ConstructorArgumentValues.ValueHolder.setConvertedValue(Object value)
Set the converted value of the constructor argument,
after processed type conversion.
|
void |
BeanDefinition.setDependsOn(String... dependsOn)
Set the names of the beans that this bean depends on being initialized.
|
void |
BeanDefinition.setDescription(String description)
Set a human-readable description of this bean definition.
|
void |
BeanDefinition.setDestroyMethodName(String destroyMethodName)
Set the name of the destroy method.
|
void |
BeanDefinition.setFactoryBeanName(String factoryBeanName)
Specify the factory bean to use, if any.
|
void |
BeanDefinition.setFactoryMethodName(String factoryMethodName)
Specify a factory method, if any.
|
void |
BeanDefinition.setInitMethodName(String initMethodName)
Set the name of the initializer method.
|
void |
ConstructorArgumentValues.ValueHolder.setName(String name)
Set the name of the constructor argument.
|
void |
BeanDefinition.setParentName(String parentName)
Set the name of the parent definition of this bean definition, if any.
|
void |
BeanDefinition.setScope(String scope)
Override the target scope of this bean, specifying a new scope name.
|
void |
TypedStringValue.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
RuntimeBeanNameReference.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
ConstructorArgumentValues.ValueHolder.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
RuntimeBeanReference.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
TypedStringValue.setSpecifiedTypeName(String specifiedTypeName)
Set the type name as actually specified for this particular value, if any.
|
void |
FieldRetrievingFactoryBean.setTargetClass(Class<?> targetClass)
Set the target class on which the field is defined.
|
void |
FieldRetrievingFactoryBean.setTargetField(String targetField)
Set the name of the field to be retrieved.
|
void |
ListFactoryBean.setTargetListClass(Class<? extends List> targetListClass)
Set the class to use for the target List.
|
void |
MapFactoryBean.setTargetMapClass(Class<? extends Map> targetMapClass)
Set the class to use for the target Map.
|
void |
FieldRetrievingFactoryBean.setTargetObject(Object targetObject)
Set the target object on which the field is defined.
|
void |
SetFactoryBean.setTargetSetClass(Class<? extends Set> targetSetClass)
Set the class to use for the target Set.
|
void |
TypedStringValue.setTargetTypeName(String targetTypeName)
Specify the type to convert to.
|
void |
ConfigurableBeanFactory.setTempClassLoader(ClassLoader tempClassLoader)
Specify a temporary ClassLoader to use for type matching purposes.
|
void |
ConstructorArgumentValues.ValueHolder.setType(String type)
Set the type of the constructor argument.
|
void |
ConstructorArgumentValues.ValueHolder.setValue(Object value)
Set the value for the constructor argument.
|
void |
TypedStringValue.setValue(String value)
Set the String value.
|
void |
PlaceholderConfigurerSupport.setValueSeparator(String valueSeparator)
Specify the separating character between the placeholder variable
and the associated default value, or
null if no such
special character should be processed as a value separator. |
Constructor and Description |
---|
BeanDefinitionHolder(BeanDefinition beanDefinition,
String beanName,
String[] aliases)
Create a new BeanDefinitionHolder.
|
BeanExpressionContext(ConfigurableBeanFactory beanFactory,
Scope scope) |
TypedStringValue(String value)
Create a new
TypedStringValue for the given String value. |
TypedStringValue(String value,
Class<?> targetType)
Create a new
TypedStringValue for the given String value
and target type. |
TypedStringValue(String value,
String targetTypeName)
Create a new
TypedStringValue for the given String value
and target type. |
ValueHolder(Object value)
Create a new ValueHolder for the given value.
|
ValueHolder(Object value,
String type)
Create a new ValueHolder for the given value and type.
|
ValueHolder(Object value,
String type)
Create a new ValueHolder for the given value and type.
|
ValueHolder(Object value,
String type,
String name)
Create a new ValueHolder for the given value, type and name.
|
ValueHolder(Object value,
String type,
String name)
Create a new ValueHolder for the given value, type and name.
|
ValueHolder(Object value,
String type,
String name)
Create a new ValueHolder for the given value, type and name.
|
Modifier and Type | Method and Description |
---|---|
Object |
ReaderContext.extractSource(Object sourceCandidate)
Call the source extractor for the given source object.
|
Object |
SourceExtractor.extractSource(Object sourceCandidate,
Resource definingResource)
Extract the source metadata from the candidate object supplied
by the configuration parser.
|
Object |
NullSourceExtractor.extractSource(Object sourceCandidate,
Resource definitionResource)
This implementation simply returns
null for any input. |
Resource[] |
ImportDefinition.getActualResources() |
ParseState |
Problem.getParseState()
Get the
ParseState at the time of the error (may be null ). |
Throwable |
Problem.getRootCause()
Get the underlying exception that caused the error (may be
null ). |
Object |
AliasDefinition.getSource() |
Object |
Location.getSource()
Get the actual location within the associated
resource
(may be null ). |
Object |
CompositeComponentDefinition.getSource() |
Object |
ImportDefinition.getSource() |
ParseState.Entry |
ParseState.peek()
Return the
ParseState.Entry currently at the top of the ArrayDeque or
null if the ArrayDeque is empty. |
Modifier and Type | Method and Description |
---|---|
boolean |
BeanComponentDefinition.equals(Object other)
This implementation expects the other object to be of type BeanComponentDefinition
as well, in addition to the superclass's equality requirements.
|
void |
ReaderContext.error(String message,
Object source)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
ParseState parseState)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
ParseState parseState)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
Throwable cause)
Raise a regular error.
|
void |
ReaderContext.error(String message,
Object source,
Throwable cause)
Raise a regular error.
|
Object |
SourceExtractor.extractSource(Object sourceCandidate,
Resource definingResource)
Extract the source metadata from the candidate object supplied
by the configuration parser.
|
Object |
NullSourceExtractor.extractSource(Object sourceCandidate,
Resource definitionResource)
This implementation simply returns
null for any input. |
Object |
PassThroughSourceExtractor.extractSource(Object sourceCandidate,
Resource definingResource)
Simply returns the supplied
sourceCandidate as-is. |
void |
ReaderContext.fatal(String message,
Object source)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
ParseState parseState)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
ParseState parseState)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
Throwable cause)
Raise a fatal error.
|
void |
ReaderContext.fatal(String message,
Object source,
Throwable cause)
Raise a fatal error.
|
void |
ReaderContext.fireAliasRegistered(String beanName,
String alias,
Object source)
Fire an alias-registered event.
|
void |
ReaderContext.fireImportProcessed(String importedResource,
Object source)
Fire an import-processed event.
|
void |
ReaderContext.fireImportProcessed(String importedResource,
Resource[] actualResources,
Object source)
Fire an import-processed event.
|
void |
FailFastProblemReporter.setLogger(Log logger)
Set the
logger that is to be used to report warnings. |
void |
ReaderContext.warning(String message,
Object source)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
ParseState parseState)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
ParseState parseState)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
ParseState parseState,
Throwable cause)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
Throwable cause)
Raise a non-critical warning.
|
void |
ReaderContext.warning(String message,
Object source,
Throwable cause)
Raise a non-critical warning.
|
Constructor and Description |
---|
AliasDefinition(String beanName,
String alias,
Object source)
Create a new AliasDefinition.
|
BeanComponentDefinition(BeanDefinition beanDefinition,
String beanName,
String[] aliases)
Create a new BeanComponentDefinition for the given bean.
|
CompositeComponentDefinition(String name,
Object source)
Create a new CompositeComponentDefinition.
|
ImportDefinition(String importedResource,
Object source)
Create a new ImportDefinition.
|
ImportDefinition(String importedResource,
Resource[] actualResources,
Object source)
Create a new ImportDefinition.
|
ImportDefinition(String importedResource,
Resource[] actualResources,
Object source)
Create a new ImportDefinition.
|
Location(Resource resource,
Object source)
Create a new instance of the
Location class. |
Problem(String message,
Location location,
ParseState parseState,
Throwable rootCause)
Create a new instance of the
Problem class. |
Problem(String message,
Location location,
ParseState parseState,
Throwable rootCause)
Create a new instance of the
Problem class. |
Modifier and Type | Method and Description |
---|---|
Class<?> |
ServiceFactoryBean.getObjectType() |
Class<?> |
AbstractServiceLoaderBasedFactoryBean.getServiceType()
Return the desired service type.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractServiceLoaderBasedFactoryBean.setBeanClassLoader(ClassLoader beanClassLoader) |
void |
AbstractServiceLoaderBasedFactoryBean.setServiceType(Class<?> serviceType)
Specify the desired service type (typically the service's public API).
|
Modifier and Type | Method and Description |
---|---|
protected Object |
AbstractAutowireCapableBeanFactory.applyBeanPostProcessorsBeforeInstantiation(Class<?> beanClass,
String beanName)
Apply InstantiationAwareBeanPostProcessors to the specified bean definition
(by class and name), invoking their
postProcessBeforeInstantiation methods. |
protected String |
DefaultListableBeanFactory.determineAutowireCandidate(Map<String,Object> candidates,
DependencyDescriptor descriptor)
Determine the autowire candidate in the given set of beans.
|
protected Constructor<?>[] |
AbstractAutowireCapableBeanFactory.determineConstructorsFromBeanPostProcessors(Class<?> beanClass,
String beanName)
Determine candidate constructors to use for the given bean, checking all registered
SmartInstantiationAwareBeanPostProcessors . |
protected String |
DefaultListableBeanFactory.determineHighestPriorityCandidate(Map<String,Object> candidates,
Class<?> requiredType)
Determine the candidate with the highest priority in the given set of beans.
|
protected String |
DefaultListableBeanFactory.determinePrimaryCandidate(Map<String,Object> candidates,
Class<?> requiredType)
Determine the primary candidate in the given set of beans.
|
protected Class<?> |
AbstractAutowireCapableBeanFactory.determineTargetType(String beanName,
RootBeanDefinition mbd,
Class<?>... typesToMatch)
Determine the target type for the given bean definition.
|
Object |
DefaultListableBeanFactory.doResolveDependency(DependencyDescriptor descriptor,
String beanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
protected Object |
AbstractBeanFactory.evaluateBeanDefinitionString(String value,
BeanDefinition beanDefinition)
Evaluate the given String as contained in a bean definition,
potentially resolving it as an expression.
|
<A extends Annotation> |
StaticListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType) |
<A extends Annotation> |
DefaultListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType) |
<A extends Annotation> |
StaticListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType,
boolean allowFactoryBeanInit) |
<A extends Annotation> |
DefaultListableBeanFactory.findAnnotationOnBean(String beanName,
Class<A> annotationType,
boolean allowFactoryBeanInit) |
ClassLoader |
AbstractBeanDefinitionReader.getBeanClassLoader() |
ClassLoader |
BeanDefinitionReader.getBeanClassLoader()
Return the class loader to use for bean classes.
|
ClassLoader |
AbstractBeanFactory.getBeanClassLoader() |
String |
AbstractBeanDefinition.getBeanClassName()
Return the current bean class name of this bean definition.
|
BeanExpressionResolver |
AbstractBeanFactory.getBeanExpressionResolver() |
protected BeanFactory |
GenericTypeAwareAutowireCandidateResolver.getBeanFactory() |
String |
LookupOverride.getBeanName()
Return the name of the bean that should be returned by this method.
|
protected Object |
FactoryBeanRegistrySupport.getCachedObjectForFactoryBean(String beanName)
Obtain an object to expose from the given FactoryBean, if available
in cached form.
|
ConversionService |
AbstractBeanFactory.getConversionService() |
static Method |
SimpleInstantiationStrategy.getCurrentlyInvokedFactoryMethod()
Return the factory method currently being invoked or
null if none. |
protected TypeConverter |
AbstractBeanFactory.getCustomTypeConverter()
Return the custom TypeConverter to use, if any.
|
BeanDefinitionHolder |
RootBeanDefinition.getDecoratedDefinition()
Return the target definition that is being decorated by this bean definition, if any.
|
String |
PropertiesBeanDefinitionReader.getDefaultParentBean()
Deprecated.
Return the default parent bean for this bean factory.
|
Comparator<Object> |
DefaultListableBeanFactory.getDependencyComparator()
Return the dependency comparator for this BeanFactory (may be
null ). |
String[] |
AbstractBeanDefinition.getDependsOn()
Return the bean names that this bean depends on.
|
String |
AbstractBeanDefinition.getDescription()
Return a human-readable description of this bean definition.
|
String |
BeanDefinitionDefaults.getDestroyMethodName()
Return the name of the default destroy method.
|
String |
AbstractBeanDefinition.getDestroyMethodName()
Return the name of the destroy method.
|
String |
ManagedSet.getElementTypeName()
Return the default element type name (class name) to be used for this set.
|
String |
ManagedList.getElementTypeName()
Return the default element type name (class name) to be used for this list.
|
String |
AbstractBeanDefinition.getFactoryBeanName()
Return the factory bean name, if any.
|
String |
AbstractBeanDefinition.getFactoryMethodName()
Return a factory method, if any.
|
String |
BeanDefinitionDefaults.getInitMethodName()
Return the name of the default initializer method.
|
String |
AbstractBeanDefinition.getInitMethodName()
Return the name of the initializer method.
|
Supplier<?> |
AbstractBeanDefinition.getInstanceSupplier()
Return a callback for creating an instance of the bean, if any.
|
String |
ManagedMap.getKeyTypeName()
Return the default key type name (class name) to be used for this map.
|
Boolean |
BeanDefinitionDefaults.getLazyInit()
Return whether beans should be lazily initialized by default, i.e.
|
Boolean |
AbstractBeanDefinition.getLazyInit()
Return whether this bean should be lazily initialized, i.e.
|
Object |
SimpleAutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName) |
default Object |
AutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName)
Build a proxy for lazy resolution of the actual dependency target,
if demanded by the injection point.
|
BeanDefinition |
AbstractBeanDefinition.getOriginatingBeanDefinition()
Return the originating BeanDefinition, or
null if none. |
MethodOverride |
MethodOverrides.getOverride(Method method)
Return the override for the given method, if any.
|
protected ParameterNameDiscoverer |
AbstractAutowireCapableBeanFactory.getParameterNameDiscoverer()
Return the ParameterNameDiscoverer to use for resolving method parameter
names if needed.
|
BeanFactory |
AbstractBeanFactory.getParentBeanFactory() |
String |
GenericBeanDefinition.getParentName() |
String |
ChildBeanDefinition.getParentName() |
Constructor<?>[] |
RootBeanDefinition.getPreferredConstructors()
Determine preferred constructors to use for default construction, if any.
|
protected Integer |
DefaultListableBeanFactory.getPriority(Object beanInstance)
Return the priority assigned for the given bean instance by
the
javax.annotation.Priority annotation. |
AnnotatedElement |
RootBeanDefinition.getQualifiedElement()
Return the
AnnotatedElement defining qualifiers, if any. |
AutowireCandidateQualifier |
AbstractBeanDefinition.getQualifier(String typeName)
Return the qualifier mapped to the provided type name.
|
Scope |
AbstractBeanFactory.getRegisteredScope(String scopeName) |
protected RootBeanDefinition |
GenericTypeAwareAutowireCandidateResolver.getResolvedDecoratedDefinition(RootBeanDefinition rbd) |
Method |
RootBeanDefinition.getResolvedFactoryMethod()
Return the resolved factory method as a Java Method object, if available.
|
Resource |
AbstractBeanDefinition.getResource()
Return the resource that this bean definition came from.
|
String |
AbstractBeanDefinition.getResourceDescription()
Return a description of the resource that this bean definition
came from (for the purpose of showing context in case of errors).
|
ResourceLoader |
AbstractBeanDefinitionReader.getResourceLoader() |
ResourceLoader |
BeanDefinitionReader.getResourceLoader()
Return the
ResourceLoader to use for resource locations. |
protected ResolvableType |
GenericTypeAwareAutowireCandidateResolver.getReturnTypeForFactoryMethod(RootBeanDefinition rbd,
DependencyDescriptor descriptor) |
String |
AbstractBeanDefinition.getScope()
Return the name of the target scope for the bean.
|
String |
DefaultListableBeanFactory.getSerializationId()
Return an id for serialization purposes, if specified, allowing this BeanFactory
to be deserialized from this id back into the BeanFactory object, if needed.
|
Object |
DefaultSingletonBeanRegistry.getSingleton(String beanName) |
protected Object |
DefaultSingletonBeanRegistry.getSingleton(String beanName,
boolean allowEarlyReference)
Return the (raw) singleton object registered under the given name.
|
Object |
ManagedSet.getSource() |
Object |
ManagedList.getSource() |
Object |
ManagedMap.getSource() |
Object |
ManagedProperties.getSource() |
Object |
MethodOverride.getSource() |
Object |
SimpleAutowireCandidateResolver.getSuggestedValue(DependencyDescriptor descriptor) |
default Object |
AutowireCandidateResolver.getSuggestedValue(DependencyDescriptor descriptor)
Determine whether a default value is suggested for the given dependency.
|
Class<?> |
RootBeanDefinition.getTargetType()
Return the target type of this bean definition, if known
(either specified in advance or resolved on first instantiation).
|
ClassLoader |
AbstractBeanFactory.getTempClassLoader() |
Class<?> |
AbstractBeanFactory.getType(String name) |
Class<?> |
AbstractBeanFactory.getType(String name,
boolean allowFactoryBeanInit) |
protected Class<?> |
FactoryBeanRegistrySupport.getTypeForFactoryBean(FactoryBean<?> factoryBean)
Determine the type for the given FactoryBean.
|
protected Class<?> |
AbstractAutowireCapableBeanFactory.getTypeForFactoryBean(String beanName,
RootBeanDefinition mbd)
Deprecated.
|
protected Class<?> |
AbstractBeanFactory.getTypeForFactoryBean(String beanName,
RootBeanDefinition mbd)
Deprecated.
since 5.2 in favor of
AbstractBeanFactory.getTypeForFactoryBean(String, RootBeanDefinition, boolean) |
protected Class<?> |
AbstractAutowireCapableBeanFactory.getTypeForFactoryMethod(String beanName,
RootBeanDefinition mbd,
Class<?>... typesToMatch)
Determine the target type for the given bean definition which is based on
a factory method.
|
String |
ManagedMap.getValueTypeName()
Return the default value type name (class name) to be used for this map.
|
protected Class<?> |
AbstractAutowireCapableBeanFactory.predictBeanType(String beanName,
RootBeanDefinition mbd,
Class<?>... typesToMatch) |
protected Class<?> |
AbstractBeanFactory.predictBeanType(String beanName,
RootBeanDefinition mbd,
Class<?>... typesToMatch)
Predict the eventual bean type (of the processed bean instance) for the
specified bean.
|
Class<?> |
AbstractBeanDefinition.resolveBeanClass(ClassLoader classLoader)
Determine the class of the wrapped bean, resolving it from a
specified class name if necessary.
|
protected Class<?> |
AbstractBeanFactory.resolveBeanClass(RootBeanDefinition mbd,
String beanName,
Class<?>... typesToMatch)
Resolve the bean class for the specified bean definition,
resolving a bean class name into a Class reference (if necessary)
and storing the resolved Class in the bean definition for further use.
|
protected Object |
AbstractAutowireCapableBeanFactory.resolveBeforeInstantiation(String beanName,
RootBeanDefinition mbd)
Apply before-instantiation post-processors, resolving whether there is a
before-instantiation shortcut for the specified bean.
|
Object |
AbstractAutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName) |
Object |
DefaultListableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
String |
AbstractBeanFactory.resolveEmbeddedValue(String value) |
Modifier and Type | Method and Description |
---|---|
BeanDefinitionBuilder |
BeanDefinitionBuilder.addConstructorArgValue(Object value)
Add an indexed constructor arg value.
|
void |
MethodOverrides.addOverrides(MethodOverrides other)
Copy all given method overrides into this object.
|
BeanDefinitionBuilder |
BeanDefinitionBuilder.addPropertyValue(String name,
Object value)
Add the supplied property value under the given property name.
|
protected BeanWrapper |
AbstractAutowireCapableBeanFactory.autowireConstructor(String beanName,
RootBeanDefinition mbd,
Constructor<?>[] ctors,
Object[] explicitArgs)
"autowire constructor" (with constructor arguments by type) behavior.
|
protected BeanWrapper |
AbstractAutowireCapableBeanFactory.autowireConstructor(String beanName,
RootBeanDefinition mbd,
Constructor<?>[] ctors,
Object[] explicitArgs)
"autowire constructor" (with constructor arguments by type) behavior.
|
protected void |
AbstractAutowireCapableBeanFactory.checkDependencies(String beanName,
AbstractBeanDefinition mbd,
PropertyDescriptor[] pds,
PropertyValues pvs)
Perform a dependency check that all properties exposed have been set,
if desired.
|
protected void |
AbstractBeanFactory.checkMergedBeanDefinition(RootBeanDefinition mbd,
String beanName,
Object[] args)
Check the given merged bean definition,
potentially throwing validation exceptions.
|
protected Object |
AbstractAutowireCapableBeanFactory.createBean(String beanName,
RootBeanDefinition mbd,
Object[] args)
Central method of this class: creates a bean instance,
populates the bean instance, applies post-processors, etc.
|
protected abstract Object |
AbstractBeanFactory.createBean(String beanName,
RootBeanDefinition mbd,
Object[] args)
Create a bean instance for the given merged bean definition (and arguments).
|
static AbstractBeanDefinition |
BeanDefinitionReaderUtils.createBeanDefinition(String parentName,
String className,
ClassLoader classLoader)
Create a new GenericBeanDefinition for the given parent name and class name,
eagerly loading the bean class if a ClassLoader has been specified.
|
static AbstractBeanDefinition |
BeanDefinitionReaderUtils.createBeanDefinition(String parentName,
String className,
ClassLoader classLoader)
Create a new GenericBeanDefinition for the given parent name and class name,
eagerly loading the bean class if a ClassLoader has been specified.
|
static AbstractBeanDefinition |
BeanDefinitionReaderUtils.createBeanDefinition(String parentName,
String className,
ClassLoader classLoader)
Create a new GenericBeanDefinition for the given parent name and class name,
eagerly loading the bean class if a ClassLoader has been specified.
|
protected BeanWrapper |
AbstractAutowireCapableBeanFactory.createBeanInstance(String beanName,
RootBeanDefinition mbd,
Object[] args)
Create a new instance for the specified bean, using an appropriate instantiation strategy:
factory method, constructor autowiring, or simple instantiation.
|
protected void |
DefaultSingletonBeanRegistry.destroyBean(String beanName,
DisposableBean bean)
Destroy the given bean.
|
protected Constructor<?>[] |
AbstractAutowireCapableBeanFactory.determineConstructorsFromBeanPostProcessors(Class<?> beanClass,
String beanName)
Determine candidate constructors to use for the given bean, checking all registered
SmartInstantiationAwareBeanPostProcessors . |
protected Object |
AbstractAutowireCapableBeanFactory.doCreateBean(String beanName,
RootBeanDefinition mbd,
Object[] args)
Actually create the specified bean.
|
protected <T> T |
AbstractBeanFactory.doGetBean(String name,
Class<T> requiredType,
Object[] args,
boolean typeCheckOnly)
Return an instance, which may be shared or independent, of the specified bean.
|
protected <T> T |
AbstractBeanFactory.doGetBean(String name,
Class<T> requiredType,
Object[] args,
boolean typeCheckOnly)
Return an instance, which may be shared or independent, of the specified bean.
|
Object |
DefaultListableBeanFactory.doResolveDependency(DependencyDescriptor descriptor,
String beanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
Object |
DefaultListableBeanFactory.doResolveDependency(DependencyDescriptor descriptor,
String beanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
Object |
DefaultListableBeanFactory.doResolveDependency(DependencyDescriptor descriptor,
String beanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
boolean |
LookupOverride.equals(Object other) |
boolean |
RootBeanDefinition.equals(Object other) |
boolean |
MethodOverrides.equals(Object other) |
boolean |
GenericBeanDefinition.equals(Object other) |
boolean |
ChildBeanDefinition.equals(Object other) |
boolean |
ReplaceOverride.equals(Object other) |
boolean |
MethodOverride.equals(Object other) |
boolean |
AbstractBeanDefinition.equals(Object other) |
protected Object |
AbstractBeanFactory.evaluateBeanDefinitionString(String value,
BeanDefinition beanDefinition)
Evaluate the given String as contained in a bean definition,
potentially resolving it as an expression.
|
protected Object |
AbstractBeanFactory.evaluateBeanDefinitionString(String value,
BeanDefinition beanDefinition)
Evaluate the given String as contained in a bean definition,
potentially resolving it as an expression.
|
protected Map<String,Object> |
DefaultListableBeanFactory.findAutowireCandidates(String beanName,
Class<?> requiredType,
DependencyDescriptor descriptor)
Find bean instances that match the required type.
|
<T> T |
DefaultListableBeanFactory.getBean(Class<T> requiredType,
Object... args) |
<T> T |
StaticListableBeanFactory.getBean(String name,
Class<T> requiredType) |
<T> T |
AbstractBeanFactory.getBean(String name,
Class<T> requiredType,
Object... args)
Return an instance, which may be shared or independent, of the specified bean.
|
<T> T |
AbstractBeanFactory.getBean(String name,
Class<T> requiredType,
Object... args)
Return an instance, which may be shared or independent, of the specified bean.
|
String[] |
StaticListableBeanFactory.getBeanNamesForType(Class<?> type) |
String[] |
DefaultListableBeanFactory.getBeanNamesForType(Class<?> type) |
String[] |
StaticListableBeanFactory.getBeanNamesForType(Class<?> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
String[] |
DefaultListableBeanFactory.getBeanNamesForType(Class<?> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
String[] |
StaticListableBeanFactory.getBeanNamesForType(ResolvableType type) |
String[] |
StaticListableBeanFactory.getBeanNamesForType(ResolvableType type,
boolean includeNonSingletons,
boolean allowEagerInit) |
<T> Map<String,T> |
StaticListableBeanFactory.getBeansOfType(Class<T> type) |
<T> Map<String,T> |
DefaultListableBeanFactory.getBeansOfType(Class<T> type) |
<T> Map<String,T> |
StaticListableBeanFactory.getBeansOfType(Class<T> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
<T> Map<String,T> |
DefaultListableBeanFactory.getBeansOfType(Class<T> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
Object |
SimpleAutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName) |
default Object |
AutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName)
Build a proxy for lazy resolution of the actual dependency target,
if demanded by the injection point.
|
protected RootBeanDefinition |
AbstractBeanFactory.getMergedBeanDefinition(String beanName,
BeanDefinition bd,
BeanDefinition containingBd)
Return a RootBeanDefinition for the given bean, by merging with the
parent if the given bean's definition is a child bean definition.
|
protected Object |
AbstractAutowireCapableBeanFactory.getObjectForBeanInstance(Object beanInstance,
String name,
String beanName,
RootBeanDefinition mbd)
Overridden in order to implicitly register the currently created bean as
dependent on further beans getting programmatically retrieved during a
Supplier callback. |
protected Object |
AbstractBeanFactory.getObjectForBeanInstance(Object beanInstance,
String name,
String beanName,
RootBeanDefinition mbd)
Get the object for the given bean instance, either the bean
instance itself or its created object in case of a FactoryBean.
|
protected Object |
AbstractAutowireCapableBeanFactory.initializeBean(String beanName,
Object bean,
RootBeanDefinition mbd)
Initialize the given bean instance, applying factory callbacks
as well as init methods and bean post processors.
|
Object |
InstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner)
Return an instance of the bean with the given name in this factory.
|
Object |
SimpleInstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner) |
Object |
InstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args)
Return an instance of the bean with the given name in this factory,
creating it via the given constructor.
|
Object |
SimpleInstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args) |
Object |
InstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Object factoryBean,
Method factoryMethod,
Object... args)
Return an instance of the bean with the given name in this factory,
creating it via the given factory method.
|
Object |
InstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Object factoryBean,
Method factoryMethod,
Object... args)
Return an instance of the bean with the given name in this factory,
creating it via the given factory method.
|
Object |
SimpleInstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Object factoryBean,
Method factoryMethod,
Object... args) |
Object |
SimpleInstantiationStrategy.instantiate(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Object factoryBean,
Method factoryMethod,
Object... args) |
protected BeanWrapper |
AbstractAutowireCapableBeanFactory.instantiateUsingFactoryMethod(String beanName,
RootBeanDefinition mbd,
Object[] explicitArgs)
Instantiate the bean using a named factory method.
|
protected Object |
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner) |
protected Object |
SimpleInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner)
Subclasses can override this method, which is implemented to throw
UnsupportedOperationException, if they can instantiate an object with
the Method Injection specified in the given RootBeanDefinition.
|
protected Object |
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args) |
protected Object |
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args) |
protected Object |
SimpleInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args)
Subclasses can override this method, which is implemented to throw
UnsupportedOperationException, if they can instantiate an object with
the Method Injection specified in the given RootBeanDefinition.
|
protected Object |
SimpleInstantiationStrategy.instantiateWithMethodInjection(RootBeanDefinition bd,
String beanName,
BeanFactory owner,
Constructor<?> ctor,
Object... args)
Subclasses can override this method, which is implemented to throw
UnsupportedOperationException, if they can instantiate an object with
the Method Injection specified in the given RootBeanDefinition.
|
protected void |
AbstractAutowireCapableBeanFactory.invokeInitMethods(String beanName,
Object bean,
RootBeanDefinition mbd)
Give a bean a chance to react now all its properties are set,
and a chance to know about its owning bean factory (this object).
|
boolean |
DefaultSingletonBeanRegistry.isSingletonCurrentlyInCreation(String beanName)
Return whether the specified singleton bean is currently in creation
(within the entire factory).
|
boolean |
StaticListableBeanFactory.isTypeMatch(String name,
Class<?> typeToMatch) |
int |
PropertiesBeanDefinitionReader.loadBeanDefinitions(EncodedResource encodedResource,
String prefix)
Deprecated.
Load bean definitions from the specified properties file.
|
int |
PropertiesBeanDefinitionReader.loadBeanDefinitions(Resource resource,
String prefix)
Deprecated.
Load bean definitions from the specified properties file.
|
int |
AbstractBeanDefinitionReader.loadBeanDefinitions(String location,
Set<Resource> actualResources)
Load bean definitions from the specified resource location.
|
protected boolean |
DefaultListableBeanFactory.matchesBeanName(String beanName,
String candidateName)
Determine whether the given candidate name matches the bean name or the aliases
stored in this bean definition.
|
Set<E> |
ManagedSet.merge(Object parent) |
List<E> |
ManagedList.merge(Object parent) |
Object |
ManagedMap.merge(Object parent) |
Object |
ManagedProperties.merge(Object parent) |
protected void |
AbstractAutowireCapableBeanFactory.populateBean(String beanName,
RootBeanDefinition mbd,
BeanWrapper bw)
Populate the bean instance in the given BeanWrapper with the property values
from the bean definition.
|
int |
PropertiesBeanDefinitionReader.registerBeanDefinitions(Map<?,?> map,
String prefix)
Deprecated.
Register bean definitions contained in a Map.
|
int |
PropertiesBeanDefinitionReader.registerBeanDefinitions(Map<?,?> map,
String prefix,
String resourceDescription)
Deprecated.
Register bean definitions contained in a Map.
|
int |
PropertiesBeanDefinitionReader.registerBeanDefinitions(ResourceBundle rb,
String prefix)
Deprecated.
Register bean definitions contained in a ResourceBundle.
|
void |
DefaultListableBeanFactory.registerResolvableDependency(Class<?> dependencyType,
Object autowiredValue) |
Class<?> |
AbstractBeanDefinition.resolveBeanClass(ClassLoader classLoader)
Determine the class of the wrapped bean, resolving it from a
specified class name if necessary.
|
Object |
AbstractAutowireCapableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName) |
Object |
DefaultListableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
Object |
DefaultListableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
Object |
DefaultListableBeanFactory.resolveDependency(DependencyDescriptor descriptor,
String requestingBeanName,
Set<String> autowiredBeanNames,
TypeConverter typeConverter) |
String |
AbstractBeanFactory.resolveEmbeddedValue(String value) |
static BeanDefinitionBuilder |
BeanDefinitionBuilder.rootBeanDefinition(Class<?> beanClass,
String factoryMethodName)
Create a new
BeanDefinitionBuilder used to construct a RootBeanDefinition . |
static BeanDefinitionBuilder |
BeanDefinitionBuilder.rootBeanDefinition(String beanClassName,
String factoryMethodName)
Create a new
BeanDefinitionBuilder used to construct a RootBeanDefinition . |
void |
AbstractBeanDefinition.setBeanClass(Class<?> beanClass)
Specify the class for this bean.
|
void |
AbstractBeanDefinitionReader.setBeanClassLoader(ClassLoader beanClassLoader)
Set the ClassLoader to use for bean classes.
|
void |
AbstractBeanFactory.setBeanClassLoader(ClassLoader beanClassLoader) |
void |
AbstractBeanDefinition.setBeanClassName(String beanClassName)
Specify the bean class name of this bean definition.
|
void |
AbstractBeanFactory.setBeanExpressionResolver(BeanExpressionResolver resolver) |
void |
AbstractBeanDefinitionReader.setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
Set the BeanNameGenerator to use for anonymous beans
(without explicit bean name specified).
|
void |
AbstractBeanFactory.setConversionService(ConversionService conversionService) |
void |
RootBeanDefinition.setDecoratedDefinition(BeanDefinitionHolder decoratedDefinition)
Register a target definition that is being decorated by this bean definition.
|
void |
PropertiesBeanDefinitionReader.setDefaultParentBean(String defaultParentBean)
Deprecated.
Set the default parent bean for this bean factory.
|
void |
DefaultListableBeanFactory.setDependencyComparator(Comparator<Object> dependencyComparator)
Set a
Comparator for dependency Lists and arrays. |
void |
AbstractBeanDefinition.setDependsOn(String... dependsOn)
Set the names of the beans that this bean depends on being initialized.
|
void |
AbstractBeanDefinition.setDescription(String description)
Set a human-readable description of this bean definition.
|
BeanDefinitionBuilder |
BeanDefinitionBuilder.setDestroyMethodName(String methodName)
Set the destroy method for this definition.
|
void |
BeanDefinitionDefaults.setDestroyMethodName(String destroyMethodName)
Set the name of the default destroy method.
|
void |
AbstractBeanDefinition.setDestroyMethodName(String destroyMethodName)
Set the name of the destroy method.
|
void |
ManagedSet.setElementTypeName(String elementTypeName)
Set the default element type name (class name) to be used for this set.
|
void |
AbstractBeanDefinition.setFactoryBeanName(String factoryBeanName)
Specify the factory bean to use, if any.
|
void |
AbstractBeanDefinition.setFactoryMethodName(String factoryMethodName)
Specify a factory method, if any.
|
BeanDefinitionBuilder |
BeanDefinitionBuilder.setInitMethodName(String methodName)
Set the init method for this definition.
|
void |
BeanDefinitionDefaults.setInitMethodName(String initMethodName)
Set the name of the default initializer method.
|
void |
AbstractBeanDefinition.setInitMethodName(String initMethodName)
Set the name of the initializer method.
|
void |
AbstractBeanDefinition.setInstanceSupplier(Supplier<?> instanceSupplier)
Specify a callback for creating an instance of the bean,
as an alternative to a declaratively specified factory method.
|
void |
ManagedMap.setKeyTypeName(String keyTypeName)
Set the default key type name (class name) to be used for this map.
|
void |
AbstractAutowireCapableBeanFactory.setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)
Set the ParameterNameDiscoverer to use for resolving method parameter
names if needed (e.g.
|
void |
AbstractBeanFactory.setParentBeanFactory(BeanFactory parentBeanFactory) |
void |
RootBeanDefinition.setParentName(String parentName) |
void |
GenericBeanDefinition.setParentName(String parentName) |
void |
ChildBeanDefinition.setParentName(String parentName) |
void |
PropertiesBeanDefinitionReader.setPropertiesPersister(PropertiesPersister propertiesPersister)
Deprecated.
Set the PropertiesPersister to use for parsing properties files.
|
void |
RootBeanDefinition.setQualifiedElement(AnnotatedElement qualifiedElement)
Specify the
AnnotatedElement defining qualifiers,
to be used instead of the target class or factory method. |
void |
RootBeanDefinition.setResolvedFactoryMethod(Method method)
Set a resolved Java Method for the factory method on this bean definition.
|
void |
AbstractBeanDefinition.setResource(Resource resource)
Set the resource that this bean definition came from
(for the purpose of showing context in case of errors).
|
void |
AbstractBeanDefinition.setResourceDescription(String resourceDescription)
Set a description of the resource that this bean definition
came from (for the purpose of showing context in case of errors).
|
void |
AbstractBeanDefinitionReader.setResourceLoader(ResourceLoader resourceLoader)
Set the ResourceLoader to use for resource locations.
|
BeanDefinitionBuilder |
BeanDefinitionBuilder.setScope(String scope)
Set the scope of this definition.
|
void |
AbstractBeanDefinition.setScope(String scope)
Set the name of the target scope for the bean.
|
void |
DefaultListableBeanFactory.setSerializationId(String serializationId)
Specify an id for serialization purposes, allowing this BeanFactory to be
deserialized from this id back into the BeanFactory object, if needed.
|
void |
ManagedSet.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
ManagedList.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
ManagedMap.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
ManagedProperties.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
MethodOverride.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
RootBeanDefinition.setTargetType(Class<?> targetType)
Specify the target type of this bean definition, if known in advance.
|
void |
AbstractBeanFactory.setTempClassLoader(ClassLoader tempClassLoader) |
void |
ManagedMap.setValueTypeName(String valueTypeName)
Set the default value type name (class name) to be used for this map.
|
Constructor and Description |
---|
AbstractAutowireCapableBeanFactory(BeanFactory parentBeanFactory)
Create a new AbstractAutowireCapableBeanFactory with the given parent.
|
AbstractBeanDefinition(ConstructorArgumentValues cargs,
MutablePropertyValues pvs)
Create a new AbstractBeanDefinition with the given
constructor argument values and property values.
|
AbstractBeanDefinition(ConstructorArgumentValues cargs,
MutablePropertyValues pvs)
Create a new AbstractBeanDefinition with the given
constructor argument values and property values.
|
AbstractBeanFactory(BeanFactory parentBeanFactory)
Create a new AbstractBeanFactory with the given parent.
|
DefaultListableBeanFactory(BeanFactory parentBeanFactory)
Create a new DefaultListableBeanFactory with the given parent.
|
LookupOverride(Method method,
String beanName)
Construct a new LookupOverride.
|
LookupOverride(String methodName,
String beanName)
Construct a new LookupOverride.
|
RootBeanDefinition(Class<?> beanClass)
Create a new RootBeanDefinition for a singleton.
|
RootBeanDefinition(Class<?> beanClass,
ConstructorArgumentValues cargs,
MutablePropertyValues pvs)
Create a new RootBeanDefinition for a singleton,
providing constructor arguments and property values.
|
RootBeanDefinition(Class<?> beanClass,
ConstructorArgumentValues cargs,
MutablePropertyValues pvs)
Create a new RootBeanDefinition for a singleton,
providing constructor arguments and property values.
|
RootBeanDefinition(Class<?> beanClass,
ConstructorArgumentValues cargs,
MutablePropertyValues pvs)
Create a new RootBeanDefinition for a singleton,
providing constructor arguments and property values.
|
RootBeanDefinition(Class<?> beanClass,
int autowireMode,
boolean dependencyCheck)
Create a new RootBeanDefinition for a singleton,
using the given autowire mode.
|
RootBeanDefinition(Class<T> beanClass,
String scope,
Supplier<T> instanceSupplier)
Create a new RootBeanDefinition for a scoped bean, constructing each instance
through calling the given supplier (possibly a lambda or method reference).
|
RootBeanDefinition(Class<T> beanClass,
String scope,
Supplier<T> instanceSupplier)
Create a new RootBeanDefinition for a scoped bean, constructing each instance
through calling the given supplier (possibly a lambda or method reference).
|
RootBeanDefinition(Class<T> beanClass,
Supplier<T> instanceSupplier)
Create a new RootBeanDefinition for a singleton bean, constructing each instance
through calling the given supplier (possibly a lambda or method reference).
|
RootBeanDefinition(Class<T> beanClass,
Supplier<T> instanceSupplier)
Create a new RootBeanDefinition for a singleton bean, constructing each instance
through calling the given supplier (possibly a lambda or method reference).
|
SimpleSecurityContextProvider(AccessControlContext acc)
Construct a new
SimpleSecurityContextProvider instance. |
Modifier and Type | Method and Description |
---|---|
protected BeanWiringInfoResolver |
BeanConfigurerSupport.createDefaultBeanWiringInfoResolver()
Create the default BeanWiringInfoResolver to be used if none was
specified explicitly.
|
String |
BeanWiringInfo.getBeanName()
Return the specific bean name that this BeanWiringInfo points to, if any.
|
BeanWiringInfo |
BeanWiringInfoResolver.resolveWiringInfo(Object beanInstance)
Resolve the BeanWiringInfo for the given bean instance.
|
Modifier and Type | Method and Description |
---|---|
BeanDefinitionHolder |
NamespaceHandler.decorate(Node source,
BeanDefinitionHolder definition,
ParserContext parserContext)
Parse the specified
Node and decorate the supplied
BeanDefinitionHolder , returning the decorated definition. |
BeanDefinitionHolder |
NamespaceHandlerSupport.decorate(Node node,
BeanDefinitionHolder definition,
ParserContext parserContext)
Decorates the supplied
Node by delegating to the BeanDefinitionDecorator that
is registered to handle that Node . |
protected Object |
DefaultBeanDefinitionDocumentReader.extractSource(Element ele)
Invoke the
SourceExtractor
to pull the source metadata from the supplied Element . |
protected Object |
BeanDefinitionParserDelegate.extractSource(Element ele)
Invoke the
SourceExtractor
to pull the source metadata from the supplied Element . |
Object |
ParserContext.extractSource(Object sourceCandidate) |
String |
DocumentDefaultsDefinition.getAutowire()
Return the default autowire setting for the document that's currently parsed.
|
String[] |
BeanDefinitionParserDelegate.getAutowireCandidatePatterns()
Return any patterns provided in the 'default-autowire-candidates'
attribute of the top-level
<beans/> element. |
String |
DocumentDefaultsDefinition.getAutowireCandidates()
Return the default autowire-candidate pattern for the document that's currently parsed.
|
protected Class<?> |
AbstractSingleBeanDefinitionParser.getBeanClass(Element element)
Determine the bean class corresponding to the supplied
Element . |
ClassLoader |
XmlReaderContext.getBeanClassLoader()
Return the bean class loader to use, if any.
|
protected String |
AbstractSingleBeanDefinitionParser.getBeanClassName(Element element)
Determine the bean class name corresponding to the supplied
Element . |
BeanDefinition |
ParserContext.getContainingBeanDefinition() |
CompositeComponentDefinition |
ParserContext.getContainingComponent() |
String |
DocumentDefaultsDefinition.getDestroyMethod()
Return the default destroy-method setting for the document that's currently parsed.
|
String |
DocumentDefaultsDefinition.getInitMethod()
Return the default init-method setting for the document that's currently parsed.
|
String |
DocumentDefaultsDefinition.getLazyInit()
Return the default lazy-init flag for the document that's currently parsed.
|
String |
DocumentDefaultsDefinition.getMerge()
Return the default merge setting for the document that's currently parsed.
|
String |
BeanDefinitionParserDelegate.getNamespaceURI(Node node)
Get the namespace URI for the supplied node.
|
protected String |
AbstractSingleBeanDefinitionParser.getParentName(Element element)
Determine the name for the parent of the currently parsed bean,
in case of the current bean being defined as a child bean.
|
ResourceLoader |
XmlReaderContext.getResourceLoader()
Return the resource loader to use, if any.
|
Object |
DocumentDefaultsDefinition.getSource() |
BeanDefinition |
NamespaceHandler.parse(Element element,
ParserContext parserContext)
Parse the specified
Element and register any resulting
BeanDefinitions with the
BeanDefinitionRegistry
that is embedded in the supplied ParserContext . |
BeanDefinition |
NamespaceHandlerSupport.parse(Element element,
ParserContext parserContext)
Parses the supplied
Element by delegating to the BeanDefinitionParser that is
registered for that Element . |
BeanDefinition |
SimpleConstructorNamespaceHandler.parse(Element element,
ParserContext parserContext) |
BeanDefinition |
BeanDefinitionParser.parse(Element element,
ParserContext parserContext)
Parse the specified
Element and register the resulting
BeanDefinition(s) with the
BeanDefinitionRegistry
embedded in the supplied ParserContext . |
BeanDefinition |
AbstractBeanDefinitionParser.parse(Element element,
ParserContext parserContext) |
BeanDefinition |
SimplePropertyNamespaceHandler.parse(Element element,
ParserContext parserContext) |
BeanDefinitionHolder |
BeanDefinitionParserDelegate.parseBeanDefinitionElement(Element ele)
Parses the supplied
<bean> element. |
BeanDefinitionHolder |
BeanDefinitionParserDelegate.parseBeanDefinitionElement(Element ele,
BeanDefinition containingBean)
Parses the supplied
<bean> element. |
AbstractBeanDefinition |
BeanDefinitionParserDelegate.parseBeanDefinitionElement(Element ele,
String beanName,
BeanDefinition containingBean)
Parse the bean definition itself, without regard to name or aliases.
|
BeanDefinition |
BeanDefinitionParserDelegate.parseCustomElement(Element ele)
Parse a custom element (outside the default namespace).
|
BeanDefinition |
BeanDefinitionParserDelegate.parseCustomElement(Element ele,
BeanDefinition containingBd)
Parse a custom element (outside the default namespace).
|
Object |
BeanDefinitionParserDelegate.parseIdRefElement(Element ele)
Return a typed String value Object for the given 'idref' element.
|
protected abstract AbstractBeanDefinition |
AbstractBeanDefinitionParser.parseInternal(Element element,
ParserContext parserContext)
Central template method to actually parse the supplied
Element
into one or more BeanDefinitions . |
protected Object |
BeanDefinitionParserDelegate.parseKeyElement(Element keyEle,
BeanDefinition bd,
String defaultKeyTypeName)
Parse a key sub-element of a map element.
|
Object |
BeanDefinitionParserDelegate.parsePropertySubElement(Element ele,
BeanDefinition bd)
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
|
Object |
BeanDefinitionParserDelegate.parsePropertySubElement(Element ele,
BeanDefinition bd,
String defaultValueType)
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
|
Object |
BeanDefinitionParserDelegate.parsePropertyValue(Element ele,
BeanDefinition bd,
String propertyName)
Get the value of a property element.
|
NamespaceHandler |
DefaultNamespaceHandlerResolver.resolve(String namespaceUri)
Locate the
NamespaceHandler for the supplied namespace URI
from the configured mappings. |
NamespaceHandler |
NamespaceHandlerResolver.resolve(String namespaceUri)
Resolve the namespace URI and return the located
NamespaceHandler
implementation. |
InputSource |
BeansDtdResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
DelegatingEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
ResourceEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
PluggableSchemaResolver.resolveEntity(String publicId,
String systemId) |
Modifier and Type | Method and Description |
---|---|
protected TypedStringValue |
BeanDefinitionParserDelegate.buildTypedStringValue(String value,
String targetTypeName)
Build a typed String value Object for the given raw value.
|
protected AbstractBeanDefinition |
BeanDefinitionParserDelegate.createBeanDefinition(String className,
String parentName)
Create a bean definition for the given class name and parent name.
|
protected AbstractBeanDefinition |
BeanDefinitionParserDelegate.createBeanDefinition(String className,
String parentName)
Create a bean definition for the given class name and parent name.
|
protected BeanDefinitionParserDelegate |
DefaultBeanDefinitionDocumentReader.createDelegate(XmlReaderContext readerContext,
Element root,
BeanDefinitionParserDelegate parentDelegate) |
protected DocumentBuilder |
DefaultDocumentLoader.createDocumentBuilder(DocumentBuilderFactory factory,
EntityResolver entityResolver,
ErrorHandler errorHandler)
Create a JAXP DocumentBuilder that this bean definition reader
will use for parsing XML documents.
|
protected DocumentBuilder |
DefaultDocumentLoader.createDocumentBuilder(DocumentBuilderFactory factory,
EntityResolver entityResolver,
ErrorHandler errorHandler)
Create a JAXP DocumentBuilder that this bean definition reader
will use for parsing XML documents.
|
BeanDefinitionHolder |
BeanDefinitionParserDelegate.decorateBeanDefinitionIfRequired(Element ele,
BeanDefinitionHolder originalDef,
BeanDefinition containingBd)
Decorate the given bean definition through a namespace handler, if applicable.
|
BeanDefinitionHolder |
BeanDefinitionParserDelegate.decorateIfRequired(Node node,
BeanDefinitionHolder originalDef,
BeanDefinition containingBd)
Decorate the given bean definition through a namespace handler,
if applicable.
|
void |
BeanDefinitionParserDelegate.initDefaults(Element root,
BeanDefinitionParserDelegate parent)
Initialize the default lazy-init, autowire, dependency check settings,
init-method, destroy-method and merge settings.
|
boolean |
BeanDefinitionParserDelegate.isDefaultNamespace(String namespaceUri)
Determine whether the given URI indicates the default namespace.
|
int |
XmlBeanDefinitionReader.loadBeanDefinitions(InputSource inputSource,
String resourceDescription)
Load bean definitions from the specified XML file.
|
Object |
BeanDefinitionParserDelegate.parseArrayElement(Element arrayEle,
BeanDefinition bd)
Parse an array element.
|
AbstractBeanDefinition |
BeanDefinitionParserDelegate.parseBeanDefinitionAttributes(Element ele,
String beanName,
BeanDefinition containingBean,
AbstractBeanDefinition bd)
Apply the attributes of the given bean element to the given bean * definition.
|
BeanDefinitionHolder |
BeanDefinitionParserDelegate.parseBeanDefinitionElement(Element ele,
BeanDefinition containingBean)
Parses the supplied
<bean> element. |
AbstractBeanDefinition |
BeanDefinitionParserDelegate.parseBeanDefinitionElement(Element ele,
String beanName,
BeanDefinition containingBean)
Parse the bean definition itself, without regard to name or aliases.
|
protected void |
BeanDefinitionParserDelegate.parseCollectionElements(NodeList elementNodes,
Collection<Object> target,
BeanDefinition bd,
String defaultElementType) |
BeanDefinition |
BeanDefinitionParserDelegate.parseCustomElement(Element ele,
BeanDefinition containingBd)
Parse a custom element (outside the default namespace).
|
protected Object |
BeanDefinitionParserDelegate.parseKeyElement(Element keyEle,
BeanDefinition bd,
String defaultKeyTypeName)
Parse a key sub-element of a map element.
|
List<Object> |
BeanDefinitionParserDelegate.parseListElement(Element collectionEle,
BeanDefinition bd)
Parse a list element.
|
Map<Object,Object> |
BeanDefinitionParserDelegate.parseMapElement(Element mapEle,
BeanDefinition bd)
Parse a map element.
|
Object |
BeanDefinitionParserDelegate.parsePropertySubElement(Element ele,
BeanDefinition bd)
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
|
Object |
BeanDefinitionParserDelegate.parsePropertySubElement(Element ele,
BeanDefinition bd,
String defaultValueType)
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
|
Object |
BeanDefinitionParserDelegate.parsePropertySubElement(Element ele,
BeanDefinition bd,
String defaultValueType)
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
|
Object |
BeanDefinitionParserDelegate.parsePropertyValue(Element ele,
BeanDefinition bd,
String propertyName)
Get the value of a property element.
|
Set<Object> |
BeanDefinitionParserDelegate.parseSetElement(Element collectionEle,
BeanDefinition bd)
Parse a set element.
|
Object |
BeanDefinitionParserDelegate.parseValueElement(Element ele,
String defaultTypeName)
Return a typed String value Object for the given value element.
|
protected void |
BeanDefinitionParserDelegate.populateDefaults(DocumentDefaultsDefinition defaults,
DocumentDefaultsDefinition parentDefaults,
Element root)
Populate the given DocumentDefaultsDefinition instance with the default lazy-init,
autowire, dependency check settings, init-method, destroy-method and merge settings.
|
InputSource |
BeansDtdResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
BeansDtdResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
DelegatingEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
DelegatingEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
ResourceEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
ResourceEntityResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
PluggableSchemaResolver.resolveEntity(String publicId,
String systemId) |
InputSource |
PluggableSchemaResolver.resolveEntity(String publicId,
String systemId) |
void |
DocumentDefaultsDefinition.setAutowire(String autowire)
Set the default autowire setting for the document that's currently parsed.
|
void |
DocumentDefaultsDefinition.setAutowireCandidates(String autowireCandidates)
Set the default autowire-candidate pattern for the document that's currently parsed.
|
void |
DocumentDefaultsDefinition.setDestroyMethod(String destroyMethod)
Set the default destroy-method setting for the document that's currently parsed.
|
void |
XmlBeanDefinitionReader.setDocumentLoader(DocumentLoader documentLoader)
Specify the
DocumentLoader to use. |
void |
XmlBeanDefinitionReader.setEntityResolver(EntityResolver entityResolver)
Set a SAX entity resolver to be used for parsing.
|
void |
XmlBeanDefinitionReader.setEventListener(ReaderEventListener eventListener)
Specify which
ReaderEventListener to use. |
void |
DocumentDefaultsDefinition.setInitMethod(String initMethod)
Set the default init-method setting for the document that's currently parsed.
|
void |
DocumentDefaultsDefinition.setLazyInit(String lazyInit)
Set the default lazy-init flag for the document that's currently parsed.
|
void |
DocumentDefaultsDefinition.setMerge(String merge)
Set the default merge setting for the document that's currently parsed.
|
void |
XmlBeanDefinitionReader.setNamespaceHandlerResolver(NamespaceHandlerResolver namespaceHandlerResolver)
Specify the
NamespaceHandlerResolver to use. |
void |
XmlBeanDefinitionReader.setProblemReporter(ProblemReporter problemReporter)
Specify which
ProblemReporter to use. |
void |
DocumentDefaultsDefinition.setSource(Object source)
Set the configuration source
Object for this metadata element. |
void |
XmlBeanDefinitionReader.setSourceExtractor(SourceExtractor sourceExtractor)
Specify the
SourceExtractor to use. |
Constructor and Description |
---|
DefaultNamespaceHandlerResolver(ClassLoader classLoader)
Create a new
DefaultNamespaceHandlerResolver using the
default mapping file location. |
DefaultNamespaceHandlerResolver(ClassLoader classLoader,
String handlerMappingsLocation)
Create a new
DefaultNamespaceHandlerResolver using the
supplied mapping file location. |
DelegatingEntityResolver(ClassLoader classLoader)
Create a new DelegatingEntityResolver that delegates to
a default
BeansDtdResolver and a default PluggableSchemaResolver . |
ParserContext(XmlReaderContext readerContext,
BeanDefinitionParserDelegate delegate,
BeanDefinition containingBeanDefinition) |
PluggableSchemaResolver(ClassLoader classLoader)
Loads the schema URL → schema file location mappings using the default
mapping file pattern "META-INF/spring.schemas".
|
PluggableSchemaResolver(ClassLoader classLoader,
String schemaMappingsLocation)
Loads the schema URL → schema file location mappings using the given
mapping file pattern.
|
Modifier and Type | Method and Description |
---|---|
String |
CustomCollectionEditor.getAsText()
This implementation returns
null to indicate that
there is no appropriate text representation. |
String |
InputStreamEditor.getAsText()
This implementation returns
null to indicate that
there is no appropriate text representation. |
String |
CustomMapEditor.getAsText()
This implementation returns
null to indicate that
there is no appropriate text representation. |
String |
ReaderEditor.getAsText()
This implementation returns
null to indicate that
there is no appropriate text representation. |
Modifier and Type | Method and Description |
---|---|
void |
CustomBooleanEditor.setAsText(String text) |
void |
ByteArrayPropertyEditor.setAsText(String text) |
void |
CharArrayPropertyEditor.setAsText(String text) |
void |
PropertiesEditor.setAsText(String text)
Convert
String into Properties , considering it as
properties content. |
void |
CharacterEditor.setAsText(String text) |
void |
PatternEditor.setAsText(String text) |
void |
StringTrimmerEditor.setAsText(String text) |
void |
CustomDateEditor.setAsText(String text)
Parse the Date from the given text, using the specified DateFormat.
|
void |
CustomCollectionEditor.setValue(Object value)
Convert the given value to a Collection of the target type.
|
void |
CustomNumberEditor.setValue(Object value)
Coerce a Number value into the required target class, if necessary.
|
void |
CustomMapEditor.setValue(Object value)
Convert the given value to a Map of the target type.
|
Constructor and Description |
---|
ClassArrayEditor(ClassLoader classLoader)
Create a default
ClassArrayEditor , using the given
ClassLoader . |
ClassEditor(ClassLoader classLoader)
Create a default ClassEditor, using the given ClassLoader.
|
CustomBooleanEditor(String trueString,
String falseString,
boolean allowEmpty)
Create a new CustomBooleanEditor instance,
with configurable String values for true and false.
|
CustomBooleanEditor(String trueString,
String falseString,
boolean allowEmpty)
Create a new CustomBooleanEditor instance,
with configurable String values for true and false.
|
CustomNumberEditor(Class<? extends Number> numberClass,
NumberFormat numberFormat,
boolean allowEmpty)
Create a new CustomNumberEditor instance, using the given NumberFormat
for parsing and rendering.
|
StringArrayPropertyEditor(String separator,
String charsToDelete,
boolean emptyArrayAsNull)
Create a new
StringArrayPropertyEditor with the given separator. |
StringArrayPropertyEditor(String separator,
String charsToDelete,
boolean emptyArrayAsNull,
boolean trimValues)
Create a new
StringArrayPropertyEditor with the given separator. |
URIEditor(ClassLoader classLoader)
Create a new URIEditor, using the given ClassLoader to resolve
"classpath:" locations into physical resource URLs.
|
URIEditor(ClassLoader classLoader,
boolean encode)
Create a new URIEditor, using the given ClassLoader to resolve
"classpath:" locations into physical resource URLs.
|
Modifier and Type | Method and Description |
---|---|
protected Method |
ArgumentConvertingMethodInvoker.doFindMatchingMethod(Object[] arguments)
Actually find a method with matching parameter type, i.e.
|
Date |
PagedListHolder.getRefreshDate()
Return the last time the list has been fetched from the source provider.
|
SortDefinition |
PagedListHolder.getSort()
Return the sort definition for this holder.
|
TypeConverter |
ArgumentConvertingMethodInvoker.getTypeConverter()
Return the TypeConverter used for argument type conversion.
|
Modifier and Type | Method and Description |
---|---|
boolean |
MutableSortDefinition.equals(Object other) |
void |
PagedListHolder.setSort(SortDefinition sort)
Set the sort definition for this holder.
|
void |
ArgumentConvertingMethodInvoker.setTypeConverter(TypeConverter typeConverter)
Set a TypeConverter to use for argument type conversion.
|
Modifier and Type | Method and Description |
---|---|
Object |
Cache.ValueWrapper.get()
Return the actual value in the cache.
|
Cache.ValueWrapper |
Cache.get(Object key)
Return the value to which this cache maps the specified key.
|
<T> T |
Cache.get(Object key,
Callable<T> valueLoader)
Return the value to which this cache maps the specified key, obtaining
that value from
valueLoader if necessary. |
<T> T |
Cache.get(Object key,
Class<T> type)
Return the value to which this cache maps the specified key,
generically specifying a type that return value will be cast to.
|
Cache |
CacheManager.getCache(String name)
Get the cache associated with the given name.
|
Object |
Cache.ValueRetrievalException.getKey() |
default Cache.ValueWrapper |
Cache.putIfAbsent(Object key,
Object value)
Atomically associate the specified value with the specified key in this cache
if it is not set already.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
Cache.get(Object key,
Class<T> type)
Return the value to which this cache maps the specified key,
generically specifying a type that return value will be cast to.
|
void |
Cache.put(Object key,
Object value)
Associate the specified value with the specified key in this cache.
|
default Cache.ValueWrapper |
Cache.putIfAbsent(Object key,
Object value)
Atomically associate the specified value with the specified key in this cache
if it is not set already.
|
Constructor and Description |
---|
ValueRetrievalException(Object key,
Callable<?> loader,
Throwable ex) |
Modifier and Type | Field and Description |
---|---|
protected Supplier<CacheManager> |
AbstractCachingConfiguration.cacheManager |
protected Supplier<CacheResolver> |
AbstractCachingConfiguration.cacheResolver |
protected AnnotationAttributes |
AbstractCachingConfiguration.enableCaching |
protected Supplier<CacheErrorHandler> |
AbstractCachingConfiguration.errorHandler |
protected Supplier<KeyGenerator> |
AbstractCachingConfiguration.keyGenerator |
Modifier and Type | Method and Description |
---|---|
<T> Supplier<T> |
AbstractCachingConfiguration.CachingConfigurerSupplier.adapt(Function<CachingConfigurer,T> provider)
Adapt the
CachingConfigurer supplier to another supplier
provided by the specified mapping function. |
default CacheManager |
CachingConfigurer.cacheManager()
Return the cache manager bean to use for annotation-driven cache
management.
|
CacheManager |
CachingConfigurerSupport.cacheManager() |
default CacheResolver |
CachingConfigurer.cacheResolver()
Return the
CacheResolver bean to use to resolve regular caches for
annotation-driven cache management. |
CacheResolver |
CachingConfigurerSupport.cacheResolver() |
protected Collection<CacheOperation> |
AnnotationCacheOperationSource.determineCacheOperations(AnnotationCacheOperationSource.CacheOperationProvider provider)
Determine the cache operation(s) for the given
AnnotationCacheOperationSource.CacheOperationProvider . |
default CacheErrorHandler |
CachingConfigurer.errorHandler()
Return the
CacheErrorHandler to use to handle cache-related errors. |
CacheErrorHandler |
CachingConfigurerSupport.errorHandler() |
protected Collection<CacheOperation> |
AnnotationCacheOperationSource.findCacheOperations(Class<?> clazz) |
protected Collection<CacheOperation> |
AnnotationCacheOperationSource.findCacheOperations(Method method) |
Collection<CacheOperation> |
AnnotationCacheOperationSource.CacheOperationProvider.getCacheOperations(CacheAnnotationParser parser)
Return the
CacheOperation instance(s) provided by the specified parser. |
default KeyGenerator |
CachingConfigurer.keyGenerator()
Return the key generator bean to use for annotation-driven cache management.
|
KeyGenerator |
CachingConfigurerSupport.keyGenerator() |
Collection<CacheOperation> |
SpringCacheAnnotationParser.parseCacheAnnotations(Class<?> type) |
Collection<CacheOperation> |
CacheAnnotationParser.parseCacheAnnotations(Class<?> type)
Parse the cache definition for the given class,
based on an annotation type understood by this parser.
|
Collection<CacheOperation> |
SpringCacheAnnotationParser.parseCacheAnnotations(Method method) |
Collection<CacheOperation> |
CacheAnnotationParser.parseCacheAnnotations(Method method)
Parse the cache definition for the given method,
based on an annotation type understood by this parser.
|
Modifier and Type | Method and Description |
---|---|
boolean |
SpringCacheAnnotationParser.equals(Object other) |
boolean |
AnnotationCacheOperationSource.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
<T> T |
CaffeineCache.get(Object key,
Callable<T> valueLoader) |
Cache |
CaffeineCacheManager.getCache(String name) |
protected Object |
CaffeineCache.lookup(Object key) |
Cache.ValueWrapper |
CaffeineCache.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
void |
CaffeineCache.put(Object key,
Object value) |
Cache.ValueWrapper |
CaffeineCache.putIfAbsent(Object key,
Object value) |
void |
CaffeineCacheManager.setCacheNames(Collection<String> cacheNames)
Specify the set of cache names for this CacheManager's 'static' mode.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
ConcurrentMapCache.get(Object key,
Callable<T> valueLoader) |
Cache |
ConcurrentMapCacheManager.getCache(String name) |
ConcurrentMapCache |
ConcurrentMapCacheFactoryBean.getObject() |
protected Object |
ConcurrentMapCache.lookup(Object key) |
Cache.ValueWrapper |
ConcurrentMapCache.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
protected Object |
ConcurrentMapCache.fromStoreValue(Object storeValue) |
void |
ConcurrentMapCache.put(Object key,
Object value) |
Cache.ValueWrapper |
ConcurrentMapCache.putIfAbsent(Object key,
Object value) |
void |
ConcurrentMapCacheManager.setCacheNames(Collection<String> cacheNames)
Specify the set of cache names for this CacheManager's 'static' mode.
|
protected Object |
ConcurrentMapCache.toStoreValue(Object userValue) |
Constructor and Description |
---|
ConcurrentMapCache(String name,
ConcurrentMap<Object,Object> store,
boolean allowNullValues,
SerializationDelegate serialization)
Create a new ConcurrentMapCache with the specified name and the
given internal
ConcurrentMap to use. |
Modifier and Type | Method and Description |
---|---|
Cache.ValueWrapper |
EhCacheCache.get(Object key) |
<T> T |
EhCacheCache.get(Object key,
Callable<T> valueLoader) |
<T> T |
EhCacheCache.get(Object key,
Class<T> type) |
net.sf.ehcache.CacheManager |
EhCacheCacheManager.getCacheManager()
Return the backing EhCache
CacheManager . |
net.sf.ehcache.CacheManager |
EhCacheManagerFactoryBean.getObject() |
net.sf.ehcache.Ehcache |
EhCacheFactoryBean.getObject() |
Cache.ValueWrapper |
EhCacheCache.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
<T> T |
EhCacheCache.get(Object key,
Class<T> type) |
void |
EhCacheCache.put(Object key,
Object value) |
Cache.ValueWrapper |
EhCacheCache.putIfAbsent(Object key,
Object value) |
void |
EhCacheCacheManager.setCacheManager(net.sf.ehcache.CacheManager cacheManager)
Set the backing EhCache
CacheManager . |
Modifier and Type | Method and Description |
---|---|
protected Cache.ValueWrapper |
AbstractCacheInvoker.doGet(Cache cache,
Object key)
Execute
Cache.get(Object) on the specified Cache and
invoke the error handler if an exception occurs. |
protected Object |
CacheAspectSupport.execute(CacheOperationInvoker invoker,
Object target,
Method method,
Object[] args) |
protected abstract Collection<CacheOperation> |
AbstractFallbackCacheOperationSource.findCacheOperations(Class<?> clazz)
Subclasses need to implement this to return the caching attribute for the
given class, if any.
|
protected abstract Collection<CacheOperation> |
AbstractFallbackCacheOperationSource.findCacheOperations(Method method)
Subclasses need to implement this to return the caching attribute for the
given method, if any.
|
protected Object |
CacheAspectSupport.CacheOperationContext.generateKey(Object result)
Compute the key for the given caching operation.
|
protected abstract Collection<String> |
AbstractCacheResolver.getCacheNames(CacheOperationInvocationContext<?> context)
Provide the name of the cache(s) to resolve against the current cache manager.
|
Collection<CacheOperation> |
CacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass)
Return the collection of cache operations for this method,
or
null if the method contains no cacheable annotations. |
Collection<CacheOperation> |
CompositeCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass) |
Collection<CacheOperation> |
NameMatchCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass) |
Collection<CacheOperation> |
AbstractFallbackCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass)
Determine the caching attribute for this method invocation.
|
CacheOperationSource |
CacheAspectSupport.getCacheOperationSource()
Return the CacheOperationSource for this cache aspect.
|
CacheResolver |
CacheAspectSupport.getCacheResolver()
Return the default
CacheResolver that this cache aspect delegates to. |
String |
CachePutOperation.getUnless() |
String |
CacheableOperation.getUnless() |
Object |
CacheOperationInvoker.invoke()
Invoke the cache operation defined by this instance.
|
Object |
CacheInterceptor.invoke(MethodInvocation invocation) |
protected Object |
CacheAspectSupport.invokeOperation(CacheOperationInvoker invoker)
Execute the underlying operation (typically in case of cache miss) and return
the result of the invocation.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
CacheAspectSupport.CacheOperationContext.canPutToCache(Object value) |
void |
CacheAspectSupport.configure(Supplier<CacheErrorHandler> errorHandler,
Supplier<KeyGenerator> keyGenerator,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheManager> cacheManager)
Configure this aspect with the given error handler, key generator and cache resolver/manager
suppliers, applying the corresponding default if a supplier is not resolvable.
|
void |
CacheAspectSupport.configure(Supplier<CacheErrorHandler> errorHandler,
Supplier<KeyGenerator> keyGenerator,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheManager> cacheManager)
Configure this aspect with the given error handler, key generator and cache resolver/manager
suppliers, applying the corresponding default if a supplier is not resolvable.
|
void |
CacheAspectSupport.configure(Supplier<CacheErrorHandler> errorHandler,
Supplier<KeyGenerator> keyGenerator,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheManager> cacheManager)
Configure this aspect with the given error handler, key generator and cache resolver/manager
suppliers, applying the corresponding default if a supplier is not resolvable.
|
void |
CacheAspectSupport.configure(Supplier<CacheErrorHandler> errorHandler,
Supplier<KeyGenerator> keyGenerator,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheManager> cacheManager)
Configure this aspect with the given error handler, key generator and cache resolver/manager
suppliers, applying the corresponding default if a supplier is not resolvable.
|
protected void |
AbstractCacheInvoker.doPut(Cache cache,
Object key,
Object value)
Execute
Cache.put(Object, Object) on the specified Cache
and invoke the error handler if an exception occurs. |
boolean |
NameMatchCacheOperationSource.equals(Object other) |
boolean |
SimpleKey.equals(Object other) |
boolean |
CacheOperation.equals(Object other)
This implementation compares the
toString() results. |
protected Object |
CacheAspectSupport.CacheOperationContext.generateKey(Object result)
Compute the key for the given caching operation.
|
protected Object |
AbstractFallbackCacheOperationSource.getCacheKey(Method method,
Class<?> targetClass)
Determine a cache key for the given method and target class.
|
Collection<CacheOperation> |
CacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass)
Return the collection of cache operations for this method,
or
null if the method contains no cacheable annotations. |
Collection<CacheOperation> |
CompositeCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass) |
Collection<CacheOperation> |
NameMatchCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass) |
Collection<CacheOperation> |
AbstractFallbackCacheOperationSource.getCacheOperations(Method method,
Class<?> targetClass)
Determine the caching attribute for this method invocation.
|
void |
CacheErrorHandler.handleCachePutError(RuntimeException exception,
Cache cache,
Object key,
Object value)
Handle the given runtime exception thrown by the cache provider when
updating an item with the specified
key and value ,
possibly rethrowing it as a fatal exception. |
void |
SimpleCacheErrorHandler.handleCachePutError(RuntimeException exception,
Cache cache,
Object key,
Object value) |
void |
LoggingCacheErrorHandler.handleCachePutError(RuntimeException exception,
Cache cache,
Object key,
Object value) |
protected boolean |
CacheAspectSupport.CacheOperationContext.isConditionPassing(Object result) |
void |
CacheAspectSupport.setCacheOperationSource(CacheOperationSource cacheOperationSource)
Set the CacheOperationSource for this cache aspect.
|
void |
CacheAspectSupport.setCacheResolver(CacheResolver cacheResolver)
Set the default
CacheResolver that this cache aspect should delegate
to if no specific cache resolver has been set for the operation. |
Modifier and Type | Method and Description |
---|---|
<T> T |
JCacheCache.get(Object key,
Callable<T> valueLoader) |
javax.cache.CacheManager |
JCacheCacheManager.getCacheManager()
Return the backing JCache
javax.cache.CacheManager . |
javax.cache.CacheManager |
JCacheManagerFactoryBean.getObject() |
protected Object |
JCacheCache.lookup(Object key) |
Cache.ValueWrapper |
JCacheCache.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
void |
JCacheCache.put(Object key,
Object value) |
Cache.ValueWrapper |
JCacheCache.putIfAbsent(Object key,
Object value) |
void |
JCacheCacheManager.setCacheManager(javax.cache.CacheManager cacheManager)
Set the backing JCache
javax.cache.CacheManager . |
void |
JCacheManagerFactoryBean.setCacheManagerProperties(Properties cacheManagerProperties)
Specify properties for the to-be-created
CacheManager . |
void |
JCacheManagerFactoryBean.setCacheManagerUri(URI cacheManagerUri)
Specify the URI for the desired
CacheManager . |
Modifier and Type | Field and Description |
---|---|
protected Supplier<CacheResolver> |
AbstractJCacheConfiguration.exceptionCacheResolver |
Modifier and Type | Method and Description |
---|---|
default CacheResolver |
JCacheConfigurer.exceptionCacheResolver()
Return the
CacheResolver bean to use to resolve exception caches for
annotation-driven cache management. |
CacheResolver |
JCacheConfigurerSupport.exceptionCacheResolver() |
Modifier and Type | Method and Description |
---|---|
protected javax.cache.annotation.CacheResolverFactory |
AnnotationJCacheOperationSource.determineCacheResolverFactory(javax.cache.annotation.CacheDefaults defaults,
Class<? extends javax.cache.annotation.CacheResolverFactory> candidate) |
protected Object |
JCacheAspectSupport.execute(CacheOperationInvoker invoker,
Object target,
Method method,
Object[] args) |
protected abstract JCacheOperation<?> |
AbstractFallbackJCacheOperationSource.findCacheOperation(Method method,
Class<?> targetType)
Subclasses need to implement this to return the caching operation
for the given method, if any.
|
protected javax.cache.annotation.CacheDefaults |
AnnotationJCacheOperationSource.getCacheDefaults(Method method,
Class<?> targetType) |
CacheManager |
DefaultJCacheOperationSource.getCacheManager()
Return the specified cache manager to use, if any.
|
JCacheOperation<?> |
JCacheOperationSource.getCacheOperation(Method method,
Class<?> targetClass)
Return the cache operations for this method, or
null
if the method contains no JSR-107 related metadata. |
protected abstract JCacheOperationSource |
JCacheOperationSourcePointcut.getCacheOperationSource()
Obtain the underlying
JCacheOperationSource (may be null ). |
CacheResolver |
DefaultJCacheOperationSource.getCacheResolver()
Return the specified cache resolver to use, if any.
|
CacheResolver |
DefaultJCacheOperationSource.getExceptionCacheResolver()
Return the specified exception cache resolver to use, if any.
|
Object |
JCacheInterceptor.invoke(MethodInvocation invocation) |
protected Object |
JCacheAspectSupport.invokeOperation(CacheOperationInvoker invoker)
Execute the underlying operation (typically in case of cache miss) and return
the result of the invocation.
|
Modifier and Type | Method and Description |
---|---|
protected org.springframework.cache.jcache.interceptor.CachePutOperation |
AnnotationJCacheOperationSource.createCachePutOperation(Method method,
javax.cache.annotation.CacheDefaults defaults,
javax.cache.annotation.CachePut ann) |
protected org.springframework.cache.jcache.interceptor.CacheRemoveAllOperation |
AnnotationJCacheOperationSource.createCacheRemoveAllOperation(Method method,
javax.cache.annotation.CacheDefaults defaults,
javax.cache.annotation.CacheRemoveAll ann) |
protected org.springframework.cache.jcache.interceptor.CacheRemoveOperation |
AnnotationJCacheOperationSource.createCacheRemoveOperation(Method method,
javax.cache.annotation.CacheDefaults defaults,
javax.cache.annotation.CacheRemove ann) |
protected org.springframework.cache.jcache.interceptor.CacheResultOperation |
AnnotationJCacheOperationSource.createCacheResultOperation(Method method,
javax.cache.annotation.CacheDefaults defaults,
javax.cache.annotation.CacheResult ann) |
protected String |
AnnotationJCacheOperationSource.determineCacheName(Method method,
javax.cache.annotation.CacheDefaults defaults,
String candidate) |
protected javax.cache.annotation.CacheResolverFactory |
AnnotationJCacheOperationSource.determineCacheResolverFactory(javax.cache.annotation.CacheDefaults defaults,
Class<? extends javax.cache.annotation.CacheResolverFactory> candidate) |
protected KeyGenerator |
AnnotationJCacheOperationSource.determineKeyGenerator(javax.cache.annotation.CacheDefaults defaults,
Class<? extends javax.cache.annotation.CacheKeyGenerator> candidate) |
boolean |
JCacheOperationSourcePointcut.equals(Object other) |
protected JCacheOperation<?> |
AnnotationJCacheOperationSource.findCacheOperation(Method method,
Class<?> targetType) |
protected abstract JCacheOperation<?> |
AbstractFallbackJCacheOperationSource.findCacheOperation(Method method,
Class<?> targetType)
Subclasses need to implement this to return the caching operation
for the given method, if any.
|
protected javax.cache.annotation.CacheDefaults |
AnnotationJCacheOperationSource.getCacheDefaults(Method method,
Class<?> targetType) |
JCacheOperation<?> |
JCacheOperationSource.getCacheOperation(Method method,
Class<?> targetClass)
Return the cache operations for this method, or
null
if the method contains no JSR-107 related metadata. |
JCacheOperation<?> |
AbstractFallbackJCacheOperationSource.getCacheOperation(Method method,
Class<?> targetClass) |
protected CacheResolver |
AnnotationJCacheOperationSource.getCacheResolver(javax.cache.annotation.CacheResolverFactory factory,
javax.cache.annotation.CacheMethodDetails<?> details) |
protected CacheResolver |
AnnotationJCacheOperationSource.getExceptionCacheResolver(javax.cache.annotation.CacheResolverFactory factory,
javax.cache.annotation.CacheMethodDetails<javax.cache.annotation.CacheResult> details) |
void |
DefaultJCacheOperationSource.setCacheManager(CacheManager cacheManager)
Set the default
CacheManager to use to lookup cache by name. |
void |
DefaultJCacheOperationSource.setCacheResolver(CacheResolver cacheResolver)
Set the
CacheResolver to resolve regular caches. |
void |
DefaultJCacheOperationSource.setExceptionCacheResolver(CacheResolver exceptionCacheResolver)
Set the
CacheResolver to resolve exception caches. |
Constructor and Description |
---|
DefaultJCacheOperationSource(Supplier<CacheManager> cacheManager,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheResolver> exceptionCacheResolver,
Supplier<KeyGenerator> keyGenerator)
Construct a new
DefaultJCacheOperationSource with the given cache manager,
cache resolver and key generator suppliers, applying the corresponding default
if a supplier is not resolvable. |
DefaultJCacheOperationSource(Supplier<CacheManager> cacheManager,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheResolver> exceptionCacheResolver,
Supplier<KeyGenerator> keyGenerator)
Construct a new
DefaultJCacheOperationSource with the given cache manager,
cache resolver and key generator suppliers, applying the corresponding default
if a supplier is not resolvable. |
DefaultJCacheOperationSource(Supplier<CacheManager> cacheManager,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheResolver> exceptionCacheResolver,
Supplier<KeyGenerator> keyGenerator)
Construct a new
DefaultJCacheOperationSource with the given cache manager,
cache resolver and key generator suppliers, applying the corresponding default
if a supplier is not resolvable. |
DefaultJCacheOperationSource(Supplier<CacheManager> cacheManager,
Supplier<CacheResolver> cacheResolver,
Supplier<CacheResolver> exceptionCacheResolver,
Supplier<KeyGenerator> keyGenerator)
Construct a new
DefaultJCacheOperationSource with the given cache manager,
cache resolver and key generator suppliers, applying the corresponding default
if a supplier is not resolvable. |
JCacheInterceptor(Supplier<CacheErrorHandler> errorHandler)
Construct a new
JCacheInterceptor with the given error handler. |
Modifier and Type | Method and Description |
---|---|
protected Object |
AbstractValueAdaptingCache.fromStoreValue(Object storeValue)
Convert the given value from the internal store to a user value
returned from the get method (adapting
null ). |
Object |
SimpleValueWrapper.get()
Simply returns the value as given at construction time.
|
Cache.ValueWrapper |
AbstractValueAdaptingCache.get(Object key) |
Cache.ValueWrapper |
NoOpCache.get(Object key) |
<T> T |
NoOpCache.get(Object key,
Callable<T> valueLoader) |
<T> T |
AbstractValueAdaptingCache.get(Object key,
Class<T> type) |
<T> T |
NoOpCache.get(Object key,
Class<T> type) |
Cache |
NoOpCacheManager.getCache(String name)
This implementation always returns a
Cache implementation that will not store items. |
Cache |
CompositeCacheManager.getCache(String name) |
Cache |
AbstractCacheManager.getCache(String name) |
protected Cache |
AbstractCacheManager.getMissingCache(String name)
Return a missing cache with the specified
name , or null if
such a cache does not exist or could not be created on demand. |
protected abstract Object |
AbstractValueAdaptingCache.lookup(Object key)
Perform an actual lookup in the underlying store.
|
protected Cache |
AbstractCacheManager.lookupCache(String name)
Check for a registered cache of the given name.
|
Cache.ValueWrapper |
NoOpCache.putIfAbsent(Object key,
Object value) |
protected Cache.ValueWrapper |
AbstractValueAdaptingCache.toValueWrapper(Object storeValue)
Wrap the given store value with a
SimpleValueWrapper , also going
through AbstractValueAdaptingCache.fromStoreValue(java.lang.Object) conversion. |
Modifier and Type | Method and Description |
---|---|
boolean |
NullValue.equals(Object obj) |
protected Object |
AbstractValueAdaptingCache.fromStoreValue(Object storeValue)
Convert the given value from the internal store to a user value
returned from the get method (adapting
null ). |
<T> T |
AbstractValueAdaptingCache.get(Object key,
Class<T> type) |
<T> T |
NoOpCache.get(Object key,
Class<T> type) |
void |
NoOpCache.put(Object key,
Object value) |
Cache.ValueWrapper |
NoOpCache.putIfAbsent(Object key,
Object value) |
protected Object |
AbstractValueAdaptingCache.toStoreValue(Object userValue)
Convert the given user value, as passed into the put method,
to a value in the internal store (adapting
null ). |
protected Cache.ValueWrapper |
AbstractValueAdaptingCache.toValueWrapper(Object storeValue)
Wrap the given store value with a
SimpleValueWrapper , also going
through AbstractValueAdaptingCache.fromStoreValue(java.lang.Object) conversion. |
Constructor and Description |
---|
SimpleValueWrapper(Object value)
Create a new SimpleValueWrapper instance for exposing the given value.
|
Modifier and Type | Method and Description |
---|---|
Cache.ValueWrapper |
TransactionAwareCacheDecorator.get(Object key) |
<T> T |
TransactionAwareCacheDecorator.get(Object key,
Callable<T> valueLoader) |
Cache |
TransactionAwareCacheManagerProxy.getCache(String name) |
Cache.ValueWrapper |
TransactionAwareCacheDecorator.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
<T> T |
TransactionAwareCacheDecorator.get(Object key,
Class<T> type) |
void |
TransactionAwareCacheDecorator.put(Object key,
Object value) |
Cache.ValueWrapper |
TransactionAwareCacheDecorator.putIfAbsent(Object key,
Object value) |
Modifier and Type | Method and Description |
---|---|
default Object[] |
MessageSourceResolvable.getArguments()
Return the array of arguments to be used to resolve this message.
|
String[] |
MessageSourceResolvable.getCodes()
Return the codes to be used to resolve this message, in the order that
they should get tried.
|
default String |
MessageSourceResolvable.getDefaultMessage()
Return the default message to be used to resolve this message.
|
String |
ApplicationContext.getId()
Return the unique id of this application context.
|
String |
MessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale)
Try to resolve the message.
|
ApplicationContext |
ApplicationContext.getParent()
Return the parent context, or
null if there is no parent
and this is the root of the context hierarchy. |
MessageSource |
HierarchicalMessageSource.getParentMessageSource()
Return the parent of this MessageSource, or
null if none. |
Modifier and Type | Method and Description |
---|---|
String |
MessageSource.getMessage(String code,
Object[] args,
Locale locale)
Try to resolve the message.
|
String |
MessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale)
Try to resolve the message.
|
String |
MessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale)
Try to resolve the message.
|
void |
ConfigurableApplicationContext.setParent(ApplicationContext parent)
Set the parent of this application context.
|
void |
HierarchicalMessageSource.setParentMessageSource(MessageSource parent)
Set the parent that will be used to try to resolve messages
that this object can't resolve.
|
Modifier and Type | Field and Description |
---|---|
protected String |
CommonAnnotationBeanPostProcessor.LookupElement.mappedName |
Modifier and Type | Method and Description |
---|---|
protected String |
AnnotationBeanNameGenerator.determineBeanNameFromAnnotation(AnnotatedBeanDefinition annotatedDef)
Derive a bean name from one of the annotations on the class.
|
static MBeanExportConfiguration.SpecificPlatform |
MBeanExportConfiguration.SpecificPlatform.get() |
ConfigurableListableBeanFactory |
ConditionContext.getBeanFactory()
Return the
ConfigurableListableBeanFactory that will hold the bean
definition should the condition match, or null if the bean factory is
not available (or not downcastable to ConfigurableListableBeanFactory ). |
ClassLoader |
ConditionContext.getClassLoader()
Return the
ClassLoader that should be used to load additional classes
(only null if even the system ClassLoader isn't accessible). |
default Predicate<String> |
ImportSelector.getExclusionFilter()
Return a predicate for excluding classes from the import candidates, to be
transitively applied to all classes found through this selector's imports.
|
MethodMetadata |
ScannedGenericBeanDefinition.getFactoryMethodMetadata() |
default Class<? extends DeferredImportSelector.Group> |
DeferredImportSelector.getImportGroup()
Return a specific import group.
|
Object |
ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName) |
abstract MBeanServer |
MBeanExportConfiguration.SpecificPlatform.getMBeanServer() |
protected BeanDefinitionRegistry |
ClassPathScanningCandidateComponentProvider.getRegistry()
Return the
BeanDefinitionRegistry used by this scanner, if any. |
BeanDefinition |
ComponentScanBeanDefinitionParser.parse(Element element,
ParserContext parserContext) |
BeanDefinition |
AnnotationConfigBeanDefinitionParser.parse(Element element,
ParserContext parserContext) |
protected String |
Jsr330ScopeMetadataResolver.resolveScopeName(String annotationType)
Resolve the given annotation type into a named Spring scope.
|
protected abstract String[] |
AdviceModeImportSelector.selectImports(AdviceMode adviceMode)
Determine which classes should be imported based on the given
AdviceMode . |
Modifier and Type | Method and Description |
---|---|
protected Object |
CommonAnnotationBeanPostProcessor.autowireResource(BeanFactory factory,
CommonAnnotationBeanPostProcessor.LookupElement element,
String requestingBeanName)
Obtain a resource object for the given name and type through autowiring
based on the given factory.
|
protected Object |
ContextAnnotationAutowireCandidateResolver.buildLazyResolutionProxy(DependencyDescriptor descriptor,
String beanName) |
protected Object |
CommonAnnotationBeanPostProcessor.buildLazyResourceProxy(CommonAnnotationBeanPostProcessor.LookupElement element,
String requestingBeanName)
Obtain a lazily resolving resource proxy for the given name and type,
delegating to
CommonAnnotationBeanPostProcessor.getResource(org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.LookupElement, java.lang.String) on demand once a method call comes in. |
protected TypeFilter |
ComponentScanBeanDefinitionParser.createTypeFilter(Element element,
ClassLoader classLoader,
ParserContext parserContext) |
boolean |
DeferredImportSelector.Group.Entry.equals(Object other) |
Object |
ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyIfNecessary(DependencyDescriptor descriptor,
String beanName) |
protected Object |
CommonAnnotationBeanPostProcessor.getResource(CommonAnnotationBeanPostProcessor.LookupElement element,
String requestingBeanName)
Obtain the resource object for the given name and type.
|
protected boolean |
AnnotationBeanNameGenerator.isStereotypeWithNameValue(String annotationType,
Set<String> metaAnnotationTypes,
Map<String,Object> attributes)
Check whether the given annotation is a stereotype that is allowed
to suggest a component name through its annotation
value() . |
static Set<BeanDefinitionHolder> |
AnnotationConfigUtils.registerAnnotationConfigProcessors(BeanDefinitionRegistry registry,
Object source)
Register all relevant annotation post processors in the given registry.
|
void |
AnnotatedBeanDefinitionReader.registerBean(Class<?> beanClass,
String name)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations.
|
void |
AnnotatedBeanDefinitionReader.registerBean(Class<?> beanClass,
String name,
Class<? extends Annotation>... qualifiers)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations.
|
<T> void |
AnnotatedBeanDefinitionReader.registerBean(Class<T> beanClass,
String name,
Supplier<T> supplier)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations, using the given supplier for obtaining a new
instance (possibly declared as a lambda expression or method reference).
|
<T> void |
AnnotatedBeanDefinitionReader.registerBean(Class<T> beanClass,
String name,
Supplier<T> supplier)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations, using the given supplier for obtaining a new
instance (possibly declared as a lambda expression or method reference).
|
<T> void |
AnnotatedBeanDefinitionReader.registerBean(Class<T> beanClass,
String name,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations.
|
<T> void |
AnnotatedBeanDefinitionReader.registerBean(Class<T> beanClass,
String name,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations.
|
<T> void |
AnnotatedBeanDefinitionReader.registerBean(Class<T> beanClass,
Supplier<T> supplier)
Register a bean from the given bean class, deriving its metadata from
class-declared annotations, using the given supplier for obtaining a new
instance (possibly declared as a lambda expression or method reference).
|
<T> void |
AnnotationConfigApplicationContext.registerBean(String beanName,
Class<T> beanClass,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers) |
<T> void |
AnnotationConfigApplicationContext.registerBean(String beanName,
Class<T> beanClass,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers) |
void |
ClassPathBeanDefinitionScanner.setAutowireCandidatePatterns(String... autowireCandidatePatterns)
Set the name-matching patterns for determining autowire candidates.
|
void |
ClassPathBeanDefinitionScanner.setBeanDefinitionDefaults(BeanDefinitionDefaults beanDefinitionDefaults)
Set the defaults to use for detected beans.
|
void |
ClassPathBeanDefinitionScanner.setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
Set the BeanNameGenerator to use for detected bean classes.
|
void |
AnnotatedBeanDefinitionReader.setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
Set the
BeanNameGenerator to use for detected bean classes. |
void |
ConfigurationClassPostProcessor.setProblemReporter(ProblemReporter problemReporter)
Set the
ProblemReporter to use. |
void |
ClassPathScanningCandidateComponentProvider.setResourceLoader(ResourceLoader resourceLoader)
Set the
ResourceLoader to use for resource locations. |
void |
ClassPathBeanDefinitionScanner.setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)
Set the ScopeMetadataResolver to use for detected bean classes.
|
void |
AnnotatedBeanDefinitionReader.setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)
Set the
ScopeMetadataResolver to use for registered component classes. |
void |
ConfigurationClassPostProcessor.setSourceExtractor(SourceExtractor sourceExtractor)
Set the
SourceExtractor to use for generated bean definitions
that correspond to Bean factory methods. |
Constructor and Description |
---|
ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry,
boolean useDefaultFilters,
Environment environment,
ResourceLoader resourceLoader)
Create a new
ClassPathBeanDefinitionScanner for the given bean factory and
using the given Environment when evaluating bean definition profile metadata. |
LookupElement(Member member,
PropertyDescriptor pd) |
Modifier and Type | Method and Description |
---|---|
protected Object |
ApplicationListenerMethodAdapter.doInvoke(Object... args)
Invoke the event listener method with the given argument values.
|
protected String |
ApplicationListenerMethodAdapter.getCondition()
Return the condition to use.
|
protected ErrorHandler |
SimpleApplicationEventMulticaster.getErrorHandler()
Return the current error handler for this multicaster.
|
protected Executor |
SimpleApplicationEventMulticaster.getTaskExecutor()
Return the current task executor for this multicaster.
|
Object |
EventPublicationInterceptor.invoke(MethodInvocation invocation) |
protected Object[] |
ApplicationListenerMethodAdapter.resolveArguments(ApplicationEvent event)
Resolve the method arguments to use for the specified
ApplicationEvent . |
Modifier and Type | Method and Description |
---|---|
void |
SimpleApplicationEventMulticaster.multicastEvent(ApplicationEvent event,
ResolvableType eventType) |
void |
ApplicationEventMulticaster.multicastEvent(ApplicationEvent event,
ResolvableType eventType)
Multicast the given application event to appropriate listeners.
|
void |
SimpleApplicationEventMulticaster.setErrorHandler(ErrorHandler errorHandler)
Set the
ErrorHandler to invoke in case an exception is thrown
from a listener. |
void |
SimpleApplicationEventMulticaster.setTaskExecutor(Executor taskExecutor)
Set a custom executor (typically a
TaskExecutor )
to invoke each listener with. |
protected boolean |
AbstractApplicationEventMulticaster.supportsEvent(ApplicationListener<?> listener,
ResolvableType eventType,
Class<?> sourceType)
Determine whether the given listener supports the given event.
|
boolean |
SourceFilteringListener.supportsSourceType(Class<?> sourceType) |
default boolean |
SmartApplicationListener.supportsSourceType(Class<?> sourceType)
Determine whether this listener actually supports the given source type.
|
boolean |
GenericApplicationListenerAdapter.supportsSourceType(Class<?> sourceType) |
boolean |
ApplicationListenerMethodAdapter.supportsSourceType(Class<?> sourceType) |
Modifier and Type | Method and Description |
---|---|
Object |
StandardBeanExpressionResolver.evaluate(String value,
BeanExpressionContext beanExpressionContext) |
Object |
MethodBasedEvaluationContext.lookupVariable(String name) |
Modifier and Type | Method and Description |
---|---|
boolean |
BeanExpressionContextAccessor.canRead(EvaluationContext context,
Object target,
String name) |
boolean |
BeanFactoryAccessor.canRead(EvaluationContext context,
Object target,
String name) |
boolean |
EnvironmentAccessor.canRead(EvaluationContext context,
Object target,
String name)
Can read any
Environment , thus always returns true. |
boolean |
MapAccessor.canRead(EvaluationContext context,
Object target,
String name) |
boolean |
BeanExpressionContextAccessor.canWrite(EvaluationContext context,
Object target,
String name) |
boolean |
BeanFactoryAccessor.canWrite(EvaluationContext context,
Object target,
String name) |
boolean |
EnvironmentAccessor.canWrite(EvaluationContext context,
Object target,
String name)
Read-only: returns
false . |
boolean |
MapAccessor.canWrite(EvaluationContext context,
Object target,
String name) |
boolean |
AnnotatedElementKey.equals(Object other) |
boolean |
CachedExpressionEvaluator.ExpressionKey.equals(Object other) |
Object |
StandardBeanExpressionResolver.evaluate(String value,
BeanExpressionContext beanExpressionContext) |
TypedValue |
BeanExpressionContextAccessor.read(EvaluationContext context,
Object target,
String name) |
TypedValue |
BeanFactoryAccessor.read(EvaluationContext context,
Object target,
String name) |
TypedValue |
EnvironmentAccessor.read(EvaluationContext context,
Object target,
String name)
Access the given target object by resolving the given property name against the given target
environment.
|
TypedValue |
MapAccessor.read(EvaluationContext context,
Object target,
String name) |
void |
BeanExpressionContextAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
BeanExpressionContextAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
BeanFactoryAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
BeanFactoryAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
EnvironmentAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue)
Read-only: no-op.
|
void |
EnvironmentAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue)
Read-only: no-op.
|
void |
MapAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
MapAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
Constructor and Description |
---|
AnnotatedElementKey(AnnotatedElement element,
Class<?> targetClass)
Create a new instance with the specified
AnnotatedElement and
optional target Class . |
StandardBeanExpressionResolver(ClassLoader beanClassLoader)
Create a new
StandardBeanExpressionResolver with the given bean class loader,
using it as the basis for expression compilation. |
Modifier and Type | Method and Description |
---|---|
Locale |
LocaleContext.getLocale()
Return the current Locale, which can be fixed or determined dynamically,
depending on the implementation strategy.
|
Locale |
SimpleLocaleContext.getLocale() |
static LocaleContext |
LocaleContextHolder.getLocaleContext()
Return the LocaleContext associated with the current thread, if any.
|
TimeZone |
TimeZoneAwareLocaleContext.getTimeZone()
Return the current TimeZone, which can be fixed or determined dynamically,
depending on the implementation strategy.
|
TimeZone |
SimpleTimeZoneAwareLocaleContext.getTimeZone() |
Modifier and Type | Method and Description |
---|---|
static Locale |
LocaleContextHolder.getLocale(LocaleContext localeContext)
Return the Locale associated with the given user context, if any,
or the system default Locale otherwise.
|
static TimeZone |
LocaleContextHolder.getTimeZone(LocaleContext localeContext)
Return the TimeZone associated with the given user context, if any,
or the system default TimeZone otherwise.
|
static void |
LocaleContextHolder.setDefaultLocale(Locale locale)
Set a shared default locale at the framework level,
as an alternative to the JVM-wide default locale.
|
static void |
LocaleContextHolder.setDefaultTimeZone(TimeZone timeZone)
Set a shared default time zone at the framework level,
as an alternative to the JVM-wide default time zone.
|
static void |
LocaleContextHolder.setLocale(Locale locale)
Associate the given Locale with the current thread,
preserving any TimeZone that may have been set already.
|
static void |
LocaleContextHolder.setLocale(Locale locale,
boolean inheritable)
Associate the given Locale with the current thread,
preserving any TimeZone that may have been set already.
|
static void |
LocaleContextHolder.setLocaleContext(LocaleContext localeContext)
Associate the given LocaleContext with the current thread,
not exposing it as inheritable for child threads.
|
static void |
LocaleContextHolder.setLocaleContext(LocaleContext localeContext,
boolean inheritable)
Associate the given LocaleContext with the current thread.
|
static void |
LocaleContextHolder.setTimeZone(TimeZone timeZone)
Associate the given TimeZone with the current thread,
preserving any Locale that may have been set already.
|
static void |
LocaleContextHolder.setTimeZone(TimeZone timeZone,
boolean inheritable)
Associate the given TimeZone with the current thread,
preserving any Locale that may have been set already.
|
Constructor and Description |
---|
SimpleLocaleContext(Locale locale)
Create a new
SimpleLocaleContext that exposes the specified Locale . |
SimpleTimeZoneAwareLocaleContext(Locale locale,
TimeZone timeZone)
Create a new SimpleTimeZoneAwareLocaleContext that exposes the specified
Locale and TimeZone.
|
SimpleTimeZoneAwareLocaleContext(Locale locale,
TimeZone timeZone)
Create a new SimpleTimeZoneAwareLocaleContext that exposes the specified
Locale and TimeZone.
|
Modifier and Type | Method and Description |
---|---|
static CandidateComponentsIndex |
CandidateComponentsIndexLoader.loadIndex(ClassLoader classLoader)
Load and instantiate the
CandidateComponentsIndex from
"META-INF/spring.components", using the given class loader. |
Modifier and Type | Method and Description |
---|---|
static CandidateComponentsIndex |
CandidateComponentsIndexLoader.loadIndex(ClassLoader classLoader)
Load and instantiate the
CandidateComponentsIndex from
"META-INF/spring.components", using the given class loader. |
Modifier and Type | Method and Description |
---|---|
<A extends Annotation> |
AbstractApplicationContext.findAnnotationOnBean(String beanName,
Class<A> annotationType) |
<A extends Annotation> |
AbstractApplicationContext.findAnnotationOnBean(String beanName,
Class<A> annotationType,
boolean allowFactoryBeanInit) |
ApplicationContext |
ApplicationObjectSupport.getApplicationContext()
Return the ApplicationContext that this object is associated with.
|
Object[] |
DefaultMessageSourceResolvable.getArguments() |
protected ClassLoader |
ResourceBundleMessageSource.getBundleClassLoader()
Return the ClassLoader to load resource bundles with.
|
ClassLoader |
GenericApplicationContext.getClassLoader() |
String |
DefaultMessageSourceResolvable.getCode()
Return the default code of this resolvable, that is,
the last one in the codes array.
|
String[] |
DefaultMessageSourceResolvable.getCodes() |
protected Properties |
AbstractMessageSource.getCommonMessages()
Return a Properties object defining locale-independent common messages, if any.
|
protected String[] |
AbstractRefreshableConfigApplicationContext.getConfigLocations()
Return an array of resource locations, referring to the XML bean definition
files that this context should be built with.
|
protected Resource[] |
AbstractXmlApplicationContext.getConfigResources()
Return an array of Resource objects, referring to the XML bean definition
files that this context should be built with.
|
protected Resource[] |
ClassPathXmlApplicationContext.getConfigResources() |
protected String[] |
AbstractRefreshableConfigApplicationContext.getDefaultConfigLocations()
Return the default config locations to use, for the case where no
explicit config locations have been specified.
|
protected String |
AbstractResourceBasedMessageSource.getDefaultEncoding()
Return the default charset to use for parsing properties files, if any.
|
protected Locale |
AbstractResourceBasedMessageSource.getDefaultLocale()
Determine a default Locale to fall back to: either a locally specified default
Locale or the system Locale, or
null for no fallback locale at all. |
String |
DefaultMessageSourceResolvable.getDefaultMessage() |
protected String |
AbstractMessageSource.getDefaultMessage(MessageSourceResolvable resolvable,
Locale locale)
Get a default message for the given
MessageSourceResolvable . |
protected String |
AbstractMessageSource.getDefaultMessage(String code)
Return a fallback default message for the given code, if any.
|
protected String |
LiveBeansView.getEscapedResourceDescription(BeanDefinition bd)
Deprecated.
Determine a resource description for the given bean definition and
apply basic JSON escaping (backslashes, double quotes) to it.
|
protected BeanFactory |
AbstractApplicationContext.getInternalParentBeanFactory()
Return the internal bean factory of the parent context if it implements
ConfigurableApplicationContext; else, return the parent context itself.
|
protected MessageSource |
AbstractApplicationContext.getInternalParentMessageSource()
Return the internal message source of the parent context if it is an
AbstractApplicationContext too; else, return the parent context itself.
|
String |
DelegatingMessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
protected MessageFormat |
ResourceBundleMessageSource.getMessageFormat(ResourceBundle bundle,
String code,
Locale locale)
Return a MessageFormat for the given bundle and code,
fetching already generated MessageFormats from the cache.
|
MessageFormat |
ReloadableResourceBundleMessageSource.PropertiesHolder.getMessageFormat(String code,
Locale locale) |
protected String |
AbstractMessageSource.getMessageFromParent(String code,
Object[] args,
Locale locale)
Try to retrieve the given message from the parent
MessageSource , if any. |
protected String |
AbstractMessageSource.getMessageInternal(String code,
Object[] args,
Locale locale)
Resolve the given code and arguments as message in the given Locale,
returning
null if not found. |
protected MessageSourceAccessor |
ApplicationObjectSupport.getMessageSourceAccessor()
Return a MessageSourceAccessor for the application context
used by this object, for easy message access.
|
ConversionService |
ConversionServiceFactoryBean.getObject() |
ApplicationContext |
AbstractApplicationContext.getParent()
Return the parent context, or
null if there is no parent
(that is, this context is the root of the context hierarchy). |
BeanFactory |
AbstractApplicationContext.getParentBeanFactory() |
MessageSource |
DelegatingMessageSource.getParentMessageSource() |
MessageSource |
AbstractMessageSource.getParentMessageSource() |
Properties |
ReloadableResourceBundleMessageSource.PropertiesHolder.getProperties() |
String |
ReloadableResourceBundleMessageSource.PropertiesHolder.getProperty(String code) |
Object |
GenericGroovyApplicationContext.getProperty(String property) |
protected ResourceBundle |
ResourceBundleMessageSource.getResourceBundle(String basename,
Locale locale)
Return a ResourceBundle for the given basename and Locale,
fetching already generated ResourceBundle from the cache.
|
protected String |
ResourceBundleMessageSource.getStringOrNull(ResourceBundle bundle,
String key)
Efficiently retrieve the String value for the specified key,
or return
null if not found. |
Class<?> |
AbstractApplicationContext.getType(String name) |
Class<?> |
AbstractApplicationContext.getType(String name,
boolean allowFactoryBeanInit) |
protected Object |
MessageSourceResourceBundle.handleGetObject(String key)
This implementation resolves the code in the MessageSource.
|
Object |
SimpleThreadScope.remove(String name) |
protected MessageFormat |
ResourceBundleMessageSource.resolveCode(String code,
Locale locale)
Resolves the given message code as key in the registered resource bundles,
using a cached MessageFormat instance per message code.
|
protected MessageFormat |
StaticMessageSource.resolveCode(String code,
Locale locale) |
protected MessageFormat |
ReloadableResourceBundleMessageSource.resolveCode(String code,
Locale locale)
Resolves the given message code as key in the retrieved bundle files,
using a cached MessageFormat instance per message code.
|
protected abstract MessageFormat |
AbstractMessageSource.resolveCode(String code,
Locale locale)
Subclasses must implement this method to resolve a message.
|
protected String |
StaticMessageSource.resolveCodeWithoutArguments(String code,
Locale locale) |
protected String |
AbstractMessageSource.resolveCodeWithoutArguments(String code,
Locale locale)
Subclasses can override this method to resolve a message without arguments
in an optimized fashion, i.e.
|
Object |
SimpleThreadScope.resolveContextualObject(String key) |
protected String |
EmbeddedValueResolutionSupport.resolveEmbeddedValue(String value)
Resolve the given embedded value through this instance's
StringValueResolver . |
Modifier and Type | Method and Description |
---|---|
boolean |
DefaultMessageSourceResolvable.equals(Object other) |
protected String |
MessageSourceSupport.formatMessage(String msg,
Object[] args,
Locale locale)
Format the given message String, using cached MessageFormats.
|
String[] |
AbstractApplicationContext.getBeanNamesForType(Class<?> type) |
String[] |
AbstractApplicationContext.getBeanNamesForType(Class<?> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
<T> Map<String,T> |
AbstractApplicationContext.getBeansOfType(Class<T> type) |
<T> Map<String,T> |
AbstractApplicationContext.getBeansOfType(Class<T> type,
boolean includeNonSingletons,
boolean allowEagerInit) |
String |
MessageSourceAccessor.getMessage(String code,
Object[] args)
Retrieve the message for the given code and the default Locale.
|
String |
AbstractApplicationContext.getMessage(String code,
Object[] args,
Locale locale) |
String |
DelegatingMessageSource.getMessage(String code,
Object[] args,
Locale locale) |
String |
MessageSourceAccessor.getMessage(String code,
Object[] args,
Locale locale)
Retrieve the message for the given code and the given Locale.
|
String |
AbstractMessageSource.getMessage(String code,
Object[] args,
Locale locale) |
String |
MessageSourceAccessor.getMessage(String code,
Object[] args,
String defaultMessage)
Retrieve the message for the given code and the default Locale.
|
String |
AbstractApplicationContext.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
String |
AbstractApplicationContext.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
String |
DelegatingMessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
String |
DelegatingMessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
String |
MessageSourceAccessor.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale)
Retrieve the message for the given code and the given Locale.
|
String |
AbstractMessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
String |
AbstractMessageSource.getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale) |
protected String |
AbstractMessageSource.getMessageFromParent(String code,
Object[] args,
Locale locale)
Try to retrieve the given message from the parent
MessageSource , if any. |
protected String |
AbstractMessageSource.getMessageInternal(String code,
Object[] args,
Locale locale)
Resolve the given code and arguments as message in the given Locale,
returning
null if not found. |
protected String |
AbstractMessageSource.getMessageInternal(String code,
Object[] args,
Locale locale)
Resolve the given code and arguments as message in the given Locale,
returning
null if not found. |
protected String |
AbstractMessageSource.getMessageInternal(String code,
Object[] args,
Locale locale)
Resolve the given code and arguments as message in the given Locale,
returning
null if not found. |
protected void |
AbstractApplicationContext.publishEvent(Object event,
ResolvableType eventType)
Publish the given event to all listeners.
|
protected ReloadableResourceBundleMessageSource.PropertiesHolder |
ReloadableResourceBundleMessageSource.refreshProperties(String filename,
ReloadableResourceBundleMessageSource.PropertiesHolder propHolder)
Refresh the PropertiesHolder for the given bundle filename.
|
<T> void |
GenericApplicationContext.registerBean(String beanName,
Class<T> beanClass,
BeanDefinitionCustomizer... customizers)
Register a bean from the given bean class, optionally customizing its
bean definition metadata (typically declared as a lambda expression).
|
<T> void |
GenericApplicationContext.registerBean(String beanName,
Class<T> beanClass,
Object... constructorArgs)
Register a bean from the given bean class, optionally providing explicit
constructor arguments for consideration in the autowiring process.
|
<T> void |
GenericApplicationContext.registerBean(String beanName,
Class<T> beanClass,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers)
Register a bean from the given bean class, using the given supplier for
obtaining a new instance (typically declared as a lambda expression or
method reference), optionally customizing its bean definition metadata
(again typically declared as a lambda expression).
|
<T> void |
GenericApplicationContext.registerBean(String beanName,
Class<T> beanClass,
Supplier<T> supplier,
BeanDefinitionCustomizer... customizers)
Register a bean from the given bean class, using the given supplier for
obtaining a new instance (typically declared as a lambda expression or
method reference), optionally customizing its bean definition metadata
(again typically declared as a lambda expression).
|
protected String |
MessageSourceSupport.renderDefaultMessage(String defaultMessage,
Object[] args,
Locale locale)
Render the given default message String.
|
protected Object[] |
MessageSourceSupport.resolveArguments(Object[] args,
Locale locale)
Template method for resolving argument objects.
|
protected Object[] |
AbstractMessageSource.resolveArguments(Object[] args,
Locale locale)
Searches through the given array of objects, finds any MessageSourceResolvable
objects and resolves them.
|
void |
ApplicationObjectSupport.setApplicationContext(ApplicationContext context) |
void |
GenericApplicationContext.setClassLoader(ClassLoader classLoader) |
void |
AbstractMessageSource.setCommonMessages(Properties commonMessages)
Specify locale-independent common messages, with the message code as key
and the full message String (may contain argument placeholders) as value.
|
void |
AbstractRefreshableConfigApplicationContext.setConfigLocations(String... locations)
Set the config locations for this application context.
|
void |
AbstractResourceBasedMessageSource.setDefaultEncoding(String defaultEncoding)
Set the default charset to use for parsing properties files.
|
void |
AbstractResourceBasedMessageSource.setDefaultLocale(Locale defaultLocale)
Specify a default Locale to fall back to, as an alternative to falling back
to the system Locale.
|
void |
AbstractApplicationContext.setParent(ApplicationContext parent)
Set the parent of this application context.
|
void |
GenericApplicationContext.setParent(ApplicationContext parent)
Set the parent of this application context, also setting
the parent of the internal BeanFactory accordingly.
|
void |
DelegatingMessageSource.setParentMessageSource(MessageSource parent) |
void |
AbstractMessageSource.setParentMessageSource(MessageSource parent) |
void |
ReloadableResourceBundleMessageSource.setPropertiesPersister(PropertiesPersister propertiesPersister)
Set the PropertiesPersister to use for parsing properties files.
|
void |
ReloadableResourceBundleMessageSource.setResourceLoader(ResourceLoader resourceLoader)
Set the ResourceLoader to use for loading bundle properties files.
|
Constructor and Description |
---|
AbstractApplicationContext(ApplicationContext parent)
Create a new AbstractApplicationContext with the given parent context.
|
AbstractRefreshableApplicationContext(ApplicationContext parent)
Create a new AbstractRefreshableApplicationContext with the given parent context.
|
AbstractRefreshableConfigApplicationContext(ApplicationContext parent)
Create a new AbstractRefreshableConfigApplicationContext with the given parent context.
|
AbstractXmlApplicationContext(ApplicationContext parent)
Create a new AbstractXmlApplicationContext with the given parent context.
|
ClassPathXmlApplicationContext(String[] configLocations,
ApplicationContext parent)
Create a new ClassPathXmlApplicationContext with the given parent,
loading the definitions from the given XML files and automatically
refreshing the context.
|
ClassPathXmlApplicationContext(String[] configLocations,
boolean refresh,
ApplicationContext parent)
Create a new ClassPathXmlApplicationContext with the given parent,
loading the definitions from the given XML files.
|
ClassPathXmlApplicationContext(String[] paths,
Class<?> clazz,
ApplicationContext parent)
Create a new ClassPathXmlApplicationContext with the given parent,
loading the definitions from the given XML files and automatically
refreshing the context.
|
DefaultMessageSourceResolvable(String[] codes,
Object[] arguments,
String defaultMessage)
Create a new DefaultMessageSourceResolvable.
|
DefaultMessageSourceResolvable(String[] codes,
Object[] arguments,
String defaultMessage)
Create a new DefaultMessageSourceResolvable.
|
DefaultMessageSourceResolvable(String[] codes,
Object[] arguments,
String defaultMessage)
Create a new DefaultMessageSourceResolvable.
|
FileSystemXmlApplicationContext(String[] configLocations,
boolean refresh,
ApplicationContext parent)
Create a new FileSystemXmlApplicationContext with the given parent,
loading the definitions from the given XML files.
|
GenericApplicationContext(ApplicationContext parent)
Create a new GenericApplicationContext with the given parent.
|
StaticApplicationContext(ApplicationContext parent)
Create a new StaticApplicationContext with the given parent.
|
Modifier and Type | Method and Description |
---|---|
protected LoadTimeWeaver |
DefaultContextLoadTimeWeaver.createServerSpecificLoadTimeWeaver(ClassLoader classLoader) |
Modifier and Type | Method and Description |
---|---|
static void |
AspectJWeavingEnabler.enableAspectJWeaving(LoadTimeWeaver weaverToUse,
ClassLoader beanClassLoader)
Enable AspectJ weaving with the given
LoadTimeWeaver . |
static void |
AspectJWeavingEnabler.enableAspectJWeaving(LoadTimeWeaver weaverToUse,
ClassLoader beanClassLoader)
Enable AspectJ weaving with the given
LoadTimeWeaver . |
Constructor and Description |
---|
LoadTimeWeaverAwareProcessor(LoadTimeWeaver loadTimeWeaver)
Create a new
LoadTimeWeaverAwareProcessor for the given
LoadTimeWeaver . |
Modifier and Type | Method and Description |
---|---|
static String |
NestedExceptionUtils.buildMessage(String message,
Throwable cause)
Build a message for the given base message and root cause.
|
protected Integer |
OrderComparator.findOrder(Object obj)
Find an order value indicated by the given object.
|
ReactiveAdapter |
ReactiveAdapterRegistry.getAdapter(Class<?> reactiveType)
Get the adapter for the given reactive type.
|
ReactiveAdapter |
ReactiveAdapterRegistry.getAdapter(Class<?> reactiveType,
Object source)
Get the adapter for the given reactive type.
|
Object |
AttributeAccessor.getAttribute(String name)
Get the value of the attribute identified by
name . |
Object |
AttributeAccessorSupport.getAttribute(String name) |
Constructor<?> |
MethodParameter.getConstructor()
Return the wrapped Constructor, if any.
|
protected ClassLoader |
ConfigurableObjectInputStream.getFallbackClassLoader()
Return the fallback ClassLoader to use when no ClassLoader was specified
and ObjectInputStream's own default class loader failed.
|
String |
NestedCheckedException.getMessage()
Return the detail message, including the message from the nested exception
if there is one.
|
String |
NestedRuntimeException.getMessage()
Return the detail message, including the message from the nested exception
if there is one.
|
String |
NestedIOException.getMessage()
Deprecated.
Return the detail message, including the message from the nested exception
if there is one.
|
Method |
MethodParameter.getMethod()
Return the wrapped Method, if any.
|
<A extends Annotation> |
MethodParameter.getMethodAnnotation(Class<A> annotationType)
Return the method/constructor annotation of the given type, if available.
|
Object |
OrderComparator.OrderSourceProvider.getOrderSource(Object obj)
Return an order source for the specified object, i.e.
|
<A extends Annotation> |
MethodParameter.getParameterAnnotation(Class<A> annotationType)
Return the parameter annotation of the given type, if available.
|
String |
MethodParameter.getParameterName()
Return the name of the method/constructor parameter.
|
String[] |
PrioritizedParameterNameDiscoverer.getParameterNames(Constructor<?> ctor) |
String[] |
KotlinReflectionParameterNameDiscoverer.getParameterNames(Constructor<?> ctor) |
String[] |
StandardReflectionParameterNameDiscoverer.getParameterNames(Constructor<?> ctor) |
String[] |
ParameterNameDiscoverer.getParameterNames(Constructor<?> ctor)
Return parameter names for a constructor, or
null if they cannot be determined. |
String[] |
LocalVariableTableParameterNameDiscoverer.getParameterNames(Constructor<?> ctor) |
String[] |
PrioritizedParameterNameDiscoverer.getParameterNames(Method method) |
String[] |
KotlinReflectionParameterNameDiscoverer.getParameterNames(Method method) |
String[] |
StandardReflectionParameterNameDiscoverer.getParameterNames(Method method) |
String[] |
ParameterNameDiscoverer.getParameterNames(Method method)
Return parameter names for a method, or
null if they cannot be determined. |
String[] |
LocalVariableTableParameterNameDiscoverer.getParameterNames(Method method) |
Integer |
OrderComparator.getPriority(Object obj)
Determine a priority value for the given object, if any.
|
static String |
SpringProperties.getProperty(String key)
Retrieve the property value for the given key, checking local Spring
properties first and falling back to JVM-level system properties.
|
Class<?> |
ResolvableType.getRawClass()
Return the underlying Java
Class being managed, if available;
otherwise null . |
ResolvableType |
ResolvableTypeProvider.getResolvableType()
Return the
ResolvableType describing this instance
(or null if some sort of default should be applied instead). |
Throwable |
NestedCheckedException.getRootCause()
Retrieve the innermost cause of this exception, if any.
|
Throwable |
NestedRuntimeException.getRootCause()
Retrieve the innermost cause of this exception, if any.
|
static Throwable |
NestedExceptionUtils.getRootCause(Throwable original)
Retrieve the innermost cause of the given exception, if any.
|
Integer |
MethodParameter.getTypeIndexForCurrentLevel()
Return the type index for the current nesting level.
|
Integer |
MethodParameter.getTypeIndexForLevel(int nestingLevel)
Return the type index for the specified nesting level.
|
static String |
SpringVersion.getVersion()
Return the full version string of the present Spring codebase,
or
null if it cannot be determined. |
T |
MethodIntrospector.MetadataLookup.inspect(Method method)
Perform a lookup on the given method and return associated metadata, if any.
|
protected byte[] |
OverridingClassLoader.loadBytesForClass(String name)
Load the defining bytes for the given class,
to be turned into a Class object through a
ClassLoader.defineClass(byte[], int, int) call. |
protected Class<?> |
OverridingClassLoader.loadClassForOverriding(String name)
Load the specified class for overriding purposes in this ClassLoader.
|
protected InputStream |
OverridingClassLoader.openStreamForClass(String name)
Open an InputStream for the specified class.
|
Object |
AttributeAccessor.removeAttribute(String name)
Remove the attribute identified by
name and return its value. |
Object |
AttributeAccessorSupport.removeAttribute(String name) |
Class<?> |
ResolvableType.resolve()
Resolve this type to a
Class , returning null
if the type cannot be resolved. |
Class<?> |
ResolvableType.resolveGeneric(int... indexes)
|
static Class<?> |
GenericTypeResolver.resolveReturnTypeArgument(Method method,
Class<?> genericIfc)
Resolve the single type argument of the given generic interface against the given
target method which is assumed to return the given interface or an implementation
of it.
|
static Class<?> |
GenericTypeResolver.resolveTypeArgument(Class<?> clazz,
Class<?> genericIfc)
Resolve the single type argument of the given generic interface against
the given target class which is assumed to implement the generic interface
and possibly declare a concrete type for its type variable.
|
static Class<?>[] |
GenericTypeResolver.resolveTypeArguments(Class<?> clazz,
Class<?> genericIfc)
Resolve the type arguments of the given generic interface against the given
target class which is assumed to implement the generic interface and possibly
declare concrete types for its type variables.
|
Modifier and Type | Method and Description |
---|---|
static String |
NestedExceptionUtils.buildMessage(String message,
Throwable cause)
Build a message for the given base message and root cause.
|
static String |
NestedExceptionUtils.buildMessage(String message,
Throwable cause)
Build a message for the given base message and root cause.
|
int |
OrderComparator.compare(Object o1,
Object o2) |
int |
OrderComparator.compare(Object o1,
Object o2) |
boolean |
NestedCheckedException.contains(Class<?> exType)
Check whether this exception contains an exception of the given type:
either it is of the given class itself or it contains a nested cause
of the given type.
|
boolean |
NestedRuntimeException.contains(Class<?> exType)
Check whether this exception contains an exception of the given type:
either it is of the given class itself or it contains a nested cause
of the given type.
|
static <E> Collection<E> |
CollectionFactory.createApproximateCollection(Object collection,
int capacity)
Create the most approximate collection for the given collection.
|
static <K,V> Map<K,V> |
CollectionFactory.createApproximateMap(Object map,
int capacity)
Create the most approximate map for the given map.
|
static <E> Collection<E> |
CollectionFactory.createCollection(Class<?> collectionType,
Class<?> elementType,
int capacity)
Create the most appropriate collection for the given collection type.
|
static <K,V> Map<K,V> |
CollectionFactory.createMap(Class<?> mapType,
Class<?> keyType,
int capacity)
Create the most appropriate map for the given map type.
|
boolean |
ResolvableType.equals(Object other) |
boolean |
AttributeAccessorSupport.equals(Object other) |
boolean |
MethodClassKey.equals(Object other) |
boolean |
MethodParameter.equals(Object other) |
boolean |
ReactiveTypeDescriptor.equals(Object other) |
boolean |
ParameterizedTypeReference.equals(Object other) |
static ResolvableType |
ResolvableType.forClass(Class<?> clazz)
Return a
ResolvableType for the specified Class ,
using the full generic type information for assignability checks. |
static ResolvableType |
ResolvableType.forField(Field field,
int nestingLevel,
Class<?> implementationClass)
Return a
ResolvableType for the specified Field with a given
implementation and the given nesting level. |
static ResolvableType |
ResolvableType.forField(Field field,
ResolvableType implementationType)
Return a
ResolvableType for the specified Field with a given
implementation. |
static ResolvableType |
ResolvableType.forInstance(Object instance)
Return a
ResolvableType for the specified instance. |
static ResolvableType |
ResolvableType.forMethodParameter(MethodParameter methodParameter,
ResolvableType implementationType)
Return a
ResolvableType for the specified MethodParameter with a
given implementation type. |
static ResolvableType |
ResolvableType.forMethodParameter(MethodParameter methodParameter,
Type targetType)
Return a
ResolvableType for the specified MethodParameter ,
overriding the target type to resolve with a specific given type. |
static ResolvableType |
ResolvableType.forRawClass(Class<?> clazz)
Return a
ResolvableType for the specified Class ,
doing assignability checks against the raw class only (analogous to
Class.isAssignableFrom(java.lang.Class<?>) , which this serves as a wrapper for). |
static ResolvableType |
ResolvableType.forType(Type type)
Return a
ResolvableType for the specified Type . |
static ResolvableType |
ResolvableType.forType(Type type,
ResolvableType owner)
Return a
ResolvableType for the specified Type backed by the given
owner type. |
static ResolvableType |
ResolvableType.forType(Type type,
ResolvableType owner)
Return a
ResolvableType for the specified Type backed by the given
owner type. |
ReactiveAdapter |
ReactiveAdapterRegistry.getAdapter(Class<?> reactiveType,
Object source)
Get the adapter for the given reactive type.
|
ReactiveAdapter |
ReactiveAdapterRegistry.getAdapter(Class<?> reactiveType,
Object source)
Get the adapter for the given reactive type.
|
ResolvableType |
ResolvableType.getGeneric(int... indexes)
Return a
ResolvableType representing the generic parameter for the
given indexes. |
Set<String> |
Constants.getNames(String namePrefix)
Return all names of the given group of constants.
|
Set<String> |
Constants.getNamesForSuffix(String nameSuffix)
Return all names of the given group of constants.
|
ResolvableType |
ResolvableType.getNested(int nestingLevel,
Map<Integer,Integer> typeIndexesPerLevel)
Return a
ResolvableType for the specified nesting level. |
protected int |
OrderComparator.getOrder(Object obj)
Determine the order value for the given object.
|
static Throwable |
NestedExceptionUtils.getRootCause(Throwable original)
Retrieve the innermost cause of the given exception, if any.
|
Set<Object> |
Constants.getValues(String namePrefix)
Return all values of the given group of constants.
|
Set<Object> |
Constants.getValuesForSuffix(String nameSuffix)
Return all values of the given group of constants.
|
static String |
Conventions.getVariableNameForReturnType(Method method,
Class<?> resolvedType,
Object value)
Determine the conventional variable name for the return type of the given
method, taking the generic collection type, if any, into account, falling
back on the given return value if the method declaration is not specific
enough, e.g.
|
static String |
Conventions.getVariableNameForReturnType(Method method,
Object value)
Determine the conventional variable name for the return type of the given
method, taking the generic collection type, if any, into account, falling
back on the given actual return value if the method declaration is not
specific enough, e.g.
|
void |
MethodParameter.initParameterNameDiscovery(ParameterNameDiscoverer parameterNameDiscoverer)
Initialize parameter name discovery for this method parameter.
|
static boolean |
CollectionFactory.isApproximableCollectionType(Class<?> collectionType)
Determine whether the given collection type is an approximable type,
i.e.
|
static boolean |
CollectionFactory.isApproximableMapType(Class<?> mapType)
Determine whether the given map type is an approximable type,
i.e.
|
boolean |
ResolvableType.isInstance(Object obj)
Determine whether the given object is an instance of this
ResolvableType . |
MethodParameter |
MethodParameter.nested(Integer typeIndex)
Return a variant of this
MethodParameter which points to the
same parameter but one nesting level deeper. |
default Class<?> |
SmartClassLoader.publicDefineClass(String name,
byte[] b,
ProtectionDomain protectionDomain)
Define a custom class (typically a CGLIB proxy class) in this class loader.
|
static Type |
GenericTypeResolver.resolveType(Type genericType,
Class<?> contextClass)
Resolve the given generic type against the given context class,
substituting type variables as far as possible.
|
void |
AttributeAccessor.setAttribute(String name,
Object value)
Set the attribute defined by
name to the supplied value . |
void |
AttributeAccessorSupport.setAttribute(String name,
Object value) |
static void |
SpringProperties.setProperty(String key,
String value)
Programmatically set a local property, overriding an entry in the
spring.properties file (if any). |
String |
Constants.toCode(Object value,
String namePrefix)
Look up the given value within the given group of constants.
|
String |
Constants.toCodeForSuffix(Object value,
String nameSuffix)
Look up the given value within the given group of constants.
|
<T> Publisher<T> |
ReactiveAdapter.toPublisher(Object source)
Adapt the given instance to a Reactive Streams
Publisher . |
MethodParameter |
MethodParameter.withContainingClass(Class<?> containingClass)
Return a variant of this
MethodParameter which refers to the
given containing class. |
Constructor and Description |
---|
ConfigurableObjectInputStream(InputStream in,
ClassLoader classLoader)
Create a new ConfigurableObjectInputStream for the given InputStream and ClassLoader.
|
ConfigurableObjectInputStream(InputStream in,
ClassLoader classLoader,
boolean acceptProxyClasses)
Create a new ConfigurableObjectInputStream for the given InputStream and ClassLoader.
|
DecoratingClassLoader(ClassLoader parent)
Create a new DecoratingClassLoader using the given parent ClassLoader
for delegation.
|
MethodClassKey(Method method,
Class<?> targetClass)
Create a key object for the given method and target class.
|
NestedCheckedException(String msg,
Throwable cause)
Construct a
NestedCheckedException with the specified detail message
and nested exception. |
NestedCheckedException(String msg,
Throwable cause)
Construct a
NestedCheckedException with the specified detail message
and nested exception. |
NestedIOException(String msg,
Throwable cause)
Deprecated.
Construct a
NestedIOException with the specified detail message
and nested exception. |
NestedIOException(String msg,
Throwable cause)
Deprecated.
Construct a
NestedIOException with the specified detail message
and nested exception. |
NestedRuntimeException(String msg,
Throwable cause)
Construct a
NestedRuntimeException with the specified detail message
and nested exception. |
NestedRuntimeException(String msg,
Throwable cause)
Construct a
NestedRuntimeException with the specified detail message
and nested exception. |
OverridingClassLoader(ClassLoader parent)
Create a new OverridingClassLoader for the given ClassLoader.
|
OverridingClassLoader(ClassLoader parent,
ClassLoader overrideDelegate)
Create a new OverridingClassLoader for the given ClassLoader.
|
OverridingClassLoader(ClassLoader parent,
ClassLoader overrideDelegate)
Create a new OverridingClassLoader for the given ClassLoader.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Annotation> |
AnnotationAttributes.annotationType()
Get the type of annotation represented by this
AnnotationAttributes . |
static <A extends Annotation> |
AnnotationUtils.findAnnotation(AnnotatedElement annotatedElement,
Class<A> annotationType)
|
static <A extends Annotation> |
AnnotationUtils.findAnnotation(Class<?> clazz,
Class<A> annotationType)
Find a single
Annotation of annotationType on the
supplied Class , traversing its interfaces, annotations, and
superclasses if the annotation is not directly present on
the given class itself. |
static <A extends Annotation> |
AnnotationUtils.findAnnotation(Method method,
Class<A> annotationType)
Find a single
Annotation of annotationType on the supplied
Method , traversing its super methods (i.e. |
static Class<?> |
AnnotationUtils.findAnnotationDeclaringClass(Class<? extends Annotation> annotationType,
Class<?> clazz)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Class<?> |
AnnotationUtils.findAnnotationDeclaringClassForTypes(List<Class<? extends Annotation>> annotationTypes,
Class<?> clazz)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static <A extends Annotation> |
AnnotatedElementUtils.findMergedAnnotation(AnnotatedElement element,
Class<A> annotationType)
Find the first annotation of the specified
annotationType within
the annotation hierarchy above the supplied element ,
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy, and synthesize
the result back into an annotation of the specified annotationType . |
static AnnotationAttributes |
AnnotatedElementUtils.findMergedAnnotationAttributes(AnnotatedElement element,
Class<? extends Annotation> annotationType,
boolean classValuesAsString,
boolean nestedAnnotationsAsMap)
Find the first annotation of the specified
annotationType within
the annotation hierarchy above the supplied element and
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy. |
static AnnotationAttributes |
AnnotatedElementUtils.findMergedAnnotationAttributes(AnnotatedElement element,
String annotationName,
boolean classValuesAsString,
boolean nestedAnnotationsAsMap)
Find the first annotation of the specified
annotationName within
the annotation hierarchy above the supplied element and
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy. |
protected Integer |
AnnotationAwareOrderComparator.findOrder(Object obj)
|
static AnnotationAttributes |
AnnotationAttributes.fromMap(Map<String,Object> map)
Return an
AnnotationAttributes instance based on the given map. |
static MultiValueMap<String,Object> |
AnnotatedElementUtils.getAllAnnotationAttributes(AnnotatedElement element,
String annotationName)
Get the annotation attributes of all annotations of the specified
annotationName in the annotation hierarchy above the supplied
AnnotatedElement and store the results in a MultiValueMap . |
static MultiValueMap<String,Object> |
AnnotatedElementUtils.getAllAnnotationAttributes(AnnotatedElement element,
String annotationName,
boolean classValuesAsString,
boolean nestedAnnotationsAsMap)
Get the annotation attributes of all annotations of
the specified
annotationName in the annotation hierarchy above
the supplied AnnotatedElement and store the results in a
MultiValueMap . |
static <A extends Annotation> |
AnnotationUtils.getAnnotation(AnnotatedElement annotatedElement,
Class<A> annotationType)
Get a single
Annotation of annotationType from the supplied
AnnotatedElement , where the annotation is either present or
meta-present on the AnnotatedElement . |
static <A extends Annotation> |
AnnotationUtils.getAnnotation(Annotation annotation,
Class<A> annotationType)
Get a single
Annotation of annotationType from the supplied
annotation: either the given annotation itself or a direct meta-annotation
thereof. |
static <A extends Annotation> |
AnnotationUtils.getAnnotation(Method method,
Class<A> annotationType)
Get a single
Annotation of annotationType from the
supplied Method , where the annotation is either present
or meta-present on the method. |
static Annotation[] |
AnnotationUtils.getAnnotations(AnnotatedElement annotatedElement)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Annotation[] |
AnnotationUtils.getAnnotations(Method method)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Object |
AnnotationUtils.getDefaultValue(Annotation annotation)
Retrieve the default value of the
value attribute
of a single-element Annotation, given an annotation instance. |
static Object |
AnnotationUtils.getDefaultValue(Annotation annotation,
String attributeName)
Retrieve the default value of a named attribute, given an annotation instance.
|
static Object |
AnnotationUtils.getDefaultValue(Class<? extends Annotation> annotationType)
Retrieve the default value of the
value attribute
of a single-element Annotation, given the annotation type . |
static Object |
AnnotationUtils.getDefaultValue(Class<? extends Annotation> annotationType,
String attributeName)
Retrieve the default value of a named attribute, given the
annotation type . |
static <A extends Annotation> |
AnnotatedElementUtils.getMergedAnnotation(AnnotatedElement element,
Class<A> annotationType)
Get the first annotation of the specified
annotationType within
the annotation hierarchy above the supplied element ,
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy, and synthesize
the result back into an annotation of the specified annotationType . |
static AnnotationAttributes |
AnnotatedElementUtils.getMergedAnnotationAttributes(AnnotatedElement element,
Class<? extends Annotation> annotationType)
Get the first annotation of the specified
annotationType within
the annotation hierarchy above the supplied element and
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy. |
static AnnotationAttributes |
AnnotatedElementUtils.getMergedAnnotationAttributes(AnnotatedElement element,
String annotationName)
Get the first annotation of the specified
annotationName within
the annotation hierarchy above the supplied element and
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy. |
static AnnotationAttributes |
AnnotatedElementUtils.getMergedAnnotationAttributes(AnnotatedElement element,
String annotationName,
boolean classValuesAsString,
boolean nestedAnnotationsAsMap)
Get the first annotation of the specified
annotationName within
the annotation hierarchy above the supplied element and
merge that annotation's attributes with matching attributes from
annotations in lower levels of the annotation hierarchy. |
MergedAnnotation<?> |
MergedAnnotation.getMetaSource()
Get the source of the meta-annotation, or
null if the
annotation is not meta-present. |
static Integer |
OrderUtils.getOrder(AnnotatedElement element)
Return the order declared on the specified
element . |
static Integer |
OrderUtils.getOrder(Class<?> type)
Return the order on the specified
type . |
static Integer |
OrderUtils.getOrder(Class<?> type,
Integer defaultOrder)
Return the order on the specified
type , or the specified
default value if none can be found. |
static Integer |
OrderUtils.getPriority(Class<?> type)
Return the value of the
javax.annotation.Priority annotation
declared on the specified type, or null if none. |
Integer |
AnnotationAwareOrderComparator.getPriority(Object obj)
|
Object |
MergedAnnotation.getSource()
Get the source that ultimately declared the root annotation, or
null if the source is not known. |
static Object |
AnnotationUtils.getValue(Annotation annotation)
Retrieve the value of the
value attribute of a
single-element Annotation, given an annotation instance. |
static Object |
AnnotationUtils.getValue(Annotation annotation,
String attributeName)
Retrieve the value of a named attribute, given an annotation instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
RepeatableContainers.equals(Object other) |
static <A extends Annotation> |
AnnotationUtils.findAnnotation(AnnotatedElement annotatedElement,
Class<A> annotationType)
|
static <A extends Annotation> |
AnnotationUtils.findAnnotation(Class<?> clazz,
Class<A> annotationType)
Find a single
Annotation of annotationType on the
supplied Class , traversing its interfaces, annotations, and
superclasses if the annotation is not directly present on
the given class itself. |
static <A extends Annotation> |
AnnotationUtils.findAnnotation(Method method,
Class<A> annotationType)
Find a single
Annotation of annotationType on the supplied
Method , traversing its super methods (i.e. |
static Class<?> |
AnnotationUtils.findAnnotationDeclaringClass(Class<? extends Annotation> annotationType,
Class<?> clazz)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Class<?> |
AnnotationUtils.findAnnotationDeclaringClassForTypes(List<Class<? extends Annotation>> annotationTypes,
Class<?> clazz)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static <A extends Annotation> |
AnnotatedElementUtils.findMergedRepeatableAnnotations(AnnotatedElement element,
Class<A> annotationType,
Class<? extends Annotation> containerType)
Find all repeatable annotations of the specified
annotationType
within the annotation hierarchy above the supplied element ;
and for each annotation found, merge that annotation's attributes with
matching attributes from annotations in lower levels of the annotation
hierarchy and synthesize the results back into an annotation of the specified
annotationType . |
static <A extends Annotation> |
MergedAnnotation.from(Object source,
A annotation)
Create a new
MergedAnnotation instance from the specified
annotation. |
static AnnotationAttributes |
AnnotationAttributes.fromMap(Map<String,Object> map)
Return an
AnnotationAttributes instance based on the given map. |
<A extends Annotation> |
MergedAnnotations.get(Class<A> annotationType,
Predicate<? super MergedAnnotation<A>> predicate)
Get the nearest matching
annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
<A extends Annotation> |
MergedAnnotations.get(Class<A> annotationType,
Predicate<? super MergedAnnotation<A>> predicate,
MergedAnnotationSelector<A> selector)
Get a matching annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
<A extends Annotation> |
MergedAnnotations.get(Class<A> annotationType,
Predicate<? super MergedAnnotation<A>> predicate,
MergedAnnotationSelector<A> selector)
Get a matching annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
<A extends Annotation> |
MergedAnnotations.get(String annotationType,
Predicate<? super MergedAnnotation<A>> predicate)
Get the nearest matching
annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
<A extends Annotation> |
MergedAnnotations.get(String annotationType,
Predicate<? super MergedAnnotation<A>> predicate,
MergedAnnotationSelector<A> selector)
Get a matching annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
<A extends Annotation> |
MergedAnnotations.get(String annotationType,
Predicate<? super MergedAnnotation<A>> predicate,
MergedAnnotationSelector<A> selector)
Get a matching annotation or meta-annotation of the specified type, or
MergedAnnotation.missing() if none is present. |
static AnnotationAttributes |
AnnotationUtils.getAnnotationAttributes(AnnotatedElement annotatedElement,
Annotation annotation)
Retrieve the given annotation's attributes as an
AnnotationAttributes map. |
static AnnotationAttributes |
AnnotationUtils.getAnnotationAttributes(AnnotatedElement annotatedElement,
Annotation annotation,
boolean classValuesAsString,
boolean nestedAnnotationsAsMap)
Retrieve the given annotation's attributes as an
AnnotationAttributes map. |
static <A extends Annotation> |
AnnotationUtils.getDeclaredRepeatableAnnotations(AnnotatedElement annotatedElement,
Class<A> annotationType,
Class<? extends Annotation> containerAnnotationType)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Object |
AnnotationUtils.getDefaultValue(Annotation annotation,
String attributeName)
Retrieve the default value of a named attribute, given an annotation instance.
|
static Object |
AnnotationUtils.getDefaultValue(Annotation annotation,
String attributeName)
Retrieve the default value of a named attribute, given an annotation instance.
|
static Object |
AnnotationUtils.getDefaultValue(Class<? extends Annotation> annotationType,
String attributeName)
Retrieve the default value of a named attribute, given the
annotation type . |
static Object |
AnnotationUtils.getDefaultValue(Class<? extends Annotation> annotationType,
String attributeName)
Retrieve the default value of a named attribute, given the
annotation type . |
static <A extends Annotation> |
AnnotatedElementUtils.getMergedRepeatableAnnotations(AnnotatedElement element,
Class<A> annotationType,
Class<? extends Annotation> containerType)
Get all repeatable annotations of the specified
annotationType
within the annotation hierarchy above the supplied element ;
and for each annotation found, merge that annotation's attributes with
matching attributes from annotations in lower levels of the annotation
hierarchy and synthesize the results back into an annotation of the specified
annotationType . |
static Integer |
OrderUtils.getOrder(Class<?> type,
Integer defaultOrder)
Return the order on the specified
type , or the specified
default value if none can be found. |
static <A extends Annotation> |
AnnotationUtils.getRepeatableAnnotations(AnnotatedElement annotatedElement,
Class<A> annotationType,
Class<? extends Annotation> containerAnnotationType)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static Object |
AnnotationUtils.getValue(Annotation annotation,
String attributeName)
Retrieve the value of a named attribute, given an annotation instance.
|
static Object |
AnnotationUtils.getValue(Annotation annotation,
String attributeName)
Retrieve the value of a named attribute, given an annotation instance.
|
static boolean |
AnnotationUtils.isAnnotationMetaPresent(Class<? extends Annotation> annotationType,
Class<? extends Annotation> metaAnnotationType)
Deprecated.
as of 5.2 since it is superseded by the
MergedAnnotations API |
static boolean |
AnnotationUtils.isCandidateClass(Class<?> clazz,
Class<? extends Annotation> annotationType)
Determine whether the given class is a candidate for carrying the specified annotation
(at type, method or field level).
|
static boolean |
AnnotationUtils.isInJavaLangAnnotationPackage(Annotation annotation)
Determine if the supplied
Annotation is defined in the core JDK
java.lang.annotation package. |
static boolean |
AnnotationUtils.isInJavaLangAnnotationPackage(String annotationType)
Determine if the
Annotation with the supplied name is defined
in the core JDK java.lang.annotation package. |
static boolean |
AnnotationUtils.isSynthesizedAnnotation(Annotation annotation)
Determine if the supplied
Annotation has been synthesized
by Spring (i.e. |
static <A extends Annotation> |
MergedAnnotation.of(AnnotatedElement source,
Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static <A extends Annotation> |
MergedAnnotation.of(AnnotatedElement source,
Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static RepeatableContainers |
RepeatableContainers.of(Class<? extends Annotation> repeatable,
Class<? extends Annotation> container)
Create a
RepeatableContainers instance that uses predefined
repeatable and container types. |
static <A extends Annotation> |
MergedAnnotation.of(Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static <A extends Annotation> |
MergedAnnotation.of(ClassLoader classLoader,
Object source,
Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static <A extends Annotation> |
MergedAnnotation.of(ClassLoader classLoader,
Object source,
Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static <A extends Annotation> |
MergedAnnotation.of(ClassLoader classLoader,
Object source,
Class<A> annotationType,
Map<String,?> attributes)
Create a new
MergedAnnotation instance of the specified
annotation type with attribute values supplied by a map. |
static void |
AnnotationUtils.postProcessAnnotationAttributes(Object annotatedElement,
AnnotationAttributes attributes,
boolean classValuesAsString)
Post-process the supplied
AnnotationAttributes , preserving nested
annotations as Annotation instances. |
static void |
AnnotationUtils.postProcessAnnotationAttributes(Object annotatedElement,
AnnotationAttributes attributes,
boolean classValuesAsString)
Post-process the supplied
AnnotationAttributes , preserving nested
annotations as Annotation instances. |
static <A extends Annotation> |
AnnotationUtils.synthesizeAnnotation(A annotation,
AnnotatedElement annotatedElement)
Synthesize an annotation from the supplied
annotation
by wrapping it in a dynamic proxy that transparently enforces
attribute alias semantics for annotation attributes that are
annotated with @AliasFor . |
static <A extends Annotation> |
AnnotationUtils.synthesizeAnnotation(Map<String,Object> attributes,
Class<A> annotationType,
AnnotatedElement annotatedElement)
Synthesize an annotation from the supplied map of annotation
attributes by wrapping the map in a dynamic proxy that implements an
annotation of the specified
annotationType and transparently
enforces attribute alias semantics for annotation attributes
that are annotated with @AliasFor . |
Constructor and Description |
---|
AnnotationAttributes(String annotationType,
ClassLoader classLoader)
Create a new, empty
AnnotationAttributes instance for the
specified annotationType . |
Modifier and Type | Method and Description |
---|---|
default T |
Decoder.decode(DataBuffer buffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints)
Decode a data buffer to an Object of type T.
|
protected T |
AbstractDataBufferDecoder.decodeDataBuffer(DataBuffer buffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Deprecated.
as of 5.2, please implement
Decoder.decode(DataBuffer, ResolvableType, MimeType, Map) instead |
Modifier and Type | Method and Description |
---|---|
boolean |
ByteArrayDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
StringDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
DataBufferDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
Decoder.canDecode(ResolvableType elementType,
MimeType mimeType)
Whether the decoder supports the given target element type and the MIME
type of the source stream.
|
boolean |
NettyByteBufDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ByteBufferDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ResourceDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
AbstractDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
CharSequenceEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
NettyByteBufEncoder.canEncode(ResolvableType type,
MimeType mimeType) |
boolean |
ByteBufferEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ResourceRegionEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
DataBufferEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ByteArrayEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
AbstractEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ResourceEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
Encoder.canEncode(ResolvableType elementType,
MimeType mimeType)
Whether the encoder supports the given source element type and the MIME
type for the output stream.
|
byte[] |
ByteArrayDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
byte[] |
ByteArrayDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
String |
StringDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
String |
StringDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
DataBufferDecoder.decode(DataBuffer buffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
DataBufferDecoder.decode(DataBuffer buffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
default T |
Decoder.decode(DataBuffer buffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints)
Decode a data buffer to an Object of type T.
|
default T |
Decoder.decode(DataBuffer buffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints)
Decode a data buffer to an Object of type T.
|
io.netty.buffer.ByteBuf |
NettyByteBufDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
io.netty.buffer.ByteBuf |
NettyByteBufDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
ByteBuffer |
ByteBufferDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
ByteBuffer |
ByteBufferDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
Resource |
ResourceDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
Resource |
ResourceDecoder.decode(DataBuffer dataBuffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<T> |
AbstractDataBufferDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<T> |
AbstractDataBufferDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<String> |
StringDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<String> |
StringDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
DataBufferDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
DataBufferDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<T> |
Decoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Decode a
DataBuffer input stream into a Flux of T . |
reactor.core.publisher.Flux<T> |
Decoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Decode a
DataBuffer input stream into a Flux of T . |
reactor.core.publisher.Flux<Resource> |
ResourceDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Resource> |
ResourceDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
protected T |
AbstractDataBufferDecoder.decodeDataBuffer(DataBuffer buffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Deprecated.
as of 5.2, please implement
Decoder.decode(DataBuffer, ResolvableType, MimeType, Map) instead |
protected T |
AbstractDataBufferDecoder.decodeDataBuffer(DataBuffer buffer,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Deprecated.
as of 5.2, please implement
Decoder.decode(DataBuffer, ResolvableType, MimeType, Map) instead |
reactor.core.publisher.Mono<T> |
AbstractDataBufferDecoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<T> |
AbstractDataBufferDecoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<T> |
Decoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Decode a
DataBuffer input stream into a Mono of T . |
reactor.core.publisher.Mono<T> |
Decoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Decode a
DataBuffer input stream into a Mono of T . |
reactor.core.publisher.Mono<T> |
AbstractDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<T> |
AbstractDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ByteArrayEncoder.encode(Publisher<? extends byte[]> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ByteArrayEncoder.encode(Publisher<? extends byte[]> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
NettyByteBufEncoder.encode(Publisher<? extends io.netty.buffer.ByteBuf> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
NettyByteBufEncoder.encode(Publisher<? extends io.netty.buffer.ByteBuf> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ByteBufferEncoder.encode(Publisher<? extends ByteBuffer> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ByteBufferEncoder.encode(Publisher<? extends ByteBuffer> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
CharSequenceEncoder.encode(Publisher<? extends CharSequence> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
CharSequenceEncoder.encode(Publisher<? extends CharSequence> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
DataBufferEncoder.encode(Publisher<? extends DataBuffer> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
DataBufferEncoder.encode(Publisher<? extends DataBuffer> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ResourceRegionEncoder.encode(Publisher<? extends ResourceRegion> input,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ResourceRegionEncoder.encode(Publisher<? extends ResourceRegion> input,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
AbstractSingleValueEncoder.encode(Publisher<? extends T> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
AbstractSingleValueEncoder.encode(Publisher<? extends T> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
Encoder.encode(Publisher<? extends T> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Encode a stream of Objects of type
T into a DataBuffer
output stream. |
reactor.core.publisher.Flux<DataBuffer> |
Encoder.encode(Publisher<? extends T> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Encode a stream of Objects of type
T into a DataBuffer
output stream. |
protected reactor.core.publisher.Flux<DataBuffer> |
ResourceEncoder.encode(Resource resource,
DataBufferFactory bufferFactory,
ResolvableType type,
MimeType mimeType,
Map<String,Object> hints) |
protected reactor.core.publisher.Flux<DataBuffer> |
ResourceEncoder.encode(Resource resource,
DataBufferFactory bufferFactory,
ResolvableType type,
MimeType mimeType,
Map<String,Object> hints) |
protected abstract reactor.core.publisher.Flux<DataBuffer> |
AbstractSingleValueEncoder.encode(T t,
DataBufferFactory dataBufferFactory,
ResolvableType type,
MimeType mimeType,
Map<String,Object> hints)
Encode
T to an output DataBuffer stream. |
protected abstract reactor.core.publisher.Flux<DataBuffer> |
AbstractSingleValueEncoder.encode(T t,
DataBufferFactory dataBufferFactory,
ResolvableType type,
MimeType mimeType,
Map<String,Object> hints)
Encode
T to an output DataBuffer stream. |
DataBuffer |
ByteArrayEncoder.encodeValue(byte[] bytes,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
ByteArrayEncoder.encodeValue(byte[] bytes,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
NettyByteBufEncoder.encodeValue(io.netty.buffer.ByteBuf byteBuf,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
NettyByteBufEncoder.encodeValue(io.netty.buffer.ByteBuf byteBuf,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
ByteBufferEncoder.encodeValue(ByteBuffer byteBuffer,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
ByteBufferEncoder.encodeValue(ByteBuffer byteBuffer,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
CharSequenceEncoder.encodeValue(CharSequence charSequence,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
CharSequenceEncoder.encodeValue(CharSequence charSequence,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
DataBufferEncoder.encodeValue(DataBuffer buffer,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
DataBufferEncoder.encodeValue(DataBuffer buffer,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
default DataBuffer |
Encoder.encodeValue(T value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints)
Encode an Object of type T to a data buffer.
|
default DataBuffer |
Encoder.encodeValue(T value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints)
Encode an Object of type T to a data buffer.
|
static String |
Hints.getLogPrefix(Map<String,Object> hints)
Obtain the hint
Hints.LOG_PREFIX_HINT , if present, or an empty String. |
static <T> T |
Hints.getRequiredHint(Map<String,Object> hints,
String hintName)
Obtain the value for a required hint.
|
static boolean |
Hints.isLoggingSuppressed(Map<String,Object> hints)
Whether to suppress logging based on the hint
Hints.SUPPRESS_LOGGING_HINT . |
static void |
Hints.touchDataBuffer(DataBuffer buffer,
Map<String,Object> hints,
Log logger)
If the hints contain a
Hints.LOG_PREFIX_HINT and the given logger has
DEBUG level enabled, apply the log prefix as a hint to the given buffer
via DataBufferUtils.touch(DataBuffer, Object) . |
Constructor and Description |
---|
CodecException(String msg,
Throwable cause)
Create a new CodecException.
|
DecodingException(String msg,
Throwable cause)
Create a new DecodingException.
|
EncodingException(String msg,
Throwable cause)
Create a new EncodingException.
|
Modifier and Type | Method and Description |
---|---|
static TypeDescriptor |
TypeDescriptor.array(TypeDescriptor elementTypeDescriptor)
Create a new type descriptor as an array of the specified type.
|
<T> T |
ConversionService.convert(Object source,
Class<T> targetType)
Convert the given
source to the specified targetType . |
Object |
ConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the given
source to the specified targetType . |
TypeDescriptor |
TypeDescriptor.elementTypeDescriptor(Object element)
If this type is a
Collection or an array, creates an element TypeDescriptor
from the provided collection or array element. |
static TypeDescriptor |
TypeDescriptor.forObject(Object source)
Create a new type descriptor for an object.
|
<T extends Annotation> |
TypeDescriptor.getAnnotation(Class<T> annotationType)
Obtain the annotation of the specified
annotationType that is on this type descriptor. |
TypeDescriptor |
TypeDescriptor.getElementTypeDescriptor()
If this type is an array, returns the array's component type.
|
TypeDescriptor |
TypeDescriptor.getMapKeyTypeDescriptor()
If this type is a
Map and its key type is parameterized,
returns the map's key type. |
TypeDescriptor |
TypeDescriptor.getMapKeyTypeDescriptor(Object mapKey)
If this type is a
Map , creates a mapKey TypeDescriptor
from the provided map key. |
TypeDescriptor |
TypeDescriptor.getMapValueTypeDescriptor()
If this type is a
Map and its value type is parameterized,
returns the map's value type. |
TypeDescriptor |
TypeDescriptor.getMapValueTypeDescriptor(Object mapValue)
If this type is a
Map , creates a mapValue TypeDescriptor
from the provided map value. |
Method |
Property.getReadMethod()
The property getter method: e.g.
|
TypeDescriptor |
ConversionFailedException.getSourceType()
Return the source type we tried to convert the value from.
|
TypeDescriptor |
ConverterNotFoundException.getSourceType()
Return the source type that was requested to convert from.
|
Object |
ConversionFailedException.getValue()
Return the offending value.
|
Method |
Property.getWriteMethod()
The property setter method: e.g.
|
static TypeDescriptor |
TypeDescriptor.nested(Field field,
int nestingLevel)
Create a type descriptor for a nested type declared within the field.
|
static TypeDescriptor |
TypeDescriptor.nested(MethodParameter methodParameter,
int nestingLevel)
Create a type descriptor for a nested type declared within the method parameter.
|
static TypeDescriptor |
TypeDescriptor.nested(Property property,
int nestingLevel)
Create a type descriptor for a nested type declared within the property.
|
TypeDescriptor |
TypeDescriptor.upcast(Class<?> superType)
Cast this
TypeDescriptor to a superclass or implemented interface
preserving annotations and nested type context. |
Modifier and Type | Method and Description |
---|---|
static TypeDescriptor |
TypeDescriptor.array(TypeDescriptor elementTypeDescriptor)
Create a new type descriptor as an array of the specified type.
|
boolean |
ConversionService.canConvert(Class<?> sourceType,
Class<?> targetType)
Return
true if objects of sourceType can be converted to the targetType . |
boolean |
ConversionService.canConvert(TypeDescriptor sourceType,
TypeDescriptor targetType)
Return
true if objects of sourceType can be converted to the targetType . |
static TypeDescriptor |
TypeDescriptor.collection(Class<?> collectionType,
TypeDescriptor elementTypeDescriptor)
Create a new type descriptor from a
Collection type. |
<T> T |
ConversionService.convert(Object source,
Class<T> targetType)
Convert the given
source to the specified targetType . |
Object |
ConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the given
source to the specified targetType . |
Object |
ConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the given
source to the specified targetType . |
boolean |
TypeDescriptor.equals(Object other) |
boolean |
Property.equals(Object other) |
static TypeDescriptor |
TypeDescriptor.forObject(Object source)
Create a new type descriptor for an object.
|
static TypeDescriptor |
TypeDescriptor.map(Class<?> mapType,
TypeDescriptor keyTypeDescriptor,
TypeDescriptor valueTypeDescriptor)
Create a new type descriptor from a
Map type. |
static TypeDescriptor |
TypeDescriptor.map(Class<?> mapType,
TypeDescriptor keyTypeDescriptor,
TypeDescriptor valueTypeDescriptor)
Create a new type descriptor from a
Map type. |
TypeDescriptor |
TypeDescriptor.narrow(Object value)
Narrows this
TypeDescriptor by setting its type to the class of the
provided value. |
TypeDescriptor |
TypeDescriptor.upcast(Class<?> superType)
Cast this
TypeDescriptor to a superclass or implemented interface
preserving annotations and nested type context. |
static TypeDescriptor |
TypeDescriptor.valueOf(Class<?> type)
Create a new type descriptor from the given type.
|
Constructor and Description |
---|
ConversionFailedException(TypeDescriptor sourceType,
TypeDescriptor targetType,
Object value,
Throwable cause)
Create a new conversion exception.
|
ConversionFailedException(TypeDescriptor sourceType,
TypeDescriptor targetType,
Object value,
Throwable cause)
Create a new conversion exception.
|
ConverterNotFoundException(TypeDescriptor sourceType,
TypeDescriptor targetType)
Create a new conversion executor not found exception.
|
Property(Class<?> objectType,
Method readMethod,
Method writeMethod) |
Property(Class<?> objectType,
Method readMethod,
Method writeMethod) |
Property(Class<?> objectType,
Method readMethod,
Method writeMethod,
String name) |
Property(Class<?> objectType,
Method readMethod,
Method writeMethod,
String name) |
Property(Class<?> objectType,
Method readMethod,
Method writeMethod,
String name) |
TypeDescriptor(ResolvableType resolvableType,
Class<?> type,
Annotation[] annotations)
Create a new type descriptor from a
ResolvableType . |
TypeDescriptor(ResolvableType resolvableType,
Class<?> type,
Annotation[] annotations)
Create a new type descriptor from a
ResolvableType . |
Modifier and Type | Method and Description |
---|---|
Object |
GenericConverter.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the source object to the targetType described by the
TypeDescriptor . |
T |
Converter.convert(S source)
Convert the source object of type
S to target type T . |
Set<GenericConverter.ConvertiblePair> |
GenericConverter.getConvertibleTypes()
Return the source and target types that this converter can convert between.
|
Modifier and Type | Method and Description |
---|---|
Object |
GenericConverter.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the source object to the targetType described by the
TypeDescriptor . |
boolean |
GenericConverter.ConvertiblePair.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
<T> T |
GenericConversionService.convert(Object source,
Class<T> targetType) |
Object |
GenericConversionService.convert(Object source,
TypeDescriptor targetType)
Convenience operation for converting a source object to the specified targetType,
where the target type is a descriptor that provides additional conversion context.
|
Object |
GenericConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
protected Object |
GenericConversionService.convertNullSource(TypeDescriptor sourceType,
TypeDescriptor targetType)
Template method to convert a
null source. |
String |
ConvertingPropertyEditorAdapter.getAsText() |
protected GenericConverter |
GenericConversionService.getConverter(TypeDescriptor sourceType,
TypeDescriptor targetType)
Hook method to look up the converter for a given sourceType/targetType pair.
|
protected GenericConverter |
GenericConversionService.getDefaultConverter(TypeDescriptor sourceType,
TypeDescriptor targetType)
Return the default converter if no converter is found for the given sourceType/targetType pair.
|
Modifier and Type | Method and Description |
---|---|
boolean |
GenericConversionService.canBypassConvert(TypeDescriptor sourceType,
TypeDescriptor targetType)
Return whether conversion between the source type and the target type can be bypassed.
|
boolean |
GenericConversionService.canConvert(Class<?> sourceType,
Class<?> targetType) |
boolean |
GenericConversionService.canConvert(TypeDescriptor sourceType,
TypeDescriptor targetType) |
<T> T |
GenericConversionService.convert(Object source,
Class<T> targetType) |
Object |
GenericConversionService.convert(Object source,
TypeDescriptor targetType)
Convenience operation for converting a source object to the specified targetType,
where the target type is a descriptor that provides additional conversion context.
|
Object |
GenericConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
Object |
GenericConversionService.convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
protected Object |
GenericConversionService.convertNullSource(TypeDescriptor sourceType,
TypeDescriptor targetType)
Template method to convert a
null source. |
static void |
ConversionServiceFactory.registerConverters(Set<?> converters,
ConverterRegistry registry)
Register the given Converter objects with the given target ConverterRegistry.
|
void |
ConvertingPropertyEditorAdapter.setAsText(String text) |
Modifier and Type | Method and Description |
---|---|
protected <T> T |
AbstractPropertyResolver.convertValueIfNecessary(Object value,
Class<T> targetType)
Convert the given value to the specified target type, if necessary.
|
protected String |
AbstractEnvironment.doGetActiveProfilesProperty()
Return the property value for the active profiles.
|
protected String |
AbstractEnvironment.doGetDefaultProfilesProperty()
Return the property value for the default profiles.
|
PropertySource<?> |
PropertySources.get(String name)
Return the property source with the given name,
null if not found. |
PropertySource<?> |
MutablePropertySources.get(String name) |
protected List<String> |
SimpleCommandLinePropertySource.getOptionValues(String name) |
protected abstract List<String> |
CommandLinePropertySource.getOptionValues(String name)
Return the collection of values associated with the command line option having the
given name.
|
List<String> |
JOptCommandLinePropertySource.getOptionValues(String name) |
String |
PropertyResolver.getProperty(String key)
Return the property value associated with the given key,
or
null if the key cannot be resolved. |
abstract Object |
PropertySource.getProperty(String name)
Return the value associated with the given name,
or
null if not found. |
String |
PropertySource.StubPropertySource.getProperty(String name)
Always returns
null . |
String |
PropertySourcesPropertyResolver.getProperty(String key) |
Object |
CompositePropertySource.getProperty(String name) |
Object |
MapPropertySource.getProperty(String name) |
String |
AbstractEnvironment.getProperty(String key) |
Object |
SystemEnvironmentPropertySource.getProperty(String name)
This implementation returns
true if a property with the given name or
any underscore/uppercase variant thereof exists in this property source. |
String |
CommandLinePropertySource.getProperty(String name)
This implementation first checks to see if the name specified is the special
"non-option arguments" property,
and if so delegates to the abstract
CommandLinePropertySource.getNonOptionArgs() method. |
String |
AbstractPropertyResolver.getProperty(String key) |
<T> T |
PropertyResolver.getProperty(String key,
Class<T> targetType)
Return the property value associated with the given key,
or
null if the key cannot be resolved. |
<T> T |
PropertySourcesPropertyResolver.getProperty(String key,
Class<T> targetValueType) |
<T> T |
AbstractEnvironment.getProperty(String key,
Class<T> targetType) |
protected <T> T |
PropertySourcesPropertyResolver.getProperty(String key,
Class<T> targetValueType,
boolean resolveNestedPlaceholders) |
protected String |
PropertySourcesPropertyResolver.getPropertyAsRawString(String key) |
protected abstract String |
AbstractPropertyResolver.getPropertyAsRawString(String key)
Retrieve the specified property as a raw String,
i.e.
|
PropertySource<?> |
MutablePropertySources.remove(String name)
Remove and return the property source with the given name,
null if not found. |
Modifier and Type | Method and Description |
---|---|
protected <T> T |
AbstractPropertyResolver.convertValueIfNecessary(Object value,
Class<T> targetType)
Convert the given value to the specified target type, if necessary.
|
boolean |
PropertySource.equals(Object other)
This
PropertySource object is equal to the given object if:
they are the same instance
the name properties for both objects are equal
|
void |
AbstractEnvironment.setValueSeparator(String valueSeparator) |
void |
ConfigurablePropertyResolver.setValueSeparator(String valueSeparator)
Specify the separating character between the placeholders replaced by this
resolver and their associated default value, or
null if no such
special character should be processed as a value separator. |
void |
AbstractPropertyResolver.setValueSeparator(String valueSeparator)
Specify the separating character between the placeholders replaced by this
resolver and their associated default value, or
null if no such
special character should be processed as a value separator. |
Constructor and Description |
---|
PropertySourcesPropertyResolver(PropertySources propertySources)
Create a new resolver against the given property sources.
|
Modifier and Type | Method and Description |
---|---|
protected static String |
VfsUtils.doGetPath(Object resource) |
protected static Object |
VfsUtils.doGetVisitorAttributes() |
String |
ResourceEditor.getAsText() |
ClassLoader |
ClassPathResource.getClassLoader()
Return the
ClassLoader that this resource will be obtained from. |
ClassLoader |
DefaultResourceLoader.getClassLoader()
Return the ClassLoader to load class path resources with.
|
ClassLoader |
ResourceLoader.getClassLoader()
Expose the
ClassLoader used by this ResourceLoader . |
String |
Resource.getFilename()
Determine a filename for this resource, i.e.
|
String |
ClassPathResource.getFilename()
This implementation returns the name of the file that this class path
resource refers to.
|
String |
AbstractResource.getFilename()
This implementation always returns
null ,
assuming that this resource type does not have a filename. |
Resource |
ProtocolResolver.resolve(String location,
ResourceLoader resourceLoader)
Resolve the given location against the given resource loader
if this implementation's protocol matches.
|
protected URL |
ClassPathResource.resolveURL()
Resolves a URL for the underlying class path resource.
|
Modifier and Type | Method and Description |
---|---|
boolean |
InputStreamResource.equals(Object other)
This implementation compares the underlying InputStream.
|
boolean |
UrlResource.equals(Object other)
This implementation compares the underlying URL references.
|
boolean |
ByteArrayResource.equals(Object other)
This implementation compares the underlying byte array.
|
boolean |
DescriptiveResource.equals(Object other)
This implementation compares the underlying description String.
|
boolean |
ClassPathResource.equals(Object other)
This implementation compares the underlying class path locations.
|
boolean |
AbstractResource.equals(Object other)
This implementation compares description strings.
|
boolean |
PathResource.equals(Object other)
This implementation compares the underlying
Path references. |
boolean |
FileSystemResource.equals(Object other)
This implementation compares the underlying file paths.
|
boolean |
VfsResource.equals(Object other) |
protected static Object |
VfsUtils.invokeVfsMethod(Method method,
Object target,
Object... args) |
void |
DefaultResourceLoader.setClassLoader(ClassLoader classLoader)
Specify the ClassLoader to load class path resources with, or
null
for using the thread context class loader at the time of actual resource access. |
Constructor and Description |
---|
ByteArrayResource(byte[] byteArray,
String description)
Create a new
ByteArrayResource with a description. |
ClassPathContextResource(String path,
ClassLoader classLoader) |
ClassPathResource(String path,
Class<?> clazz)
Create a new
ClassPathResource for Class usage. |
ClassPathResource(String path,
ClassLoader classLoader)
Create a new
ClassPathResource for ClassLoader usage. |
ClassPathResource(String path,
ClassLoader classLoader,
Class<?> clazz)
Deprecated.
as of 4.3.13, in favor of selective use of
ClassPathResource(String, ClassLoader) vs ClassPathResource(String, Class) |
ClassPathResource(String path,
ClassLoader classLoader,
Class<?> clazz)
Deprecated.
as of 4.3.13, in favor of selective use of
ClassPathResource(String, ClassLoader) vs ClassPathResource(String, Class) |
DefaultResourceLoader(ClassLoader classLoader)
Create a new DefaultResourceLoader.
|
DescriptiveResource(String description)
Create a new DescriptiveResource.
|
InputStreamResource(InputStream inputStream,
String description)
Create a new InputStreamResource.
|
ResourceEditor(ResourceLoader resourceLoader,
PropertyResolver propertyResolver)
Create a new instance of the
ResourceEditor class
using the given ResourceLoader and PropertyResolver . |
ResourceEditor(ResourceLoader resourceLoader,
PropertyResolver propertyResolver,
boolean ignoreUnresolvablePlaceholders)
Create a new instance of the
ResourceEditor class
using the given ResourceLoader . |
UrlResource(String protocol,
String location,
String fragment)
Create a new
UrlResource based on a URI specification. |
Modifier and Type | Method and Description |
---|---|
boolean |
NettyDataBuffer.equals(Object other) |
boolean |
DefaultDataBuffer.equals(Object other) |
static boolean |
DataBufferUtils.release(DataBuffer dataBuffer)
Release the given data buffer, if it is a
PooledDataBuffer and
has been allocated. |
Modifier and Type | Field and Description |
---|---|
protected Properties[] |
PropertiesLoaderSupport.localProperties |
Modifier and Type | Method and Description |
---|---|
Charset |
EncodedResource.getCharset()
|
ClassLoader |
PathMatchingResourcePatternResolver.getClassLoader() |
String |
EncodedResource.getEncoding()
Return the encoding to use for reading from the resource,
or
null if none specified. |
Modifier and Type | Method and Description |
---|---|
protected void |
PathMatchingResourcePatternResolver.addAllClassLoaderJarRoots(ClassLoader classLoader,
Set<Resource> result)
Search all
URLClassLoader URLs for jar file references and add them to the
given set of resources in the form of pointers to the root of the jar file content. |
PropertySource<?> |
PropertySourceFactory.createPropertySource(String name,
EncodedResource resource)
Create a
PropertySource that wraps the given resource. |
PropertySource<?> |
DefaultPropertySourceFactory.createPropertySource(String name,
EncodedResource resource) |
boolean |
EncodedResource.equals(Object other) |
Resource |
LocalizedResourceHelper.findLocalizedResource(String name,
String extension,
Locale locale)
Find the most specific localized resource for the given name,
extension and locale:
|
static ResourcePatternResolver |
ResourcePatternUtils.getResourcePatternResolver(ResourceLoader resourceLoader)
Return a default
ResourcePatternResolver for the given ResourceLoader . |
static boolean |
ResourcePatternUtils.isUrl(String resourceLocation)
Return whether the given resource location is a URL: either a
special "classpath" or "classpath*" pseudo URL or a standard URL.
|
static Properties |
PropertiesLoaderUtils.loadAllProperties(String resourceName,
ClassLoader classLoader)
Load all properties from the specified class path resource
(in ISO-8859-1 encoding), using the given class loader.
|
static <T> List<T> |
SpringFactoriesLoader.loadFactories(Class<T> factoryType,
ClassLoader classLoader)
Load and instantiate the factory implementations of the given type from
"META-INF/spring.factories", using the given class loader.
|
static List<String> |
SpringFactoriesLoader.loadFactoryNames(Class<?> factoryType,
ClassLoader classLoader)
Load the fully qualified class names of factory implementations of the
given type from "META-INF/spring.factories", using the given
class loader.
|
void |
PropertiesLoaderSupport.setPropertiesPersister(PropertiesPersister propertiesPersister)
Set the PropertiesPersister to use for parsing properties files.
|
void |
LocalizedResourceHelper.setSeparator(String separator)
Set the separator to use in-between file name parts.
|
Constructor and Description |
---|
EncodedResource(Resource resource,
Charset charset)
Create a new
EncodedResource for the given Resource ,
using the specified Charset . |
EncodedResource(Resource resource,
String encoding)
Create a new
EncodedResource for the given Resource ,
using the specified encoding . |
PathMatchingResourcePatternResolver(ClassLoader classLoader)
Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.
|
ResourceArrayPropertyEditor(ResourcePatternResolver resourcePatternResolver,
PropertyResolver propertyResolver)
Create a new ResourceArrayPropertyEditor with the given
ResourcePatternResolver
and PropertyResolver (typically an Environment ). |
ResourceArrayPropertyEditor(ResourcePatternResolver resourcePatternResolver,
PropertyResolver propertyResolver,
boolean ignoreUnresolvablePlaceholders)
Create a new ResourceArrayPropertyEditor with the given
ResourcePatternResolver
and PropertyResolver (typically an Environment ). |
Modifier and Type | Method and Description |
---|---|
static LogMessage |
LogMessage.format(String format,
Object... args)
Build a lazily formatted message from the given format string and varargs.
|
static LogMessage |
LogMessage.format(String format,
Object arg1)
Build a lazily formatted message from the given format string and argument.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Build a lazily formatted message from the given format string and arguments.
|
static LogMessage |
LogMessage.format(String format,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Build a lazily formatted message from the given format string and arguments.
|
static String |
LogFormatUtils.formatValue(Object value,
boolean limitLength)
Convenience variant of
LogFormatUtils.formatValue(Object, int, boolean) that
limits the length of a log message to 100 characters and also replaces
newline and control characters if limitLength is set to "true". |
static String |
LogFormatUtils.formatValue(Object value,
int maxLength,
boolean replaceNewlinesAndControlCharacters)
Format the given value via
toString() , quoting it if it is a
CharSequence , truncating at the specified maxLength , and
compacting it into a single line when replaceNewLines is set. |
Modifier and Type | Method and Description |
---|---|
Long |
StartupStep.getParentId()
Return, if available, the id of the parent step.
|
Constructor and Description |
---|
DefaultDeserializer(ClassLoader classLoader)
|
Constructor and Description |
---|
DeserializingConverter(ClassLoader classLoader)
|
Modifier and Type | Method and Description |
---|---|
ToStringCreator |
ToStringCreator.append(String fieldName,
Object value)
Append a field value.
|
String |
ValueStyler.style(Object value)
Style the given value, returning a String representation.
|
String |
DefaultValueStyler.style(Object value) |
void |
DefaultToStringStyler.styleField(StringBuilder buffer,
String fieldName,
Object value) |
void |
ToStringStyler.styleField(StringBuilder buffer,
String fieldName,
Object value)
Style a field value as a string.
|
void |
DefaultToStringStyler.styleValue(StringBuilder buffer,
Object value) |
Constructor and Description |
---|
ToStringCreator(Object obj,
ToStringStyler styler)
Create a ToStringCreator for the given object, using the provided style.
|
ToStringCreator(Object obj,
ValueStyler styler)
Create a ToStringCreator for the given object, using the provided style.
|
Modifier and Type | Method and Description |
---|---|
ThreadFactory |
SimpleAsyncTaskExecutor.getThreadFactory()
Return the external factory to use for creating new Threads, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
SimpleAsyncTaskExecutor.setThreadFactory(ThreadFactory threadFactory)
Specify an external factory to use for creating new Threads,
instead of relying on the local properties of this executor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
TaskExecutorAdapter.doExecute(Executor concurrentExecutor,
TaskDecorator taskDecorator,
Runnable runnable)
Actually execute the given
Runnable (which may be a user-supplied task
or a wrapper around a user-supplied task) with the given executor. |
Modifier and Type | Method and Description |
---|---|
default MultiValueMap<String,Object> |
AnnotatedTypeMetadata.getAllAnnotationAttributes(String annotationName)
Retrieve all attributes of all annotations of the given type, if any (i.e.
|
MultiValueMap<String,Object> |
StandardMethodMetadata.getAllAnnotationAttributes(String annotationName,
boolean classValuesAsString) |
MultiValueMap<String,Object> |
StandardAnnotationMetadata.getAllAnnotationAttributes(String annotationName,
boolean classValuesAsString) |
default MultiValueMap<String,Object> |
AnnotatedTypeMetadata.getAllAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Retrieve all attributes of all annotations of the given type, if any (i.e.
|
default Map<String,Object> |
AnnotatedTypeMetadata.getAnnotationAttributes(String annotationName)
Retrieve the attributes of the annotation of the given type, if any (i.e.
|
Map<String,Object> |
StandardMethodMetadata.getAnnotationAttributes(String annotationName,
boolean classValuesAsString) |
Map<String,Object> |
StandardAnnotationMetadata.getAnnotationAttributes(String annotationName,
boolean classValuesAsString) |
default Map<String,Object> |
AnnotatedTypeMetadata.getAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Retrieve the attributes of the annotation of the given type, if any (i.e.
|
String |
StandardClassMetadata.getEnclosingClassName() |
String |
ClassMetadata.getEnclosingClassName()
Return the name of the enclosing class of the underlying class,
or
null if the underlying class is a top-level class. |
String |
StandardClassMetadata.getSuperClassName() |
String |
ClassMetadata.getSuperClassName()
Return the name of the superclass of the underlying class,
or
null if there is no superclass defined. |
Modifier and Type | Method and Description |
---|---|
boolean |
StandardMethodMetadata.equals(Object obj) |
boolean |
StandardClassMetadata.equals(Object obj) |
Modifier and Type | Field and Description |
---|---|
protected ClassLoader |
AnnotationMetadataReadingVisitor.classLoader
Deprecated.
|
protected ClassLoader |
MethodMetadataReadingVisitor.classLoader
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
MultiValueMap<String,Object> |
AnnotationMetadataReadingVisitor.getAllAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Deprecated.
|
MultiValueMap<String,Object> |
MethodMetadataReadingVisitor.getAllAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Deprecated.
|
AnnotationAttributes |
AnnotationMetadataReadingVisitor.getAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Deprecated.
|
AnnotationAttributes |
MethodMetadataReadingVisitor.getAnnotationAttributes(String annotationName,
boolean classValuesAsString)
Deprecated.
|
AnnotationVisitor |
AnnotationMetadataReadingVisitor.visitAnnotation(String desc,
boolean visible)
Deprecated.
|
AnnotationVisitor |
MethodMetadataReadingVisitor.visitAnnotation(String desc,
boolean visible)
Deprecated.
|
Constructor and Description |
---|
AnnotationMetadataReadingVisitor(ClassLoader classLoader)
Deprecated.
|
CachingMetadataReaderFactory(ClassLoader classLoader)
Create a new CachingMetadataReaderFactory for the given
ClassLoader ,
using a local resource cache. |
CachingMetadataReaderFactory(ResourceLoader resourceLoader)
Create a new CachingMetadataReaderFactory for the given
ResourceLoader ,
using a shared resource cache if supported or a local resource cache otherwise. |
MethodMetadataReadingVisitor(String methodName,
int access,
String declaringClassName,
String returnTypeName,
ClassLoader classLoader,
Set<MethodMetadata> methodMetadataSet)
Deprecated.
|
SimpleMetadataReaderFactory(ClassLoader classLoader)
Create a new SimpleMetadataReaderFactory for the given class loader.
|
SimpleMetadataReaderFactory(ResourceLoader resourceLoader)
Create a new SimpleMetadataReaderFactory for the given resource loader.
|
Modifier and Type | Method and Description |
---|---|
protected Boolean |
AnnotationTypeFilter.hasAnnotation(String typeName) |
protected Boolean |
AbstractTypeHierarchyTraversingFilter.matchInterface(String interfaceName)
Override this to match on interface type name.
|
protected Boolean |
AnnotationTypeFilter.matchInterface(String interfaceName) |
protected Boolean |
AssignableTypeFilter.matchInterface(String interfaceName) |
protected Boolean |
AbstractTypeHierarchyTraversingFilter.matchSuperClass(String superClassName)
Override this to match on supertype name.
|
protected Boolean |
AnnotationTypeFilter.matchSuperClass(String superClassName) |
protected Boolean |
AssignableTypeFilter.matchSuperClass(String superClassName) |
protected Boolean |
AssignableTypeFilter.matchTargetType(String typeName) |
Constructor and Description |
---|
AspectJTypeFilter(String typePatternExpression,
ClassLoader classLoader) |
Constructor and Description |
---|
ConcurrencyFailureException(String msg,
Throwable cause)
Constructor for ConcurrencyFailureException.
|
DataAccessException(String msg,
Throwable cause)
Constructor for DataAccessException.
|
DataAccessException(String msg,
Throwable cause)
Constructor for DataAccessException.
|
DataAccessResourceFailureException(String msg,
Throwable cause)
Constructor for DataAccessResourceFailureException.
|
DataRetrievalFailureException(String msg,
Throwable cause)
Constructor for DataRetrievalFailureException.
|
NonTransientDataAccessException(String msg,
Throwable cause)
Constructor for NonTransientDataAccessException.
|
NonTransientDataAccessException(String msg,
Throwable cause)
Constructor for NonTransientDataAccessException.
|
NonTransientDataAccessResourceException(String msg,
Throwable cause)
Constructor for NonTransientDataAccessResourceException.
|
OptimisticLockingFailureException(String msg,
Throwable cause)
Constructor for OptimisticLockingFailureException.
|
TransientDataAccessException(String msg,
Throwable cause)
Constructor for TransientDataAccessException.
|
UncategorizedDataAccessException(String msg,
Throwable cause)
Constructor for UncategorizedDataAccessException.
|
UncategorizedDataAccessException(String msg,
Throwable cause)
Constructor for UncategorizedDataAccessException.
|
Modifier and Type | Method and Description |
---|---|
Object |
PersistenceExceptionTranslationInterceptor.invoke(MethodInvocation mi) |
static <T> T |
DataAccessUtils.nullableSingleResult(Collection<T> results)
Return a single result object from the given Collection.
|
static <T> T |
DataAccessUtils.singleResult(Collection<T> results)
Return a single result object from the given Collection.
|
DataAccessException |
ChainedPersistenceExceptionTranslator.translateExceptionIfPossible(RuntimeException ex) |
DataAccessException |
PersistenceExceptionTranslator.translateExceptionIfPossible(RuntimeException ex)
Translate the given runtime exception thrown by a persistence framework to a
corresponding exception from Spring's generic
DataAccessException hierarchy, if possible. |
static <T> T |
DataAccessUtils.uniqueResult(Collection<T> results)
Return a unique result object from the given Collection.
|
Modifier and Type | Method and Description |
---|---|
static int |
DataAccessUtils.intResult(Collection<?> results)
Return a unique int result from the given Collection.
|
static long |
DataAccessUtils.longResult(Collection<?> results)
Return a unique long result from the given Collection.
|
static <T> T |
DataAccessUtils.nullableSingleResult(Collection<T> results)
Return a single result object from the given Collection.
|
static <T> T |
DataAccessUtils.objectResult(Collection<?> results,
Class<T> requiredType)
Return a unique result object from the given Collection.
|
static <T> T |
DataAccessUtils.objectResult(Collection<?> results,
Class<T> requiredType)
Return a unique result object from the given Collection.
|
static <T> T |
DataAccessUtils.requiredSingleResult(Collection<T> results)
Return a single result object from the given Collection.
|
static <T> T |
DataAccessUtils.requiredUniqueResult(Collection<T> results)
Return a unique result object from the given Collection.
|
static <T> T |
DataAccessUtils.singleResult(Collection<T> results)
Return a single result object from the given Collection.
|
static <T> T |
DataAccessUtils.uniqueResult(Collection<T> results)
Return a unique result object from the given Collection.
|
Modifier and Type | Method and Description |
---|---|
protected abstract Object |
AbstractRemoteSlsbInvokerInterceptor.doInvoke(MethodInvocation invocation)
Perform the given invocation on the current EJB home.
|
protected Object |
SimpleRemoteSlsbInvokerInterceptor.doInvoke(MethodInvocation invocation)
This implementation "creates" a new EJB instance for each invocation.
|
Class<?> |
LocalStatelessSessionProxyFactoryBean.getBusinessInterface()
Return the business interface of the EJB we're proxying.
|
Class<?> |
SimpleRemoteStatelessSessionProxyFactoryBean.getBusinessInterface()
Return the business interface of the EJB we're proxying.
|
protected Method |
AbstractSlsbInvokerInterceptor.getCreateMethod(Object home)
Determine the create method of the given EJB home object.
|
Object |
LocalStatelessSessionProxyFactoryBean.getObject() |
Object |
SimpleRemoteStatelessSessionProxyFactoryBean.getObject() |
Object |
AbstractSlsbInvokerInterceptor.invoke(MethodInvocation invocation)
Prepares the thread context if necessary, and delegates to
AbstractSlsbInvokerInterceptor.invokeInContext(org.aopalliance.intercept.MethodInvocation) . |
Object |
AbstractRemoteSlsbInvokerInterceptor.invokeInContext(MethodInvocation invocation)
Fetches an EJB home object and delegates to
doInvoke . |
Object |
LocalSlsbInvokerInterceptor.invokeInContext(MethodInvocation invocation)
This implementation "creates" a new EJB instance for each invocation.
|
protected abstract Object |
AbstractSlsbInvokerInterceptor.invokeInContext(MethodInvocation invocation)
Perform the given invocation on the current EJB home,
within the thread context being prepared accordingly.
|
protected Object |
AbstractRemoteSlsbInvokerInterceptor.refreshAndRetry(MethodInvocation invocation)
Refresh the EJB home object and retry the given invocation.
|
Modifier and Type | Method and Description |
---|---|
protected void |
LocalSlsbInvokerInterceptor.removeSessionBeanInstance(EJBLocalObject ejb)
Remove the given EJB instance.
|
protected void |
AbstractRemoteSlsbInvokerInterceptor.removeSessionBeanInstance(EJBObject ejb)
Remove the given EJB instance.
|
void |
LocalStatelessSessionProxyFactoryBean.setBusinessInterface(Class<?> businessInterface)
Set the business interface of the EJB we're proxying.
|
void |
SimpleRemoteStatelessSessionProxyFactoryBean.setBusinessInterface(Class<?> businessInterface)
Set the business interface of the EJB we're proxying.
|
Modifier and Type | Field and Description |
---|---|
protected String |
ExpressionException.expressionString |
Modifier and Type | Method and Description |
---|---|
Object |
TypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert (or coerce) a value from one type to another, for example from a
boolean to a String . |
BeanResolver |
EvaluationContext.getBeanResolver()
Return a bean resolver that can look up beans by name.
|
String |
ExpressionException.getExpressionString()
Return the expression string.
|
Class<?>[] |
PropertyAccessor.getSpecificTargetClasses()
Return an array of classes for which this resolver should be called.
|
TypeDescriptor |
TypedValue.getTypeDescriptor() |
Object |
TypedValue.getValue() |
Object |
Expression.getValue()
Evaluate this expression in the default standard context.
|
<T> T |
Expression.getValue(Class<T> desiredResultType)
Evaluate the expression in the default context.
|
Object |
Expression.getValue(EvaluationContext context)
Evaluate this expression in the provided context and return the result
of evaluation.
|
<T> T |
Expression.getValue(EvaluationContext context,
Class<T> desiredResultType)
Evaluate the expression in a specified context which can resolve references
to properties, methods, types, etc.
|
Object |
Expression.getValue(EvaluationContext context,
Object rootObject)
Evaluate this expression in the provided context and return the result
of evaluation, but use the supplied root context as an override for any
default root object specified in the context.
|
<T> T |
Expression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in a specified context which can resolve references
to properties, methods, types, etc.
|
Object |
Expression.getValue(Object rootObject)
Evaluate this expression against the specified root object.
|
<T> T |
Expression.getValue(Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in the default context against the specified root
object.
|
Class<?> |
Expression.getValueType()
Return the most general type that can be passed to a
Expression.setValue(java.lang.Object, java.lang.Object)
method using the default context. |
Class<?> |
Expression.getValueType(EvaluationContext context)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object) method for the given context. |
Class<?> |
Expression.getValueType(EvaluationContext context,
Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object, Object) method for the given
context. |
Class<?> |
Expression.getValueType(Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(Object, Object) method using the default context. |
TypeDescriptor |
Expression.getValueTypeDescriptor()
Return the most general type that can be passed to a
Expression.setValue(java.lang.Object, java.lang.Object)
method using the default context. |
TypeDescriptor |
Expression.getValueTypeDescriptor(EvaluationContext context)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object) method for the given context. |
TypeDescriptor |
Expression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object, Object) method for the given
context. |
TypeDescriptor |
Expression.getValueTypeDescriptor(Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(Object, Object) method using the default context. |
Object |
EvaluationContext.lookupVariable(String name)
Look up a named variable within this evaluation context.
|
MethodExecutor |
MethodResolver.resolve(EvaluationContext context,
Object targetObject,
String name,
List<TypeDescriptor> argumentTypes)
Within the supplied context determine a suitable method on the supplied object that
can handle the specified arguments.
|
ConstructorExecutor |
ConstructorResolver.resolve(EvaluationContext context,
String typeName,
List<TypeDescriptor> argumentTypes)
Within the supplied context determine a suitable constructor on the supplied type
that can handle the specified arguments.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TypeComparator.canCompare(Object firstObject,
Object secondObject)
Return
true if the comparator can compare these two objects. |
boolean |
TypeComparator.canCompare(Object firstObject,
Object secondObject)
Return
true if the comparator can compare these two objects. |
boolean |
TypeConverter.canConvert(TypeDescriptor sourceType,
TypeDescriptor targetType)
Return
true if the type converter can convert the specified type
to the desired target type. |
boolean |
PropertyAccessor.canRead(EvaluationContext context,
Object target,
String name)
Called to determine if a resolver instance is able to access a specified property
on a specified target object.
|
boolean |
PropertyAccessor.canWrite(EvaluationContext context,
Object target,
String name)
Called to determine if a resolver instance is able to write to a specified
property on a specified target object.
|
int |
TypeComparator.compare(Object firstObject,
Object secondObject)
Compare two given objects.
|
int |
TypeComparator.compare(Object firstObject,
Object secondObject)
Compare two given objects.
|
Object |
TypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert (or coerce) a value from one type to another, for example from a
boolean to a String . |
Object |
TypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert (or coerce) a value from one type to another, for example from a
boolean to a String . |
boolean |
TypedValue.equals(Object other) |
<T> T |
Expression.getValue(Class<T> desiredResultType)
Evaluate the expression in the default context.
|
<T> T |
Expression.getValue(EvaluationContext context,
Class<T> desiredResultType)
Evaluate the expression in a specified context which can resolve references
to properties, methods, types, etc.
|
Object |
Expression.getValue(EvaluationContext context,
Object rootObject)
Evaluate this expression in the provided context and return the result
of evaluation, but use the supplied root context as an override for any
default root object specified in the context.
|
<T> T |
Expression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in a specified context which can resolve references
to properties, methods, types, etc.
|
<T> T |
Expression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in a specified context which can resolve references
to properties, methods, types, etc.
|
Object |
Expression.getValue(Object rootObject)
Evaluate this expression against the specified root object.
|
<T> T |
Expression.getValue(Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in the default context against the specified root
object.
|
<T> T |
Expression.getValue(Object rootObject,
Class<T> desiredResultType)
Evaluate the expression in the default context against the specified root
object.
|
Class<?> |
Expression.getValueType(EvaluationContext context,
Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object, Object) method for the given
context. |
Class<?> |
Expression.getValueType(Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(Object, Object) method using the default context. |
TypeDescriptor |
Expression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object, Object) method for the given
context. |
TypeDescriptor |
Expression.getValueTypeDescriptor(Object rootObject)
Return the most general type that can be passed to the
Expression.setValue(Object, Object) method using the default context. |
boolean |
Expression.isWritable(EvaluationContext context,
Object rootObject)
Determine if an expression can be written to, i.e.
|
boolean |
Expression.isWritable(Object rootObject)
Determine if an expression can be written to, i.e.
|
Object |
OperatorOverloader.operate(Operation operation,
Object leftOperand,
Object rightOperand)
Execute the specified operation on two operands, returning a result.
|
Object |
OperatorOverloader.operate(Operation operation,
Object leftOperand,
Object rightOperand)
Execute the specified operation on two operands, returning a result.
|
boolean |
OperatorOverloader.overridesOperation(Operation operation,
Object leftOperand,
Object rightOperand)
Return true if the operator overloader supports the specified operation
between the two operands and so should be invoked to handle it.
|
boolean |
OperatorOverloader.overridesOperation(Operation operation,
Object leftOperand,
Object rightOperand)
Return true if the operator overloader supports the specified operation
between the two operands and so should be invoked to handle it.
|
TypedValue |
PropertyAccessor.read(EvaluationContext context,
Object target,
String name)
Called to read a property from a specified target object.
|
void |
Expression.setValue(EvaluationContext context,
Object value)
Set this expression in the provided context to the value provided.
|
void |
Expression.setValue(EvaluationContext context,
Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
void |
Expression.setValue(EvaluationContext context,
Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
void |
Expression.setValue(Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
void |
Expression.setValue(Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
void |
EvaluationContext.setVariable(String name,
Object value)
Set a named variable in this evaluation context to a specified value.
|
void |
PropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue)
Called to write to a property on a specified target object.
|
void |
PropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue)
Called to write to a property on a specified target object.
|
Constructor and Description |
---|
ExpressionException(String expressionString,
int position,
String message)
Construct a new expression exception.
|
ExpressionException(String expressionString,
String message)
Construct a new expression exception.
|
ParseException(String expressionString,
int position,
String message)
Create a new expression parsing exception.
|
TypedValue(Object value)
Create a
TypedValue for a simple object. |
TypedValue(Object value,
TypeDescriptor typeDescriptor)
Create a
TypedValue for a particular value with a particular
TypeDescriptor which may contain additional generic declarations. |
TypedValue(Object value,
TypeDescriptor typeDescriptor)
Create a
TypedValue for a particular value with a particular
TypeDescriptor which may contain additional generic declarations. |
Modifier and Type | Method and Description |
---|---|
static <T> T |
ExpressionUtils.convertTypedValue(EvaluationContext context,
TypedValue typedValue,
Class<T> targetType)
Determines if there is a type converter available in the specified context and
attempts to use it to convert the supplied value to the specified type.
|
<T> T |
CompositeStringExpression.getValue(Class<T> expectedResultType) |
<T> T |
LiteralExpression.getValue(Class<T> expectedResultType) |
<T> T |
CompositeStringExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
<T> T |
LiteralExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
<T> T |
CompositeStringExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
<T> T |
CompositeStringExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
Modifier and Type | Method and Description |
---|---|
static <T> T |
ExpressionUtils.convertTypedValue(EvaluationContext context,
TypedValue typedValue,
Class<T> targetType)
Determines if there is a type converter available in the specified context and
attempts to use it to convert the supplied value to the specified type.
|
static <T> T |
ExpressionUtils.convertTypedValue(EvaluationContext context,
TypedValue typedValue,
Class<T> targetType)
Determines if there is a type converter available in the specified context and
attempts to use it to convert the supplied value to the specified type.
|
protected abstract Expression |
TemplateAwareExpressionParser.doParseExpression(String expressionString,
ParserContext context)
Actually parse the expression string and return an Expression object.
|
<T> T |
CompositeStringExpression.getValue(Class<T> expectedResultType) |
<T> T |
LiteralExpression.getValue(Class<T> expectedResultType) |
<T> T |
CompositeStringExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
<T> T |
LiteralExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
String |
CompositeStringExpression.getValue(EvaluationContext context,
Object rootObject) |
String |
LiteralExpression.getValue(EvaluationContext context,
Object rootObject) |
<T> T |
CompositeStringExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
<T> T |
CompositeStringExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> desiredResultType) |
String |
CompositeStringExpression.getValue(Object rootObject) |
String |
LiteralExpression.getValue(Object rootObject) |
<T> T |
CompositeStringExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
<T> T |
CompositeStringExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
<T> T |
LiteralExpression.getValue(Object rootObject,
Class<T> desiredResultType) |
Class<?> |
CompositeStringExpression.getValueType(EvaluationContext context,
Object rootObject) |
Class<?> |
LiteralExpression.getValueType(EvaluationContext context,
Object rootObject) |
Class<?> |
CompositeStringExpression.getValueType(Object rootObject) |
Class<?> |
LiteralExpression.getValueType(Object rootObject) |
TypeDescriptor |
CompositeStringExpression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject) |
TypeDescriptor |
LiteralExpression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject) |
TypeDescriptor |
CompositeStringExpression.getValueTypeDescriptor(Object rootObject) |
TypeDescriptor |
LiteralExpression.getValueTypeDescriptor(Object rootObject) |
boolean |
CompositeStringExpression.isWritable(EvaluationContext context,
Object rootObject) |
boolean |
LiteralExpression.isWritable(EvaluationContext context,
Object rootObject) |
boolean |
CompositeStringExpression.isWritable(Object rootObject) |
boolean |
LiteralExpression.isWritable(Object rootObject) |
Expression |
TemplateAwareExpressionParser.parseExpression(String expressionString,
ParserContext context) |
void |
CompositeStringExpression.setValue(EvaluationContext context,
Object value) |
void |
LiteralExpression.setValue(EvaluationContext context,
Object value) |
void |
CompositeStringExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
CompositeStringExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
LiteralExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
LiteralExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
CompositeStringExpression.setValue(Object rootObject,
Object value) |
void |
CompositeStringExpression.setValue(Object rootObject,
Object value) |
void |
LiteralExpression.setValue(Object rootObject,
Object value) |
void |
LiteralExpression.setValue(Object rootObject,
Object value) |
Modifier and Type | Method and Description |
---|---|
Object |
ExpressionState.convertValue(TypedValue value,
TypeDescriptor targetTypeDescriptor) |
ClassLoader |
SpelParserConfiguration.getCompilerClassLoader()
Return the ClassLoader to use as the basis for expression compilation.
|
Class<?> |
SpelNode.getObjectClass(Object obj)
Determine the class of the object passed in, unless it is already a class object.
|
Object |
SpelNode.getValue(ExpressionState expressionState)
Evaluate the expression node in the context of the supplied expression state
and return the value.
|
String |
CodeFlow.lastDescriptor()
Return the descriptor for the item currently on top of the stack (in the current scope).
|
Object |
ExpressionState.lookupLocalVariable(String name) |
Modifier and Type | Method and Description |
---|---|
Class<?> |
SpelNode.getObjectClass(Object obj)
Determine the class of the object passed in, unless it is already a class object.
|
abstract Object |
CompiledExpression.getValue(Object target,
EvaluationContext context)
Subclasses of CompiledExpression generated by SpelCompiler will provide an
implementation of this method.
|
abstract Object |
CompiledExpression.getValue(Object target,
EvaluationContext context)
Subclasses of CompiledExpression generated by SpelCompiler will provide an
implementation of this method.
|
static void |
CodeFlow.insertBoxIfNecessary(MethodVisitor mv,
String descriptor)
Determine the appropriate boxing instruction for a specific type (if it needs
boxing) and insert the instruction into the supplied visitor.
|
static void |
CodeFlow.insertCheckCast(MethodVisitor mv,
String descriptor)
Insert the appropriate CHECKCAST instruction for the supplied descriptor.
|
static void |
CodeFlow.insertNumericUnboxOrPrimitiveTypeCoercion(MethodVisitor mv,
String stackDescriptor,
char targetDescriptor)
For use in mathematical operators, handles converting from a (possibly boxed)
number on the stack to a primitive numeric type.
|
static void |
CodeFlow.insertUnboxInsns(MethodVisitor mv,
char ch,
String stackDescriptor)
Insert any necessary cast and value call to convert from a boxed type to a
primitive value.
|
static void |
CodeFlow.insertUnboxNumberInsns(MethodVisitor mv,
char targetDescriptor,
String stackDescriptor)
For numbers, use the appropriate method on the number to convert it to the primitive type requested.
|
static boolean |
CodeFlow.isBooleanCompatible(String descriptor)
Determine whether the descriptor is for a boolean primitive or boolean reference type.
|
static boolean |
CodeFlow.isPrimitive(String descriptor)
Determine whether the descriptor is for a primitive type.
|
static boolean |
CodeFlow.isPrimitiveArray(String descriptor)
Determine whether the descriptor is for a primitive array (e.g.
|
static boolean |
CodeFlow.isPrimitiveOrUnboxableSupportedNumber(String descriptor)
Determine if the supplied descriptor is for a supported number.
|
static boolean |
CodeFlow.isPrimitiveOrUnboxableSupportedNumberOrBoolean(String descriptor)
Determine if the supplied descriptor is for a supported number type or boolean.
|
TypedValue |
ExpressionState.operate(Operation op,
Object left,
Object right) |
TypedValue |
ExpressionState.operate(Operation op,
Object left,
Object right) |
void |
CodeFlow.pushDescriptor(String descriptor)
Record the descriptor for the most recently evaluated expression element.
|
void |
SpelNode.setValue(ExpressionState expressionState,
Object newValue)
Evaluate the expression to a node and then set the new value on that node.
|
void |
ExpressionState.setVariable(String name,
Object value)
Set a named variable in the evaluation context to a specified value.
|
static String |
CodeFlow.toDescriptorFromObject(Object value)
Determine the descriptor for an object instance (or
null ). |
Constructor and Description |
---|
SpelParseException(String expressionString,
int position,
SpelMessage message,
Object... inserts) |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader)
Create a new
SpelParserConfiguration instance. |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader)
Create a new
SpelParserConfiguration instance. |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader,
boolean autoGrowNullReferences,
boolean autoGrowCollections,
int maximumAutoGrowSize)
Create a new
SpelParserConfiguration instance. |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader,
boolean autoGrowNullReferences,
boolean autoGrowCollections,
int maximumAutoGrowSize)
Create a new
SpelParserConfiguration instance. |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader,
boolean autoGrowNullReferences,
boolean autoGrowCollections,
int maximumAutoGrowSize,
int maximumExpressionLength)
Create a new
SpelParserConfiguration instance. |
SpelParserConfiguration(SpelCompilerMode compilerMode,
ClassLoader compilerClassLoader,
boolean autoGrowNullReferences,
boolean autoGrowCollections,
int maximumAutoGrowSize,
int maximumExpressionLength)
Create a new
SpelParserConfiguration instance. |
Modifier and Type | Field and Description |
---|---|
protected String |
SpelNodeImpl.exitTypeDescriptor
Indicates the type descriptor for the result of this expression node.
|
protected String |
Operator.leftActualDescriptor |
protected String |
Operator.rightActualDescriptor |
Modifier and Type | Method and Description |
---|---|
List<Object> |
InlineList.getConstantValue() |
Map<Object,Object> |
InlineMap.getConstantValue() |
String |
SpelNodeImpl.getExitDescriptor() |
Class<?> |
SpelNodeImpl.getObjectClass(Object obj) |
String |
Literal.getOriginalValue() |
Object |
SpelNodeImpl.getValue(ExpressionState expressionState) |
protected <T> T |
SpelNodeImpl.getValue(ExpressionState state,
Class<T> desiredReturnType) |
Modifier and Type | Method and Description |
---|---|
static Operator.DescriptorComparison |
Operator.DescriptorComparison.checkNumericCompatibility(String leftDeclaredDescriptor,
String rightDeclaredDescriptor,
String leftActualDescriptor,
String rightActualDescriptor)
Return an object that indicates whether the input descriptors are compatible.
|
static Operator.DescriptorComparison |
Operator.DescriptorComparison.checkNumericCompatibility(String leftDeclaredDescriptor,
String rightDeclaredDescriptor,
String leftActualDescriptor,
String rightActualDescriptor)
Return an object that indicates whether the input descriptors are compatible.
|
static Operator.DescriptorComparison |
Operator.DescriptorComparison.checkNumericCompatibility(String leftDeclaredDescriptor,
String rightDeclaredDescriptor,
String leftActualDescriptor,
String rightActualDescriptor)
Return an object that indicates whether the input descriptors are compatible.
|
static Operator.DescriptorComparison |
Operator.DescriptorComparison.checkNumericCompatibility(String leftDeclaredDescriptor,
String rightDeclaredDescriptor,
String leftActualDescriptor,
String rightActualDescriptor)
Return an object that indicates whether the input descriptors are compatible.
|
static boolean |
Operator.equalityCheck(EvaluationContext context,
Object left,
Object right)
Perform an equality check for the given operand values.
|
static boolean |
Operator.equalityCheck(EvaluationContext context,
Object left,
Object right)
Perform an equality check for the given operand values.
|
Class<?> |
SpelNodeImpl.getObjectClass(Object obj) |
static List<PropertyAccessor> |
AstUtils.getPropertyAccessorsToTry(Class<?> targetType,
List<PropertyAccessor> propertyAccessors)
Determines the set of property resolvers that should be used to try and access a
property on the specified target type.
|
void |
SpelNodeImpl.setValue(ExpressionState expressionState,
Object newValue) |
void |
ValueRef.setValue(Object newValue)
Sets the value this ValueRef points to, it should not require expression component
re-evaluation.
|
void |
ValueRef.NullValueRef.setValue(Object newValue) |
void |
ValueRef.TypedValueHolderValueRef.setValue(Object newValue) |
Constructor and Description |
---|
Literal(String originalValue,
int startPos,
int endPos) |
Modifier and Type | Method and Description |
---|---|
CompiledExpression |
SpelCompiler.compile(SpelNodeImpl expression)
Attempt compilation of the supplied expression.
|
Object |
SpelExpression.getValue() |
<T> T |
SpelExpression.getValue(Class<T> expectedResultType) |
Object |
SpelExpression.getValue(EvaluationContext context) |
<T> T |
SpelExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
Object |
SpelExpression.getValue(EvaluationContext context,
Object rootObject) |
<T> T |
SpelExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> expectedResultType) |
Object |
SpelExpression.getValue(Object rootObject) |
<T> T |
SpelExpression.getValue(Object rootObject,
Class<T> expectedResultType) |
Class<?> |
SpelExpression.getValueType() |
Class<?> |
SpelExpression.getValueType(EvaluationContext context) |
Class<?> |
SpelExpression.getValueType(EvaluationContext context,
Object rootObject) |
Class<?> |
SpelExpression.getValueType(Object rootObject) |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor() |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor(EvaluationContext context) |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject) |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor(Object rootObject) |
Modifier and Type | Method and Description |
---|---|
protected SpelExpression |
SpelExpressionParser.doParseExpression(String expressionString,
ParserContext context) |
static SpelCompiler |
SpelCompiler.getCompiler(ClassLoader classLoader)
Factory method for compiler instances.
|
<T> T |
SpelExpression.getValue(Class<T> expectedResultType) |
<T> T |
SpelExpression.getValue(EvaluationContext context,
Class<T> expectedResultType) |
Object |
SpelExpression.getValue(EvaluationContext context,
Object rootObject) |
<T> T |
SpelExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> expectedResultType) |
<T> T |
SpelExpression.getValue(EvaluationContext context,
Object rootObject,
Class<T> expectedResultType) |
Object |
SpelExpression.getValue(Object rootObject) |
<T> T |
SpelExpression.getValue(Object rootObject,
Class<T> expectedResultType) |
<T> T |
SpelExpression.getValue(Object rootObject,
Class<T> expectedResultType) |
Class<?> |
SpelExpression.getValueType(EvaluationContext context,
Object rootObject) |
Class<?> |
SpelExpression.getValueType(Object rootObject) |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor(EvaluationContext context,
Object rootObject) |
TypeDescriptor |
SpelExpression.getValueTypeDescriptor(Object rootObject) |
boolean |
SpelExpression.isWritable(EvaluationContext context,
Object rootObject) |
boolean |
SpelExpression.isWritable(Object rootObject) |
void |
SpelExpression.setValue(EvaluationContext context,
Object value) |
void |
SpelExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
SpelExpression.setValue(EvaluationContext context,
Object rootObject,
Object value) |
void |
SpelExpression.setValue(Object rootObject,
Object value) |
void |
SpelExpression.setValue(Object rootObject,
Object value) |
Modifier and Type | Method and Description |
---|---|
Object |
StandardTypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
protected Field |
ReflectivePropertyAccessor.findField(String name,
Class<?> clazz,
boolean mustBeStatic)
Find a field of a certain name on a specified class.
|
protected Method |
ReflectivePropertyAccessor.findGetterForProperty(String propertyName,
Class<?> clazz,
boolean mustBeStatic)
Find a getter method for the specified property.
|
protected Method |
ReflectivePropertyAccessor.findSetterForProperty(String propertyName,
Class<?> clazz,
boolean mustBeStatic)
Find a setter method for the specified property.
|
BeanResolver |
StandardEvaluationContext.getBeanResolver() |
BeanResolver |
SimpleEvaluationContext.getBeanResolver()
SimpleEvaluationContext does not support the use of bean references. |
Member |
ReflectivePropertyAccessor.getLastReadInvokerPair()
Deprecated.
as of 4.3.15 since it is not used within the framework anymore
|
Class<?> |
ReflectiveMethodExecutor.getPublicDeclaringClass()
Find the first public class in the methods declaring class hierarchy that declares this method.
|
Class<?>[] |
ReflectivePropertyAccessor.getSpecificTargetClasses()
Returns
null which means this is a general purpose accessor. |
Class<?>[] |
ReflectivePropertyAccessor.OptimalPropertyAccessor.getSpecificTargetClasses() |
Object |
StandardEvaluationContext.lookupVariable(String name) |
Object |
SimpleEvaluationContext.lookupVariable(String name) |
MethodExecutor |
DataBindingMethodResolver.resolve(EvaluationContext context,
Object targetObject,
String name,
List<TypeDescriptor> argumentTypes) |
MethodExecutor |
ReflectiveMethodResolver.resolve(EvaluationContext context,
Object targetObject,
String name,
List<TypeDescriptor> argumentTypes)
Locate a method on a type.
|
ConstructorExecutor |
ReflectiveConstructorResolver.resolve(EvaluationContext context,
String typeName,
List<TypeDescriptor> argumentTypes)
Locate a constructor on the type.
|
Modifier and Type | Method and Description |
---|---|
boolean |
StandardTypeComparator.canCompare(Object left,
Object right) |
boolean |
StandardTypeComparator.canCompare(Object left,
Object right) |
boolean |
StandardTypeConverter.canConvert(TypeDescriptor sourceType,
TypeDescriptor targetType) |
boolean |
ReflectivePropertyAccessor.canRead(EvaluationContext context,
Object target,
String name) |
boolean |
ReflectivePropertyAccessor.OptimalPropertyAccessor.canRead(EvaluationContext context,
Object target,
String name) |
boolean |
ReflectivePropertyAccessor.canWrite(EvaluationContext context,
Object target,
String name) |
boolean |
ReflectivePropertyAccessor.OptimalPropertyAccessor.canWrite(EvaluationContext context,
Object target,
String name) |
int |
StandardTypeComparator.compare(Object left,
Object right) |
int |
StandardTypeComparator.compare(Object left,
Object right) |
Object |
StandardTypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
Object |
StandardTypeConverter.convertValue(Object value,
TypeDescriptor sourceType,
TypeDescriptor targetType) |
PropertyAccessor |
ReflectivePropertyAccessor.createOptimalAccessor(EvaluationContext context,
Object target,
String name)
Attempt to create an optimized property accessor tailored for a property of a
particular name on a particular class.
|
Object |
StandardOperatorOverloader.operate(Operation operation,
Object leftOperand,
Object rightOperand) |
Object |
StandardOperatorOverloader.operate(Operation operation,
Object leftOperand,
Object rightOperand) |
boolean |
StandardOperatorOverloader.overridesOperation(Operation operation,
Object leftOperand,
Object rightOperand) |
boolean |
StandardOperatorOverloader.overridesOperation(Operation operation,
Object leftOperand,
Object rightOperand) |
TypedValue |
ReflectivePropertyAccessor.read(EvaluationContext context,
Object target,
String name) |
TypedValue |
ReflectivePropertyAccessor.OptimalPropertyAccessor.read(EvaluationContext context,
Object target,
String name) |
void |
ReflectiveMethodResolver.registerMethodFilter(Class<?> type,
MethodFilter filter)
Register a filter for methods on the given type.
|
void |
StandardEvaluationContext.setRootObject(Object rootObject) |
void |
StandardEvaluationContext.setRootObject(Object rootObject,
TypeDescriptor typeDescriptor) |
void |
StandardEvaluationContext.setVariable(String name,
Object value) |
void |
StandardEvaluationContext.setVariable(String name,
Object value) |
void |
SimpleEvaluationContext.setVariable(String name,
Object value) |
void |
ReflectivePropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
ReflectivePropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
ReflectivePropertyAccessor.OptimalPropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
void |
ReflectivePropertyAccessor.OptimalPropertyAccessor.write(EvaluationContext context,
Object target,
String name,
Object newValue) |
Constructor and Description |
---|
ReflectiveMethodExecutor(Method method,
Class<?> targetClass)
Create a new executor for the given method.
|
StandardEvaluationContext(Object rootObject)
Create a
StandardEvaluationContext with the given root object. |
StandardTypeLocator(ClassLoader classLoader)
Create a StandardTypeLocator for the given ClassLoader.
|
Modifier and Type | Method and Description |
---|---|
Chronology |
JodaTimeContext.getChronology()
Deprecated.
Return the user's chronology (calendar system), if any.
|
static JodaTimeContext |
JodaTimeContextHolder.getJodaTimeContext()
Deprecated.
Return the JodaTimeContext associated with the current thread, if any.
|
DateTimeFormatter |
DateTimeFormatterFactoryBean.getObject()
Deprecated.
|
DateTimeZone |
JodaTimeContext.getTimeZone()
Deprecated.
Return the user's time zone, if any.
|
Modifier and Type | Method and Description |
---|---|
static DateTimeFormatter |
JodaTimeContextHolder.getFormatter(DateTimeFormatter formatter,
Locale locale)
Deprecated.
Obtain a DateTimeFormatter with user-specific settings applied to the given base Formatter.
|
void |
JodaTimeContext.setChronology(Chronology chronology)
Deprecated.
Set the user's chronology (calendar system).
|
static void |
JodaTimeContextHolder.setJodaTimeContext(JodaTimeContext jodaTimeContext)
Deprecated.
Associate the given JodaTimeContext with the current thread.
|
void |
JodaTimeContext.setTimeZone(DateTimeZone timeZone)
Deprecated.
Set the user's time zone.
|
Modifier and Type | Method and Description |
---|---|
Chronology |
DateTimeContext.getChronology()
Return the user's chronology (calendar system), if any.
|
static DateTimeContext |
DateTimeContextHolder.getDateTimeContext()
Return the DateTimeContext associated with the current thread, if any.
|
DateTimeFormatter |
DateTimeFormatterFactoryBean.getObject() |
ZoneId |
DateTimeContext.getTimeZone()
Return the user's time zone, if any.
|
Modifier and Type | Method and Description |
---|---|
static DateTimeFormatter |
DateTimeContextHolder.getFormatter(DateTimeFormatter formatter,
Locale locale)
Obtain a DateTimeFormatter with user-specific settings applied to the given base formatter.
|
void |
DateTimeContext.setChronology(Chronology chronology)
Set the user's chronology (calendar system).
|
static void |
DateTimeContextHolder.setDateTimeContext(DateTimeContext dateTimeContext)
Associate the given DateTimeContext with the current thread.
|
void |
DateTimeContext.setTimeZone(ZoneId timeZone)
Set the user's time zone.
|
Modifier and Type | Method and Description |
---|---|
FormattingConversionService |
FormattingConversionServiceFactoryBean.getObject() |
Constructor and Description |
---|
DefaultFormattingConversionService(StringValueResolver embeddedValueResolver,
boolean registerDefaultFormatters)
Create a new
DefaultFormattingConversionService with the set of
default converters and,
based on the value of registerDefaultFormatters , the set of
default formatters. |
Modifier and Type | Method and Description |
---|---|
List<String> |
HttpHeaders.get(Object key) |
String |
HttpHeaders.getAccessControlAllowOrigin()
Return the value of the
Access-Control-Allow-Origin response header. |
HttpMethod |
HttpHeaders.getAccessControlRequestMethod()
Return the value of the
Access-Control-Request-Method request header. |
T |
HttpEntity.getBody()
Returns the body of this entity.
|
String |
HttpHeaders.getCacheControl()
Return the value of the
Cache-Control header. |
Charset |
ContentDisposition.getCharset()
Return the charset defined in filename* parameter, or
null if not defined. |
Locale |
HttpHeaders.getContentLanguage()
Get the first
Locale of the content languages, as specified by the
Content-Language header. |
MediaType |
HttpHeaders.getContentType()
Return the media type of the body, as specified
by the
Content-Type header. |
ZonedDateTime |
ContentDisposition.getCreationDate()
Deprecated.
since 5.2.3 as per
RFC 6266, Appendix B,
to be removed in a future release.
|
String |
ResponseCookie.getDomain()
Return the cookie "Domain" attribute, or
null if not set. |
String |
HttpHeaders.getETag()
Return the entity tag of the body, as specified by the
ETag header. |
protected String |
HttpHeaders.getFieldValues(String headerName)
Retrieve a combined result from the field values of multivalued headers.
|
String |
ContentDisposition.getFilename()
Return the value of the filename parameter, possibly decoded
from BASE64 encoding based on RFC 2047, or of the filename*
parameter, possibly decoded as defined in the RFC 5987.
|
String |
HttpHeaders.getFirst(String headerName)
Return the first header value for the given header name, if any.
|
ZonedDateTime |
HttpHeaders.getFirstZonedDateTime(String headerName)
Parse the first header value for the given header name as a date,
return
null if there is no value, or raise IllegalArgumentException
if the value cannot be parsed as a date. |
String |
CacheControl.getHeaderValue()
Return the "Cache-Control" header value, if any.
|
InetSocketAddress |
HttpHeaders.getHost()
Return the value of the
Host header, if available. |
URI |
HttpHeaders.getLocation()
Return the (new) location of a resource
as specified by the
Location header. |
default HttpMethod |
HttpRequest.getMethod()
Return the HTTP method of the request.
|
HttpMethod |
RequestEntity.getMethod()
Return the HTTP method of the request.
|
ZonedDateTime |
ContentDisposition.getModificationDate()
Deprecated.
since 5.2.3 as per
RFC 6266, Appendix B,
to be removed in a future release.
|
String |
ContentDisposition.getName()
Return the value of the name parameter, or
null if not defined. |
String |
HttpHeaders.getOrigin()
Return the value of the
Origin header. |
String |
ResponseCookie.getPath()
Return the cookie "Path" attribute, or
null if not set. |
String |
HttpHeaders.getPragma()
Return the value of the
Pragma header. |
ZonedDateTime |
ContentDisposition.getReadDate()
Deprecated.
since 5.2.3 as per
RFC 6266, Appendix B,
to be removed in a future release.
|
String |
ResponseCookie.getSameSite()
Return the cookie "SameSite" attribute, or
null if not set. |
Long |
ContentDisposition.getSize()
Deprecated.
since 5.2.3 as per
RFC 6266, Appendix B,
to be removed in a future release.
|
String |
ContentDisposition.getType()
Return the disposition type.
|
Type |
RequestEntity.getType()
Return the type of the request's body.
|
String |
HttpHeaders.getUpgrade()
Return the value of the
Upgrade header. |
Object[] |
RequestEntity.UriTemplateRequestEntity.getVars() |
Map<String,?> |
RequestEntity.UriTemplateRequestEntity.getVarsMap() |
static HttpStatus |
HttpStatus.resolve(int statusCode)
Resolve the given status code to an
HttpStatus , if possible. |
static HttpStatus.Series |
HttpStatus.Series.resolve(int statusCode)
Resolve the given status code to an
HttpStatus.Series , if possible. |
static HttpMethod |
HttpMethod.resolve(String method)
Resolve the given method value to an
HttpMethod . |
Modifier and Type | Method and Description |
---|---|
void |
HttpHeaders.add(String headerName,
String headerValue)
Add the given, single header value under the given name.
|
<T> ResponseEntity<T> |
ResponseEntity.BodyBuilder.body(T body)
Set the body of the response entity and returns it.
|
ResponseCookie.ResponseCookieBuilder |
ResponseCookie.ResponseCookieBuilder.domain(String domain)
Set the cookie "Domain" attribute.
|
static String |
HttpHeaders.encodeBasicAuth(String username,
String password,
Charset charset)
Encode the given username and password into Basic Authentication credentials.
|
boolean |
HttpEntity.equals(Object other) |
boolean |
HttpCookie.equals(Object other) |
boolean |
ResponseCookie.equals(Object other) |
boolean |
ContentDisposition.equals(Object other) |
boolean |
ResponseEntity.equals(Object other) |
boolean |
HttpHeaders.equals(Object other) |
boolean |
RequestEntity.equals(Object other) |
boolean |
RequestEntity.UriTemplateRequestEntity.equals(Object other) |
static Optional<MediaType> |
MediaTypeFactory.getMediaType(Resource resource)
Determine a media type for the given resource, if possible.
|
static Optional<MediaType> |
MediaTypeFactory.getMediaType(String filename)
Determine a media type for the given file name, if possible.
|
static List<MediaType> |
MediaTypeFactory.getMediaTypes(String filename)
Determine the media types for the given file name, if possible.
|
B |
ResponseEntity.HeadersBuilder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
B |
RequestEntity.HeadersBuilder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
boolean |
MediaType.includes(MediaType other)
Indicate whether this
MediaType includes the given media type. |
boolean |
MediaType.isCompatibleWith(MediaType other)
Indicate whether this
MediaType is compatible with the given media type. |
static <T> ResponseEntity<T> |
ResponseEntity.ok(T body)
A shortcut for creating a
ResponseEntity with the given body
and the status set to OK. |
static List<MediaType> |
MediaType.parseMediaTypes(List<String> mediaTypes)
Parse the given list of (potentially) comma-separated strings into a
list of
MediaType objects. |
static List<MediaType> |
MediaType.parseMediaTypes(String mediaTypes)
Parse the comma-separated string into a list of
MediaType objects. |
static List<HttpRange> |
HttpRange.parseRanges(String ranges)
Parse the given, comma-separated string into a list of
HttpRange objects. |
ResponseCookie.ResponseCookieBuilder |
ResponseCookie.ResponseCookieBuilder.path(String path)
Set the cookie "Path" attribute.
|
static HttpMethod |
HttpMethod.resolve(String method)
Resolve the given method value to an
HttpMethod . |
ResponseCookie.ResponseCookieBuilder |
ResponseCookie.ResponseCookieBuilder.sameSite(String sameSite)
Add the "SameSite" attribute to the cookie.
|
void |
HttpHeaders.set(String headerName,
String headerValue)
Set the given, single header value under the given name.
|
void |
HttpHeaders.setAccessControlAllowOrigin(String allowedOrigin)
Set the (new) value of the
Access-Control-Allow-Origin response header. |
void |
HttpHeaders.setAccessControlRequestMethod(HttpMethod requestMethod)
Set the (new) value of the
Access-Control-Request-Method request header. |
void |
HttpHeaders.setBasicAuth(String username,
String password,
Charset charset)
Set the value of the Authorization header to
Basic Authentication based on the given username and password.
|
void |
HttpHeaders.setCacheControl(String cacheControl)
Set the (new) value of the
Cache-Control header. |
void |
HttpHeaders.setContentDispositionFormData(String name,
String filename)
Set the
Content-Disposition header when creating a
"multipart/form-data" request. |
void |
HttpHeaders.setContentLanguage(Locale locale)
Set the
Locale of the content language,
as specified by the Content-Language header. |
void |
HttpHeaders.setContentType(MediaType mediaType)
Set the media type of the body,
as specified by the
Content-Type header. |
void |
HttpHeaders.setETag(String etag)
Set the (new) entity tag of the body, as specified by the
ETag header. |
void |
HttpHeaders.setHost(InetSocketAddress host)
Set the (new) value of the
Host header. |
void |
HttpHeaders.setLocation(URI location)
Set the (new) location of a resource,
as specified by the
Location header. |
void |
HttpHeaders.setOrigin(String origin)
Set the (new) value of the
Origin header. |
void |
HttpHeaders.setPragma(String pragma)
Set the (new) value of the
Pragma header. |
void |
HttpHeaders.setUpgrade(String upgrade)
Set the (new) value of the
Upgrade header. |
Constructor and Description |
---|
HttpCookie(String name,
String value) |
HttpEntity(T body,
MultiValueMap<String,String> headers)
Create a new
HttpEntity with the given body and headers. |
HttpEntity(T body,
MultiValueMap<String,String> headers)
Create a new
HttpEntity with the given body and headers. |
MediaType(MediaType other,
Map<String,String> parameters)
Copy-constructor that copies the type and subtype of the given
MediaType ,
and allows for different parameters. |
MediaType(String type,
String subtype,
Map<String,String> parameters)
Create a new
MediaType for the given type, subtype, and parameters. |
RequestEntity(T body,
HttpMethod method,
URI url)
Constructor with method, URL and body but without headers.
|
RequestEntity(T body,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, body and type but without headers.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url)
Constructor with method, URL, headers and body.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url)
Constructor with method, URL, headers and body.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url)
Constructor with method, URL, headers and body.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, headers, body and type.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, headers, body and type.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, headers, body and type.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, headers, body and type.
|
RequestEntity(T body,
MultiValueMap<String,String> headers,
HttpMethod method,
URI url,
Type type)
Constructor with method, URL, headers, body and type.
|
ResponseEntity(T body,
HttpStatus status)
Create a
ResponseEntity with a body and status code. |
ResponseEntity(T body,
MultiValueMap<String,String> headers,
HttpStatus status)
Create a
ResponseEntity with a body, headers, and a status code. |
ResponseEntity(T body,
MultiValueMap<String,String> headers,
HttpStatus status)
Create a
ResponseEntity with a body, headers, and a status code. |
ResponseEntity(T body,
MultiValueMap<String,String> headers,
int rawStatus)
Create a
ResponseEntity with a body, headers, and a raw status code. |
ResponseEntity(T body,
MultiValueMap<String,String> headers,
int rawStatus)
Create a
ResponseEntity with a body, headers, and a raw status code. |
Modifier and Type | Method and Description |
---|---|
protected org.apache.http.protocol.HttpContext |
HttpComponentsClientHttpRequestFactory.createHttpContext(HttpMethod httpMethod,
URI uri)
Template methods that creates a
HttpContext for the given HTTP method and URI. |
protected org.apache.http.client.config.RequestConfig |
HttpComponentsClientHttpRequestFactory.createRequestConfig(Object client)
Create a default
RequestConfig to use with the given client. |
Modifier and Type | Method and Description |
---|---|
protected HttpURLConnection |
SimpleClientHttpRequestFactory.openConnection(URL url,
Proxy proxy)
Opens and returns a connection to the given URL.
|
MultipartBodyBuilder.PartBuilder |
MultipartBodyBuilder.part(String name,
Object part,
MediaType contentType)
Variant of
MultipartBodyBuilder.part(String, Object) that also accepts a MediaType. |
Constructor and Description |
---|
InterceptingAsyncClientHttpRequestFactory(AsyncClientHttpRequestFactory delegate,
List<AsyncClientHttpRequestInterceptor> interceptors)
Deprecated.
Create new instance of
InterceptingAsyncClientHttpRequestFactory
with delegated request factory and list of interceptors. |
InterceptingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory,
List<ClientHttpRequestInterceptor> interceptors)
Create a new instance of the
InterceptingClientHttpRequestFactory with the given parameters. |
Modifier and Type | Method and Description |
---|---|
org.eclipse.jetty.io.ByteBufferPool |
JettyResourceFactory.getByteBufferPool()
Return the configured
ByteBufferPool . |
Executor |
JettyResourceFactory.getExecutor()
Return the configured
Executor . |
org.eclipse.jetty.util.thread.Scheduler |
JettyResourceFactory.getScheduler()
Return the configured
Scheduler . |
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<Void> |
AbstractClientHttpRequest.doCommit(Supplier<? extends Publisher<Void>> writeAction)
Apply
beforeCommit actions, apply the
request headers/cookies, and write the request body. |
void |
JettyResourceFactory.setByteBufferPool(org.eclipse.jetty.io.ByteBufferPool byteBufferPool)
Configure the
ByteBufferPool to use. |
void |
JettyResourceFactory.setExecutor(Executor executor)
Configure the
Executor to use. |
void |
JettyResourceFactory.setScheduler(org.eclipse.jetty.util.thread.Scheduler scheduler)
Configure the
Scheduler to use. |
Constructor and Description |
---|
JettyClientHttpConnector(org.eclipse.jetty.client.HttpClient httpClient,
JettyResourceFactory resourceFactory)
Constructor with an initialized
HttpClient and configures it
with the given JettyResourceFactory . |
JettyClientHttpConnector(JettyResourceFactory resourceFactory,
Consumer<org.eclipse.jetty.client.HttpClient> customizer)
Deprecated.
as of 5.2, in favor of
JettyClientHttpConnector(HttpClient, JettyResourceFactory) |
Modifier and Type | Method and Description |
---|---|
HttpMethod |
HttpRequestWrapper.getMethod()
Return the method of the wrapped request.
|
Proxy |
ProxyFactoryBean.getObject() |
Constructor and Description |
---|
BasicAuthenticationInterceptor(String username,
String password,
Charset charset)
Create a new interceptor which adds Basic Authentication for the
given username and password, encoded using the specified charset.
|
BasicAuthorizationInterceptor(String username,
String password)
Deprecated.
Create a new interceptor which adds a BASIC authorization header
for the given username and password.
|
BasicAuthorizationInterceptor(String username,
String password)
Deprecated.
Create a new interceptor which adds a BASIC authorization header
for the given username and password.
|
Modifier and Type | Method and Description |
---|---|
String |
ServerSentEvent.comment()
Return the comment of this event, if available.
|
T |
ServerSentEvent.data()
Return the
data field of this event, if available. |
String |
ServerSentEvent.event()
Return the
event field of this event, if available. |
protected MediaType |
DecoderHttpMessageReader.getContentType(HttpMessage inputMessage)
Determine the Content-Type of the HTTP message based on the
"Content-Type" header or otherwise default to
MediaType.APPLICATION_OCTET_STREAM . |
Decoder<?> |
ServerSentEventHttpMessageReader.getDecoder()
Return the configured
Decoder . |
Encoder<?> |
ServerSentEventHttpMessageWriter.getEncoder()
Return the configured
Encoder , if any. |
String |
ServerSentEvent.id()
Return the
id field of this event, if available. |
Boolean |
CodecConfigurer.DefaultCodecConfig.isEnableLoggingRequestDetails()
Whether to log form data at DEBUG level, and headers at TRACE level.
|
Integer |
CodecConfigurer.DefaultCodecConfig.maxInMemorySize()
Get the configured limit on the number of bytes that can be buffered whenever
the input stream needs to be aggregated.
|
Duration |
ServerSentEvent.retry()
Return the
retry field of this event, if available. |
Modifier and Type | Method and Description |
---|---|
boolean |
DecoderHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
HttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType)
Whether the given object type is supported by this reader.
|
boolean |
ServerSentEventHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
FormHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
ServerSentEventHttpMessageWriter.canWrite(ResolvableType elementType,
MediaType mediaType) |
boolean |
FormHttpMessageWriter.canWrite(ResolvableType elementType,
MediaType mediaType) |
boolean |
EncoderHttpMessageWriter.canWrite(ResolvableType elementType,
MediaType mediaType) |
boolean |
ResourceHttpMessageWriter.canWrite(ResolvableType elementType,
MediaType mediaType) |
boolean |
HttpMessageWriter.canWrite(ResolvableType elementType,
MediaType mediaType)
Whether the given object type is supported by this writer.
|
ServerSentEvent.Builder<T> |
ServerSentEvent.Builder.data(T data)
Set the value of the
data field. |
default Map<String,Object> |
HttpMessageEncoder.getEncodeHints(ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response)
Get decoding hints based on the server request or annotations on the
target controller method parameter.
|
protected MediaType |
FormHttpMessageWriter.getMediaType(MediaType mediaType) |
protected Map<String,Object> |
EncoderHttpMessageWriter.getWriteHints(ResolvableType streamType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response)
Get additional hints for encoding for example based on the server request
or annotations from controller method parameters.
|
reactor.core.publisher.Mono<Void> |
ServerSentEventHttpMessageWriter.write(Publisher<?> input,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
ServerSentEventHttpMessageWriter.write(Publisher<?> input,
ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
FormHttpMessageWriter.write(Publisher<? extends MultiValueMap<String,String>> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
ResourceHttpMessageWriter.write(Publisher<? extends Resource> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
ResourceHttpMessageWriter.write(Publisher<? extends Resource> inputStream,
ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
ResourceHttpMessageWriter.write(Publisher<? extends Resource> inputStream,
ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
EncoderHttpMessageWriter.write(Publisher<? extends T> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
HttpMessageWriter.write(Publisher<? extends T> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints)
Write a given stream of object to the output message.
|
reactor.core.publisher.Mono<Void> |
EncoderHttpMessageWriter.write(Publisher<? extends T> inputStream,
ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> hints) |
default reactor.core.publisher.Mono<Void> |
HttpMessageWriter.write(Publisher<? extends T> inputStream,
ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> hints)
Server-side only alternative to
HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
with additional context available. |
Constructor and Description |
---|
ServerSentEventHttpMessageReader(Decoder<?> decoder)
Constructor with JSON
Decoder for decoding to Objects. |
ServerSentEventHttpMessageWriter(Encoder<?> encoder)
Constructor with JSON
Encoder for encoding objects. |
Modifier and Type | Method and Description |
---|---|
protected abstract <A extends Annotation> |
Jackson2CodecSupport.getAnnotation(MethodParameter parameter,
Class<A> annotType) |
Map<MimeType,ObjectMapper> |
Jackson2CodecSupport.getObjectMappersForType(Class<?> clazz)
Return ObjectMapper registrations for the given class, if any.
|
protected MethodParameter |
Jackson2CodecSupport.getParameter(ResolvableType type) |
protected byte[] |
Jackson2SmileEncoder.getStreamingMediaTypeSeparator(MimeType mimeType)
Return the separator to use for the given mime type.
|
protected byte[] |
AbstractJackson2Encoder.getStreamingMediaTypeSeparator(MimeType mimeType)
Return the separator to use for the given mime type.
|
protected ObjectMapper |
Jackson2CodecSupport.selectObjectMapper(ResolvableType targetType,
MimeType targetMimeType)
Select an ObjectMapper to use, either the main ObjectMapper or another
if the handling for the given Class has been customized through
Jackson2CodecSupport.registerObjectMappersForType(Class, Consumer) . |
Modifier and Type | Method and Description |
---|---|
boolean |
KotlinSerializationJsonDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
AbstractJackson2Decoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
AbstractJackson2Encoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
boolean |
KotlinSerializationJsonEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
protected ObjectWriter |
AbstractJackson2Encoder.customizeWriter(ObjectWriter writer,
MimeType mimeType,
ResolvableType elementType,
Map<String,Object> hints) |
protected ObjectWriter |
AbstractJackson2Encoder.customizeWriter(ObjectWriter writer,
MimeType mimeType,
ResolvableType elementType,
Map<String,Object> hints) |
protected ObjectWriter |
Jackson2JsonEncoder.customizeWriter(ObjectWriter writer,
MimeType mimeType,
ResolvableType elementType,
Map<String,Object> hints) |
protected ObjectWriter |
Jackson2JsonEncoder.customizeWriter(ObjectWriter writer,
MimeType mimeType,
ResolvableType elementType,
Map<String,Object> hints) |
Object |
AbstractJackson2Decoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
Object |
AbstractJackson2Decoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
KotlinSerializationJsonDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
KotlinSerializationJsonDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
AbstractJackson2Decoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
AbstractJackson2Decoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
KotlinSerializationJsonDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
KotlinSerializationJsonDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
AbstractJackson2Decoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
AbstractJackson2Decoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
AbstractJackson2Encoder.encode(Publisher<?> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
AbstractJackson2Encoder.encode(Publisher<?> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
KotlinSerializationJsonEncoder.encode(Publisher<?> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
KotlinSerializationJsonEncoder.encode(Publisher<?> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
AbstractJackson2Encoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
AbstractJackson2Encoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
KotlinSerializationJsonEncoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
KotlinSerializationJsonEncoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
Map<String,Object> |
AbstractJackson2Encoder.getEncodeHints(ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response) |
Map<String,Object> |
AbstractJackson2Encoder.getEncodeHints(ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response) |
protected JavaType |
Jackson2CodecSupport.getJavaType(Type type,
Class<?> contextClass) |
protected JsonEncoding |
AbstractJackson2Encoder.getJsonEncoding(MimeType mimeType)
Determine the JSON encoding to use for the given mime type.
|
protected byte[] |
Jackson2SmileEncoder.getStreamingMediaTypeSeparator(MimeType mimeType)
Return the separator to use for the given mime type.
|
protected byte[] |
AbstractJackson2Encoder.getStreamingMediaTypeSeparator(MimeType mimeType)
Return the separator to use for the given mime type.
|
protected void |
Jackson2CodecSupport.logWarningIfNecessary(Type type,
Throwable cause)
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check. |
protected reactor.core.publisher.Flux<DataBuffer> |
Jackson2JsonDecoder.processInput(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
protected reactor.core.publisher.Flux<DataBuffer> |
Jackson2JsonDecoder.processInput(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
protected reactor.core.publisher.Flux<DataBuffer> |
AbstractJackson2Decoder.processInput(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Process the input publisher into a flux.
|
protected reactor.core.publisher.Flux<DataBuffer> |
AbstractJackson2Decoder.processInput(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Process the input publisher into a flux.
|
protected ObjectMapper |
Jackson2CodecSupport.selectObjectMapper(ResolvableType targetType,
MimeType targetMimeType)
Select an ObjectMapper to use, either the main ObjectMapper or another
if the handling for the given Class has been customized through
Jackson2CodecSupport.registerObjectMappersForType(Class, Consumer) . |
protected boolean |
Jackson2CodecSupport.supportsMimeType(MimeType mimeType) |
Modifier and Type | Method and Description |
---|---|
HttpMessageWriter<MultiValueMap<String,String>> |
MultipartHttpMessageWriter.getFormWriter()
Return the configured form writer.
|
Modifier and Type | Method and Description |
---|---|
boolean |
DefaultPartHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
SynchronossPartHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
MultipartHttpMessageReader.canRead(ResolvableType elementType,
MediaType mediaType) |
boolean |
MultipartWriterSupport.canWrite(ResolvableType elementType,
MediaType mediaType) |
protected MediaType |
MultipartWriterSupport.getMultipartMediaType(MediaType mediaType,
byte[] boundary)
Prepare the
MediaType to use by adding "boundary" and "charset"
parameters to the given mediaType or "multipart/form-data"
otherwise by default. |
reactor.core.publisher.Mono<Void> |
MultipartHttpMessageWriter.write(Publisher<? extends MultiValueMap<String,?>> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage outputMessage,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Void> |
PartHttpMessageWriter.write(Publisher<? extends Part> parts,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage outputMessage,
Map<String,Object> hints) |
Constructor and Description |
---|
MultipartHttpMessageWriter(List<HttpMessageWriter<?>> partWriters,
HttpMessageWriter<MultiValueMap<String,String>> formWriter)
Constructor with explicit list of writers for serializing parts and a
writer for plain form data to fall back when no media type is specified
and the actual map consists of String values only.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ProtobufDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
ProtobufEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
com.google.protobuf.Message |
ProtobufDecoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
com.google.protobuf.Message |
ProtobufDecoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<com.google.protobuf.Message> |
ProtobufDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<com.google.protobuf.Message> |
ProtobufDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<com.google.protobuf.Message> |
ProtobufDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<com.google.protobuf.Message> |
ProtobufDecoder.decodeToMono(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ProtobufEncoder.encode(Publisher<? extends com.google.protobuf.Message> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
ProtobufEncoder.encode(Publisher<? extends com.google.protobuf.Message> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
ProtobufEncoder.encodeValue(com.google.protobuf.Message message,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
ProtobufEncoder.encodeValue(com.google.protobuf.Message message,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
protected boolean |
ProtobufCodecSupport.supportsMimeType(MimeType mimeType) |
reactor.core.publisher.Mono<Void> |
ProtobufHttpMessageWriter.write(Publisher<? extends com.google.protobuf.Message> inputStream,
ResolvableType elementType,
MediaType mediaType,
ReactiveHttpOutputMessage message,
Map<String,Object> hints) |
Modifier and Type | Method and Description |
---|---|
boolean |
Jaxb2XmlDecoder.canDecode(ResolvableType elementType,
MimeType mimeType) |
boolean |
Jaxb2XmlEncoder.canEncode(ResolvableType elementType,
MimeType mimeType) |
Object |
Jaxb2XmlDecoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
Object |
Jaxb2XmlDecoder.decode(DataBuffer dataBuffer,
ResolvableType targetType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<XMLEvent> |
XmlEventDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<XMLEvent> |
XmlEventDecoder.decode(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
Jaxb2XmlDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<Object> |
Jaxb2XmlDecoder.decode(Publisher<DataBuffer> inputStream,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
Jaxb2XmlDecoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
reactor.core.publisher.Mono<Object> |
Jaxb2XmlDecoder.decodeToMono(Publisher<DataBuffer> input,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints) |
protected reactor.core.publisher.Flux<DataBuffer> |
Jaxb2XmlEncoder.encode(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
protected reactor.core.publisher.Flux<DataBuffer> |
Jaxb2XmlEncoder.encode(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
Jaxb2XmlEncoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
DataBuffer |
Jaxb2XmlEncoder.encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints) |
Modifier and Type | Method and Description |
---|---|
protected Long |
ResourceHttpMessageConverter.getContentLength(Resource resource,
MediaType contentType) |
protected Long |
AbstractHttpMessageConverter.getContentLength(T t,
MediaType contentType)
Returns the content length for the given type.
|
Charset |
AbstractHttpMessageConverter.getDefaultCharset()
Return the default character set, if any.
|
MediaType |
BufferedImageHttpMessageConverter.getDefaultContentType()
Returns the default
Content-Type to be used for writing. |
protected MediaType |
AbstractHttpMessageConverter.getDefaultContentType(T t)
Returns the default content type for the given type.
|
protected String |
FormHttpMessageConverter.getFilename(Object part)
Return the filename of the given multipart part.
|
Modifier and Type | Method and Description |
---|---|
protected void |
StringHttpMessageConverter.addDefaultHeaders(HttpHeaders headers,
String s,
MediaType type) |
protected void |
AbstractHttpMessageConverter.addDefaultHeaders(HttpHeaders headers,
T t,
MediaType contentType)
Add default headers to the output message.
|
boolean |
ResourceRegionHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
ObjectToStringHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
HttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be read by this converter.
|
boolean |
AbstractHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType)
This implementation checks if the given class is supported,
and if the supported media types
include the given media type.
|
boolean |
FormHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
BufferedImageHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
protected boolean |
AbstractHttpMessageConverter.canRead(MediaType mediaType)
|
boolean |
ResourceRegionHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
ResourceRegionHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
AbstractGenericHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
AbstractGenericHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
GenericHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType)
Indicates whether the given type can be read by this converter.
|
boolean |
GenericHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType)
Indicates whether the given type can be read by this converter.
|
boolean |
ResourceRegionHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
ObjectToStringHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
HttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be written by this converter.
|
boolean |
AbstractHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType)
|
boolean |
FormHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
BufferedImageHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
protected boolean |
AbstractHttpMessageConverter.canWrite(MediaType mediaType)
Returns
true if the given media type includes any of the
supported media types. |
boolean |
ResourceRegionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
ResourceRegionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
ResourceRegionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
AbstractGenericHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
AbstractGenericHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
GenericHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be written by this converter.
|
boolean |
GenericHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be written by this converter.
|
protected Long |
ByteArrayHttpMessageConverter.getContentLength(byte[] bytes,
MediaType contentType) |
protected Long |
ObjectToStringHttpMessageConverter.getContentLength(Object obj,
MediaType contentType) |
protected Long |
ResourceHttpMessageConverter.getContentLength(Resource resource,
MediaType contentType) |
protected Long |
StringHttpMessageConverter.getContentLength(String str,
MediaType contentType) |
protected Long |
AbstractHttpMessageConverter.getContentLength(T t,
MediaType contentType)
Returns the content length for the given type.
|
protected MediaType |
FormHttpMessageConverter.getFormContentType(MediaType contentType)
Return the content type used to write forms, given the preferred content type.
|
BufferedImage |
BufferedImageHttpMessageConverter.read(Class<? extends BufferedImage> clazz,
HttpInputMessage inputMessage) |
MultiValueMap<String,String> |
FormHttpMessageConverter.read(Class<? extends MultiValueMap<String,?>> clazz,
HttpInputMessage inputMessage) |
Object |
ResourceRegionHttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage) |
T |
GenericHttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage)
Read an object of the given type form the given input message, and returns it.
|
void |
FormHttpMessageConverter.setCharset(Charset charset)
Set the default character set to use for reading and writing form data when
the request or response
Content-Type header does not explicitly
specify it. |
void |
AbstractHttpMessageConverter.setDefaultCharset(Charset defaultCharset)
Set the default character set, if any.
|
void |
BufferedImageHttpMessageConverter.setDefaultContentType(MediaType defaultContentType)
Sets the default
Content-Type to be used for writing. |
void |
BufferedImageHttpMessageConverter.write(BufferedImage image,
MediaType contentType,
HttpOutputMessage outputMessage) |
void |
FormHttpMessageConverter.write(MultiValueMap<String,?> map,
MediaType contentType,
HttpOutputMessage outputMessage) |
void |
HttpMessageConverter.write(T t,
MediaType contentType,
HttpOutputMessage outputMessage)
Write a given object to the given output message.
|
void |
AbstractHttpMessageConverter.write(T t,
MediaType contentType,
HttpOutputMessage outputMessage)
This implementation sets the default headers by calling
AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType) ,
and then calls AbstractHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage) . |
void |
AbstractGenericHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage)
This implementation sets the default headers by calling
AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType) ,
and then calls AbstractGenericHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage) . |
void |
AbstractGenericHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage)
This implementation sets the default headers by calling
AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType) ,
and then calls AbstractGenericHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage) . |
void |
GenericHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage)
Write a given object to the given output message.
|
void |
GenericHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage)
Write a given object to the given output message.
|
protected void |
ResourceRegionHttpMessageConverter.writeInternal(Object object,
Type type,
HttpOutputMessage outputMessage) |
protected abstract void |
AbstractGenericHttpMessageConverter.writeInternal(T t,
Type type,
HttpOutputMessage outputMessage)
Abstract template method that writes the actual body.
|
Constructor and Description |
---|
HttpMessageConversionException(String msg,
Throwable cause)
Create a new HttpMessageConversionException.
|
HttpMessageNotReadableException(String msg,
Throwable cause)
Deprecated.
as of 5.1, in favor of
HttpMessageNotReadableException(String, Throwable, HttpInputMessage) |
HttpMessageNotReadableException(String msg,
Throwable cause,
HttpInputMessage httpInputMessage)
Create a new HttpMessageNotReadableException.
|
HttpMessageNotWritableException(String msg,
Throwable cause)
Create a new HttpMessageNotWritableException.
|
Modifier and Type | Field and Description |
---|---|
static Charset |
AbstractJackson2HttpMessageConverter.DEFAULT_CHARSET
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected Long |
AbstractJackson2HttpMessageConverter.getContentLength(Object object,
MediaType contentType) |
protected MediaType |
AbstractJackson2HttpMessageConverter.getDefaultContentType(Object object) |
Class<?> |
MappingJacksonInputMessage.getDeserializationView() |
FilterProvider |
MappingJacksonValue.getFilters()
Return the Jackson filter provider to use.
|
ObjectMapper |
Jackson2ObjectMapperFactoryBean.getObject()
Return the singleton ObjectMapper.
|
com.google.gson.Gson |
GsonFactoryBean.getObject()
Return the created Gson instance.
|
Map<MediaType,ObjectMapper> |
AbstractJackson2HttpMessageConverter.getObjectMappersForType(Class<?> clazz)
Return ObjectMapper registrations for the given class, if any.
|
Class<?> |
MappingJacksonValue.getSerializationView()
Return the serialization view to use.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractJackson2HttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
AbstractJackson2HttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
AbstractJackson2HttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
KotlinSerializationJsonHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
KotlinSerializationJsonHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType) |
boolean |
AbstractJackson2HttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
KotlinSerializationJsonHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
boolean |
KotlinSerializationJsonHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType) |
protected Charset |
AbstractJackson2HttpMessageConverter.getCharset(MediaType contentType)
Determine the charset to use for JSON input.
|
protected Long |
AbstractJackson2HttpMessageConverter.getContentLength(Object object,
MediaType contentType) |
protected JavaType |
AbstractJackson2HttpMessageConverter.getJavaType(Type type,
Class<?> contextClass)
Return the Jackson
JavaType for the specified type and context class. |
protected JsonEncoding |
AbstractJackson2HttpMessageConverter.getJsonEncoding(MediaType contentType)
Determine the JSON encoding to use for the given content type.
|
protected void |
AbstractJackson2HttpMessageConverter.logWarningIfNecessary(Type type,
Throwable cause)
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check. |
Object |
AbstractJsonHttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage) |
Object |
AbstractJackson2HttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage) |
Object |
KotlinSerializationJsonHttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage) |
void |
MappingJacksonInputMessage.setDeserializationView(Class<?> deserializationView) |
void |
MappingJacksonValue.setFilters(FilterProvider filters)
Set the Jackson filter provider to serialize the POJO with.
|
void |
MappingJacksonValue.setSerializationView(Class<?> serializationView)
Set the serialization view to serialize the POJO with.
|
protected void |
AbstractJsonHttpMessageConverter.writeInternal(Object object,
Type type,
HttpOutputMessage outputMessage) |
protected void |
AbstractJackson2HttpMessageConverter.writeInternal(Object object,
Type type,
HttpOutputMessage outputMessage) |
protected void |
KotlinSerializationJsonHttpMessageConverter.writeInternal(Object object,
Type type,
HttpOutputMessage outputMessage) |
protected abstract void |
AbstractJsonHttpMessageConverter.writeInternal(Object object,
Type type,
Writer writer)
Template method that writes the JSON-bound object to the given
Writer . |
protected void |
JsonbHttpMessageConverter.writeInternal(Object object,
Type type,
Writer writer) |
protected void |
GsonHttpMessageConverter.writeInternal(Object object,
Type type,
Writer writer) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
ProtobufHttpMessageConverter.canWrite(MediaType mediaType) |
Constructor and Description |
---|
ProtobufHttpMessageConverter(ExtensionRegistryInitializer registryInitializer)
Deprecated.
as of Spring Framework 5.1, use
ProtobufHttpMessageConverter(ExtensionRegistry) instead |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer)
Constructor with given instances of
JsonFormat.Parser ,
JsonFormat.Printer ,
and a default instance of ExtensionRegistry . |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer)
Constructor with given instances of
JsonFormat.Parser ,
JsonFormat.Printer ,
and a default instance of ExtensionRegistry . |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser ,
JsonFormat.Printer ,
and ExtensionRegistry . |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser ,
JsonFormat.Printer ,
and ExtensionRegistry . |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser ,
JsonFormat.Printer ,
and ExtensionRegistry . |
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
ExtensionRegistryInitializer registryInitializer)
|
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
ExtensionRegistryInitializer registryInitializer)
|
ProtobufJsonFormatHttpMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
ExtensionRegistryInitializer registryInitializer)
|
Modifier and Type | Method and Description |
---|---|
protected Long |
SourceHttpMessageConverter.getContentLength(T t,
MediaType contentType) |
Modifier and Type | Method and Description |
---|---|
boolean |
Jaxb2CollectionHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType)
Always returns
false since Jaxb2CollectionHttpMessageConverter
required generic type information in order to read a Collection. |
boolean |
MarshallingHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
Jaxb2RootElementHttpMessageConverter.canRead(Class<?> clazz,
MediaType mediaType) |
boolean |
Jaxb2CollectionHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType)
Indicates whether the given type can be read by this converter.
|
boolean |
Jaxb2CollectionHttpMessageConverter.canRead(Type type,
Class<?> contextClass,
MediaType mediaType)
Indicates whether the given type can be read by this converter.
|
boolean |
Jaxb2CollectionHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType)
Always returns
false since Jaxb2CollectionHttpMessageConverter
does not convert collections to XML. |
boolean |
MarshallingHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
Jaxb2RootElementHttpMessageConverter.canWrite(Class<?> clazz,
MediaType mediaType) |
boolean |
Jaxb2CollectionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType)
Always returns
false since Jaxb2CollectionHttpMessageConverter
does not convert collections to XML. |
boolean |
Jaxb2CollectionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType)
Always returns
false since Jaxb2CollectionHttpMessageConverter
does not convert collections to XML. |
boolean |
Jaxb2CollectionHttpMessageConverter.canWrite(Type type,
Class<?> clazz,
MediaType mediaType)
Always returns
false since Jaxb2CollectionHttpMessageConverter
does not convert collections to XML. |
protected Long |
SourceHttpMessageConverter.getContentLength(T t,
MediaType contentType) |
T |
Jaxb2CollectionHttpMessageConverter.read(Type type,
Class<?> contextClass,
HttpInputMessage inputMessage) |
void |
Jaxb2CollectionHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage) |
void |
Jaxb2CollectionHttpMessageConverter.write(T t,
Type type,
MediaType contentType,
HttpOutputMessage outputMessage) |
Modifier and Type | Method and Description |
---|---|
HttpMethod |
ServletServerHttpRequest.getMethod() |
Principal |
ServerHttpRequest.getPrincipal()
Return a
Principal instance containing the name of the
authenticated user. |
Modifier and Type | Method and Description |
---|---|
static RequestPath |
RequestPath.parse(String rawPath,
String contextPath)
Variant of
RequestPath.parse(URI, String) with the encoded
raw path . |
static RequestPath |
RequestPath.parse(URI uri,
String contextPath)
Parse the URI for a request into a
RequestPath . |
Modifier and Type | Method and Description |
---|---|
default InetSocketAddress |
ServerHttpRequest.getLocalAddress()
Return the local address the request was accepted on, if available.
|
InetSocketAddress |
ServerHttpRequestDecorator.getLocalAddress() |
HttpMethod |
ServerHttpRequestDecorator.getMethod() |
X509Certificate[] |
SslInfo.getPeerCertificates()
Return SSL certificates associated with the request, if any.
|
Integer |
AbstractServerHttpResponse.getRawStatusCode() |
default Integer |
ServerHttpResponse.getRawStatusCode()
Return the status code that has been set, or otherwise fall back on the
status of the response from the underlying server.
|
default InetSocketAddress |
ServerHttpRequest.getRemoteAddress()
Return the remote address where this request is connected to, if available.
|
InetSocketAddress |
ServerHttpRequestDecorator.getRemoteAddress() |
ServletConfig |
ServletHttpHandlerAdapter.getServletConfig() |
String |
ServletHttpHandlerAdapter.getServletPath()
Return the Servlet path under which the Servlet is deployed by checking
the Servlet registration from
ServletHttpHandlerAdapter.init(ServletConfig) . |
String |
SslInfo.getSessionId()
Return the SSL session id, if any.
|
default SslInfo |
ServerHttpRequest.getSslInfo()
Return the SSL session information if the request has been transmitted
over a secure protocol including SSL certificates, if available.
|
SslInfo |
ServerHttpRequestDecorator.getSslInfo() |
SslInfo |
AbstractServerHttpRequest.getSslInfo() |
HttpStatus |
AbstractServerHttpResponse.getStatusCode() |
HttpStatus |
ServerHttpResponse.getStatusCode()
Return the status code that has been set, or otherwise fall back on the
status of the response from the underlying server.
|
Integer |
AbstractServerHttpResponse.getStatusCodeValue()
Deprecated.
as of 5.2.4 in favor of
ServerHttpResponse.getRawStatusCode() . |
protected String |
AbstractServerHttpRequest.initId()
Obtain the request id to use, or
null in which case the Object
identity of this request instance is used. |
protected abstract SslInfo |
AbstractServerHttpRequest.initSslInfo()
Obtain SSL session information from the underlying "native" request.
|
protected abstract T |
AbstractListenerReadPublisher.read()
Read once from the input, if possible.
|
Object |
ChannelSendOperator.scanUnsafe(reactor.core.Scannable.Attr key) |
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<Void> |
AbstractServerHttpResponse.doCommit(Supplier<? extends reactor.core.publisher.Mono<Void>> writeAction)
Apply
beforeCommit actions, apply the
response status and headers/cookies, and write the response body. |
boolean |
AbstractServerHttpResponse.setRawStatusCode(Integer statusCode) |
boolean |
ServerHttpResponseDecorator.setRawStatusCode(Integer value) |
default boolean |
ServerHttpResponse.setRawStatusCode(Integer value)
Set the HTTP status code to the given value (potentially non-standard and
not resolvable through the
HttpStatus enum) as an integer. |
boolean |
AbstractServerHttpResponse.setStatusCode(HttpStatus status) |
boolean |
ServerHttpResponseDecorator.setStatusCode(HttpStatus status) |
boolean |
ServerHttpResponse.setStatusCode(HttpStatus status)
Set the HTTP status code of the response.
|
void |
AbstractServerHttpResponse.setStatusCodeValue(Integer statusCode)
Deprecated.
as of 5.2.4 in favor of
ServerHttpResponse.setRawStatusCode(Integer) . |
Constructor and Description |
---|
AbstractServerHttpRequest(URI uri,
String contextPath,
HttpHeaders headers)
Constructor with the URI and headers for the request.
|
AbstractServerHttpRequest(URI uri,
String contextPath,
MultiValueMap<String,String> headers)
Constructor with the URI and headers for the request.
|
Modifier and Type | Method and Description |
---|---|
InputStream |
ResourceOverridingShadowingClassLoader.getResourceAsStream(String requestedPath) |
InputStream |
ShadowingClassLoader.getResourceAsStream(String name) |
Modifier and Type | Method and Description |
---|---|
byte[] |
WeavingTransformer.transformIfNecessary(String className,
String internalName,
byte[] bytes,
ProtectionDomain pd)
Apply transformation on a given class byte definition.
|
Constructor and Description |
---|
InstrumentationLoadTimeWeaver(ClassLoader classLoader)
Create a new InstrumentationLoadTimeWeaver for the given ClassLoader.
|
ReflectiveLoadTimeWeaver(ClassLoader classLoader)
Create a new SimpleLoadTimeWeaver for the given class loader.
|
SimpleInstrumentableClassLoader(ClassLoader parent)
Create a new SimpleInstrumentableClassLoader for the given ClassLoader.
|
SimpleThrowawayClassLoader(ClassLoader parent)
Create a new SimpleThrowawayClassLoader for the given ClassLoader.
|
WeavingTransformer(ClassLoader classLoader)
Create a new WeavingTransformer for the given class loader.
|
Constructor and Description |
---|
GlassFishLoadTimeWeaver(ClassLoader classLoader)
Create a new instance of the
GlassFishLoadTimeWeaver class using
the supplied ClassLoader . |
Constructor and Description |
---|
JBossLoadTimeWeaver(ClassLoader classLoader)
Create a new instance of the
JBossLoadTimeWeaver class using
the supplied ClassLoader . |
Constructor and Description |
---|
TomcatLoadTimeWeaver(ClassLoader classLoader)
Create a new instance of the
TomcatLoadTimeWeaver class using
the supplied ClassLoader . |
Constructor and Description |
---|
WebLogicLoadTimeWeaver(ClassLoader classLoader)
Creates a new instance of the
WebLogicLoadTimeWeaver class using
the supplied ClassLoader . |
Constructor and Description |
---|
WebSphereLoadTimeWeaver(ClassLoader classLoader)
Create a new instance of the
WebSphereLoadTimeWeaver class using
the supplied ClassLoader . |
Modifier and Type | Method and Description |
---|---|
ConnectionFactory |
CciLocalTransactionManager.getConnectionFactory()
Deprecated.
Return the CCI ConnectionFactory that this instance manages local
transactions for.
|
ConnectionFactory |
DelegatingConnectionFactory.getTargetConnectionFactory()
Deprecated.
Return the target ConnectionFactory that this ConnectionFactory should delegate to.
|
Modifier and Type | Method and Description |
---|---|
protected Connection |
ConnectionSpecConnectionFactoryAdapter.doGetConnection(ConnectionSpec spec)
Deprecated.
This implementation delegates to the
getConnection(ConnectionSpec)
method of the target ConnectionFactory, passing in the specified user credentials. |
static void |
ConnectionFactoryUtils.doReleaseConnection(Connection con,
ConnectionFactory cf)
Deprecated.
Actually close the given Connection, obtained from the given ConnectionFactory.
|
static void |
ConnectionFactoryUtils.doReleaseConnection(Connection con,
ConnectionFactory cf)
Deprecated.
Actually close the given Connection, obtained from the given ConnectionFactory.
|
protected void |
CciLocalTransactionManager.doResume(Object transaction,
Object suspendedResources)
Deprecated.
|
static Connection |
ConnectionFactoryUtils.getConnection(ConnectionFactory cf,
ConnectionSpec spec)
Deprecated.
Obtain a Connection from the given ConnectionFactory.
|
static boolean |
ConnectionFactoryUtils.isConnectionTransactional(Connection con,
ConnectionFactory cf)
Deprecated.
Determine whether the given JCA CCI Connection is transactional, that is,
bound to the current thread by Spring's transaction facilities.
|
static void |
ConnectionFactoryUtils.releaseConnection(Connection con,
ConnectionFactory cf)
Deprecated.
Close the given Connection, obtained from the given ConnectionFactory,
if it is not managed externally (that is, not bound to the thread).
|
static void |
ConnectionFactoryUtils.releaseConnection(Connection con,
ConnectionFactory cf)
Deprecated.
Close the given Connection, obtained from the given ConnectionFactory,
if it is not managed externally (that is, not bound to the thread).
|
void |
CciLocalTransactionManager.setConnectionFactory(ConnectionFactory cf)
Deprecated.
Set the CCI ConnectionFactory that this instance should manage local
transactions for.
|
void |
DelegatingConnectionFactory.setTargetConnectionFactory(ConnectionFactory targetConnectionFactory)
Deprecated.
Set the target ConnectionFactory that this ConnectionFactory should delegate to.
|
Modifier and Type | Method and Description |
---|---|
protected <T> T |
CciTemplate.doExecute(InteractionSpec spec,
Record inputRecord,
Record outputRecord,
RecordExtractor<T> outputExtractor)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
T |
ConnectionCallback.doInConnection(Connection connection,
ConnectionFactory connectionFactory)
Deprecated.
Gets called by
CciTemplate.execute with an active CCI Connection. |
T |
InteractionCallback.doInInteraction(Interaction interaction,
ConnectionFactory connectionFactory)
Deprecated.
Gets called by
CciTemplate.execute with an active CCI Interaction. |
<T> T |
CciOperations.execute(ConnectionCallback<T> action)
Deprecated.
Execute a request on an EIS with CCI, implemented as callback action
working on a CCI Connection.
|
<T> T |
CciTemplate.execute(ConnectionCallback<T> action)
Deprecated.
|
<T> T |
CciOperations.execute(InteractionCallback<T> action)
Deprecated.
Execute a request on an EIS with CCI, implemented as callback action
working on a CCI Interaction.
|
<T> T |
CciTemplate.execute(InteractionCallback<T> action)
Deprecated.
|
Record |
CciOperations.execute(InteractionSpec spec,
Record inputRecord)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
Record |
CciTemplate.execute(InteractionSpec spec,
Record inputRecord)
Deprecated.
|
<T> T |
CciOperations.execute(InteractionSpec spec,
RecordCreator inputCreator,
RecordExtractor<T> outputExtractor)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
<T> T |
CciOperations.execute(InteractionSpec spec,
Record inputRecord,
RecordExtractor<T> outputExtractor)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
T |
RecordExtractor.extractData(Record record)
Deprecated.
Process the data in the given Record, creating a corresponding result object.
|
ConnectionFactory |
CciTemplate.getConnectionFactory()
Deprecated.
Return the CCI ConnectionFactory used by this template.
|
ConnectionSpec |
CciTemplate.getConnectionSpec()
Deprecated.
Return the CCI ConnectionSpec used by this template, if any.
|
RecordCreator |
CciTemplate.getOutputRecordCreator()
Deprecated.
Return a RecordCreator that should be used for creating default output Records.
|
Modifier and Type | Method and Description |
---|---|
protected <T> T |
CciTemplate.doExecute(InteractionSpec spec,
Record inputRecord,
Record outputRecord,
RecordExtractor<T> outputExtractor)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
protected <T> T |
CciTemplate.doExecute(InteractionSpec spec,
Record inputRecord,
Record outputRecord,
RecordExtractor<T> outputExtractor)
Deprecated.
Execute the specified interaction on an EIS with CCI.
|
void |
CciTemplate.setConnectionFactory(ConnectionFactory connectionFactory)
Deprecated.
Set the CCI ConnectionFactory to obtain Connections from.
|
void |
CciTemplate.setConnectionSpec(ConnectionSpec connectionSpec)
Deprecated.
Set the CCI ConnectionSpec that this template instance is
supposed to obtain Connections for.
|
void |
CciTemplate.setOutputRecordCreator(RecordCreator creator)
Deprecated.
Set a RecordCreator that should be used for creating default output Records.
|
Constructor and Description |
---|
CciTemplate(ConnectionFactory connectionFactory,
ConnectionSpec connectionSpec)
Deprecated.
Construct a new CciTemplate, given a ConnectionFactory to obtain Connections from.
|
Modifier and Type | Method and Description |
---|---|
CciTemplate |
CciDaoSupport.getCciTemplate()
Deprecated.
Return the CciTemplate for this DAO,
pre-initialized with the ConnectionFactory or set explicitly.
|
ConnectionFactory |
CciDaoSupport.getConnectionFactory()
Deprecated.
Return the ConnectionFactory used by this DAO.
|
Modifier and Type | Method and Description |
---|---|
Object |
MappingRecordOperation.execute(Object inputObject)
Deprecated.
Execute the interaction encapsulated by this operation object.
|
Record |
SimpleRecordOperation.execute(Record inputRecord)
Deprecated.
Execute the CCI interaction encapsulated by this operation object.
|
InteractionSpec |
EisOperation.getInteractionSpec()
Deprecated.
Return the CCI InteractionSpec for this operation.
|
Modifier and Type | Method and Description |
---|---|
void |
EisOperation.setInteractionSpec(InteractionSpec interactionSpec)
Deprecated.
Set the CCI InteractionSpec for this operation.
|
Modifier and Type | Method and Description |
---|---|
XAResource[] |
SpringContextResourceAdapter.getXAResources(ActivationSpec[] activationSpecs)
This implementation always returns
null . |
Modifier and Type | Method and Description |
---|---|
boolean |
SpringContextResourceAdapter.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
String |
AbstractMessageEndpointFactory.getActivationName()
Implementation of the JCA 1.7
#getActivationName() method,
returning the bean name as set on this MessageEndpointFactory. |
ActivationSpec |
GenericMessageEndpointManager.getActivationSpec()
Return the JCA ActivationSpec to use for activating the endpoint.
|
Class<?> |
AbstractMessageEndpointFactory.getEndpointClass()
Implementation of the JCA 1.7
#getEndpointClass() method,
returning null in order to indicate a synthetic endpoint type. |
MessageEndpointFactory |
GenericMessageEndpointManager.getMessageEndpointFactory()
Return the JCA MessageEndpointFactory to activate.
|
ResourceAdapter |
GenericMessageEndpointManager.getResourceAdapter()
Return the JCA ResourceAdapter to manage endpoints for.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractMessageEndpointFactory.AbstractMessageEndpoint.beforeDelivery(Method method)
This
beforeDelivery implementation starts a transaction,
if necessary, and exposes the endpoint ClassLoader as current
thread context ClassLoader. |
void |
GenericMessageEndpointManager.setActivationSpec(ActivationSpec activationSpec)
Set the JCA ActivationSpec to use for activating the endpoint.
|
void |
GenericMessageEndpointManager.setMessageEndpointFactory(MessageEndpointFactory messageEndpointFactory)
Set the JCA MessageEndpointFactory to activate, pointing to a
MessageListener object that the endpoints will delegate to.
|
void |
GenericMessageEndpointManager.setResourceAdapter(ResourceAdapter resourceAdapter)
Set the JCA ResourceAdapter to manage endpoints for.
|
Modifier and Type | Method and Description |
---|---|
ResourceAdapter |
ResourceAdapterFactoryBean.getObject() |
Object |
LocalConnectionFactoryBean.getObject() |
TransactionSynchronizationRegistry |
SimpleBootstrapContext.getTransactionSynchronizationRegistry() |
XATerminator |
SimpleBootstrapContext.getXATerminator() |
Constructor and Description |
---|
SimpleBootstrapContext(WorkManager workManager)
Create a new SimpleBootstrapContext for the given WorkManager,
with no XATerminator available.
|
SimpleBootstrapContext(WorkManager workManager,
XATerminator xaTerminator)
Create a new SimpleBootstrapContext for the given WorkManager and XATerminator.
|
SimpleBootstrapContext(WorkManager workManager,
XATerminator xaTerminator)
Create a new SimpleBootstrapContext for the given WorkManager and XATerminator.
|
SimpleBootstrapContext(WorkManager workManager,
XATerminator xaTerminator,
TransactionSynchronizationRegistry transactionSynchronizationRegistry)
Create a new SimpleBootstrapContext for the given WorkManager, XATerminator
and TransactionSynchronizationRegistry.
|
SimpleBootstrapContext(WorkManager workManager,
XATerminator xaTerminator,
TransactionSynchronizationRegistry transactionSynchronizationRegistry)
Create a new SimpleBootstrapContext for the given WorkManager, XATerminator
and TransactionSynchronizationRegistry.
|
SimpleBootstrapContext(WorkManager workManager,
XATerminator xaTerminator,
TransactionSynchronizationRegistry transactionSynchronizationRegistry)
Create a new SimpleBootstrapContext for the given WorkManager, XATerminator
and TransactionSynchronizationRegistry.
|
Modifier and Type | Method and Description |
---|---|
void |
SimpleTaskWorkManager.doWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
void |
SimpleTaskWorkManager.doWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
protected long |
SimpleTaskWorkManager.executeWork(TaskExecutor taskExecutor,
Work work,
long startTimeout,
boolean blockUntilStarted,
ExecutionContext executionContext,
WorkListener workListener)
Execute the given Work on the specified TaskExecutor.
|
protected long |
SimpleTaskWorkManager.executeWork(TaskExecutor taskExecutor,
Work work,
long startTimeout,
boolean blockUntilStarted,
ExecutionContext executionContext,
WorkListener workListener)
Execute the given Work on the specified TaskExecutor.
|
void |
SimpleTaskWorkManager.scheduleWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
void |
SimpleTaskWorkManager.scheduleWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
void |
WorkManagerTaskExecutor.setWorkListener(WorkListener workListener)
Specify a JCA WorkListener to apply, if any.
|
long |
SimpleTaskWorkManager.startWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
long |
SimpleTaskWorkManager.startWork(Work work,
long startTimeout,
ExecutionContext executionContext,
WorkListener workListener) |
Modifier and Type | Method and Description |
---|---|
String |
UncategorizedSQLException.getSql()
Return the SQL that led to the problem (if known).
|
String |
InvalidResultSetAccessException.getSql()
Return the SQL that caused the problem.
|
Constructor and Description |
---|
CannotGetJdbcConnectionException(String msg,
SQLException ex)
Constructor for
CannotGetJdbcConnectionException . |
UncategorizedSQLException(String task,
String sql,
SQLException ex)
Constructor for UncategorizedSQLException.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
SingleColumnRowMapper.convertValueToRequiredType(Object value,
Class<?> requiredType)
Convert the given column value to the specified required type.
|
T |
CallableStatementCallback.doInCallableStatement(CallableStatement cs)
Gets called by
JdbcTemplate.execute with an active JDBC
CallableStatement. |
T |
ConnectionCallback.doInConnection(Connection con)
Gets called by
JdbcTemplate.execute with an active JDBC
Connection. |
T |
PreparedStatementCallback.doInPreparedStatement(PreparedStatement ps)
Gets called by
JdbcTemplate.execute with an active JDBC
PreparedStatement. |
T |
StatementCallback.doInStatement(Statement stmt)
Gets called by
JdbcTemplate.execute with an active JDBC
Statement. |
<T> T |
JdbcOperations.execute(CallableStatementCreator csc,
CallableStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC CallableStatement.
|
<T> T |
JdbcTemplate.execute(CallableStatementCreator csc,
CallableStatementCallback<T> action) |
<T> T |
JdbcOperations.execute(ConnectionCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC Connection.
|
<T> T |
JdbcTemplate.execute(ConnectionCallback<T> action) |
<T> T |
JdbcOperations.execute(PreparedStatementCreator psc,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
<T> T |
JdbcTemplate.execute(PreparedStatementCreator psc,
PreparedStatementCallback<T> action) |
<T> T |
JdbcOperations.execute(StatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC Statement.
|
<T> T |
JdbcTemplate.execute(StatementCallback<T> action) |
<T> T |
JdbcOperations.execute(String callString,
CallableStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC CallableStatement.
|
<T> T |
JdbcTemplate.execute(String callString,
CallableStatementCallback<T> action) |
<T> T |
JdbcOperations.execute(String sql,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
<T> T |
JdbcTemplate.execute(String sql,
PreparedStatementCallback<T> action) |
T |
ResultSetExtractor.extractData(ResultSet rs)
Implementations must implement this method to process the entire ResultSet.
|
String[] |
RowCountCallbackHandler.getColumnNames()
Return the names of the columns.
|
int[] |
RowCountCallbackHandler.getColumnTypes()
Return the types of the columns as java.sql.Types constants
Valid after processRow is invoked the first time.
|
protected Object |
ColumnMapRowMapper.getColumnValue(ResultSet rs,
int index)
Retrieve a JDBC object value for the specified column.
|
protected Object |
SingleColumnRowMapper.getColumnValue(ResultSet rs,
int index)
Retrieve a JDBC object value for the specified column, using the most
appropriate value type.
|
protected Object |
BeanPropertyRowMapper.getColumnValue(ResultSet rs,
int index,
Class<?> paramType)
Retrieve a JDBC object value for the specified column.
|
protected Object |
SingleColumnRowMapper.getColumnValue(ResultSet rs,
int index,
Class<?> requiredType)
Retrieve a JDBC object value for the specified column.
|
protected Object |
BeanPropertyRowMapper.getColumnValue(ResultSet rs,
int index,
PropertyDescriptor pd)
Retrieve a JDBC object value for the specified column.
|
ConversionService |
BeanPropertyRowMapper.getConversionService()
Return a
ConversionService for binding JDBC values to bean properties,
or null if none. |
Class<T> |
BeanPropertyRowMapper.getMappedClass()
Get the class that we are mapping to.
|
String |
SqlParameter.getName()
Return the name of the parameter, or
null if anonymous. |
ResultSetExtractor<?> |
ResultSetSupportingSqlParameter.getResultSetExtractor()
Return the ResultSetExtractor held by this parameter, if any.
|
RowCallbackHandler |
ResultSetSupportingSqlParameter.getRowCallbackHandler()
Return the RowCallbackHandler held by this parameter, if any.
|
RowMapper<?> |
ResultSetSupportingSqlParameter.getRowMapper()
Return the RowMapper held by this parameter, if any.
|
Integer |
SqlParameter.getScale()
Return the scale of the parameter, if any.
|
String |
SqlProvider.getSql()
Return the SQL string for this object, i.e.
|
SqlReturnType |
SqlOutParameter.getSqlReturnType()
Return the custom return type, if any.
|
String |
SqlParameter.getTypeName()
Return the type name of the parameter, if any.
|
Object |
SqlParameterValue.getValue()
Return the value object that this parameter value holds.
|
T |
RowMapper.mapRow(ResultSet rs,
int rowNum)
Implementations must implement this method to map each row of data in the
ResultSet . |
T |
SingleColumnRowMapper.mapRow(ResultSet rs,
int rowNum)
Extract a value for the single column in the current row.
|
<T> T |
JdbcTemplate.query(PreparedStatementCreator psc,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, allowing for a PreparedStatementCreator
and a PreparedStatementSetter.
|
<T> T |
JdbcOperations.query(PreparedStatementCreator psc,
ResultSetExtractor<T> rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(PreparedStatementCreator psc,
ResultSetExtractor<T> rse) |
<T> T |
JdbcOperations.query(String sql,
Object[] args,
int[] argTypes,
ResultSetExtractor<T> rse)
Query given SQL to create a prepared statement from SQL and a list of arguments
to bind to the query, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
Object[] args,
int[] argTypes,
ResultSetExtractor<T> rse) |
<T> T |
JdbcOperations.query(String sql,
Object[] args,
ResultSetExtractor<T> rse)
Deprecated.
as of 5.3, in favor of
JdbcOperations.query(String, ResultSetExtractor, Object...) |
<T> T |
JdbcTemplate.query(String sql,
Object[] args,
ResultSetExtractor<T> rse)
Deprecated.
|
<T> T |
JdbcOperations.query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse) |
<T> T |
JdbcOperations.query(String sql,
ResultSetExtractor<T> rse)
Execute a query given static SQL, reading the ResultSet with a
ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
ResultSetExtractor<T> rse) |
<T> T |
JdbcOperations.query(String sql,
ResultSetExtractor<T> rse,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of arguments
to bind to the query, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
ResultSetExtractor<T> rse,
Object... args) |
<T> T |
JdbcOperations.queryForObject(String sql,
Class<T> requiredType)
Execute a query for a result object, given static SQL.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
Class<T> requiredType) |
<T> T |
JdbcOperations.queryForObject(String sql,
Class<T> requiredType,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result object.
|
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
Class<T> requiredType)
Deprecated.
as of 5.3, in favor of
JdbcOperations.queryForObject(String, Class, Object...) |
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
int[] argTypes,
Class<T> requiredType)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result object.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
Object[] args,
int[] argTypes,
Class<T> requiredType) |
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
int[] argTypes,
RowMapper<T> rowMapper)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, mapping a single result row to a
result object via a RowMapper.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
Object[] args,
int[] argTypes,
RowMapper<T> rowMapper) |
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
as of 5.3, in favor of
JdbcOperations.queryForObject(String, RowMapper, Object...) |
<T> T |
JdbcTemplate.queryForObject(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
|
<T> T |
JdbcOperations.queryForObject(String sql,
RowMapper<T> rowMapper)
Execute a query given static SQL, mapping a single result row to a
result object via a RowMapper.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
RowMapper<T> rowMapper) |
<T> T |
JdbcOperations.queryForObject(String sql,
RowMapper<T> rowMapper,
Object... args)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, mapping a single result row to a
result object via a RowMapper.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
RowMapper<T> rowMapper,
Object... args) |
Modifier and Type | Method and Description |
---|---|
static void |
StatementCreatorUtils.cleanupParameters(Collection<?> paramValues)
Clean up all resources held by parameter values which were passed to an
execute method.
|
static void |
StatementCreatorUtils.cleanupParameters(Object... paramValues)
Clean up all resources held by parameter values which were passed to an
execute method.
|
protected Map<String,Object> |
JdbcTemplate.extractReturnedResults(CallableStatement cs,
List<SqlParameter> updateCountParameters,
List<SqlParameter> resultSetParameters,
int updateCount)
Extract returned ResultSets from the completed stored procedure.
|
protected Map<String,Object> |
JdbcTemplate.extractReturnedResults(CallableStatement cs,
List<SqlParameter> updateCountParameters,
List<SqlParameter> resultSetParameters,
int updateCount)
Extract returned ResultSets from the completed stored procedure.
|
protected Object |
SingleColumnRowMapper.getColumnValue(ResultSet rs,
int index,
Class<?> requiredType)
Retrieve a JDBC object value for the specified column.
|
Object |
SqlReturnType.getTypeValue(CallableStatement cs,
int paramIndex,
int sqlType,
String typeName)
Get the type value from the specific object.
|
protected void |
JdbcTemplate.handleWarnings(SQLWarning warning)
Throw a
SQLWarningException if encountering an actual warning. |
static int |
StatementCreatorUtils.javaTypeToSqlParameterType(Class<?> javaType)
Derive a default SQL type from the given Java type.
|
protected PreparedStatementSetter |
JdbcTemplate.newArgPreparedStatementSetter(Object[] args)
Create a new arg-based PreparedStatementSetter using the args passed in.
|
CallableStatementCreator |
CallableStatementCreatorFactory.newCallableStatementCreator(Map<String,?> params)
Return a new CallableStatementCreator instance given these parameters.
|
static <T> DataClassRowMapper<T> |
DataClassRowMapper.newInstance(Class<T> mappedClass,
ConversionService conversionService)
Static factory method to create a new
DataClassRowMapper . |
static <T> BeanPropertyRowMapper<T> |
BeanPropertyRowMapper.newInstance(Class<T> mappedClass,
ConversionService conversionService)
Static factory method to create a new
BeanPropertyRowMapper . |
static <T> SingleColumnRowMapper<T> |
SingleColumnRowMapper.newInstance(Class<T> requiredType,
ConversionService conversionService)
Static factory method to create a new
SingleColumnRowMapper . |
PreparedStatementCreator |
PreparedStatementCreatorFactory.newPreparedStatementCreator(List<?> params)
Return a new PreparedStatementCreator for the given parameters.
|
PreparedStatementCreator |
PreparedStatementCreatorFactory.newPreparedStatementCreator(Object[] params)
Return a new PreparedStatementCreator for the given parameters.
|
PreparedStatementCreator |
PreparedStatementCreatorFactory.newPreparedStatementCreator(String sqlToUse,
Object[] params)
Return a new PreparedStatementCreator for the given parameters.
|
PreparedStatementSetter |
PreparedStatementCreatorFactory.newPreparedStatementSetter(List<?> params)
Return a new PreparedStatementSetter for the given parameters.
|
PreparedStatementSetter |
PreparedStatementCreatorFactory.newPreparedStatementSetter(Object[] params)
Return a new PreparedStatementSetter for the given parameters.
|
protected Map<String,Object> |
JdbcTemplate.processResultSet(ResultSet rs,
ResultSetSupportingSqlParameter param)
Process the given ResultSet from a stored procedure.
|
<T> T |
JdbcTemplate.query(PreparedStatementCreator psc,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, allowing for a PreparedStatementCreator
and a PreparedStatementSetter.
|
<T> T |
JdbcOperations.query(String sql,
Object[] args,
ResultSetExtractor<T> rse)
Deprecated.
as of 5.3, in favor of
JdbcOperations.query(String, ResultSetExtractor, Object...) |
<T> T |
JdbcTemplate.query(String sql,
Object[] args,
ResultSetExtractor<T> rse)
Deprecated.
|
void |
JdbcOperations.query(String sql,
Object[] args,
RowCallbackHandler rch)
Deprecated.
as of 5.3, in favor of
JdbcOperations.query(String, RowCallbackHandler, Object...) |
void |
JdbcTemplate.query(String sql,
Object[] args,
RowCallbackHandler rch)
Deprecated.
|
<T> List<T> |
JdbcOperations.query(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
as of 5.3, in favor of
JdbcOperations.query(String, RowMapper, Object...) |
<T> List<T> |
JdbcTemplate.query(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
|
<T> T |
JdbcOperations.query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse)
Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
PreparedStatementSetter pss,
ResultSetExtractor<T> rse) |
void |
JdbcOperations.query(String sql,
PreparedStatementSetter pss,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a
PreparedStatementSetter implementation that knows how to bind values to the
query, reading the ResultSet on a per-row basis with a RowCallbackHandler.
|
void |
JdbcTemplate.query(String sql,
PreparedStatementSetter pss,
RowCallbackHandler rch) |
<T> List<T> |
JdbcOperations.query(String sql,
PreparedStatementSetter pss,
RowMapper<T> rowMapper)
Query given SQL to create a prepared statement from SQL and a
PreparedStatementSetter implementation that knows how to bind values
to the query, mapping each row to a result object via a RowMapper.
|
<T> List<T> |
JdbcTemplate.query(String sql,
PreparedStatementSetter pss,
RowMapper<T> rowMapper) |
<T> T |
JdbcOperations.query(String sql,
ResultSetExtractor<T> rse,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of arguments
to bind to the query, reading the ResultSet with a ResultSetExtractor.
|
<T> T |
JdbcTemplate.query(String sql,
ResultSetExtractor<T> rse,
Object... args) |
void |
JdbcOperations.query(String sql,
RowCallbackHandler rch,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, reading the ResultSet on a per-row basis
with a RowCallbackHandler.
|
void |
JdbcTemplate.query(String sql,
RowCallbackHandler rch,
Object... args) |
<T> List<T> |
JdbcOperations.query(String sql,
RowMapper<T> rowMapper,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, mapping each row to a result object
via a RowMapper.
|
<T> List<T> |
JdbcTemplate.query(String sql,
RowMapper<T> rowMapper,
Object... args) |
<T> List<T> |
JdbcOperations.queryForList(String sql,
Class<T> elementType,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result list.
|
<T> List<T> |
JdbcTemplate.queryForList(String sql,
Class<T> elementType,
Object... args) |
List<Map<String,Object>> |
JdbcOperations.queryForList(String sql,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result list.
|
List<Map<String,Object>> |
JdbcTemplate.queryForList(String sql,
Object... args) |
<T> List<T> |
JdbcOperations.queryForList(String sql,
Object[] args,
Class<T> elementType)
Deprecated.
as of 5.3, in favor of
JdbcOperations.queryForList(String, Class, Object...) |
<T> List<T> |
JdbcTemplate.queryForList(String sql,
Object[] args,
Class<T> elementType)
Deprecated.
|
Map<String,Object> |
JdbcOperations.queryForMap(String sql,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result map.
|
Map<String,Object> |
JdbcTemplate.queryForMap(String sql,
Object... args) |
<T> T |
JdbcOperations.queryForObject(String sql,
Class<T> requiredType,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting a result object.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
Class<T> requiredType,
Object... args) |
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
Class<T> requiredType)
Deprecated.
as of 5.3, in favor of
JdbcOperations.queryForObject(String, Class, Object...) |
<T> T |
JdbcTemplate.queryForObject(String sql,
Object[] args,
Class<T> requiredType)
Deprecated.
|
<T> T |
JdbcOperations.queryForObject(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
as of 5.3, in favor of
JdbcOperations.queryForObject(String, RowMapper, Object...) |
<T> T |
JdbcTemplate.queryForObject(String sql,
Object[] args,
RowMapper<T> rowMapper)
Deprecated.
|
<T> T |
JdbcOperations.queryForObject(String sql,
RowMapper<T> rowMapper,
Object... args)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, mapping a single result row to a
result object via a RowMapper.
|
<T> T |
JdbcTemplate.queryForObject(String sql,
RowMapper<T> rowMapper,
Object... args) |
SqlRowSet |
JdbcOperations.queryForRowSet(String sql,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, expecting an SqlRowSet.
|
SqlRowSet |
JdbcTemplate.queryForRowSet(String sql,
Object... args) |
<T> Stream<T> |
JdbcTemplate.queryForStream(PreparedStatementCreator psc,
PreparedStatementSetter pss,
RowMapper<T> rowMapper)
Query using a prepared statement, allowing for a PreparedStatementCreator
and a PreparedStatementSetter.
|
<T> Stream<T> |
JdbcOperations.queryForStream(String sql,
PreparedStatementSetter pss,
RowMapper<T> rowMapper)
Query given SQL to create a prepared statement from SQL and a
PreparedStatementSetter implementation that knows how to bind values
to the query, mapping each row to a result object via a RowMapper,
and turning it into an iterable and closeable Stream.
|
<T> Stream<T> |
JdbcTemplate.queryForStream(String sql,
PreparedStatementSetter pss,
RowMapper<T> rowMapper) |
<T> Stream<T> |
JdbcOperations.queryForStream(String sql,
RowMapper<T> rowMapper,
Object... args)
Query given SQL to create a prepared statement from SQL and a list of
arguments to bind to the query, mapping each row to a result object
via a RowMapper, and turning it into an iterable and closeable Stream.
|
<T> Stream<T> |
JdbcTemplate.queryForStream(String sql,
RowMapper<T> rowMapper,
Object... args) |
void |
BeanPropertyRowMapper.setConversionService(ConversionService conversionService)
Set a
ConversionService for binding JDBC values to bean properties,
or null for none. |
void |
SingleColumnRowMapper.setConversionService(ConversionService conversionService)
Set a
ConversionService for converting a fetched value. |
static void |
StatementCreatorUtils.setParameterValue(PreparedStatement ps,
int paramIndex,
int sqlType,
Object inValue)
Set the value for a parameter.
|
static void |
StatementCreatorUtils.setParameterValue(PreparedStatement ps,
int paramIndex,
int sqlType,
String typeName,
Object inValue)
Set the value for a parameter.
|
static void |
StatementCreatorUtils.setParameterValue(PreparedStatement ps,
int paramIndex,
SqlParameter param,
Object inValue)
Set the value for a parameter.
|
protected static void |
BatchUpdateUtils.setStatementParameters(Object[] values,
PreparedStatement ps,
int[] columnTypes)
Deprecated.
|
void |
SqlTypeValue.setTypeValue(PreparedStatement ps,
int paramIndex,
int sqlType,
String typeName)
Set the type value on the given PreparedStatement.
|
static List<SqlParameter> |
SqlParameter.sqlTypesToAnonymousParameterList(int... types)
Convert a list of JDBC types, as defined in
java.sql.Types ,
to a List of SqlParameter objects as used in this package. |
protected DataAccessException |
JdbcTemplate.translateException(String task,
String sql,
SQLException ex)
Translate the given
SQLException into a generic DataAccessException . |
protected int |
JdbcTemplate.update(PreparedStatementCreator psc,
PreparedStatementSetter pss) |
int |
JdbcOperations.update(String sql,
Object... args)
Issue a single SQL update operation (such as an insert, update or delete statement)
via a prepared statement, binding the given arguments.
|
int |
JdbcTemplate.update(String sql,
Object... args) |
int |
JdbcOperations.update(String sql,
PreparedStatementSetter pss)
Issue an update statement using a PreparedStatementSetter to set bind parameters,
with given SQL.
|
int |
JdbcTemplate.update(String sql,
PreparedStatementSetter pss) |
Constructor and Description |
---|
ArgumentPreparedStatementSetter(Object[] args)
Create a new ArgPreparedStatementSetter for the given arguments.
|
ArgumentTypePreparedStatementSetter(Object[] args,
int[] argTypes)
Create a new ArgTypePreparedStatementSetter for the given arguments.
|
ArgumentTypePreparedStatementSetter(Object[] args,
int[] argTypes)
Create a new ArgTypePreparedStatementSetter for the given arguments.
|
ResultSetSupportingSqlParameter(String name,
int sqlType,
String typeName)
Create a new ResultSetSupportingSqlParameter.
|
SqlOutParameter(String name,
int sqlType,
String typeName)
Create a new SqlOutParameter.
|
SqlOutParameter(String name,
int sqlType,
String typeName,
SqlReturnType sqlReturnType)
Create a new SqlOutParameter.
|
SqlOutParameter(String name,
int sqlType,
String typeName,
SqlReturnType sqlReturnType)
Create a new SqlOutParameter.
|
SqlParameter(int sqlType,
String typeName)
Create a new anonymous SqlParameter, supplying the SQL type.
|
SqlParameter(String name,
int sqlType,
String typeName)
Create a new SqlParameter, supplying name and SQL type.
|
SqlParameterValue(int sqlType,
int scale,
Object value)
Create a new SqlParameterValue, supplying the SQL type.
|
SqlParameterValue(int sqlType,
Object value)
Create a new SqlParameterValue, supplying the SQL type.
|
SqlParameterValue(int sqlType,
String typeName,
Object value)
Create a new SqlParameterValue, supplying the SQL type.
|
SqlParameterValue(int sqlType,
String typeName,
Object value)
Create a new SqlParameterValue, supplying the SQL type.
|
SqlParameterValue(SqlParameter declaredParam,
Object value)
Create a new SqlParameterValue based on the given SqlParameter declaration.
|
Modifier and Type | Method and Description |
---|---|
String |
CallMetaDataProvider.catalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.catalogNameToUse(String catalogName)
Get the catalog name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.catalogNameToUse(String catalogName) |
String |
GenericCallMetaDataProvider.catalogNameToUse(String catalogName) |
String |
TableMetaDataContext.getCatalogName()
Get the name of the catalog for this context.
|
String |
CallMetaDataContext.getCatalogName()
Get the name of the catalog.
|
protected String |
GenericTableMetaDataProvider.getDatabaseVersion()
Provide access to version info for subclasses.
|
protected String |
OracleTableMetaDataProvider.getDefaultSchema() |
protected String |
GenericTableMetaDataProvider.getDefaultSchema()
Provide access to default schema for subclasses.
|
String |
CallParameterMetaData.getParameterName()
Return the parameter name.
|
String |
CallMetaDataContext.getProcedureName()
Get the name of the procedure.
|
String |
CallMetaDataContext.getScalarOutParameterName()
Get the name of the single out parameter for this call.
|
String |
TableMetaDataContext.getSchemaName()
Get the name of the schema for this context.
|
String |
CallMetaDataContext.getSchemaName()
Get the name of the schema.
|
String |
TableMetaDataContext.getSimpleQueryForGetGeneratedKey(String tableName,
String keyColumnName)
Does this database support a simple query to retrieve generated keys
when the JDBC 3.0 feature is not supported:
DatabaseMetaData.supportsGetGeneratedKeys() ? |
String |
TableMetaDataProvider.getSimpleQueryForGetGeneratedKey(String tableName,
String keyColumnName)
Get the simple query to retrieve a generated key.
|
String |
GenericTableMetaDataProvider.getSimpleQueryForGetGeneratedKey(String tableName,
String keyColumnName) |
String |
TableMetaDataContext.getSimulationQueryForGetGeneratedKey(String tableName,
String keyColumnName)
Deprecated.
as of 4.3.15, in favor of
TableMetaDataContext.getSimpleQueryForGetGeneratedKey(java.lang.String, java.lang.String) |
String |
TableMetaDataContext.getTableName()
Get the name of the table for this context.
|
String |
CallParameterMetaData.getTypeName()
Return the parameter type name.
|
String |
CallMetaDataProvider.getUserName()
Get the name of the current user.
|
String |
OracleCallMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
CallMetaDataProvider.metaDataCatalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.metaDataCatalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
GenericTableMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
GenericCallMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
PostgresCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
DerbyCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
OracleCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
Db2CallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
CallMetaDataProvider.metaDataSchemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.metaDataSchemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
GenericTableMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
GenericCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
SqlServerCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
SybaseCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
CallMetaDataProvider.parameterNameToUse(String parameterName)
Provide any modification of the column name passed in to match the meta-data currently used.
|
String |
GenericCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
CallMetaDataProvider.procedureNameToUse(String procedureName)
Provide any modification of the procedure name passed in to match the meta-data currently used.
|
String |
GenericCallMetaDataProvider.procedureNameToUse(String procedureName) |
String |
CallMetaDataProvider.schemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.schemaNameToUse(String schemaName)
Get the schema name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.schemaNameToUse(String schemaName) |
String |
GenericCallMetaDataProvider.schemaNameToUse(String schemaName) |
String |
TableMetaDataProvider.tableNameToUse(String tableName)
Get the table name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.tableNameToUse(String tableName) |
Modifier and Type | Method and Description |
---|---|
String |
CallMetaDataProvider.catalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.catalogNameToUse(String catalogName)
Get the catalog name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.catalogNameToUse(String catalogName) |
String |
GenericCallMetaDataProvider.catalogNameToUse(String catalogName) |
void |
CallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName)
Initialize the database specific management of procedure column meta-data.
|
void |
CallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName)
Initialize the database specific management of procedure column meta-data.
|
void |
CallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName)
Initialize the database specific management of procedure column meta-data.
|
void |
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName) |
void |
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName) |
void |
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String procedureName) |
void |
OracleTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
void |
OracleTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
void |
OracleTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
void |
TableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName)
Initialize using provided database meta-data, table and column information.
|
void |
TableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName)
Initialize using provided database meta-data, table and column information.
|
void |
TableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName)
Initialize using provided database meta-data, table and column information.
|
void |
GenericTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
void |
GenericTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
void |
GenericTableMetaDataProvider.initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData,
String catalogName,
String schemaName,
String tableName) |
String |
OracleCallMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
CallMetaDataProvider.metaDataCatalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.metaDataCatalogNameToUse(String catalogName)
Provide any modification of the catalog name passed in to match the meta-data currently used.
|
String |
GenericTableMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
GenericCallMetaDataProvider.metaDataCatalogNameToUse(String catalogName) |
String |
PostgresCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
DerbyCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
OracleCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
Db2CallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
CallMetaDataProvider.metaDataSchemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.metaDataSchemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
GenericTableMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
GenericCallMetaDataProvider.metaDataSchemaNameToUse(String schemaName) |
String |
SqlServerCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
SybaseCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
CallMetaDataProvider.parameterNameToUse(String parameterName)
Provide any modification of the column name passed in to match the meta-data currently used.
|
String |
GenericCallMetaDataProvider.parameterNameToUse(String parameterName) |
String |
CallMetaDataProvider.procedureNameToUse(String procedureName)
Provide any modification of the procedure name passed in to match the meta-data currently used.
|
String |
GenericCallMetaDataProvider.procedureNameToUse(String procedureName) |
String |
CallMetaDataProvider.schemaNameToUse(String schemaName)
Provide any modification of the schema name passed in to match the meta-data currently used.
|
String |
TableMetaDataProvider.schemaNameToUse(String schemaName)
Get the schema name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.schemaNameToUse(String schemaName) |
String |
GenericCallMetaDataProvider.schemaNameToUse(String schemaName) |
void |
TableMetaDataContext.setCatalogName(String catalogName)
Set the name of the catalog for this context.
|
void |
CallMetaDataContext.setCatalogName(String catalogName)
Specify the name of the catalog.
|
void |
CallMetaDataContext.setProcedureName(String procedureName)
Specify the name of the procedure.
|
void |
TableMetaDataContext.setSchemaName(String schemaName)
Set the name of the schema for this context.
|
void |
CallMetaDataContext.setSchemaName(String schemaName)
Specify the name of the schema.
|
void |
TableMetaDataContext.setTableName(String tableName)
Set the name of the table for this context.
|
String |
TableMetaDataProvider.tableNameToUse(String tableName)
Get the table name formatted based on meta-data information.
|
String |
GenericTableMetaDataProvider.tableNameToUse(String tableName) |
Constructor and Description |
---|
CallParameterMetaData(boolean function,
String columnName,
int columnType,
int sqlType,
String typeName,
boolean nullable)
Constructor taking all the properties including the function marker.
|
CallParameterMetaData(boolean function,
String columnName,
int columnType,
int sqlType,
String typeName,
boolean nullable)
Constructor taking all the properties including the function marker.
|
CallParameterMetaData(String columnName,
int columnType,
int sqlType,
String typeName,
boolean nullable)
Deprecated.
|
CallParameterMetaData(String columnName,
int columnType,
int sqlType,
String typeName,
boolean nullable)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
NamedParameterJdbcTemplate.execute(String sql,
Map<String,?> paramMap,
PreparedStatementCallback<T> action) |
<T> T |
NamedParameterJdbcOperations.execute(String sql,
Map<String,?> paramMap,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
<T> T |
NamedParameterJdbcTemplate.execute(String sql,
PreparedStatementCallback<T> action) |
<T> T |
NamedParameterJdbcOperations.execute(String sql,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
<T> T |
NamedParameterJdbcTemplate.execute(String sql,
SqlParameterSource paramSource,
PreparedStatementCallback<T> action) |
<T> T |
NamedParameterJdbcOperations.execute(String sql,
SqlParameterSource paramSource,
PreparedStatementCallback<T> action)
Execute a JDBC data access operation, implemented as callback action
working on a JDBC PreparedStatement.
|
NamedParameterJdbcTemplate |
NamedParameterJdbcDaoSupport.getNamedParameterJdbcTemplate()
Return a NamedParameterJdbcTemplate wrapping the configured JdbcTemplate.
|
String[] |
EmptySqlParameterSource.getParameterNames() |
default String[] |
SqlParameterSource.getParameterNames()
Enumerate all available parameter names if possible.
|
static Object |
SqlParameterSourceUtils.getTypedValue(SqlParameterSource source,
String parameterName)
Create a wrapped value if parameter has type information, plain object if not.
|
String |
AbstractSqlParameterSource.getTypeName(String paramName)
Return the type name for the given parameter, if registered.
|
String |
EmptySqlParameterSource.getTypeName(String paramName) |
default String |
SqlParameterSource.getTypeName(String paramName)
Determine the type name for the specified named parameter.
|
Object |
BeanPropertySqlParameterSource.getValue(String paramName) |
Object |
EmptySqlParameterSource.getValue(String paramName) |
Object |
MapSqlParameterSource.getValue(String paramName) |
Object |
SqlParameterSource.getValue(String paramName)
Return the parameter value for the requested named parameter.
|
<T> T |
NamedParameterJdbcTemplate.query(String sql,
Map<String,?> paramMap,
ResultSetExtractor<T> rse) |
<T> T |
NamedParameterJdbcOperations.query(String sql,
Map<String,?> paramMap,
ResultSetExtractor<T> rse)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, reading the ResultSet with a
ResultSetExtractor.
|
<T> T |
NamedParameterJdbcTemplate.query(String sql,
ResultSetExtractor<T> rse) |
<T> T |
NamedParameterJdbcOperations.query(String sql,
ResultSetExtractor<T> rse)
Query given SQL to create a prepared statement from SQL,
reading the ResultSet with a ResultSetExtractor.
|
<T> T |
NamedParameterJdbcTemplate.query(String sql,
SqlParameterSource paramSource,
ResultSetExtractor<T> rse) |
<T> T |
NamedParameterJdbcOperations.query(String sql,
SqlParameterSource paramSource,
ResultSetExtractor<T> rse)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, reading the ResultSet with a
ResultSetExtractor.
|
<T> T |
NamedParameterJdbcTemplate.queryForObject(String sql,
Map<String,?> paramMap,
Class<T> requiredType) |
<T> T |
NamedParameterJdbcOperations.queryForObject(String sql,
Map<String,?> paramMap,
Class<T> requiredType)
Query given SQL to create a prepared statement from SQL and a
list of arguments to bind to the query, expecting a result object.
|
<T> T |
NamedParameterJdbcTemplate.queryForObject(String sql,
Map<String,?> paramMap,
RowMapper<T> rowMapper) |
<T> T |
NamedParameterJdbcOperations.queryForObject(String sql,
Map<String,?> paramMap,
RowMapper<T> rowMapper)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, mapping a single result row to a
Java object via a RowMapper.
|
<T> T |
NamedParameterJdbcTemplate.queryForObject(String sql,
SqlParameterSource paramSource,
Class<T> requiredType) |
<T> T |
NamedParameterJdbcOperations.queryForObject(String sql,
SqlParameterSource paramSource,
Class<T> requiredType)
Query given SQL to create a prepared statement from SQL and a
list of arguments to bind to the query, expecting a result object.
|
<T> T |
NamedParameterJdbcTemplate.queryForObject(String sql,
SqlParameterSource paramSource,
RowMapper<T> rowMapper) |
<T> T |
NamedParameterJdbcOperations.queryForObject(String sql,
SqlParameterSource paramSource,
RowMapper<T> rowMapper)
Query given SQL to create a prepared statement from SQL and a list
of arguments to bind to the query, mapping a single result row to a
Java object via a RowMapper.
|
Modifier and Type | Method and Description |
---|---|
MapSqlParameterSource |
MapSqlParameterSource.addValue(String paramName,
Object value)
Add a parameter to this parameter source.
|
MapSqlParameterSource |
MapSqlParameterSource.addValue(String paramName,
Object value,
int sqlType)
Add a parameter to this parameter source.
|
MapSqlParameterSource |
MapSqlParameterSource.addValue(String paramName,
Object value,
int sqlType,
String typeName)
Add a parameter to this parameter source.
|
MapSqlParameterSource |
MapSqlParameterSource.addValues(Map<String,?> values)
Add a Map of parameters to this parameter source.
|
static Object[] |
NamedParameterUtils.buildValueArray(ParsedSql parsedSql,
SqlParameterSource paramSource,
List<SqlParameter> declaredParams)
Convert a Map of named parameter values to a corresponding array.
|
protected PreparedStatementCreator |
NamedParameterJdbcTemplate.getPreparedStatementCreator(String sql,
SqlParameterSource paramSource,
Consumer<PreparedStatementCreatorFactory> customizer)
Build a
PreparedStatementCreator based on the given SQL and named parameters. |
static String |
NamedParameterUtils.substituteNamedParameters(ParsedSql parsedSql,
SqlParameterSource paramSource)
Parse the SQL statement and locate any placeholders or named parameters.
|
int |
NamedParameterJdbcTemplate.update(String sql,
SqlParameterSource paramSource,
KeyHolder generatedKeyHolder,
String[] keyColumnNames) |
Constructor and Description |
---|
MapSqlParameterSource(Map<String,?> values)
Create a new MapSqlParameterSource based on a Map.
|
MapSqlParameterSource(String paramName,
Object value)
Create a new MapSqlParameterSource, with one value
comprised of the supplied arguments.
|
Modifier and Type | Method and Description |
---|---|
String |
AbstractJdbcCall.getCallString()
Get the call string that should be used based on parameters and meta-data.
|
String |
AbstractJdbcCall.getCatalogName()
Get the catalog name used.
|
String |
AbstractJdbcInsert.getCatalogName()
Get the name of the catalog for this insert.
|
String |
AbstractJdbcCall.getProcedureName()
Get the name of the stored procedure.
|
protected String |
AbstractJdbcCall.getScalarOutParameterName()
Get the name of a single out parameter or return value.
|
String |
AbstractJdbcCall.getSchemaName()
Get the schema name used.
|
String |
AbstractJdbcInsert.getSchemaName()
Get the name of the schema for this insert.
|
String |
AbstractJdbcInsert.getTableName()
Get the name of the table for this insert.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractJdbcCall.setCatalogName(String catalogName)
Set the catalog name to use.
|
void |
AbstractJdbcInsert.setCatalogName(String catalogName)
Set the name of the catalog for this insert.
|
void |
AbstractJdbcCall.setProcedureName(String procedureName)
Set the name of the stored procedure.
|
void |
AbstractJdbcCall.setSchemaName(String schemaName)
Set the schema name to use.
|
void |
AbstractJdbcInsert.setSchemaName(String schemaName)
Set the name of the schema for this insert.
|
void |
AbstractJdbcInsert.setTableName(String tableName)
Set the name of the table for this insert.
|
Modifier and Type | Method and Description |
---|---|
T |
AbstractLobStreamingResultSetExtractor.extractData(ResultSet rs)
Delegates to handleNoRowFound, handleMultipleRowsFound and streamData,
according to the ResultSet state.
|
DataSource |
JdbcDaoSupport.getDataSource()
Return the JDBC DataSource used by this DAO.
|
JdbcTemplate |
JdbcDaoSupport.getJdbcTemplate()
Return the JdbcTemplate for this DAO,
pre-initialized with the DataSource or set explicitly.
|
Modifier and Type | Method and Description |
---|---|
protected abstract Object |
AbstractSqlTypeValue.createTypeValue(Connection con,
int sqlType,
String typeName)
Create the type value to be passed into
PreparedStatement.setObject . |
void |
JdbcDaoSupport.setJdbcTemplate(JdbcTemplate jdbcTemplate)
Set the JdbcTemplate for this DAO explicitly,
as an alternative to specifying a DataSource.
|
void |
AbstractSqlTypeValue.setTypeValue(PreparedStatement ps,
int paramIndex,
int sqlType,
String typeName) |
void |
SqlLobValue.setTypeValue(PreparedStatement ps,
int paramIndex,
int sqlType,
String typeName)
Set the specified content via the LobCreator.
|
Constructor and Description |
---|
SqlLobValue(byte[] bytes)
Create a new BLOB value with the given byte array,
using a DefaultLobHandler.
|
SqlLobValue(byte[] bytes,
LobHandler lobHandler)
Create a new BLOB value with the given byte array.
|
SqlLobValue(String content)
Create a new CLOB value with the given content string,
using a DefaultLobHandler.
|
SqlLobValue(String content,
LobHandler lobHandler)
Create a new CLOB value with the given content string.
|
Modifier and Type | Method and Description |
---|---|
protected Boolean |
LazyConnectionDataSourceProxy.defaultAutoCommit()
Expose the default auto-commit value.
|
protected Integer |
LazyConnectionDataSourceProxy.defaultTransactionIsolation()
Expose the default transaction isolation value.
|
protected Boolean |
SingleConnectionDataSource.getAutoCommitValue()
Return whether the returned Connection's "autoCommit" setting should be overridden.
|
String |
AbstractDriverBasedDataSource.getCatalog()
Return the database catalog to be applied to each Connection, if any.
|
ConnectionHandle |
ConnectionHolder.getConnectionHandle()
Return the ConnectionHandle held by this ConnectionHolder.
|
Properties |
AbstractDriverBasedDataSource.getConnectionProperties()
Return the connection properties to be passed to the Driver, if any.
|
protected Integer |
IsolationLevelDataSourceAdapter.getCurrentIsolationLevel()
Determine the current isolation level: either the transaction's
isolation level or a statically defined isolation level.
|
protected Boolean |
IsolationLevelDataSourceAdapter.getCurrentReadOnlyFlag()
Determine the current read-only flag: by default,
the transaction's read-only hint.
|
DataSource |
DataSourceTransactionManager.getDataSource()
Return the JDBC
DataSource that this instance manages transactions for. |
Driver |
SimpleDriverDataSource.getDriver()
Return the JDBC Driver instance to use.
|
protected Integer |
IsolationLevelDataSourceAdapter.getIsolationLevel()
Return the statically specified isolation level,
or
null if none. |
String |
AbstractDriverBasedDataSource.getPassword()
Return the JDBC password to use for connecting through the Driver.
|
Integer |
JdbcTransactionObjectSupport.getPreviousIsolationLevel()
Return the retained previous isolation level, if any.
|
String |
AbstractDriverBasedDataSource.getSchema()
Return the database schema to be applied to each Connection, if any.
|
DataSource |
DelegatingDataSource.getTargetDataSource()
Return the target DataSource that this DataSource should delegate to.
|
String |
AbstractDriverBasedDataSource.getUrl()
Return the JDBC URL to use for connecting through the Driver.
|
String |
AbstractDriverBasedDataSource.getUsername()
Return the JDBC username to use for connecting through the Driver.
|
static Integer |
DataSourceUtils.prepareConnectionForTransaction(Connection con,
TransactionDefinition definition)
Prepare the given Connection with the given transaction semantics.
|
Modifier and Type | Method and Description |
---|---|
static void |
DataSourceUtils.applyTimeout(Statement stmt,
DataSource dataSource,
int timeout)
Apply the specified timeout - overridden by the current transaction timeout,
if any - to the given JDBC Statement object.
|
static void |
DataSourceUtils.applyTransactionTimeout(Statement stmt,
DataSource dataSource)
Apply the current transaction timeout, if any,
to the given JDBC Statement object.
|
protected Object |
WebSphereDataSourceAdapter.createConnectionSpec(Integer isolationLevel,
Boolean readOnlyFlag,
String username,
String password)
Create a WebSphere
JDBCConnectionSpec object for the given characteristics. |
protected Object |
WebSphereDataSourceAdapter.createConnectionSpec(Integer isolationLevel,
Boolean readOnlyFlag,
String username,
String password)
Create a WebSphere
JDBCConnectionSpec object for the given characteristics. |
protected Object |
WebSphereDataSourceAdapter.createConnectionSpec(Integer isolationLevel,
Boolean readOnlyFlag,
String username,
String password)
Create a WebSphere
JDBCConnectionSpec object for the given characteristics. |
protected Object |
WebSphereDataSourceAdapter.createConnectionSpec(Integer isolationLevel,
Boolean readOnlyFlag,
String username,
String password)
Create a WebSphere
JDBCConnectionSpec object for the given characteristics. |
static void |
DataSourceUtils.doCloseConnection(Connection con,
DataSource dataSource)
Close the Connection, unless a
SmartDataSource doesn't want us to. |
protected Connection |
IsolationLevelDataSourceAdapter.doGetConnection(String username,
String password)
Applies the current isolation level value and read-only flag
to the returned Connection.
|
protected Connection |
IsolationLevelDataSourceAdapter.doGetConnection(String username,
String password)
Applies the current isolation level value and read-only flag
to the returned Connection.
|
protected Connection |
UserCredentialsDataSourceAdapter.doGetConnection(String username,
String password)
This implementation delegates to the
getConnection(username, password)
method of the target DataSource, passing in the specified user credentials. |
protected Connection |
UserCredentialsDataSourceAdapter.doGetConnection(String username,
String password)
This implementation delegates to the
getConnection(username, password)
method of the target DataSource, passing in the specified user credentials. |
protected Connection |
WebSphereDataSourceAdapter.doGetConnection(String username,
String password)
Builds a WebSphere JDBCConnectionSpec object for the current settings
and calls
WSDataSource.getConnection(JDBCConnectionSpec) . |
protected Connection |
WebSphereDataSourceAdapter.doGetConnection(String username,
String password)
Builds a WebSphere JDBCConnectionSpec object for the current settings
and calls
WSDataSource.getConnection(JDBCConnectionSpec) . |
static void |
DataSourceUtils.doReleaseConnection(Connection con,
DataSource dataSource)
Actually close the given Connection, obtained from the given DataSource.
|
static void |
DataSourceUtils.doReleaseConnection(Connection con,
DataSource dataSource)
Actually close the given Connection, obtained from the given DataSource.
|
protected void |
DataSourceTransactionManager.doResume(Object transaction,
Object suspendedResources) |
protected Connection |
AbstractDriverBasedDataSource.getConnectionFromDriver(String username,
String password)
Build properties for the Driver, including the given username and password (if any),
and obtain a corresponding Connection.
|
protected Connection |
AbstractDriverBasedDataSource.getConnectionFromDriver(String username,
String password)
Build properties for the Driver, including the given username and password (if any),
and obtain a corresponding Connection.
|
static boolean |
DataSourceUtils.isConnectionTransactional(Connection con,
DataSource dataSource)
Determine whether the given JDBC Connection is transactional, that is,
bound to the current thread by Spring's transaction facilities.
|
static Integer |
DataSourceUtils.prepareConnectionForTransaction(Connection con,
TransactionDefinition definition)
Prepare the given Connection with the given transaction semantics.
|
static void |
DataSourceUtils.releaseConnection(Connection con,
DataSource dataSource)
Close the given Connection, obtained from the given DataSource,
if it is not managed externally (that is, not bound to the thread).
|
static void |
DataSourceUtils.releaseConnection(Connection con,
DataSource dataSource)
Close the given Connection, obtained from the given DataSource,
if it is not managed externally (that is, not bound to the thread).
|
static void |
DataSourceUtils.resetConnectionAfterTransaction(Connection con,
Integer previousIsolationLevel)
Deprecated.
as of 5.1.11, in favor of
DataSourceUtils.resetConnectionAfterTransaction(Connection, Integer, boolean) |
static void |
DataSourceUtils.resetConnectionAfterTransaction(Connection con,
Integer previousIsolationLevel,
boolean resetReadOnly)
Reset the given Connection after a transaction,
regarding read-only flag and isolation level.
|
void |
AbstractDriverBasedDataSource.setCatalog(String catalog)
Specify a database catalog to be applied to each Connection.
|
protected void |
ConnectionHolder.setConnection(Connection connection)
Override the existing Connection handle with the given Connection.
|
void |
JdbcTransactionObjectSupport.setConnectionHolder(ConnectionHolder connectionHolder)
Set the ConnectionHolder for this transaction object.
|
void |
AbstractDriverBasedDataSource.setConnectionProperties(Properties connectionProperties)
Specify arbitrary connection properties as key/value pairs,
to be passed to the Driver.
|
void |
DataSourceTransactionManager.setDataSource(DataSource dataSource)
Set the JDBC
DataSource that this instance should manage transactions for. |
void |
SimpleDriverDataSource.setDriver(Driver driver)
Specify the JDBC Driver instance to use.
|
void |
AbstractDriverBasedDataSource.setPassword(String password)
Set the JDBC password to use for connecting through the Driver.
|
void |
JdbcTransactionObjectSupport.setPreviousIsolationLevel(Integer previousIsolationLevel)
Set the previous isolation level to retain, if any.
|
void |
AbstractDriverBasedDataSource.setSchema(String schema)
Specify a database schema to be applied to each Connection.
|
void |
DelegatingDataSource.setTargetDataSource(DataSource targetDataSource)
Set the target DataSource that this DataSource should delegate to.
|
void |
AbstractDriverBasedDataSource.setUrl(String url)
Set the JDBC URL to use for connecting through the Driver.
|
void |
AbstractDriverBasedDataSource.setUsername(String username)
Set the JDBC username to use for connecting through the Driver.
|
Modifier and Type | Method and Description |
---|---|
protected DataSource |
EmbeddedDatabaseFactory.getDataSource()
Hook that gets the
DataSource that provides the connectivity to the
embedded database. |
DataSource |
EmbeddedDatabaseFactoryBean.getObject() |
Modifier and Type | Method and Description |
---|---|
static void |
ScriptUtils.executeSqlScript(Connection connection,
EncodedResource resource,
boolean continueOnError,
boolean ignoreFailedDrops,
String[] commentPrefixes,
String separator,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter)
Execute the given SQL script.
|
static void |
ScriptUtils.executeSqlScript(Connection connection,
EncodedResource resource,
boolean continueOnError,
boolean ignoreFailedDrops,
String commentPrefix,
String separator,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter)
Execute the given SQL script.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String[] commentPrefixes,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String[] commentPrefixes,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String[] commentPrefixes,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String commentPrefix,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String commentPrefix,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static String |
ScriptUtils.readScript(LineNumberReader lineNumberReader,
String commentPrefix,
String separator,
String blockCommentEndDelimiter)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
void |
ResourceDatabasePopulator.setSqlScriptEncoding(String sqlScriptEncoding)
Specify the encoding for the configured SQL scripts,
if different from the platform encoding.
|
static void |
ScriptUtils.splitSqlScript(EncodedResource resource,
String script,
String separator,
String[] commentPrefixes,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter,
List<String> statements)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
static void |
ScriptUtils.splitSqlScript(EncodedResource resource,
String script,
String separator,
String commentPrefix,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter,
List<String> statements)
Deprecated.
as of Spring Framework 5.2.16 with no plans for replacement.
This is an internal API and will likely be removed in Spring Framework 6.0.
|
Constructor and Description |
---|
ResourceDatabasePopulator(boolean continueOnError,
boolean ignoreFailedDrops,
String sqlScriptEncoding,
Resource... scripts)
Construct a new
ResourceDatabasePopulator with the supplied values. |
ScriptException(String message,
Throwable cause)
Create a new
ScriptException . |
ScriptParseException(String message,
EncodedResource resource)
Create a new
ScriptParseException . |
ScriptParseException(String message,
EncodedResource resource,
Throwable cause)
Create a new
ScriptParseException . |
ScriptParseException(String message,
EncodedResource resource,
Throwable cause)
Create a new
ScriptParseException . |
Modifier and Type | Method and Description |
---|---|
protected Object |
IsolationLevelDataSourceRouter.determineCurrentLookupKey() |
protected abstract Object |
AbstractRoutingDataSource.determineCurrentLookupKey()
Determine the current lookup key.
|
DataSource |
AbstractRoutingDataSource.getResolvedDefaultDataSource()
Return the resolved default target DataSource, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractRoutingDataSource.setDataSourceLookup(DataSourceLookup dataSourceLookup)
Set the DataSourceLookup implementation to use for resolving data source
name Strings in the
targetDataSources map. |
void |
MapDataSourceLookup.setDataSources(Map<String,DataSource> dataSources)
|
Modifier and Type | Method and Description |
---|---|
T |
SqlQuery.findObject(int p1)
Convenient method to find a single object given a single int parameter.
|
T |
SqlQuery.findObject(int p1,
int p2)
Convenient method to find a single object given two int parameters.
|
T |
SqlQuery.findObject(int p1,
int p2,
Map<?,?> context)
Convenient method to find a single object given two int parameters
and a context.
|
T |
SqlQuery.findObject(int p1,
Map<?,?> context)
Convenient method to find a single object given a single int parameter
and a context.
|
T |
SqlQuery.findObject(long p1)
Convenient method to find a single object given a single long parameter.
|
T |
SqlQuery.findObject(long p1,
Map<?,?> context)
Convenient method to find a single object given a single long parameter
and a context.
|
T |
SqlQuery.findObject(Object... params)
Convenient method to find a single object without context.
|
T |
SqlQuery.findObject(Object[] params,
Map<?,?> context)
Generic object finder method, used by all other
findObject methods. |
T |
SqlQuery.findObject(String p1)
Convenient method to find a single object given a single String parameter.
|
T |
SqlQuery.findObject(String p1,
Map<?,?> context)
Convenient method to find a single object given a single String parameter
and a context.
|
T |
SqlQuery.findObjectByNamedParam(Map<String,?> paramMap)
Convenient method to execute without context.
|
T |
SqlQuery.findObjectByNamedParam(Map<String,?> paramMap,
Map<?,?> context)
Generic object finder method for named parameters.
|
String |
SqlCall.getCallString()
Get the call string.
|
String[] |
RdbmsOperation.getGeneratedKeysColumnNames()
Return the column names of the auto generated keys.
|
String |
RdbmsOperation.getSql()
Subclasses can override this to supply dynamic SQL if they wish, but SQL is
normally set by calling the
RdbmsOperation.setSql(java.lang.String) method or in a subclass constructor. |
protected T |
SqlFunction.mapRow(ResultSet rs,
int rowNum)
This implementation of this method extracts a single value from the
single row returned by the function.
|
protected abstract T |
MappingSqlQuery.mapRow(ResultSet rs,
int rowNum)
Subclasses must implement this method to convert each row of the
ResultSet into an object of the result type.
|
T |
MappingSqlQueryWithParameters.RowMapperImpl.mapRow(ResultSet rs,
int rowNum) |
protected T |
MappingSqlQuery.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
This method is implemented to invoke the simpler mapRow
template method, ignoring parameters.
|
protected abstract T |
MappingSqlQueryWithParameters.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
Subclasses must implement this method to convert each row
of the ResultSet into an object of the result type.
|
Object |
SqlFunction.runGeneric()
Convenient method to run the function without arguments,
returning the value as an object.
|
Object |
SqlFunction.runGeneric(int parameter)
Convenient method to run the function with a single int argument.
|
Object |
SqlFunction.runGeneric(Object[] parameters)
Analogous to the
SqlQuery.findObject(Object[]) method. |
Modifier and Type | Method and Description |
---|---|
List<T> |
SqlQuery.execute(int p1,
int p2,
Map<?,?> context)
Convenient method to execute with two int parameters and context.
|
List<T> |
SqlQuery.execute(int p1,
Map<?,?> context)
Convenient method to execute with a single int parameter and context.
|
List<T> |
SqlQuery.execute(long p1,
Map<?,?> context)
Convenient method to execute with a single long parameter and context.
|
List<T> |
SqlQuery.execute(Object[] params,
Map<?,?> context)
Central execution method.
|
List<T> |
SqlQuery.execute(Object[] params,
Map<?,?> context)
Central execution method.
|
List<T> |
SqlQuery.execute(String p1,
Map<?,?> context)
Convenient method to execute with a single String parameter and context.
|
List<T> |
SqlQuery.executeByNamedParam(Map<String,?> paramMap,
Map<?,?> context)
Central execution method.
|
T |
SqlQuery.findObject(int p1,
int p2,
Map<?,?> context)
Convenient method to find a single object given two int parameters
and a context.
|
T |
SqlQuery.findObject(int p1,
Map<?,?> context)
Convenient method to find a single object given a single int parameter
and a context.
|
T |
SqlQuery.findObject(long p1,
Map<?,?> context)
Convenient method to find a single object given a single long parameter
and a context.
|
T |
SqlQuery.findObject(Object[] params,
Map<?,?> context)
Generic object finder method, used by all other
findObject methods. |
T |
SqlQuery.findObject(Object[] params,
Map<?,?> context)
Generic object finder method, used by all other
findObject methods. |
T |
SqlQuery.findObject(String p1,
Map<?,?> context)
Convenient method to find a single object given a single String parameter
and a context.
|
T |
SqlQuery.findObjectByNamedParam(Map<String,?> paramMap,
Map<?,?> context)
Generic object finder method for named parameters.
|
protected T |
MappingSqlQuery.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
This method is implemented to invoke the simpler mapRow
template method, ignoring parameters.
|
protected T |
MappingSqlQuery.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
This method is implemented to invoke the simpler mapRow
template method, ignoring parameters.
|
protected abstract T |
MappingSqlQueryWithParameters.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
Subclasses must implement this method to convert each row
of the ResultSet into an object of the result type.
|
protected abstract T |
MappingSqlQueryWithParameters.mapRow(ResultSet rs,
int rowNum,
Object[] parameters,
Map<?,?> context)
Subclasses must implement this method to convert each row
of the ResultSet into an object of the result type.
|
protected CallableStatementCreator |
SqlCall.newCallableStatementCreator(Map<String,?> inParams)
Return a CallableStatementCreator to perform an operation
with these parameters.
|
protected PreparedStatementCreator |
SqlOperation.newPreparedStatementCreator(Object[] params)
Return a PreparedStatementCreator to perform an operation
with the given parameters.
|
protected PreparedStatementCreator |
SqlOperation.newPreparedStatementCreator(String sqlToUse,
Object[] params)
Return a PreparedStatementCreator to perform an operation
with the given parameters.
|
protected PreparedStatementSetter |
SqlOperation.newPreparedStatementSetter(Object[] params)
Return a PreparedStatementSetter to perform an operation
with the given parameters.
|
protected RowMapper<T> |
UpdatableSqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context)
Implementation of the superclass template method.
|
protected RowMapper<T> |
UpdatableSqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context)
Implementation of the superclass template method.
|
protected RowMapper<T> |
MappingSqlQueryWithParameters.newRowMapper(Object[] parameters,
Map<?,?> context)
Implementation of protected abstract method.
|
protected RowMapper<T> |
MappingSqlQueryWithParameters.newRowMapper(Object[] parameters,
Map<?,?> context)
Implementation of protected abstract method.
|
protected abstract RowMapper<T> |
SqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context)
Subclasses must implement this method to extract an object per row, to be
returned by the
execute method as an aggregated List . |
protected abstract RowMapper<T> |
SqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context)
Subclasses must implement this method to extract an object per row, to be
returned by the
execute method as an aggregated List . |
protected RowMapper<T> |
GenericSqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context) |
protected RowMapper<T> |
GenericSqlQuery.newRowMapper(Object[] parameters,
Map<?,?> context) |
void |
RdbmsOperation.setGeneratedKeysColumnNames(String... names)
Set the column names of the auto-generated keys.
|
void |
RdbmsOperation.setSql(String sql)
Set the SQL executed by this operation.
|
void |
RdbmsOperation.setTypes(int[] types)
Add anonymous parameters, specifying only their SQL types
as defined in the
java.sql.Types class. |
protected abstract T |
UpdatableSqlQuery.updateRow(ResultSet rs,
int rowNum,
Map<?,?> context)
Subclasses must implement this method to update each row of the
ResultSet and optionally create object of the result type.
|
protected void |
RdbmsOperation.validateNamedParameters(Map<String,?> parameters)
Validate the named parameters passed to an execute method based on declared parameters.
|
protected void |
RdbmsOperation.validateParameters(Object[] parameters)
Validate the parameters passed to an execute method based on declared parameters.
|
Constructor and Description |
---|
RowMapperImpl(Map<?,?> context) |
RowMapperImpl(Object[] parameters,
Map<?,?> context)
Use an array results.
|
RowMapperImpl(Object[] parameters,
Map<?,?> context)
Use an array results.
|
Modifier and Type | Method and Description |
---|---|
static String |
JdbcUtils.commonDatabaseName(String source)
Extract a common name for the target database in use even if
various drivers/platforms provide varying names at runtime.
|
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.createCustomException(String task,
String sql,
SQLException sqlEx,
Class<?> exceptionClass)
Create a custom
DataAccessException , based on a given exception
class from a CustomSQLErrorCodesTranslation definition. |
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.customTranslate(String task,
String sql,
SQLException sqlEx)
Subclasses can override this method to attempt a custom mapping from
SQLException to DataAccessException . |
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex) |
protected abstract DataAccessException |
AbstractFallbackSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex)
Template method for actually translating the given exception.
|
protected DataAccessException |
SQLExceptionSubclassTranslator.doTranslate(String task,
String sql,
SQLException ex) |
protected DataAccessException |
SQLStateSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex) |
SQLExceptionTranslator |
CustomSQLExceptionTranslatorRegistry.findTranslatorForDatabase(String dbName)
Find a custom translator for the specified database.
|
SQLExceptionTranslator |
SQLErrorCodes.getCustomSqlExceptionTranslator() |
CustomSQLErrorCodesTranslation[] |
SQLErrorCodes.getCustomTranslations() |
String |
SQLErrorCodes.getDatabaseProductName() |
String[] |
SQLErrorCodes.getDatabaseProductNames() |
DataSource |
JdbcAccessor.getDataSource()
Return the DataSource used by this template.
|
Class<?> |
CustomSQLErrorCodesTranslation.getExceptionClass()
Return the exception class for the specified error codes.
|
SQLExceptionTranslator |
AbstractFallbackSQLExceptionTranslator.getFallbackTranslator()
Return the fallback exception translator, if any.
|
Number |
KeyHolder.getKey()
Retrieve the first item from the first map, assuming that there is just
one item and just one map, and that the item is a number.
|
Number |
GeneratedKeyHolder.getKey() |
<T> T |
KeyHolder.getKeyAs(Class<T> keyType)
Retrieve the first item from the first map, assuming that there is just
one item and just one map, and that the item is an instance of specified type.
|
<T> T |
GeneratedKeyHolder.getKeyAs(Class<T> keyType) |
Map<String,Object> |
KeyHolder.getKeys()
Retrieve the first map of keys.
|
Map<String,Object> |
GeneratedKeyHolder.getKeys() |
static Object |
JdbcUtils.getResultSetValue(ResultSet rs,
int index)
Retrieve a JDBC column value from a ResultSet, using the most appropriate
value type.
|
static Object |
JdbcUtils.getResultSetValue(ResultSet rs,
int index,
Class<?> requiredType)
Retrieve a JDBC column value from a ResultSet, using the specified value type.
|
SQLErrorCodes |
SQLErrorCodeSQLExceptionTranslator.getSqlErrorCodes()
Return the error codes used by this translator.
|
protected Resource |
SQLErrorCodesFactory.loadResource(String path)
Load the given resource from the class path.
|
SQLErrorCodes |
SQLErrorCodesFactory.resolveErrorCodes(DataSource dataSource)
Return
SQLErrorCodes for the given DataSource ,
evaluating "databaseProductName" from the
DatabaseMetaData , or null if case
of a JDBC meta-data access problem. |
static String |
JdbcUtils.resolveTypeName(int sqlType)
Resolve the standard type name for the given SQL type, if possible.
|
DataAccessException |
AbstractFallbackSQLExceptionTranslator.translate(String task,
String sql,
SQLException ex)
Pre-checks the arguments, calls
AbstractFallbackSQLExceptionTranslator.doTranslate(java.lang.String, java.lang.String, java.sql.SQLException) , and invokes the
fallback translator if necessary. |
DataAccessException |
SQLExceptionTranslator.translate(String task,
String sql,
SQLException ex)
Translate the given
SQLException into a generic DataAccessException . |
SQLErrorCodes |
SQLErrorCodesFactory.unregisterDatabase(DataSource dataSource)
Clear the cache for the specified
DataSource , if registered. |
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractFallbackSQLExceptionTranslator.buildMessage(String task,
String sql,
SQLException ex)
Build a message
String for the given SQLException . |
static void |
JdbcUtils.closeConnection(Connection con)
Close the given JDBC Connection and ignore any thrown exception.
|
static void |
JdbcUtils.closeResultSet(ResultSet rs)
Close the given JDBC ResultSet and ignore any thrown exception.
|
static void |
JdbcUtils.closeStatement(Statement stmt)
Close the given JDBC Statement and ignore any thrown exception.
|
static String |
JdbcUtils.commonDatabaseName(String source)
Extract a common name for the target database in use even if
various drivers/platforms provide varying names at runtime.
|
static String |
JdbcUtils.convertUnderscoreNameToPropertyName(String name)
Convert a column name with underscores to the corresponding property name using "camel case".
|
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.createCustomException(String task,
String sql,
SQLException sqlEx,
Class<?> exceptionClass)
Create a custom
DataAccessException , based on a given exception
class from a CustomSQLErrorCodesTranslation definition. |
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.customTranslate(String task,
String sql,
SQLException sqlEx)
Subclasses can override this method to attempt a custom mapping from
SQLException to DataAccessException . |
protected DataAccessException |
SQLErrorCodeSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex) |
protected abstract DataAccessException |
AbstractFallbackSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex)
Template method for actually translating the given exception.
|
protected DataAccessException |
SQLExceptionSubclassTranslator.doTranslate(String task,
String sql,
SQLException ex) |
protected DataAccessException |
SQLStateSQLExceptionTranslator.doTranslate(String task,
String sql,
SQLException ex) |
static Object |
JdbcUtils.getResultSetValue(ResultSet rs,
int index,
Class<?> requiredType)
Retrieve a JDBC column value from a ResultSet, using the specified value type.
|
void |
SQLErrorCodes.setCustomSqlExceptionTranslator(SQLExceptionTranslator customSqlExceptionTranslator) |
void |
SQLErrorCodes.setCustomSqlExceptionTranslatorClass(Class<? extends SQLExceptionTranslator> customTranslatorClass) |
void |
SQLErrorCodes.setDatabaseProductName(String databaseProductName)
Set this property if the database name contains spaces,
in which case we can not use the bean name for lookup.
|
void |
SQLErrorCodes.setDatabaseProductNames(String... databaseProductNames)
Set this property to specify multiple database names that contains spaces,
in which case we can not use bean names for lookup.
|
void |
JdbcAccessor.setDataSource(DataSource dataSource)
Set the JDBC DataSource to obtain connections from.
|
void |
CustomSQLErrorCodesTranslation.setExceptionClass(Class<?> exceptionClass)
Set the exception class for the specified error codes.
|
void |
AbstractFallbackSQLExceptionTranslator.setFallbackTranslator(SQLExceptionTranslator fallback)
Set the fallback translator to use when this translator cannot find a
specific match itself.
|
void |
SQLErrorCodeSQLExceptionTranslator.setSqlErrorCodes(SQLErrorCodes sec)
Set custom error codes to be used for translation.
|
DataAccessException |
AbstractFallbackSQLExceptionTranslator.translate(String task,
String sql,
SQLException ex)
Pre-checks the arguments, calls
AbstractFallbackSQLExceptionTranslator.doTranslate(java.lang.String, java.lang.String, java.sql.SQLException) , and invokes the
fallback translator if necessary. |
DataAccessException |
SQLExceptionTranslator.translate(String task,
String sql,
SQLException ex)
Translate the given
SQLException into a generic DataAccessException . |
Modifier and Type | Method and Description |
---|---|
InputStream |
LobHandler.getBlobAsBinaryStream(ResultSet rs,
int columnIndex)
Retrieve the given column as binary stream from the given ResultSet.
|
InputStream |
DefaultLobHandler.getBlobAsBinaryStream(ResultSet rs,
int columnIndex) |
InputStream |
AbstractLobHandler.getBlobAsBinaryStream(ResultSet rs,
String columnName) |
InputStream |
LobHandler.getBlobAsBinaryStream(ResultSet rs,
String columnName)
Retrieve the given column as binary stream from the given ResultSet.
|
byte[] |
LobHandler.getBlobAsBytes(ResultSet rs,
int columnIndex)
Retrieve the given column as bytes from the given ResultSet.
|
byte[] |
DefaultLobHandler.getBlobAsBytes(ResultSet rs,
int columnIndex) |
byte[] |
AbstractLobHandler.getBlobAsBytes(ResultSet rs,
String columnName) |
byte[] |
LobHandler.getBlobAsBytes(ResultSet rs,
String columnName)
Retrieve the given column as bytes from the given ResultSet.
|
InputStream |
LobHandler.getClobAsAsciiStream(ResultSet rs,
int columnIndex)
Retrieve the given column as ASCII stream from the given ResultSet.
|
InputStream |
AbstractLobHandler.getClobAsAsciiStream(ResultSet rs,
String columnName) |
InputStream |
LobHandler.getClobAsAsciiStream(ResultSet rs,
String columnName)
Retrieve the given column as ASCII stream from the given ResultSet.
|
String |
LobHandler.getClobAsString(ResultSet rs,
int columnIndex)
Retrieve the given column as String from the given ResultSet.
|
String |
DefaultLobHandler.getClobAsString(ResultSet rs,
int columnIndex) |
String |
AbstractLobHandler.getClobAsString(ResultSet rs,
String columnName) |
String |
LobHandler.getClobAsString(ResultSet rs,
String columnName)
Retrieve the given column as String from the given ResultSet.
|
Modifier and Type | Method and Description |
---|---|
void |
TemporaryLobCreator.setBlobAsBinaryStream(PreparedStatement ps,
int paramIndex,
InputStream binaryStream,
int contentLength) |
void |
DefaultLobHandler.DefaultLobCreator.setBlobAsBinaryStream(PreparedStatement ps,
int paramIndex,
InputStream binaryStream,
int contentLength) |
void |
LobCreator.setBlobAsBinaryStream(PreparedStatement ps,
int paramIndex,
InputStream contentStream,
int contentLength)
Set the given content as binary stream on the given statement, using the given
parameter index.
|
void |
TemporaryLobCreator.setBlobAsBytes(PreparedStatement ps,
int paramIndex,
byte[] content) |
void |
DefaultLobHandler.DefaultLobCreator.setBlobAsBytes(PreparedStatement ps,
int paramIndex,
byte[] content) |
void |
LobCreator.setBlobAsBytes(PreparedStatement ps,
int paramIndex,
byte[] content)
Set the given content as bytes on the given statement, using the given
parameter index.
|
void |
TemporaryLobCreator.setClobAsAsciiStream(PreparedStatement ps,
int paramIndex,
InputStream asciiStream,
int contentLength) |
void |
DefaultLobHandler.DefaultLobCreator.setClobAsAsciiStream(PreparedStatement ps,
int paramIndex,
InputStream asciiStream,
int contentLength) |
void |
LobCreator.setClobAsAsciiStream(PreparedStatement ps,
int paramIndex,
InputStream asciiStream,
int contentLength)
Set the given content as ASCII stream on the given statement, using the given
parameter index.
|
void |
TemporaryLobCreator.setClobAsCharacterStream(PreparedStatement ps,
int paramIndex,
Reader characterStream,
int contentLength) |
void |
DefaultLobHandler.DefaultLobCreator.setClobAsCharacterStream(PreparedStatement ps,
int paramIndex,
Reader characterStream,
int contentLength) |
void |
LobCreator.setClobAsCharacterStream(PreparedStatement ps,
int paramIndex,
Reader characterStream,
int contentLength)
Set the given content as character stream on the given statement, using the given
parameter index.
|
void |
TemporaryLobCreator.setClobAsString(PreparedStatement ps,
int paramIndex,
String content) |
void |
DefaultLobHandler.DefaultLobCreator.setClobAsString(PreparedStatement ps,
int paramIndex,
String content) |
void |
LobCreator.setClobAsString(PreparedStatement ps,
int paramIndex,
String content)
Set the given content as String on the given statement, using the given
parameter index.
|
Modifier and Type | Method and Description |
---|---|
BigDecimal |
ResultSetWrappingSqlRowSet.getBigDecimal(int columnIndex) |
BigDecimal |
SqlRowSet.getBigDecimal(int columnIndex)
Retrieve the value of the indicated column in the current row as a BigDecimal object.
|
BigDecimal |
ResultSetWrappingSqlRowSet.getBigDecimal(String columnLabel) |
BigDecimal |
SqlRowSet.getBigDecimal(String columnLabel)
Retrieve the value of the indicated column in the current row as a BigDecimal object.
|
Date |
ResultSetWrappingSqlRowSet.getDate(int columnIndex) |
Date |
SqlRowSet.getDate(int columnIndex)
Retrieve the value of the indicated column in the current row as a Date object.
|
Date |
ResultSetWrappingSqlRowSet.getDate(int columnIndex,
Calendar cal) |
Date |
SqlRowSet.getDate(int columnIndex,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Date object.
|
Date |
ResultSetWrappingSqlRowSet.getDate(String columnLabel) |
Date |
SqlRowSet.getDate(String columnLabel)
Retrieve the value of the indicated column in the current row as a Date object.
|
Date |
ResultSetWrappingSqlRowSet.getDate(String columnLabel,
Calendar cal) |
Date |
SqlRowSet.getDate(String columnLabel,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Date object.
|
String |
ResultSetWrappingSqlRowSet.getNString(int columnIndex) |
String |
SqlRowSet.getNString(int columnIndex)
Retrieve the value of the indicated column in the current row as a String
(for NCHAR, NVARCHAR, LONGNVARCHAR columns).
|
String |
ResultSetWrappingSqlRowSet.getNString(String columnLabel) |
String |
SqlRowSet.getNString(String columnLabel)
Retrieve the value of the indicated column in the current row as a String
(for NCHAR, NVARCHAR, LONGNVARCHAR columns).
|
Object |
ResultSetWrappingSqlRowSet.getObject(int columnIndex) |
Object |
SqlRowSet.getObject(int columnIndex)
Retrieve the value of the indicated column in the current row as an Object.
|
<T> T |
ResultSetWrappingSqlRowSet.getObject(int columnIndex,
Class<T> type) |
<T> T |
SqlRowSet.getObject(int columnIndex,
Class<T> type)
Retrieve the value of the indicated column in the current row as an Object.
|
Object |
ResultSetWrappingSqlRowSet.getObject(int columnIndex,
Map<String,Class<?>> map) |
Object |
SqlRowSet.getObject(int columnIndex,
Map<String,Class<?>> map)
Retrieve the value of the indicated column in the current row as an Object.
|
Object |
ResultSetWrappingSqlRowSet.getObject(String columnLabel) |
Object |
SqlRowSet.getObject(String columnLabel)
Retrieve the value of the indicated column in the current row as an Object.
|
<T> T |
ResultSetWrappingSqlRowSet.getObject(String columnLabel,
Class<T> type) |
<T> T |
SqlRowSet.getObject(String columnLabel,
Class<T> type)
Retrieve the value of the indicated column in the current row as an Object.
|
Object |
ResultSetWrappingSqlRowSet.getObject(String columnLabel,
Map<String,Class<?>> map) |
Object |
SqlRowSet.getObject(String columnLabel,
Map<String,Class<?>> map)
Retrieve the value of the indicated column in the current row as an Object.
|
String |
ResultSetWrappingSqlRowSet.getString(int columnIndex) |
String |
SqlRowSet.getString(int columnIndex)
Retrieve the value of the indicated column in the current row as a String.
|
String |
ResultSetWrappingSqlRowSet.getString(String columnLabel) |
String |
SqlRowSet.getString(String columnLabel)
Retrieve the value of the indicated column in the current row as a String.
|
Time |
ResultSetWrappingSqlRowSet.getTime(int columnIndex) |
Time |
SqlRowSet.getTime(int columnIndex)
Retrieve the value of the indicated column in the current row as a Time object.
|
Time |
ResultSetWrappingSqlRowSet.getTime(int columnIndex,
Calendar cal) |
Time |
SqlRowSet.getTime(int columnIndex,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Time object.
|
Time |
ResultSetWrappingSqlRowSet.getTime(String columnLabel) |
Time |
SqlRowSet.getTime(String columnLabel)
Retrieve the value of the indicated column in the current row as a Time object.
|
Time |
ResultSetWrappingSqlRowSet.getTime(String columnLabel,
Calendar cal) |
Time |
SqlRowSet.getTime(String columnLabel,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Time object.
|
Timestamp |
ResultSetWrappingSqlRowSet.getTimestamp(int columnIndex) |
Timestamp |
SqlRowSet.getTimestamp(int columnIndex)
Retrieve the value of the indicated column in the current row as a Timestamp object.
|
Timestamp |
ResultSetWrappingSqlRowSet.getTimestamp(int columnIndex,
Calendar cal) |
Timestamp |
SqlRowSet.getTimestamp(int columnIndex,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Timestamp object.
|
Timestamp |
ResultSetWrappingSqlRowSet.getTimestamp(String columnLabel) |
Timestamp |
SqlRowSet.getTimestamp(String columnLabel)
Retrieve the value of the indicated column in the current row as a Timestamp object.
|
Timestamp |
ResultSetWrappingSqlRowSet.getTimestamp(String columnLabel,
Calendar cal) |
Timestamp |
SqlRowSet.getTimestamp(String columnLabel,
Calendar cal)
Retrieve the value of the indicated column in the current row as a Timestamp object.
|
Modifier and Type | Method and Description |
---|---|
InputStream |
SqlXmlHandler.getXmlAsBinaryStream(ResultSet rs,
int columnIndex)
Retrieve the given column as binary stream from the given ResultSet.
|
InputStream |
Jdbc4SqlXmlHandler.getXmlAsBinaryStream(ResultSet rs,
int columnIndex) |
InputStream |
SqlXmlHandler.getXmlAsBinaryStream(ResultSet rs,
String columnName)
Retrieve the given column as binary stream from the given ResultSet.
|
InputStream |
Jdbc4SqlXmlHandler.getXmlAsBinaryStream(ResultSet rs,
String columnName) |
Reader |
SqlXmlHandler.getXmlAsCharacterStream(ResultSet rs,
int columnIndex)
Retrieve the given column as character stream from the given ResultSet.
|
Reader |
Jdbc4SqlXmlHandler.getXmlAsCharacterStream(ResultSet rs,
int columnIndex) |
Reader |
SqlXmlHandler.getXmlAsCharacterStream(ResultSet rs,
String columnName)
Retrieve the given column as character stream from the given ResultSet.
|
Reader |
Jdbc4SqlXmlHandler.getXmlAsCharacterStream(ResultSet rs,
String columnName) |
Source |
SqlXmlHandler.getXmlAsSource(ResultSet rs,
int columnIndex,
Class<? extends Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
Source |
Jdbc4SqlXmlHandler.getXmlAsSource(ResultSet rs,
int columnIndex,
Class<? extends Source> sourceClass) |
Source |
SqlXmlHandler.getXmlAsSource(ResultSet rs,
String columnName,
Class<? extends Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
Source |
Jdbc4SqlXmlHandler.getXmlAsSource(ResultSet rs,
String columnName,
Class<? extends Source> sourceClass) |
String |
SqlXmlHandler.getXmlAsString(ResultSet rs,
int columnIndex)
Retrieve the given column as String from the given ResultSet.
|
String |
Jdbc4SqlXmlHandler.getXmlAsString(ResultSet rs,
int columnIndex) |
String |
SqlXmlHandler.getXmlAsString(ResultSet rs,
String columnName)
Retrieve the given column as String from the given ResultSet.
|
String |
Jdbc4SqlXmlHandler.getXmlAsString(ResultSet rs,
String columnName) |
Modifier and Type | Method and Description |
---|---|
Source |
SqlXmlHandler.getXmlAsSource(ResultSet rs,
int columnIndex,
Class<? extends Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
Source |
Jdbc4SqlXmlHandler.getXmlAsSource(ResultSet rs,
int columnIndex,
Class<? extends Source> sourceClass) |
Source |
SqlXmlHandler.getXmlAsSource(ResultSet rs,
String columnName,
Class<? extends Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
Source |
Jdbc4SqlXmlHandler.getXmlAsSource(ResultSet rs,
String columnName,
Class<? extends Source> sourceClass) |
Modifier and Type | Method and Description |
---|---|
String |
JmsException.getErrorCode()
Convenience method to get the vendor specific error code if
the root cause was an instance of JMSException.
|
String |
JmsException.getMessage()
Return the detail message, including the message from the linked exception
if there is one.
|
Constructor and Description |
---|
JmsException(String msg,
Throwable cause)
Constructor that takes a message and a root cause.
|
JmsException(Throwable cause)
Constructor that takes a plain root cause, intended for
subclasses mirroring corresponding
javax.jms exceptions. |
Modifier and Type | Method and Description |
---|---|
Object |
MethodJmsListenerEndpoint.getBean() |
String |
AbstractJmsListenerEndpoint.getConcurrency()
Return the concurrency for the listener, if any.
|
protected String |
MethodJmsListenerEndpoint.getDefaultResponseDestination()
Return the default response destination, if any.
|
String |
AbstractJmsListenerEndpoint.getDestination()
Return the name of the destination for this endpoint.
|
JmsListenerEndpointRegistry |
JmsListenerEndpointRegistrar.getEndpointRegistry()
Return the
JmsListenerEndpointRegistry instance for this
registrar, may be null . |
MessageListenerContainer |
JmsListenerEndpointRegistry.getListenerContainer(String id)
Return the
MessageListenerContainer with the specified id or
null if no such container exists. |
MessageHandlerMethodFactory |
JmsListenerEndpointRegistrar.getMessageHandlerMethodFactory()
Return the custom
MessageHandlerMethodFactory to use, if any. |
MessageListener |
SimpleJmsListenerEndpoint.getMessageListener()
Return the
MessageListener to invoke when a message matching
the endpoint is received. |
Method |
MethodJmsListenerEndpoint.getMethod() |
Method |
MethodJmsListenerEndpoint.getMostSpecificMethod() |
String |
AbstractJmsListenerEndpoint.getSelector()
Return the JMS message selector expression, if any.
|
String |
AbstractJmsListenerEndpoint.getSubscription()
Return the name for the durable subscription, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
JmsListenerEndpointRegistrar.registerEndpoint(JmsListenerEndpoint endpoint,
JmsListenerContainerFactory<?> factory)
Register a new
JmsListenerEndpoint alongside the
JmsListenerContainerFactory to use to create the underlying container. |
void |
DefaultJmsListenerContainerFactory.setBackOff(BackOff backOff) |
void |
MethodJmsListenerEndpoint.setBean(Object bean)
Set the actual bean instance to invoke this endpoint method on.
|
void |
MethodJmsListenerEndpoint.setBeanFactory(BeanFactory beanFactory)
Set the
BeanFactory to use to resolve expressions (may be null ). |
void |
DefaultJmsListenerContainerFactory.setCacheLevel(Integer cacheLevel) |
void |
DefaultJmsListenerContainerFactory.setCacheLevelName(String cacheLevelName) |
void |
DefaultJmsListenerContainerFactory.setConcurrency(String concurrency) |
void |
AbstractJmsListenerEndpoint.setConcurrency(String concurrency)
Set a concurrency for the listener, if any.
|
void |
AbstractJmsListenerEndpoint.setDestination(String destination)
Set the name of the destination for this endpoint.
|
void |
MethodJmsListenerEndpoint.setEmbeddedValueResolver(StringValueResolver embeddedValueResolver)
Set a value resolver for embedded placeholders and expressions.
|
void |
JmsListenerEndpointRegistrar.setEndpointRegistry(JmsListenerEndpointRegistry endpointRegistry)
Set the
JmsListenerEndpointRegistry instance to use. |
void |
DefaultJmsListenerContainerFactory.setMaxMessagesPerTask(Integer maxMessagesPerTask) |
void |
JmsListenerEndpointRegistrar.setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory)
Set the
MessageHandlerMethodFactory to use to configure the message
listener responsible to serve an endpoint detected by this processor. |
void |
SimpleJmsListenerEndpoint.setMessageListener(MessageListener messageListener)
Set the
MessageListener to invoke when a message matching
the endpoint is received. |
void |
MethodJmsListenerEndpoint.setMethod(Method method)
Set the method to invoke for processing a message managed by this endpoint.
|
void |
MethodJmsListenerEndpoint.setMostSpecificMethod(Method mostSpecificMethod)
Set the most specific method known for this endpoint's declaration.
|
void |
DefaultJmsListenerContainerFactory.setReceiveTimeout(Long receiveTimeout) |
void |
DefaultJmsListenerContainerFactory.setRecoveryInterval(Long recoveryInterval) |
void |
AbstractJmsListenerEndpoint.setSelector(String selector)
Set the JMS message selector expression.
|
void |
AbstractJmsListenerEndpoint.setSubscription(String subscription)
Set the name for the durable subscription.
|
void |
DefaultJmsListenerContainerFactory.setTaskExecutor(Executor taskExecutor) |
void |
DefaultJmsListenerContainerFactory.setTransactionManager(PlatformTransactionManager transactionManager) |
Modifier and Type | Method and Description |
---|---|
static Session |
ConnectionFactoryUtils.doGetTransactionalSession(ConnectionFactory connectionFactory,
ConnectionFactoryUtils.ResourceFactory resourceFactory)
Obtain a JMS Session that is synchronized with the current transaction, if any.
|
static Session |
ConnectionFactoryUtils.doGetTransactionalSession(ConnectionFactory connectionFactory,
ConnectionFactoryUtils.ResourceFactory resourceFactory,
boolean startConnection)
Obtain a JMS Session that is synchronized with the current transaction, if any.
|
protected String |
SingleConnectionFactory.getClientId()
Return a JMS client ID for the single Connection created and exposed
by this ConnectionFactory, if any.
|
Connection |
JmsResourceHolder.getConnection()
Return this resource holder's default Connection,
or
null if none. |
<C extends Connection> |
JmsResourceHolder.getConnection(Class<C> connectionType)
Return this resource holder's Connection of the given type,
or
null if none. |
Connection |
ConnectionFactoryUtils.ResourceFactory.getConnection(JmsResourceHolder holder)
Fetch an appropriate Connection from the given JmsResourceHolder.
|
ConnectionFactory |
JmsTransactionManager.getConnectionFactory()
Return the JMS ConnectionFactory that this instance should manage transactions for.
|
protected ExceptionListener |
SingleConnectionFactory.getExceptionListener()
Return the JMS ExceptionListener implementation that should be registered
with the single Connection created by this factory, if any.
|
Session |
JmsResourceHolder.getSession()
Return this resource holder's default Session,
or
null if none. |
<S extends Session> |
JmsResourceHolder.getSession(Class<S> sessionType)
Return this resource holder's Session of the given type,
or
null if none. |
<S extends Session> |
JmsResourceHolder.getSession(Class<S> sessionType,
Connection connection)
Return this resource holder's Session of the given type
for the given connection, or
null if none. |
protected Session |
SingleConnectionFactory.getSession(Connection con,
Integer mode)
Template method for obtaining a (potentially cached) Session.
|
Session |
ConnectionFactoryUtils.ResourceFactory.getSession(JmsResourceHolder holder)
Fetch an appropriate Session from the given JmsResourceHolder.
|
ConnectionFactory |
DelegatingConnectionFactory.getTargetConnectionFactory()
Return the target ConnectionFactory that this ConnectionFactory delegates to.
|
ConnectionFactory |
SingleConnectionFactory.getTargetConnectionFactory()
Return the target ConnectionFactory which will be used to lazily
create a single Connection, if any.
|
static QueueSession |
ConnectionFactoryUtils.getTransactionalQueueSession(QueueConnectionFactory cf,
QueueConnection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS QueueSession that is synchronized with the current transaction, if any.
|
static Session |
ConnectionFactoryUtils.getTransactionalSession(ConnectionFactory cf,
Connection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS Session that is synchronized with the current transaction, if any.
|
static TopicSession |
ConnectionFactoryUtils.getTransactionalTopicSession(TopicConnectionFactory cf,
TopicConnection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS TopicSession that is synchronized with the current transaction, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
JmsResourceHolder.addSession(Session session,
Connection connection)
Add the given Session to this resource holder,
registered for a specific Connection.
|
protected Connection |
UserCredentialsConnectionFactoryAdapter.doCreateConnection(String username,
String password)
This implementation delegates to the
createConnection(username, password)
method of the target ConnectionFactory, passing in the specified user credentials. |
protected Connection |
UserCredentialsConnectionFactoryAdapter.doCreateConnection(String username,
String password)
This implementation delegates to the
createConnection(username, password)
method of the target ConnectionFactory, passing in the specified user credentials. |
protected QueueConnection |
UserCredentialsConnectionFactoryAdapter.doCreateQueueConnection(String username,
String password)
This implementation delegates to the
createQueueConnection(username, password)
method of the target QueueConnectionFactory, passing in the specified user credentials. |
protected QueueConnection |
UserCredentialsConnectionFactoryAdapter.doCreateQueueConnection(String username,
String password)
This implementation delegates to the
createQueueConnection(username, password)
method of the target QueueConnectionFactory, passing in the specified user credentials. |
protected TopicConnection |
UserCredentialsConnectionFactoryAdapter.doCreateTopicConnection(String username,
String password)
This implementation delegates to the
createTopicConnection(username, password)
method of the target TopicConnectionFactory, passing in the specified user credentials. |
protected TopicConnection |
UserCredentialsConnectionFactoryAdapter.doCreateTopicConnection(String username,
String password)
This implementation delegates to the
createTopicConnection(username, password)
method of the target TopicConnectionFactory, passing in the specified user credentials. |
protected void |
JmsTransactionManager.doResume(Object transaction,
Object suspendedResources) |
<S extends Session> |
JmsResourceHolder.getSession(Class<S> sessionType,
Connection connection)
Return this resource holder's Session of the given type
for the given connection, or
null if none. |
static QueueSession |
ConnectionFactoryUtils.getTransactionalQueueSession(QueueConnectionFactory cf,
QueueConnection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS QueueSession that is synchronized with the current transaction, if any.
|
static Session |
ConnectionFactoryUtils.getTransactionalSession(ConnectionFactory cf,
Connection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS Session that is synchronized with the current transaction, if any.
|
static TopicSession |
ConnectionFactoryUtils.getTransactionalTopicSession(TopicConnectionFactory cf,
TopicConnection existingCon,
boolean synchedLocalTransactionAllowed)
Obtain a JMS TopicSession that is synchronized with the current transaction, if any.
|
static boolean |
ConnectionFactoryUtils.isSessionTransactional(Session session,
ConnectionFactory cf)
Determine whether the given JMS Session is transactional, that is,
bound to the current thread by Spring's transaction facilities.
|
static boolean |
ConnectionFactoryUtils.isSessionTransactional(Session session,
ConnectionFactory cf)
Determine whether the given JMS Session is transactional, that is,
bound to the current thread by Spring's transaction facilities.
|
static void |
ConnectionFactoryUtils.releaseConnection(Connection con,
ConnectionFactory cf,
boolean started)
Release the given Connection, stopping it (if necessary) and eventually closing it.
|
static void |
ConnectionFactoryUtils.releaseConnection(Connection con,
ConnectionFactory cf,
boolean started)
Release the given Connection, stopping it (if necessary) and eventually closing it.
|
void |
SingleConnectionFactory.setClientId(String clientId)
Specify a JMS client ID for the single Connection created and exposed
by this ConnectionFactory.
|
void |
JmsTransactionManager.setConnectionFactory(ConnectionFactory cf)
Set the JMS ConnectionFactory that this instance should manage transactions for.
|
void |
SingleConnectionFactory.setExceptionListener(ExceptionListener exceptionListener)
Specify an JMS ExceptionListener implementation that should be
registered with the single Connection created by this factory.
|
void |
DelegatingConnectionFactory.setTargetConnectionFactory(ConnectionFactory targetConnectionFactory)
Set the target ConnectionFactory that this ConnectionFactory should delegate to.
|
void |
SingleConnectionFactory.setTargetConnectionFactory(ConnectionFactory targetConnectionFactory)
Set the target ConnectionFactory which will be used to lazily
create a single Connection.
|
Constructor and Description |
---|
JmsResourceHolder(ConnectionFactory connectionFactory)
Create a new JmsResourceHolder that is open for resources to be added.
|
JmsResourceHolder(ConnectionFactory connectionFactory,
Connection connection,
Session session)
Create a new JmsResourceHolder for the given JMS resources.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
JmsOperations.browse(BrowserCallback<T> action)
Browse messages in the default JMS queue.
|
<T> T |
JmsTemplate.browse(BrowserCallback<T> action) |
<T> T |
JmsOperations.browse(Queue queue,
BrowserCallback<T> action)
Browse messages in a JMS queue.
|
<T> T |
JmsTemplate.browse(Queue queue,
BrowserCallback<T> action) |
<T> T |
JmsOperations.browse(String queueName,
BrowserCallback<T> action)
Browse messages in a JMS queue.
|
<T> T |
JmsTemplate.browse(String queueName,
BrowserCallback<T> action) |
<T> T |
JmsOperations.browseSelected(Queue queue,
String messageSelector,
BrowserCallback<T> action)
Browse selected messages in a JMS queue.
|
<T> T |
JmsTemplate.browseSelected(Queue queue,
String messageSelector,
BrowserCallback<T> action) |
<T> T |
JmsOperations.browseSelected(String messageSelector,
BrowserCallback<T> action)
Browse selected messages in a JMS queue.
|
<T> T |
JmsTemplate.browseSelected(String messageSelector,
BrowserCallback<T> action) |
<T> T |
JmsOperations.browseSelected(String queueName,
String messageSelector,
BrowserCallback<T> action)
Browse selected messages in a JMS queue.
|
<T> T |
JmsTemplate.browseSelected(String queueName,
String messageSelector,
BrowserCallback<T> action) |
protected Message<?> |
JmsMessagingTemplate.convertJmsMessage(Message message) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
JmsMessageOperations.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message to the given destination, receive the reply and convert
its body of the specified target class. |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass) |
<T> T |
JmsMessageOperations.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
apply the given post processor and send the resulting Message to the
given destination, receive the reply and convert its body of the given
target class. |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor) |
<T> T |
JmsMessageOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message with the given headers, to the specified destination,
receive the reply and convert its body of the specified target class. |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
JmsMessageOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor
and send the resulting Message to the specified destination, receive
the reply and convert its body of the given target class. |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
protected Object |
JmsTemplate.doConvertFromMessage(Message message)
Extract the content from the given JMS message.
|
T |
SessionCallback.doInJms(Session session)
Execute any number of operations against the supplied JMS
Session ,
possibly returning a result. |
T |
ProducerCallback.doInJms(Session session,
MessageProducer producer)
Perform operations on the given
Session and MessageProducer . |
T |
BrowserCallback.doInJms(Session session,
QueueBrowser browser)
Perform operations on the given
Session and
QueueBrowser . |
protected Message<?> |
JmsMessagingTemplate.doReceive(Destination destination) |
protected Message |
JmsTemplate.doReceive(Session session,
Destination destination,
String messageSelector)
Receive a JMS message.
|
protected Message |
JmsTemplate.doReceive(Session session,
MessageConsumer consumer)
Actually receive a JMS message.
|
protected Message<?> |
JmsMessagingTemplate.doReceive(String destinationName) |
protected Message<?> |
JmsMessagingTemplate.doSendAndReceive(Destination destination,
Message<?> requestMessage) |
protected Message |
JmsTemplate.doSendAndReceive(Session session,
Destination destination,
MessageCreator messageCreator)
Send a request message to the given
Destination and block until
a reply has been received on a temporary queue created on-the-fly. |
protected Message<?> |
JmsMessagingTemplate.doSendAndReceive(String destinationName,
Message<?> requestMessage) |
<T> T |
JmsOperations.execute(Destination destination,
ProducerCallback<T> action)
Send messages to a JMS destination.
|
<T> T |
JmsTemplate.execute(Destination destination,
ProducerCallback<T> action) |
<T> T |
JmsOperations.execute(ProducerCallback<T> action)
Send messages to the default JMS destination (or one specified
for each send operation).
|
<T> T |
JmsTemplate.execute(ProducerCallback<T> action) |
<T> T |
JmsOperations.execute(SessionCallback<T> action)
Execute the action specified by the given action object within a JMS Session.
|
<T> T |
JmsTemplate.execute(SessionCallback<T> action) |
<T> T |
JmsTemplate.execute(SessionCallback<T> action,
boolean startConnection)
Execute the action specified by the given action object within a
JMS Session.
|
<T> T |
JmsOperations.execute(String destinationName,
ProducerCallback<T> action)
Send messages to a JMS destination.
|
<T> T |
JmsTemplate.execute(String destinationName,
ProducerCallback<T> action) |
protected Connection |
JmsTemplate.getConnection(JmsResourceHolder holder)
Fetch an appropriate Connection from the given JmsResourceHolder.
|
ConnectionFactory |
JmsMessagingTemplate.getConnectionFactory()
Return the ConnectionFactory that the underlying
JmsTemplate uses. |
Destination |
JmsTemplate.getDefaultDestination()
Return the destination to be used on send/receive operations that do not
have a destination parameter.
|
String |
JmsTemplate.getDefaultDestinationName()
Return the destination name to be used on send/receive operations that
do not have a destination parameter.
|
String |
JmsMessagingTemplate.getDefaultDestinationName()
Return the configured default destination name.
|
JmsTemplate |
JmsMessagingTemplate.getJmsTemplate()
Return the configured
JmsTemplate . |
MessageConverter |
JmsTemplate.getMessageConverter()
Return the message converter for this template.
|
protected Session |
JmsTemplate.getSession(JmsResourceHolder holder)
Fetch an appropriate Session from the given JmsResourceHolder.
|
Message |
JmsOperations.receive()
Receive a message synchronously from the default destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receive() |
Message<?> |
JmsMessagingTemplate.receive() |
Message |
JmsOperations.receive(Destination destination)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receive(Destination destination) |
Message<?> |
JmsMessageOperations.receive(String destinationName)
Receive a message from the given destination.
|
Message |
JmsOperations.receive(String destinationName)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receive(String destinationName) |
Message<?> |
JmsMessagingTemplate.receive(String destinationName) |
Object |
JmsOperations.receiveAndConvert()
Receive a message synchronously from the default destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveAndConvert() |
<T> T |
JmsMessagingTemplate.receiveAndConvert(Class<T> targetClass) |
Object |
JmsOperations.receiveAndConvert(Destination destination)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveAndConvert(Destination destination) |
Object |
JmsOperations.receiveAndConvert(String destinationName)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveAndConvert(String destinationName) |
<T> T |
JmsMessageOperations.receiveAndConvert(String destinationName,
Class<T> targetClass)
Receive a message from the given destination and convert its payload to the
specified target class.
|
<T> T |
JmsMessagingTemplate.receiveAndConvert(String destinationName,
Class<T> targetClass) |
Message |
JmsOperations.receiveSelected(Destination destination,
String messageSelector)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receiveSelected(Destination destination,
String messageSelector) |
Message |
JmsOperations.receiveSelected(String messageSelector)
Receive a message synchronously from the default destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receiveSelected(String messageSelector) |
Message |
JmsOperations.receiveSelected(String destinationName,
String messageSelector)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Message |
JmsTemplate.receiveSelected(String destinationName,
String messageSelector) |
Object |
JmsOperations.receiveSelectedAndConvert(Destination destination,
String messageSelector)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveSelectedAndConvert(Destination destination,
String messageSelector) |
Object |
JmsOperations.receiveSelectedAndConvert(String messageSelector)
Receive a message synchronously from the default destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveSelectedAndConvert(String messageSelector) |
Object |
JmsOperations.receiveSelectedAndConvert(String destinationName,
String messageSelector)
Receive a message synchronously from the specified destination, but only
wait up to a specified time for delivery.
|
Object |
JmsTemplate.receiveSelectedAndConvert(String destinationName,
String messageSelector) |
Message |
JmsOperations.sendAndReceive(Destination destination,
MessageCreator messageCreator)
Send a message and receive the reply from the specified destination.
|
Message |
JmsTemplate.sendAndReceive(Destination destination,
MessageCreator messageCreator) |
Message<?> |
JmsMessagingTemplate.sendAndReceive(Message<?> requestMessage) |
Message |
JmsOperations.sendAndReceive(MessageCreator messageCreator)
Send a request message and receive the reply from a default destination.
|
Message |
JmsTemplate.sendAndReceive(MessageCreator messageCreator) |
Message<?> |
JmsMessageOperations.sendAndReceive(String destinationName,
Message<?> requestMessage)
Send a request message and receive the reply from the given destination.
|
Message<?> |
JmsMessagingTemplate.sendAndReceive(String destinationName,
Message<?> requestMessage) |
Message |
JmsOperations.sendAndReceive(String destinationName,
MessageCreator messageCreator)
Send a message and receive the reply from the specified destination.
|
Message |
JmsTemplate.sendAndReceive(String destinationName,
MessageCreator messageCreator) |
Modifier and Type | Method and Description |
---|---|
<T> T |
JmsTemplate.browseSelected(Queue queue,
String messageSelector,
BrowserCallback<T> action) |
<T> T |
JmsTemplate.browseSelected(String queueName,
String messageSelector,
BrowserCallback<T> action) |
void |
JmsMessagingTemplate.convertAndSend(Object payload,
MessagePostProcessor postProcessor) |
void |
JmsMessagingTemplate.convertAndSend(String destinationName,
Object payload,
Map<String,Object> headers) |
void |
JmsMessageOperations.convertAndSend(String destinationName,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the given destination. |
void |
JmsMessageOperations.convertAndSend(String destinationName,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the given destination. |
void |
JmsMessagingTemplate.convertAndSend(String destinationName,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
JmsMessagingTemplate.convertAndSend(String destinationName,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
JmsMessagingTemplate.convertAndSend(String destinationName,
Object payload,
MessagePostProcessor postProcessor) |
protected Message<?> |
JmsMessagingTemplate.convertJmsMessage(Message message) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor) |
<T> T |
JmsMessageOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message with the given headers, to the specified destination,
receive the reply and convert its body of the specified target class. |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
JmsMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
protected QueueBrowser |
JmsTemplate.createBrowser(Session session,
Queue queue,
String messageSelector)
Create a JMS MessageProducer for the given Session and Destination,
configuring it to disable message ids and/or timestamps (if necessary).
|
protected MessageConsumer |
JmsTemplate.createConsumer(Session session,
Destination destination,
String messageSelector)
Create a JMS MessageConsumer for the given Session and Destination.
|
protected MessageProducer |
JmsTemplate.createProducer(Session session,
Destination destination)
Create a JMS MessageProducer for the given Session and Destination,
configuring it to disable message ids and/or timestamps (if necessary).
|
protected Object |
JmsTemplate.doConvertFromMessage(Message message)
Extract the content from the given JMS message.
|
protected MessageProducer |
JmsTemplate.doCreateProducer(Session session,
Destination destination)
Create a raw JMS MessageProducer for the given Session and Destination.
|
protected Message |
JmsTemplate.doReceive(Session session,
Destination destination,
String messageSelector)
Receive a JMS message.
|
<T> T |
JmsTemplate.execute(Destination destination,
ProducerCallback<T> action) |
Message |
JmsTemplate.receiveSelected(Destination destination,
String messageSelector) |
Message |
JmsTemplate.receiveSelected(String destinationName,
String messageSelector) |
void |
JmsTemplate.setDefaultDestination(Destination destination)
Set the destination to be used on send/receive operations that do not
have a destination parameter.
|
void |
JmsTemplate.setDefaultDestinationName(String destinationName)
Set the destination name to be used on send/receive operations that
do not have a destination parameter.
|
void |
JmsMessagingTemplate.setDefaultDestinationName(String defaultDestinationName)
Configure the default destination name to use in send methods that don't have
a destination argument.
|
void |
JmsMessagingTemplate.setJmsTemplate(JmsTemplate jmsTemplate)
Set the
JmsTemplate to use. |
void |
JmsTemplate.setMessageConverter(MessageConverter messageConverter)
Set the message converter for this template.
|
Modifier and Type | Method and Description |
---|---|
ConnectionFactory |
JmsGatewaySupport.getConnectionFactory()
Return the JMS ConnectionFactory used by the gateway.
|
JmsTemplate |
JmsGatewaySupport.getJmsTemplate()
Return the JmsTemplate for the gateway.
|
Modifier and Type | Method and Description |
---|---|
void |
JmsGatewaySupport.setJmsTemplate(JmsTemplate jmsTemplate)
Set the JmsTemplate for the gateway.
|
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractJmsListeningContainer.getBeanName()
Return the bean name that this listener container has been assigned
in its containing bean factory, if any.
|
String |
AbstractJmsListeningContainer.getClientId()
Return the JMS client ID for the shared Connection created and used
by this container, if any.
|
protected Connection |
AbstractPollingMessageListenerContainer.getConnection(JmsResourceHolder holder)
Fetch an appropriate Connection from the given JmsResourceHolder.
|
Destination |
AbstractMessageListenerContainer.getDestination()
Return the destination to receive messages from.
|
String |
AbstractMessageListenerContainer.getDestinationName()
Return the name of the destination to receive messages from.
|
DestinationResolver |
MessageListenerContainer.getDestinationResolver()
Return the
DestinationResolver to use to resolve
destinations by names. |
String |
AbstractMessageListenerContainer.getDurableSubscriptionName()
Return the name of a durable subscription to create, if any.
|
ErrorHandler |
AbstractMessageListenerContainer.getErrorHandler()
Return the ErrorHandler to be invoked in case of any uncaught exceptions thrown
while processing a Message.
|
ExceptionListener |
AbstractMessageListenerContainer.getExceptionListener()
Return the JMS ExceptionListener to notify in case of a JMSException thrown
by the registered message listener or the invocation infrastructure, if any.
|
MessageConverter |
MessageListenerContainer.getMessageConverter()
Return the
MessageConverter that can be used to
convert Message , if any. |
MessageConverter |
AbstractMessageListenerContainer.getMessageConverter() |
Object |
AbstractMessageListenerContainer.getMessageListener()
Return the message listener object to register.
|
String |
AbstractMessageListenerContainer.getMessageSelector()
Return the JMS message selector expression (or
null if none). |
QosSettings |
MessageListenerContainer.getReplyQosSettings()
Return the
QosSettings to use when sending a reply,
or null if the broker's defaults should be used. |
QosSettings |
AbstractMessageListenerContainer.getReplyQosSettings() |
protected Session |
AbstractPollingMessageListenerContainer.getSession(JmsResourceHolder holder)
Fetch an appropriate Session from the given JmsResourceHolder.
|
String |
AbstractMessageListenerContainer.getSubscriptionName()
Return the name of a subscription to create, if any.
|
protected PlatformTransactionManager |
AbstractPollingMessageListenerContainer.getTransactionManager()
Return the Spring PlatformTransactionManager to use for transactional
wrapping of message reception plus listener execution.
|
protected Message |
AbstractPollingMessageListenerContainer.receiveMessage(MessageConsumer consumer)
Receive a message from the given consumer.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractMessageListenerContainer.checkMessageListener(Object messageListener)
Check the given message listener, throwing an exception
if it does not correspond to a supported listener type.
|
protected void |
AbstractMessageListenerContainer.commitIfNecessary(Session session,
Message message)
Perform a commit or message acknowledgement, as appropriate.
|
protected boolean |
AbstractPollingMessageListenerContainer.doReceiveAndExecute(Object invoker,
Session session,
MessageConsumer consumer,
TransactionStatus status)
Actually execute the listener for a message received from the given consumer,
fetching all requires resources and invoking the listener.
|
protected boolean |
AbstractPollingMessageListenerContainer.doReceiveAndExecute(Object invoker,
Session session,
MessageConsumer consumer,
TransactionStatus status)
Actually execute the listener for a message received from the given consumer,
fetching all requires resources and invoking the listener.
|
protected boolean |
AbstractPollingMessageListenerContainer.doReceiveAndExecute(Object invoker,
Session session,
MessageConsumer consumer,
TransactionStatus status)
Actually execute the listener for a message received from the given consumer,
fetching all requires resources and invoking the listener.
|
protected boolean |
AbstractPollingMessageListenerContainer.receiveAndExecute(Object invoker,
Session session,
MessageConsumer consumer)
Execute the listener for a message received from the given consumer,
wrapping the entire operation in an external transaction if demanded.
|
protected boolean |
AbstractPollingMessageListenerContainer.receiveAndExecute(Object invoker,
Session session,
MessageConsumer consumer)
Execute the listener for a message received from the given consumer,
wrapping the entire operation in an external transaction if demanded.
|
void |
AbstractJmsListeningContainer.setBeanName(String beanName) |
void |
AbstractJmsListeningContainer.setClientId(String clientId)
Specify the JMS client ID for a shared Connection created and used
by this container.
|
void |
AbstractMessageListenerContainer.setDestination(Destination destination)
Set the destination to receive messages from.
|
void |
AbstractMessageListenerContainer.setDestinationName(String destinationName)
Set the name of the destination to receive messages from.
|
void |
AbstractMessageListenerContainer.setDurableSubscriptionName(String durableSubscriptionName)
Set the name of a durable subscription to create.
|
void |
AbstractMessageListenerContainer.setErrorHandler(ErrorHandler errorHandler)
Set the ErrorHandler to be invoked in case of any uncaught exceptions thrown
while processing a Message.
|
void |
AbstractMessageListenerContainer.setExceptionListener(ExceptionListener exceptionListener)
Set the JMS ExceptionListener to notify in case of a JMSException thrown
by the registered message listener or the invocation infrastructure.
|
void |
AbstractMessageListenerContainer.setMessageConverter(MessageConverter messageConverter)
Set the
MessageConverter strategy for converting JMS Messages. |
void |
AbstractMessageListenerContainer.setMessageListener(Object messageListener)
Set the message listener implementation to register.
|
void |
AbstractMessageListenerContainer.setMessageSelector(String messageSelector)
Set the JMS message selector expression (or
null if none). |
void |
AbstractMessageListenerContainer.setReplyQosSettings(QosSettings replyQosSettings)
Configure the
QosSettings to use when sending a reply. |
void |
AbstractMessageListenerContainer.setSubscriptionName(String subscriptionName)
Set the name of a subscription to create.
|
void |
AbstractPollingMessageListenerContainer.setTransactionManager(PlatformTransactionManager transactionManager)
Specify the Spring
PlatformTransactionManager
to use for transactional wrapping of message reception plus listener execution. |
Modifier and Type | Method and Description |
---|---|
protected MessageConverter |
AbstractAdaptableMessageListener.getMessageConverter()
Return the converter that will convert incoming JMS messages to
listener method arguments, and objects returned from listener
methods back to JMS messages.
|
protected QosSettings |
AbstractAdaptableMessageListener.getResponseQosSettings()
Return the
QosSettings to use when sending a response,
or null if the defaults should be used. |
protected Object |
MessageListenerAdapter.invokeListenerMethod(String methodName,
Object[] arguments)
Invoke the specified listener method.
|
protected Destination |
AbstractAdaptableMessageListener.resolveDefaultResponseDestination(Session session)
Resolve the default response destination into a JMS
Destination , using this
accessor's DestinationResolver in case of a destination name. |
Destination |
JmsResponse.resolveDestination(DestinationResolver destinationResolver,
Session session)
Resolve the
Destination to use for this instance. |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractAdaptableMessageListener.handleResult(Object result,
Message request,
Session session)
Handle the given result object returned from the listener method,
sending a response message back.
|
abstract void |
AbstractAdaptableMessageListener.onMessage(Message message,
Session session) |
void |
MessagingMessageListenerAdapter.onMessage(Message jmsMessage,
Session session) |
void |
MessageListenerAdapter.onMessage(Message message,
Session session)
Spring
SessionAwareMessageListener entry point. |
void |
AbstractAdaptableMessageListener.setMessageConverter(MessageConverter messageConverter)
Set the converter that will convert incoming JMS messages to
listener method arguments, and objects returned from listener
methods back to JMS messages.
|
void |
AbstractAdaptableMessageListener.setResponseQosSettings(QosSettings responseQosSettings)
Set the
QosSettings to use when sending a response. |
Modifier and Type | Method and Description |
---|---|
protected Class<?> |
StandardJmsActivationSpecFactory.determineActivationSpecClass(ResourceAdapter adapter)
Determine the ActivationSpec class for the given ResourceAdapter,
if possible.
|
JmsActivationSpecConfig |
JmsMessageEndpointManager.getActivationSpecConfig()
Return the
JmsActivationSpecConfig object that this endpoint manager
should use for activating its listener. |
String |
JmsActivationSpecConfig.getClientId() |
String |
JmsActivationSpecConfig.getDestinationName() |
DestinationResolver |
StandardJmsActivationSpecFactory.getDestinationResolver()
Return the
DestinationResolver to use for resolving destinations names. |
DestinationResolver |
JmsMessageEndpointManager.getDestinationResolver() |
String |
JmsActivationSpecConfig.getDurableSubscriptionName() |
MessageConverter |
JmsMessageEndpointManager.getMessageConverter() |
MessageConverter |
JmsActivationSpecConfig.getMessageConverter()
Return the
MessageConverter to use, if any. |
String |
JmsActivationSpecConfig.getMessageSelector() |
QosSettings |
JmsMessageEndpointManager.getReplyQosSettings() |
QosSettings |
JmsActivationSpecConfig.getReplyQosSettings() |
String |
JmsActivationSpecConfig.getSubscriptionName() |
Modifier and Type | Method and Description |
---|---|
void |
JmsMessageEndpointManager.setActivationSpecConfig(JmsActivationSpecConfig activationSpecConfig)
Specify the
JmsActivationSpecConfig object that this endpoint manager
should use for activating its listener. |
void |
JmsMessageEndpointManager.setActivationSpecFactory(JmsActivationSpecFactory activationSpecFactory)
Set the factory for concrete JCA 1.5 ActivationSpec objects,
creating JCA ActivationSpecs based on
JmsActivationSpecConfig objects. |
void |
JmsActivationSpecConfig.setClientId(String clientId) |
void |
JmsActivationSpecConfig.setDestinationName(String destinationName) |
void |
StandardJmsActivationSpecFactory.setDestinationResolver(DestinationResolver destinationResolver)
Set the DestinationResolver to use for resolving destination names
into the JCA 1.5 ActivationSpec "destination" property.
|
void |
JmsActivationSpecConfig.setDurableSubscriptionName(String durableSubscriptionName) |
void |
JmsActivationSpecConfig.setMessageConverter(MessageConverter messageConverter)
Set the
MessageConverter strategy for converting JMS Messages. |
void |
JmsActivationSpecConfig.setMessageSelector(String messageSelector) |
void |
JmsActivationSpecConfig.setReplyQosSettings(QosSettings replyQosSettings) |
void |
JmsActivationSpecConfig.setSubscriptionName(String subscriptionName) |
Modifier and Type | Method and Description |
---|---|
protected Message |
JmsInvokerClientInterceptor.doExecuteRequest(Session session,
Queue queue,
Message requestMessage)
Deprecated.
Actually execute the given request, sending the invoker request message
to the specified target queue and waiting for a corresponding response.
|
protected ConnectionFactory |
JmsInvokerClientInterceptor.getConnectionFactory()
Deprecated.
Return the QueueConnectionFactory to use for obtaining JMS QueueConnections.
|
Object |
JmsInvokerProxyFactoryBean.getObject()
Deprecated.
|
Object |
JmsInvokerClientInterceptor.invoke(MethodInvocation methodInvocation)
Deprecated.
|
protected RemoteInvocation |
JmsInvokerServiceExporter.onInvalidRequest(Message requestMessage)
Deprecated.
Callback that is invoked by
JmsInvokerServiceExporter.readRemoteInvocation(javax.jms.Message)
when it encounters an invalid request message. |
protected RemoteInvocation |
JmsInvokerServiceExporter.readRemoteInvocation(Message requestMessage)
Deprecated.
Read a RemoteInvocation from the given JMS message.
|
protected Object |
JmsInvokerClientInterceptor.recreateRemoteInvocationResult(RemoteInvocationResult result)
Deprecated.
Recreate the invocation result contained in the given
RemoteInvocationResult
object. |
Modifier and Type | Method and Description |
---|---|
void |
JmsInvokerClientInterceptor.setConnectionFactory(ConnectionFactory connectionFactory)
Deprecated.
Set the QueueConnectionFactory to use for obtaining JMS QueueConnections.
|
void |
JmsInvokerClientInterceptor.setDestinationResolver(DestinationResolver destinationResolver)
Deprecated.
Set the DestinationResolver that is to be used to resolve Queue
references for this accessor.
|
void |
JmsInvokerClientInterceptor.setMessageConverter(MessageConverter messageConverter)
Deprecated.
Specify the
MessageConverter to use for turning
RemoteInvocation
objects into request messages, as well as response messages into
RemoteInvocationResult objects. |
void |
JmsInvokerServiceExporter.setMessageConverter(MessageConverter messageConverter)
Deprecated.
Specify the MessageConverter to use for turning request messages into
RemoteInvocation objects,
as well as RemoteInvocationResult
objects into response messages. |
void |
JmsInvokerClientInterceptor.setRemoteInvocationFactory(RemoteInvocationFactory remoteInvocationFactory)
Deprecated.
Set the
RemoteInvocationFactory to use for this accessor. |
Modifier and Type | Method and Description |
---|---|
ConnectionFactory |
JmsAccessor.getConnectionFactory()
Return the ConnectionFactory that this accessor uses for obtaining
JMS
Connections . |
String |
JmsMessageHeaderAccessor.getCorrelationId()
Return the
correlationId . |
Integer |
JmsMessageHeaderAccessor.getDeliveryMode()
Return the
delivery mode . |
Destination |
JmsMessageHeaderAccessor.getDestination()
Return the
destination . |
Long |
JmsMessageHeaderAccessor.getExpiration()
Return the message
expiration . |
String |
JmsMessageHeaderAccessor.getMessageId()
Return the
message id . |
Integer |
JmsMessageHeaderAccessor.getPriority()
Return the
priority . |
Boolean |
JmsMessageHeaderAccessor.getRedelivered()
Return the
redelivered flag. |
Destination |
JmsMessageHeaderAccessor.getReplyTo()
Return the
reply to . |
Long |
JmsMessageHeaderAccessor.getTimestamp()
Return the
timestamp . |
String |
JmsMessageHeaderAccessor.getType()
Return the
type . |
Modifier and Type | Method and Description |
---|---|
static void |
JmsUtils.closeConnection(Connection con)
Close the given JMS Connection and ignore any thrown exception.
|
static void |
JmsUtils.closeConnection(Connection con,
boolean stop)
Close the given JMS Connection and ignore any thrown exception.
|
static void |
JmsUtils.closeMessageConsumer(MessageConsumer consumer)
Close the given JMS MessageConsumer and ignore any thrown exception.
|
static void |
JmsUtils.closeMessageProducer(MessageProducer producer)
Close the given JMS MessageProducer and ignore any thrown exception.
|
static void |
JmsUtils.closeQueueBrowser(QueueBrowser browser)
Close the given JMS QueueBrowser and ignore any thrown exception.
|
static void |
JmsUtils.closeQueueRequestor(QueueRequestor requestor)
Close the given JMS QueueRequestor and ignore any thrown exception.
|
static void |
JmsUtils.closeSession(Session session)
Close the given JMS Session and ignore any thrown exception.
|
boolean |
QosSettings.equals(Object other) |
void |
JmsAccessor.setConnectionFactory(ConnectionFactory connectionFactory)
Set the ConnectionFactory to use for obtaining JMS
Connections . |
Modifier and Type | Method and Description |
---|---|
protected Class<?> |
MappingJackson2MessageConverter.getSerializationView(Object conversionHint)
Determine a Jackson serialization view based on the given conversion hint.
|
Modifier and Type | Method and Description |
---|---|
protected Message |
MessagingMessageConverter.createMessageForPayload(Object payload,
Session session,
Object conversionHint)
Create a JMS message for the specified payload and conversionHint.
|
protected Class<?> |
MappingJackson2MessageConverter.getSerializationView(Object conversionHint)
Determine a Jackson serialization view based on the given conversion hint.
|
Message |
MappingJackson2MessageConverter.toMessage(Object object,
Session session,
Class<?> jsonView)
Convert a Java object to a JMS Message using the specified json view
and the supplied session to create the message object.
|
Message |
SmartMessageConverter.toMessage(Object object,
Session session,
Object conversionHint)
A variant of
MessageConverter.toMessage(Object, Session) which takes an extra conversion
context as an argument, allowing to take e.g. |
Message |
MappingJackson2MessageConverter.toMessage(Object object,
Session session,
Object conversionHint) |
Constructor and Description |
---|
MessageConversionException(String msg,
Throwable cause)
Create a new MessageConversionException.
|
Modifier and Type | Method and Description |
---|---|
protected Message |
JmsDestinationAccessor.receiveFromConsumer(MessageConsumer consumer,
long timeout)
Actually receive a message from the given consumer.
|
Modifier and Type | Method and Description |
---|---|
Destination |
DestinationResolver.resolveDestinationName(Session session,
String destinationName,
boolean pubSubDomain)
Resolve the given destination name, either as located resource
or as dynamic destination.
|
Destination |
BeanFactoryDestinationResolver.resolveDestinationName(Session session,
String destinationName,
boolean pubSubDomain) |
Destination |
JndiDestinationResolver.resolveDestinationName(Session session,
String destinationName,
boolean pubSubDomain) |
Destination |
DynamicDestinationResolver.resolveDestinationName(Session session,
String destinationName,
boolean pubSubDomain)
Resolve the specified destination name as a dynamic destination.
|
Constructor and Description |
---|
DestinationResolutionException(String msg,
Throwable cause)
Create a new DestinationResolutionException.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
MBeanClientInterceptor.convertResultValueIfNecessary(Object result,
MethodParameter parameter)
Convert the given result object (from attribute access or operation invocation)
to the specified target class for returning from the proxy method.
|
protected Object |
MBeanClientInterceptor.doInvoke(MethodInvocation invocation)
Route the invocation to the configured managed resource.
|
Map<String,?> |
NotificationListenerRegistrar.getEnvironment()
Allow
Map access to the environment to be set for the connector,
with the option to add or override specific entries. |
Map<String,?> |
MBeanClientInterceptor.getEnvironment()
Allow
Map access to the environment to be set for the connector,
with the option to add or override specific entries. |
protected Class<?> |
MBeanClientInterceptor.getManagementInterface()
Return the management interface of the target MBean,
or
null if none specified. |
Object |
MBeanProxyFactoryBean.getObject() |
protected Object |
MBeanClientInterceptor.handleConnectFailure(MethodInvocation invocation,
Exception ex)
Refresh the connection and retry the MBean invocation if possible.
|
Object |
MBeanClientInterceptor.invoke(MethodInvocation invocation)
Route the invocation to the configured managed resource..
|
Modifier and Type | Method and Description |
---|---|
protected Object |
MBeanClientInterceptor.convertResultValueIfNecessary(Object result,
MethodParameter parameter)
Convert the given result object (from attribute access or operation invocation)
to the specified target class for returning from the proxy method.
|
void |
NotificationListenerRegistrar.setEnvironment(Map<String,?> environment)
Specify the environment for the JMX connector.
|
void |
MBeanClientInterceptor.setEnvironment(Map<String,?> environment)
Specify the environment for the JMX connector.
|
void |
MBeanClientInterceptor.setManagementInterface(Class<?> managementInterface)
Set the management interface of the target MBean, exposing bean property
setters and getters for MBean attributes and conventional Java methods
for MBean operations.
|
Modifier and Type | Method and Description |
---|---|
protected DynamicMBean |
MBeanExporter.adaptMBeanIfPossible(Object bean)
Build an adapted MBean for the given bean instance, if possible.
|
Modifier and Type | Method and Description |
---|---|
protected ObjectName |
MBeanExporter.getObjectName(Object bean,
String beanKey)
Retrieve the
ObjectName for a bean. |
protected boolean |
MBeanExporter.isMBean(Class<?> beanClass)
Determine whether the given bean class qualifies as an MBean as-is.
|
Modifier and Type | Method and Description |
---|---|
ManagedAttribute |
AnnotationJmxAttributeSource.getManagedAttribute(Method method) |
ManagedMetric |
AnnotationJmxAttributeSource.getManagedMetric(Method method) |
ManagedOperation |
AnnotationJmxAttributeSource.getManagedOperation(Method method) |
ManagedResource |
AnnotationJmxAttributeSource.getManagedResource(Class<?> beanClass) |
Modifier and Type | Method and Description |
---|---|
protected Integer |
AbstractReflectiveMBeanInfoAssembler.getDefaultCurrencyTimeLimit()
Return default value for the JMX field "currencyTimeLimit", if any.
|
protected ParameterNameDiscoverer |
AbstractReflectiveMBeanInfoAssembler.getParameterNameDiscoverer()
Return the ParameterNameDiscoverer to use for resolving method parameter
names if needed (may be
null in order to skip parameter detection). |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractReflectiveMBeanInfoAssembler.populateAttributeDescriptor(Descriptor desc,
Method getter,
Method setter,
String beanKey)
Allows subclasses to add extra fields to the
Descriptor for a
particular attribute. |
protected void |
AbstractReflectiveMBeanInfoAssembler.populateAttributeDescriptor(Descriptor desc,
Method getter,
Method setter,
String beanKey)
Allows subclasses to add extra fields to the
Descriptor for a
particular attribute. |
protected void |
MetadataMBeanInfoAssembler.populateAttributeDescriptor(Descriptor desc,
Method getter,
Method setter,
String beanKey)
Adds descriptor fields from the
ManagedAttribute attribute or the ManagedMetric attribute
to the attribute descriptor. |
protected void |
MetadataMBeanInfoAssembler.populateAttributeDescriptor(Descriptor desc,
Method getter,
Method setter,
String beanKey)
Adds descriptor fields from the
ManagedAttribute attribute or the ManagedMetric attribute
to the attribute descriptor. |
void |
InterfaceBasedMBeanInfoAssembler.setBeanClassLoader(ClassLoader beanClassLoader) |
void |
AbstractReflectiveMBeanInfoAssembler.setDefaultCurrencyTimeLimit(Integer defaultCurrencyTimeLimit)
Set the default for the JMX field "currencyTimeLimit".
|
void |
InterfaceBasedMBeanInfoAssembler.setInterfaceMappings(Properties mappings)
Set the mappings of bean keys to a comma-separated list of interface names.
|
void |
InterfaceBasedMBeanInfoAssembler.setManagedInterfaces(Class<?>... managedInterfaces)
Set the array of interfaces to use for creating the management info.
|
void |
AbstractReflectiveMBeanInfoAssembler.setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)
Set the ParameterNameDiscoverer to use for resolving method parameter
names if needed (e.g.
|
Modifier and Type | Method and Description |
---|---|
String |
ManagedMetric.getCategory()
The category of this metric (ex.
|
Object |
ManagedAttribute.getDefaultValue()
Return the default value of this attribute.
|
String |
ManagedNotification.getDescription()
Return a description for this notification.
|
String |
ManagedMetric.getDisplayName()
A display name for this metric.
|
String |
ManagedResource.getLogFile() |
ManagedAttribute |
JmxAttributeSource.getManagedAttribute(Method method)
Implementations should return an instance of
ManagedAttribute
if the supplied Method has the corresponding metadata. |
ManagedMetric |
JmxAttributeSource.getManagedMetric(Method method)
Implementations should return an instance of
ManagedMetric
if the supplied Method has the corresponding metadata. |
ManagedOperation |
JmxAttributeSource.getManagedOperation(Method method)
Implementations should return an instance of
ManagedOperation
if the supplied Method has the corresponding metadata. |
ManagedResource |
JmxAttributeSource.getManagedResource(Class<?> clazz)
Implementations should return an instance of
ManagedResource
if the supplied Class has the appropriate metadata. |
String |
ManagedNotification.getName()
Return the name of this notification.
|
String[] |
ManagedNotification.getNotificationTypes()
Return the list of notification types.
|
String |
ManagedResource.getObjectName()
Return the JMX ObjectName of this managed resource.
|
String |
ManagedResource.getPersistLocation() |
String |
ManagedResource.getPersistName() |
String |
ManagedResource.getPersistPolicy() |
String |
ManagedMetric.getPersistPolicy()
The persist policy for this metric.
|
String |
ManagedAttribute.getPersistPolicy() |
String |
ManagedMetric.getUnit()
The expected unit of measurement values.
|
Modifier and Type | Method and Description |
---|---|
void |
ManagedMetric.setCategory(String category)
The category of this metric (ex.
|
void |
ManagedAttribute.setDefaultValue(Object defaultValue)
Set the default value of this attribute.
|
void |
ManagedNotification.setDescription(String description)
Set a description for this notification.
|
void |
ManagedMetric.setDisplayName(String displayName)
A display name for this metric.
|
void |
ManagedResource.setLogFile(String logFile) |
void |
ManagedNotification.setName(String name)
Set the name of this notification.
|
void |
ManagedNotification.setNotificationTypes(String... notificationTypes)
Set a list of notification types.
|
void |
ManagedResource.setObjectName(String objectName)
Set the JMX ObjectName of this managed resource.
|
void |
ManagedResource.setPersistLocation(String persistLocation) |
void |
ManagedResource.setPersistName(String persistName) |
void |
ManagedResource.setPersistPolicy(String persistPolicy) |
void |
ManagedMetric.setPersistPolicy(String persistPolicy)
The persist policy for this metric.
|
void |
ManagedAttribute.setPersistPolicy(String persistPolicy) |
void |
ManagedMetric.setUnit(String unit)
The expected unit of measurement values.
|
Modifier and Type | Method and Description |
---|---|
ObjectName |
IdentityNamingStrategy.getObjectName(Object managedBean,
String beanKey)
Returns an instance of
ObjectName based on the identity
of the managed resource. |
ObjectName |
MetadataNamingStrategy.getObjectName(Object managedBean,
String beanKey)
Reads the
ObjectName from the source-level metadata associated
with the managed resource's Class . |
ObjectName |
KeyNamingStrategy.getObjectName(Object managedBean,
String beanKey)
Attempts to retrieve the
ObjectName via the given key, trying to
find a mapped value in the mappings first. |
ObjectName |
ObjectNamingStrategy.getObjectName(Object managedBean,
String beanKey)
Obtain an
ObjectName for the supplied bean. |
Modifier and Type | Field and Description |
---|---|
protected Set<Object> |
NotificationListenerHolder.mappedObjectNames |
protected MBeanServer |
MBeanRegistrationSupport.server
The
MBeanServer instance being used to register beans. |
Modifier and Type | Method and Description |
---|---|
Object |
NotificationListenerHolder.getHandback()
Return the (arbitrary) object that will be 'handed back' as-is by an
NotificationBroadcaster when notifying
any NotificationListener . |
static Class<?> |
JmxUtils.getMBeanInterface(Class<?> clazz)
Return the Standard MBean interface for the given class, if any
(that is, an interface whose name matches the class name of the
given class but with suffix "MBean").
|
static Class<?> |
JmxUtils.getMXBeanInterface(Class<?> clazz)
Return the Java MXBean interface for the given class, if any
(that is, an interface whose name ends with "MXBean" and/or
carries an appropriate MXBean annotation).
|
NotificationFilter |
NotificationListenerHolder.getNotificationFilter()
Return the
NotificationFilter associated
with the encapsulated NotificationListener . |
NotificationListener |
NotificationListenerHolder.getNotificationListener()
Get the
NotificationListener . |
MBeanServer |
WebSphereMBeanServerFactoryBean.getObject() |
JMXConnectorServer |
ConnectorServerFactoryBean.getObject() |
MBeanServer |
MBeanServerFactoryBean.getObject() |
MBeanServerConnection |
MBeanServerConnectionFactoryBean.getObject() |
ObjectName[] |
NotificationListenerHolder.getResolvedObjectNames()
Return the list of
ObjectName String representations for
which the encapsulated NotificationFilter will
be registered as a listener for Notifications . |
MBeanServer |
MBeanRegistrationSupport.getServer()
Return the
MBeanServer that the beans will be registered with. |
static Class<?>[] |
JmxUtils.parameterInfoToTypes(MBeanParameterInfo[] paramInfo)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
static Class<?>[] |
JmxUtils.parameterInfoToTypes(MBeanParameterInfo[] paramInfo,
ClassLoader classLoader)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
Modifier and Type | Method and Description |
---|---|
protected MBeanServer |
MBeanServerFactoryBean.createMBeanServer(String defaultDomain,
boolean registerWithFactory)
Create a new
MBeanServer instance and register it with the
MBeanServerFactory , if desired. |
boolean |
NotificationListenerHolder.equals(Object other) |
static Class<?> |
JmxUtils.getMBeanInterface(Class<?> clazz)
Return the Standard MBean interface for the given class, if any
(that is, an interface whose name matches the class name of the
given class but with suffix "MBean").
|
static Class<?> |
JmxUtils.getMXBeanInterface(Class<?> clazz)
Return the Java MXBean interface for the given class, if any
(that is, an interface whose name ends with "MXBean" and/or
carries an appropriate MXBean annotation).
|
static boolean |
JmxUtils.isMBean(Class<?> clazz)
Determine whether the given bean class qualifies as an MBean as-is.
|
static MBeanServer |
JmxUtils.locateMBeanServer(String agentId)
Attempt to find a locally running
MBeanServer . |
protected MBeanServer |
MBeanServerFactoryBean.locateMBeanServer(String agentId)
Attempt to locate an existing
MBeanServer . |
static Class<?>[] |
JmxUtils.parameterInfoToTypes(MBeanParameterInfo[] paramInfo)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
static Class<?>[] |
JmxUtils.parameterInfoToTypes(MBeanParameterInfo[] paramInfo,
ClassLoader classLoader)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
static Class<?>[] |
JmxUtils.parameterInfoToTypes(MBeanParameterInfo[] paramInfo,
ClassLoader classLoader)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
void |
ConnectorServerFactoryBean.setEnvironment(Properties environment)
Set the environment properties used to construct the
JMXConnectorServer
as java.util.Properties (String key/value pairs). |
void |
ConnectorServerFactoryBean.setEnvironmentMap(Map<String,?> environment)
Set the environment properties used to construct the
JMXConnector
as a Map of String keys and arbitrary Object values. |
void |
MBeanServerConnectionFactoryBean.setEnvironmentMap(Map<String,?> environment)
Set the environment properties used to construct the
JMXConnector
as a Map of String keys and arbitrary Object values. |
void |
NotificationListenerHolder.setHandback(Object handback)
Set the (arbitrary) object that will be 'handed back' as-is by an
NotificationBroadcaster when notifying
any NotificationListener . |
void |
NotificationListenerHolder.setMappedObjectName(Object mappedObjectName)
Set the
ObjectName -style name of the single MBean
that the encapsulated NotificationFilter
will be registered with to listen for Notifications . |
void |
NotificationListenerHolder.setNotificationFilter(NotificationFilter notificationFilter)
Set the
NotificationFilter associated
with the encapsulated NotificationFilter . |
void |
NotificationListenerHolder.setNotificationListener(NotificationListener notificationListener)
Set the
NotificationListener . |
void |
MBeanRegistrationSupport.setServer(MBeanServer server)
Specify the
MBeanServer instance with which all beans should
be registered. |
Modifier and Type | Method and Description |
---|---|
T |
JndiCallback.doInContext(Context ctx)
Do something with the given JNDI context.
|
<T> T |
JndiTemplate.execute(JndiCallback<T> contextCallback)
Execute the given JNDI context callback implementation.
|
Properties |
JndiTemplate.getEnvironment()
Return the environment for the JNDI InitialContext, if any.
|
Class<?> |
JndiObjectLocator.getExpectedType()
Return the type that the located JNDI object is supposed
to be assignable to, if any.
|
Properties |
JndiAccessor.getJndiEnvironment()
Return the JNDI environment to use for JNDI lookups.
|
String |
JndiObjectLocator.getJndiName()
Return the JNDI name to look up.
|
Object |
JndiObjectFactoryBean.getObject()
Return the singleton JNDI object.
|
Object |
JndiPropertySource.getProperty(String name)
This implementation looks up and returns the value associated with the given
name from the underlying
JndiLocatorDelegate . |
Object |
JndiObjectTargetSource.getTarget() |
Class<?> |
JndiObjectTargetSource.getTargetClass() |
Modifier and Type | Method and Description |
---|---|
protected <T> T |
JndiLocatorSupport.lookup(String jndiName,
Class<T> requiredType)
Perform an actual JNDI lookup for the given name via the JndiTemplate.
|
<T> T |
JndiLocatorDelegate.lookup(String jndiName,
Class<T> requiredType) |
<T> T |
JndiTemplate.lookup(String name,
Class<T> requiredType)
Look up the object with the given name in the current JNDI context.
|
void |
JndiTemplate.releaseContext(Context ctx)
Release a JNDI context as obtained from
JndiTemplate.getContext() . |
void |
JndiTemplateEditor.setAsText(String text) |
void |
JndiTemplate.setEnvironment(Properties environment)
Set the environment for the JNDI InitialContext.
|
void |
JndiObjectLocator.setExpectedType(Class<?> expectedType)
Specify the type that the located JNDI object is supposed
to be assignable to, if any.
|
void |
JndiAccessor.setJndiEnvironment(Properties jndiEnvironment)
Set the JNDI environment to use for JNDI lookups.
|
void |
JndiObjectLocator.setJndiName(String jndiName)
Specify the JNDI name to look up.
|
void |
JndiAccessor.setJndiTemplate(JndiTemplate jndiTemplate)
Set the JNDI template to use for JNDI lookups.
|
Constructor and Description |
---|
JndiTemplate(Properties environment)
Create a new JndiTemplate instance, using the given environment.
|
Modifier and Type | Method and Description |
---|---|
Class<?> |
SimpleJndiBeanFactory.getType(String name) |
Class<?> |
SimpleJndiBeanFactory.getType(String name,
boolean allowFactoryBeanInit) |
Modifier and Type | Method and Description |
---|---|
<T> T |
SimpleJndiBeanFactory.getBean(Class<T> requiredType,
Object... args) |
Object |
SimpleJndiBeanFactory.getBean(String name,
Object... args) |
boolean |
SimpleJndiBeanFactory.isTypeMatch(String name,
Class<?> typeToMatch) |
Modifier and Type | Method and Description |
---|---|
String[] |
SimpleMailMessage.getBcc() |
String[] |
SimpleMailMessage.getCc() |
String |
SimpleMailMessage.getFrom() |
String |
MailSendException.getMessage() |
String |
SimpleMailMessage.getReplyTo() |
Date |
SimpleMailMessage.getSentDate() |
String |
SimpleMailMessage.getSubject() |
String |
SimpleMailMessage.getText() |
String[] |
SimpleMailMessage.getTo() |
Modifier and Type | Method and Description |
---|---|
boolean |
SimpleMailMessage.equals(Object other) |
void |
SimpleMailMessage.setBcc(String... bcc) |
void |
SimpleMailMessage.setBcc(String bcc) |
void |
SimpleMailMessage.setCc(String... cc) |
void |
SimpleMailMessage.setCc(String cc) |
void |
SimpleMailMessage.setFrom(String from) |
void |
SimpleMailMessage.setReplyTo(String replyTo) |
void |
SimpleMailMessage.setSentDate(Date sentDate) |
void |
SimpleMailMessage.setSubject(String subject) |
void |
SimpleMailMessage.setText(String text) |
void |
SimpleMailMessage.setTo(String to) |
Constructor and Description |
---|
MailException(String msg,
Throwable cause)
Constructor for MailException.
|
MailException(String msg,
Throwable cause)
Constructor for MailException.
|
MailSendException(String msg,
Throwable cause)
Constructor for MailSendException.
|
MailSendException(String msg,
Throwable cause,
Map<Object,Exception> failedMessages)
Constructor for registration of failed messages, with the
messages that failed as keys, and the thrown exceptions as values.
|
MailSendException(String msg,
Throwable cause,
Map<Object,Exception> failedMessages)
Constructor for registration of failed messages, with the
messages that failed as keys, and the thrown exceptions as values.
|
Modifier and Type | Method and Description |
---|---|
String |
JavaMailSenderImpl.getDefaultEncoding()
Return the default encoding for
MimeMessages ,
or null if none. |
protected String |
MimeMessageHelper.getDefaultEncoding(MimeMessage mimeMessage)
Determine the default encoding for the given MimeMessage.
|
FileTypeMap |
JavaMailSenderImpl.getDefaultFileTypeMap()
|
String |
MimeMessageHelper.getEncoding()
Return the specific character encoding used for this message, if any.
|
String |
JavaMailSenderImpl.getHost()
Return the mail server host.
|
String |
JavaMailSenderImpl.getPassword()
Return the password for the account at the mail host.
|
String |
JavaMailSenderImpl.getProtocol()
Return the mail protocol.
|
String |
JavaMailSenderImpl.getUsername()
Return the username for the account at the mail host.
|
Modifier and Type | Method and Description |
---|---|
protected FileTypeMap |
ConfigurableMimeFileTypeMap.createFileTypeMap(Resource mappingLocation,
String[] mappings)
Compile a
FileTypeMap from the mappings in the given mapping file
and the given mapping entries. |
protected FileTypeMap |
ConfigurableMimeFileTypeMap.createFileTypeMap(Resource mappingLocation,
String[] mappings)
Compile a
FileTypeMap from the mappings in the given mapping file
and the given mapping entries. |
protected void |
JavaMailSenderImpl.doSend(MimeMessage[] mimeMessages,
Object[] originalMessages)
Actually send the given array of MimeMessages via JavaMail.
|
void |
JavaMailSenderImpl.setDefaultEncoding(String defaultEncoding)
Set the default encoding to use for
MimeMessages
created by this instance. |
void |
JavaMailSenderImpl.setDefaultFileTypeMap(FileTypeMap defaultFileTypeMap)
Set the default Java Activation
FileTypeMap to use for
MimeMessages created by this instance. |
void |
MimeMessageHelper.setFileTypeMap(FileTypeMap fileTypeMap)
Set the Java Activation Framework
FileTypeMap to use
for determining the content type of inline content and attachments
that get added to the message. |
void |
JavaMailSenderImpl.setHost(String host)
Set the mail server host, typically an SMTP host.
|
protected void |
MimeMessageHelper.setMimeMultiparts(MimeMultipart root,
MimeMultipart main)
Set the given MimeMultipart objects for use by this MimeMessageHelper.
|
protected void |
MimeMessageHelper.setMimeMultiparts(MimeMultipart root,
MimeMultipart main)
Set the given MimeMultipart objects for use by this MimeMessageHelper.
|
void |
JavaMailSenderImpl.setPassword(String password)
Set the password for the account at the mail host, if any.
|
void |
JavaMailSenderImpl.setProtocol(String protocol)
Set the mail protocol.
|
void |
JavaMailSenderImpl.setUsername(String username)
Set the username for the account at the mail host, if any.
|
Constructor and Description |
---|
MimeMessageHelper(MimeMessage mimeMessage,
boolean multipart,
String encoding)
Create a new MimeMessageHelper for the given MimeMessage,
in multipart mode (supporting alternative texts, inline
elements and attachments) if requested.
|
MimeMessageHelper(MimeMessage mimeMessage,
int multipartMode,
String encoding)
Create a new MimeMessageHelper for the given MimeMessage,
in multipart mode (supporting alternative texts, inline
elements and attachments) if requested.
|
MimeMessageHelper(MimeMessage mimeMessage,
String encoding)
Create a new MimeMessageHelper for the given MimeMessage,
assuming a simple text message (no multipart content,
i.e.
|
Modifier and Type | Method and Description |
---|---|
Object |
MessageHeaders.get(Object key) |
<T> T |
MessageHeaders.get(Object key,
Class<T> type) |
Object |
MessageHeaders.getErrorChannel() |
Message<?> |
MessagingException.getFailedMessage() |
UUID |
MessageHeaders.getId() |
Object |
MessageHeaders.getReplyChannel() |
Long |
MessageHeaders.getTimestamp() |
Message<?> |
PollableChannel.receive()
Receive a message from this channel, blocking indefinitely if necessary.
|
Message<?> |
PollableChannel.receive(long timeout)
Receive a message from this channel, blocking until either a message is available
or the specified timeout period elapses.
|
Modifier and Type | Method and Description |
---|---|
boolean |
MessageHeaders.equals(Object other) |
Constructor and Description |
---|
MessageHeaders(Map<String,Object> headers)
Construct a
MessageHeaders with the given headers. |
MessageHeaders(Map<String,Object> headers,
UUID id,
Long timestamp)
Constructor providing control over the ID and TIMESTAMP header values.
|
MessageHeaders(Map<String,Object> headers,
UUID id,
Long timestamp)
Constructor providing control over the ID and TIMESTAMP header values.
|
MessageHeaders(Map<String,Object> headers,
UUID id,
Long timestamp)
Constructor providing control over the ID and TIMESTAMP header values.
|
MessagingException(Message<?> message,
String description,
Throwable cause) |
MessagingException(Message<?> message,
String description,
Throwable cause) |
MessagingException(String description,
Throwable cause) |
MessagingException(String description,
Throwable cause) |
Modifier and Type | Method and Description |
---|---|
protected Object |
AbstractMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint)
Convert the message payload from serialized form to an Object.
|
protected Object |
MarshallingMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
MappingJackson2MessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
AbstractJsonMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
AbstractMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint)
Convert the payload object to serialized form.
|
protected Object |
MarshallingMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
MappingJackson2MessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
StringMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
AbstractJsonMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
Object |
AbstractMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass) |
Object |
GenericMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass) |
Object |
MessageConverter.fromMessage(Message<?> message,
Class<?> targetClass)
Convert the payload of a
Message from a serialized form to a typed Object
of the specified target class. |
Object |
CompositeMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass) |
Object |
SimpleMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass) |
Object |
AbstractMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
Object |
CompositeMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
Object |
SmartMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint)
A variant of
MessageConverter.fromMessage(Message, Class) which takes an extra
conversion context as an argument, allowing to take e.g. |
ContentTypeResolver |
AbstractMessageConverter.getContentTypeResolver()
Return the configured
ContentTypeResolver . |
protected MimeType |
AbstractMessageConverter.getDefaultContentType(Object payload)
Return the default content type for the payload.
|
MimeType |
DefaultContentTypeResolver.getDefaultMimeType()
Return the default MIME type to use if no
MessageHeaders.CONTENT_TYPE header is present. |
Marshaller |
MarshallingMessageConverter.getMarshaller()
Return the configured Marshaller.
|
protected MimeType |
AbstractMessageConverter.getMimeType(MessageHeaders headers) |
protected Class<?> |
MappingJackson2MessageConverter.getSerializationView(Object conversionHint)
Determine a Jackson serialization view based on the given conversion hint.
|
Unmarshaller |
MarshallingMessageConverter.getUnmarshaller()
Return the configured unmarshaller.
|
MimeType |
ContentTypeResolver.resolve(MessageHeaders headers)
Determine the
MimeType of a message from the given MessageHeaders. |
MimeType |
DefaultContentTypeResolver.resolve(MessageHeaders headers) |
Message<?> |
AbstractMessageConverter.toMessage(Object payload,
MessageHeaders headers) |
Message<?> |
MessageConverter.toMessage(Object payload,
MessageHeaders headers)
Create a
Message whose payload is the result of converting the given
payload Object to serialized form. |
Message<?> |
CompositeMessageConverter.toMessage(Object payload,
MessageHeaders headers) |
Message<?> |
AbstractMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
CompositeMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
SmartMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint)
A variant of
MessageConverter.toMessage(Object, MessageHeaders) which takes an extra
conversion context as an argument, allowing to take e.g. |
Modifier and Type | Method and Description |
---|---|
protected boolean |
MappingJackson2MessageConverter.canConvertFrom(Message<?> message,
Class<?> targetClass) |
protected boolean |
AbstractMessageConverter.canConvertTo(Object payload,
MessageHeaders headers) |
protected boolean |
MarshallingMessageConverter.canConvertTo(Object payload,
MessageHeaders headers) |
protected boolean |
MappingJackson2MessageConverter.canConvertTo(Object payload,
MessageHeaders headers) |
protected boolean |
ProtobufMessageConverter.canConvertTo(Object payload,
MessageHeaders headers) |
protected Object |
AbstractMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint)
Convert the message payload from serialized form to an Object.
|
protected Object |
MarshallingMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
MappingJackson2MessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
StringMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
ProtobufMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
AbstractJsonMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertFromInternal(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
protected Object |
AbstractMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint)
Convert the payload object to serialized form.
|
protected Object |
AbstractMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint)
Convert the payload object to serialized form.
|
protected Object |
MarshallingMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
MarshallingMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
MappingJackson2MessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
MappingJackson2MessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
StringMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
StringMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
ProtobufMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
ProtobufMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
AbstractJsonMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
AbstractJsonMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
protected Object |
ByteArrayMessageConverter.convertToInternal(Object payload,
MessageHeaders headers,
Object conversionHint) |
Object |
AbstractMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
Object |
CompositeMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint) |
Object |
SmartMessageConverter.fromMessage(Message<?> message,
Class<?> targetClass,
Object conversionHint)
A variant of
MessageConverter.fromMessage(Message, Class) which takes an extra
conversion context as an argument, allowing to take e.g. |
protected JsonEncoding |
MappingJackson2MessageConverter.getJsonEncoding(MimeType contentType)
Determine the JSON encoding to use for the given content type.
|
protected MimeType |
AbstractMessageConverter.getMimeType(MessageHeaders headers) |
protected Class<?> |
MappingJackson2MessageConverter.getSerializationView(Object conversionHint)
Determine a Jackson serialization view based on the given conversion hint.
|
protected void |
MappingJackson2MessageConverter.logWarningIfNecessary(Type type,
Throwable cause)
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check. |
MimeType |
ContentTypeResolver.resolve(MessageHeaders headers)
Determine the
MimeType of a message from the given MessageHeaders. |
MimeType |
DefaultContentTypeResolver.resolve(MessageHeaders headers) |
void |
AbstractMessageConverter.setContentTypeResolver(ContentTypeResolver resolver)
Configure the
ContentTypeResolver to use to resolve the content
type of an input message. |
void |
DefaultContentTypeResolver.setDefaultMimeType(MimeType defaultMimeType)
Set the default MIME type to use when there is no
MessageHeaders.CONTENT_TYPE header present. |
void |
MarshallingMessageConverter.setMarshaller(Marshaller marshaller)
Set the
Marshaller to be used by this message converter. |
void |
MarshallingMessageConverter.setUnmarshaller(Unmarshaller unmarshaller)
Set the
Unmarshaller to be used by this message converter. |
protected boolean |
AbstractMessageConverter.supportsMimeType(MessageHeaders headers) |
Message<?> |
AbstractMessageConverter.toMessage(Object payload,
MessageHeaders headers) |
Message<?> |
MessageConverter.toMessage(Object payload,
MessageHeaders headers)
Create a
Message whose payload is the result of converting the given
payload Object to serialized form. |
Message<?> |
CompositeMessageConverter.toMessage(Object payload,
MessageHeaders headers) |
Message<?> |
SimpleMessageConverter.toMessage(Object payload,
MessageHeaders headers) |
Message<?> |
AbstractMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
AbstractMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
CompositeMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
CompositeMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint) |
Message<?> |
SmartMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint)
A variant of
MessageConverter.toMessage(Object, MessageHeaders) which takes an extra
conversion context as an argument, allowing to take e.g. |
Message<?> |
SmartMessageConverter.toMessage(Object payload,
MessageHeaders headers,
Object conversionHint)
A variant of
MessageConverter.toMessage(Object, MessageHeaders) which takes an extra
conversion context as an argument, allowing to take e.g. |
Constructor and Description |
---|
MessageConversionException(Message<?> failedMessage,
String description,
Throwable cause) |
MessageConversionException(Message<?> failedMessage,
String description,
Throwable cause) |
MessageConversionException(String description,
Throwable cause) |
MessageConversionException(String description,
Throwable cause) |
ProtobufJsonFormatMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with default instances of
JsonFormat.Parser , JsonFormat.Printer , and ExtensionRegistry . |
ProtobufJsonFormatMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer)
Constructor with given instances of
JsonFormat.Parser , JsonFormat.Printer , and a default instance of ExtensionRegistry . |
ProtobufJsonFormatMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer)
Constructor with given instances of
JsonFormat.Parser , JsonFormat.Printer , and a default instance of ExtensionRegistry . |
ProtobufJsonFormatMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser , JsonFormat.Printer , and ExtensionRegistry . |
ProtobufJsonFormatMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser , JsonFormat.Printer , and ExtensionRegistry . |
ProtobufJsonFormatMessageConverter(com.google.protobuf.util.JsonFormat.Parser parser,
com.google.protobuf.util.JsonFormat.Printer printer,
com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with given instances of
JsonFormat.Parser , JsonFormat.Printer , and ExtensionRegistry . |
Modifier and Type | Method and Description |
---|---|
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message to the given destination, receive the reply and convert
its body of the specified target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Class<T> targetClass) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
apply the given post processor and send the resulting Message to the
given destination, receive the reply and convert its body of the given
target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message with the given headers, to the specified destination,
receive the reply and convert its body of the specified target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor
and send the resulting Message to the specified destination, receive
the reply and convert its body of the given target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(Object request,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message to a default destination, receive the reply and convert
its body of the specified target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
apply the given post processor and send the resulting Message to a
default destination, receive the reply and convert its body of the given
target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message and send it to the resolved destination, receive a reply
and convert its body to the specified target class. |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message, apply the given post process, and send the resulting
message to the resolved destination, then receive a reply and convert its
body to the specified target class. |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers and send it to the resolved destination,
receive a reply and convert its body to the specified target class. |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post process,
and send the resulting message to the resolved destination, then receive
a reply and convert its body to the specified target class. |
protected <T> T |
AbstractMessageReceivingTemplate.doConvert(Message<?> message,
Class<T> targetClass)
Convert from the given message to the given target class.
|
protected abstract Message<?> |
AbstractMessageReceivingTemplate.doReceive(D destination)
Actually receive a message from the given destination.
|
protected Message<?> |
GenericMessagingTemplate.doReceive(MessageChannel channel) |
protected Message<?> |
GenericMessagingTemplate.doReceive(MessageChannel channel,
long timeout) |
protected abstract Message<?> |
AbstractMessagingTemplate.doSendAndReceive(D destination,
Message<?> requestMessage) |
protected Message<?> |
GenericMessagingTemplate.doSendAndReceive(MessageChannel channel,
Message<?> requestMessage) |
D |
AbstractMessageSendingTemplate.getDefaultDestination()
Return the configured default destination.
|
DestinationResolver<D> |
AbstractDestinationResolvingMessagingTemplate.getDestinationResolver()
Return the configured destination resolver.
|
protected Map<String,Object> |
AbstractMessageSendingTemplate.processHeadersToSend(Map<String,Object> headers)
Provides access to the map of input headers before a send operation.
|
Message<?> |
AbstractMessageReceivingTemplate.receive() |
Message<?> |
MessageReceivingOperations.receive()
Receive a message from a default destination.
|
Message<?> |
AbstractMessageReceivingTemplate.receive(D destination) |
Message<?> |
MessageReceivingOperations.receive(D destination)
Receive a message from the given destination.
|
Message<?> |
DestinationResolvingMessageReceivingOperations.receive(String destinationName)
Resolve the given destination name and receive a message from it.
|
Message<?> |
AbstractDestinationResolvingMessagingTemplate.receive(String destinationName) |
<T> T |
AbstractMessageReceivingTemplate.receiveAndConvert(Class<T> targetClass) |
<T> T |
MessageReceivingOperations.receiveAndConvert(Class<T> targetClass)
Receive a message from a default destination and convert its payload to the
specified target class.
|
<T> T |
AbstractMessageReceivingTemplate.receiveAndConvert(D destination,
Class<T> targetClass) |
<T> T |
MessageReceivingOperations.receiveAndConvert(D destination,
Class<T> targetClass)
Receive a message from the given destination and convert its payload to the
specified target class.
|
<T> T |
DestinationResolvingMessageReceivingOperations.receiveAndConvert(String destinationName,
Class<T> targetClass)
Resolve the given destination name, receive a message from it,
convert the payload to the specified target type.
|
<T> T |
AbstractDestinationResolvingMessagingTemplate.receiveAndConvert(String destinationName,
Class<T> targetClass) |
Message<?> |
MessageRequestReplyOperations.sendAndReceive(D destination,
Message<?> requestMessage)
Send a request message and receive the reply from the given destination.
|
Message<?> |
AbstractMessagingTemplate.sendAndReceive(D destination,
Message<?> requestMessage) |
Message<?> |
MessageRequestReplyOperations.sendAndReceive(Message<?> requestMessage)
Send a request message and receive the reply from a default destination.
|
Message<?> |
AbstractMessagingTemplate.sendAndReceive(Message<?> requestMessage) |
Message<?> |
AbstractDestinationResolvingMessagingTemplate.sendAndReceive(String destinationName,
Message<?> requestMessage) |
Message<?> |
DestinationResolvingMessageRequestReplyOperations.sendAndReceive(String destinationName,
Message<?> requestMessage)
Resolve the given destination name to a destination and send the given message,
receive a reply and return it.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractMessageSendingTemplate.convertAndSend(D destination,
Object payload,
Map<String,Object> headers) |
void |
MessageSendingOperations.convertAndSend(D destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the given destination. |
void |
MessageSendingOperations.convertAndSend(D destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the given destination. |
void |
AbstractMessageSendingTemplate.convertAndSend(D destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
AbstractMessageSendingTemplate.convertAndSend(D destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
AbstractMessageSendingTemplate.convertAndSend(D destination,
Object payload,
MessagePostProcessor postProcessor) |
void |
MessageSendingOperations.convertAndSend(Object payload,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message, apply the given post processor, and send
the resulting message to a default destination. |
void |
AbstractMessageSendingTemplate.convertAndSend(Object payload,
MessagePostProcessor postProcessor) |
<T> void |
DestinationResolvingMessageSendingOperations.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers)
Resolve the given destination name to a destination, convert the payload
Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers and send it to the resolved
destination. |
<T> void |
AbstractDestinationResolvingMessagingTemplate.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers) |
<T> void |
DestinationResolvingMessageSendingOperations.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Resolve the given destination name to a destination, convert the payload
Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the resolved destination. |
<T> void |
DestinationResolvingMessageSendingOperations.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Resolve the given destination name to a destination, convert the payload
Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor,
and send the resulting message to the resolved destination. |
<T> void |
AbstractDestinationResolvingMessagingTemplate.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
<T> void |
AbstractDestinationResolvingMessagingTemplate.convertAndSend(String destinationName,
T payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
<T> void |
DestinationResolvingMessageSendingOperations.convertAndSend(String destinationName,
T payload,
MessagePostProcessor postProcessor)
Resolve the given destination name to a destination, convert the payload
Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message, apply the given post processor, and send the resulting
message to the resolved destination. |
<T> void |
AbstractDestinationResolvingMessagingTemplate.convertAndSend(String destinationName,
T payload,
MessagePostProcessor postProcessor) |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Convert the given request Object to serialized form, possibly using a
MessageConverter , send
it as a Message with the given headers, to the specified destination,
receive the reply and convert its body of the specified target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor
and send the resulting Message to the specified destination, receive
the reply and convert its body of the given target class. |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post processor
and send the resulting Message to the specified destination, receive
the reply and convert its body of the given target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(D destination,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
MessageRequestReplyOperations.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Convert the given request Object to serialized form, possibly using a
MessageConverter ,
apply the given post processor and send the resulting Message to a
default destination, receive the reply and convert its body of the given
target class. |
<T> T |
AbstractMessagingTemplate.convertSendAndReceive(Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message, apply the given post process, and send the resulting
message to the resolved destination, then receive a reply and convert its
body to the specified target class. |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers and send it to the resolved destination,
receive a reply and convert its body to the specified target class. |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor postProcessor) |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post process,
and send the resulting message to the resolved destination, then receive
a reply and convert its body to the specified target class. |
<T> T |
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive(String destinationName,
Object request,
Map<String,Object> headers,
Class<T> targetClass,
MessagePostProcessor requestPostProcessor)
Resolve the given destination name, convert the payload request Object
to serialized form, possibly using a
MessageConverter ,
wrap it as a message with the given headers, apply the given post process,
and send the resulting message to the resolved destination, then receive
a reply and convert its body to the specified target class. |
protected Message<?> |
AbstractMessageSendingTemplate.doConvert(Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter , wrap it as a message with the given
headers and apply the given post processor. |
protected Message<?> |
AbstractMessageSendingTemplate.doConvert(Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Convert the given Object to serialized form, possibly using a
MessageConverter , wrap it as a message with the given
headers and apply the given post processor. |
protected Map<String,Object> |
AbstractMessageSendingTemplate.processHeadersToSend(Map<String,Object> headers)
Provides access to the map of input headers before a send operation.
|
void |
AbstractMessageSendingTemplate.setDefaultDestination(D defaultDestination)
Configure the default destination to use in send methods that don't have
a destination argument.
|
void |
AbstractDestinationResolvingMessagingTemplate.setDestinationResolver(DestinationResolver<D> destinationResolver)
Configure the
DestinationResolver to use to resolve String destination
names into actual destinations of type <D> . |
Constructor and Description |
---|
DestinationResolutionException(String description,
Throwable cause) |
DestinationResolutionException(String description,
Throwable cause) |
Modifier and Type | Method and Description |
---|---|
protected static Object |
HandlerMethod.findProvidedArgument(MethodParameter parameter,
Object... providedArgs) |
Class<?> |
MessagingAdviceBean.getBeanType()
Return the type of the contained advice bean.
|
DestinationPatternsMessageCondition |
DestinationPatternsMessageCondition.getMatchingCondition(Message<?> message)
Check if any of the patterns match the given Message destination and return an instance
that is guaranteed to contain matching patterns, sorted via
PathMatcher.getPatternComparator(String) . |
T |
MessageCondition.getMatchingCondition(Message<?> message)
Check if this condition matches the given Message and returns a
potentially new condition with content tailored to the current message.
|
<A extends Annotation> |
HandlerMethod.getMethodAnnotation(Class<A> annotationType)
Return a single annotation on the underlying method traversing its super methods
if no annotation can be found on the given method itself.
|
HandlerMethod |
HandlerMethod.getResolvedFromHandlerMethod()
Return the HandlerMethod from which this HandlerMethod instance was
resolved via
HandlerMethod.createWithResolvedBean() . |
Modifier and Type | Method and Description |
---|---|
boolean |
HandlerMethod.equals(Object other) |
boolean |
AbstractMessageCondition.equals(Object other) |
boolean |
CompositeMessageCondition.equals(Object other) |
protected static Object |
HandlerMethod.findProvidedArgument(MethodParameter parameter,
Object... providedArgs) |
MethodParameter |
HandlerMethod.getReturnValueType(Object returnValue)
Return the actual return value type.
|
Constructor and Description |
---|
DestinationPatternsMessageCondition(String[] patterns,
PathMatcher matcher)
Constructor with patterns and a
PathMatcher instance. |
Modifier and Type | Method and Description |
---|---|
protected CompositeMessageCondition |
MessageMappingMessageHandler.getCondition(AnnotatedElement element)
Determine the mapping condition for the given annotated element.
|
protected MimeType |
PayloadMethodArgumentResolver.getMimeType(Message<?> message)
Return the mime type for the content.
|
RouteMatcher |
MessageMappingMessageHandler.getRouteMatcher()
Return the
RouteMatcher used to map messages to handlers. |
Validator |
PayloadMethodArgumentResolver.getValidator()
Return the configured validator, if any.
|
Validator |
MessageMappingMessageHandler.getValidator()
Return the configured Validator instance.
|
protected Object |
DestinationVariableMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name) |
protected abstract Object |
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name)
Resolves the given parameter type and value name into an argument value.
|
protected Object |
HeaderMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name) |
Object |
HeadersMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter,
Message<?> message) |
Modifier and Type | Method and Description |
---|---|
void |
MessageMappingMessageHandler.setRouteMatcher(RouteMatcher routeMatcher)
Set the
RouteMatcher to use for mapping messages to handlers
based on the route patterns they're configured with. |
void |
MessageMappingMessageHandler.setValidator(Validator validator)
Set the Validator instance used for validating
@Payload arguments. |
Constructor and Description |
---|
AbstractNamedValueMethodArgumentResolver(ConversionService conversionService,
ConfigurableBeanFactory beanFactory)
Constructor with a
ConversionService and a BeanFactory . |
HeaderMethodArgumentResolver(ConversionService conversionService,
ConfigurableBeanFactory beanFactory) |
NamedValueInfo(String name,
boolean required,
String defaultValue) |
PayloadMethodArgumentResolver(List<? extends Decoder<?>> decoders,
Validator validator,
ReactiveAdapterRegistry registry,
boolean useDefaultResolution) |
PayloadMethodArgumentResolver(List<? extends Decoder<?>> decoders,
Validator validator,
ReactiveAdapterRegistry registry,
boolean useDefaultResolution) |
Modifier and Type | Method and Description |
---|---|
BindingResult |
MethodArgumentNotValidException.getBindingResult()
Return the BindingResult if the failure is validation-related,
or
null if none. |
Object |
PayloadMethodArgumentResolver.resolveArgument(MethodParameter parameter,
Message<?> message) |
Object |
HeadersMethodArgumentResolver.resolveArgument(MethodParameter parameter,
Message<?> message) |
protected Object |
DestinationVariableMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name) |
protected abstract Object |
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name)
Resolves the given parameter type and value name into an argument value.
|
protected Object |
HeaderMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter,
Message<?> message,
String name) |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractNamedValueMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
Message<?> message)
Invoked after a value is resolved.
|
protected boolean |
PayloadMethodArgumentResolver.isEmptyPayload(Object payload)
Specify if the given
payload is empty. |
protected boolean |
MessageMethodArgumentResolver.isEmptyPayload(Object payload)
Check if the given
payload is empty. |
void |
DefaultMessageHandlerMethodFactory.setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types effectively overriding
the ones configured by default.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
InvocableHandlerMethod.doInvoke(Object... args)
Invoke the handler method with the given argument values.
|
ApplicationContext |
AbstractMethodMessageHandler.getApplicationContext() |
protected abstract String |
AbstractMethodMessageHandler.getDestination(Message<?> message) |
protected InvocableHandlerMethod |
AbstractMethodMessageHandler.getExceptionHandlerMethod(HandlerMethod handlerMethod,
Exception exception)
Find an
@MessageExceptionHandler method for the given exception. |
protected Log |
AbstractMethodMessageHandler.getHandlerMethodLogger()
Return a logger to set on
InvocableHandlerMethod . |
protected String |
AbstractMethodMessageHandler.getLookupDestination(String destination)
Check whether the given destination (of an incoming message) matches to
one of the configured destination prefixes and if so return the remaining
portion of the destination after the matched prefix.
|
protected abstract T |
AbstractMethodMessageHandler.getMappingForMethod(Method method,
Class<?> handlerType)
Provide the mapping for a handler method.
|
protected abstract T |
AbstractMethodMessageHandler.getMatchingMapping(T mapping,
Message<?> message)
Check if a mapping matches the current message and return a possibly
new mapping with conditions relevant to the current request.
|
protected Log |
AbstractMethodMessageHandler.getReturnValueHandlerLogger()
Return a logger to set on
HandlerMethodReturnValueHandlerComposite . |
Object |
InvocableHandlerMethod.invoke(Message<?> message,
Object... providedArgs)
Invoke the method after resolving its argument values in the context of the given message.
|
Object |
HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter,
Message<?> message)
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. |
Object |
HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
Message<?> message)
Resolves a method parameter into an argument value from a given message.
|
Method |
AbstractExceptionHandlerMethodResolver.resolveMethod(Throwable exception)
Find a
Method to handle the given exception. |
Method |
AbstractExceptionHandlerMethodResolver.resolveMethodByExceptionType(Class<? extends Throwable> exceptionType)
Find a
Method to handle the given exception type. |
ListenableFuture<?> |
AsyncHandlerMethodReturnValueHandler.toListenableFuture(Object returnValue,
MethodParameter returnType)
Adapt the asynchronous return value to a
ListenableFuture . |
ListenableFuture<?> |
HandlerMethodReturnValueHandlerComposite.toListenableFuture(Object returnValue,
MethodParameter returnType) |
Modifier and Type | Method and Description |
---|---|
HandlerMethodReturnValueHandlerComposite |
HandlerMethodReturnValueHandlerComposite.addHandlers(List<? extends HandlerMethodReturnValueHandler> handlers)
Add the given
HandlerMethodReturnValueHandlers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(HandlerMethodArgumentResolver... resolvers)
Add the given
HandlerMethodArgumentResolvers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(List<? extends HandlerMethodArgumentResolver> resolvers)
Add the given
HandlerMethodArgumentResolvers . |
protected String |
AbstractMethodMessageHandler.getLookupDestination(String destination)
Check whether the given destination (of an incoming message) matches to
one of the configured destination prefixes and if so return the remaining
portion of the destination after the matched prefix.
|
void |
HandlerMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message)
Handle the given return value.
|
void |
AbstractAsyncReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
void |
HandlerMethodReturnValueHandlerComposite.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
void |
AbstractMethodMessageHandler.setApplicationContext(ApplicationContext applicationContext) |
void |
AbstractMethodMessageHandler.setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types, effectively overriding
the ones configured by default.
|
void |
AbstractMethodMessageHandler.setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> customArgumentResolvers)
Sets the list of custom
HandlerMethodArgumentResolver s that will be used
after resolvers for supported argument type. |
void |
AbstractMethodMessageHandler.setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> customReturnValueHandlers)
Set the list of custom
HandlerMethodReturnValueHandler s that will be used
after return value handlers for known types. |
void |
AbstractMethodMessageHandler.setDestinationPrefixes(Collection<String> prefixes)
When this property is configured only messages to destinations matching
one of the configured prefixes are eligible for handling.
|
void |
AbstractMethodMessageHandler.setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Configure the complete list of supported return value types, effectively overriding
the ones configured by default.
|
Constructor and Description |
---|
MethodArgumentResolutionException(Message<?> message,
MethodParameter parameter,
String description,
Throwable cause)
Create a new instance providing the invalid
MethodParameter ,
prepared description, and a cause. |
Modifier and Type | Method and Description |
---|---|
ApplicationContext |
AbstractMethodMessageHandler.getApplicationContext() |
HandlerMethodArgumentResolver |
HandlerMethodArgumentResolverComposite.getArgumentResolver(MethodParameter parameter)
Find a registered
HandlerMethodArgumentResolver that supports
the given method parameter. |
protected abstract RouteMatcher.Route |
AbstractMethodMessageHandler.getDestination(Message<?> message)
Extract the destination from the given message.
|
Predicate<Class<?>> |
AbstractMethodMessageHandler.getHandlerPredicate()
Return the
configured handler predicate. |
protected abstract T |
AbstractMethodMessageHandler.getMappingForMethod(Method method,
Class<?> handlerType)
Obtain the mapping for the given method, if any.
|
protected abstract T |
AbstractMethodMessageHandler.getMatchingMapping(T mapping,
Message<?> message)
Check if a mapping matches the current message and return a possibly
new mapping with conditions relevant to the current request.
|
Object |
SyncHandlerMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter,
Message<?> message)
Resolve the value for the method parameter synchronously.
|
Modifier and Type | Method and Description |
---|---|
HandlerMethodReturnValueHandlerComposite |
HandlerMethodReturnValueHandlerComposite.addHandlers(List<? extends HandlerMethodReturnValueHandler> handlers)
Add the given
HandlerMethodReturnValueHandlers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(HandlerMethodArgumentResolver... resolvers)
Add the given
HandlerMethodArgumentResolvers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(List<? extends HandlerMethodArgumentResolver> resolvers)
Add the given
HandlerMethodArgumentResolvers . |
protected void |
AbstractMethodMessageHandler.handleNoMatch(RouteMatcher.Route destination,
Message<?> message)
Invoked when no matching handler is found.
|
reactor.core.publisher.Mono<Void> |
HandlerMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message)
Handle the given return value.
|
reactor.core.publisher.Mono<Void> |
AbstractEncoderMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
reactor.core.publisher.Mono<Void> |
HandlerMethodReturnValueHandlerComposite.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
void |
AbstractMethodMessageHandler.setApplicationContext(ApplicationContext applicationContext) |
void |
AbstractMethodMessageHandler.setHandlerPredicate(Predicate<Class<?>> handlerPredicate)
Configure a predicate for selecting which Spring beans to check for the
presence of message handler methods.
|
Modifier and Type | Method and Description |
---|---|
RSocket |
RSocketRequester.rsocket()
Return the underlying
RSocket if the requester was created with a
"live" RSocket via RSocketRequester.wrap(RSocket, MimeType, MimeType, RSocketStrategies)
or via one of the (deprecated) connect methods on the
RSocketRequester builder, or otherwise return null . |
Modifier and Type | Method and Description |
---|---|
RSocketStrategies.Builder |
RSocketStrategies.Builder.dataBufferFactory(DataBufferFactory bufferFactory)
Configure the DataBufferFactory to use for allocating buffers when
preparing requests or creating responses.
|
RSocketRequester.Builder |
RSocketRequester.Builder.dataMimeType(MimeType mimeType)
Configure the payload data MimeType to specify on the
SETUP
frame that applies to the whole connection. |
default <T> Decoder<T> |
RSocketStrategies.decoder(ResolvableType elementType,
MimeType mimeType)
Find a compatible Decoder for the given element type.
|
default <T> Encoder<T> |
RSocketStrategies.encoder(ResolvableType elementType,
MimeType mimeType)
Find a compatible Encoder for the given element type.
|
RSocketRequester.RequestSpec |
RSocketRequester.metadata(Object metadata,
MimeType mimeType)
Begin to specify a new request with the given metadata value, which can
be a concrete value or any producer of a single value that can be adapted
to a
Publisher via ReactiveAdapterRegistry . |
RSocketStrategies.Builder |
RSocketStrategies.Builder.metadataExtractor(MetadataExtractor metadataExtractor)
Configure a
MetadataExtractor to extract the route along with
other metadata. |
default void |
MetadataExtractorRegistry.metadataToExtract(MimeType mimeType,
Class<?> targetType,
String name)
Decode metadata entries with the given
MimeType to the specified
target class, and store the decoded value in the output map under the
given name. |
default void |
MetadataExtractorRegistry.metadataToExtract(MimeType mimeType,
ParameterizedTypeReference<?> targetType,
String name)
Variant of
MetadataExtractorRegistry.metadataToExtract(MimeType, Class, String) that accepts
ParameterizedTypeReference instead of Class for
specifying a target type with generic parameters. |
RSocketStrategies.Builder |
RSocketStrategies.Builder.reactiveAdapterStrategy(ReactiveAdapterRegistry registry)
Configure the registry for reactive type support.
|
RSocketStrategies.Builder |
RSocketStrategies.Builder.routeMatcher(RouteMatcher routeMatcher)
Configure a
RouteMatcher for matching routes to message
handlers based on route patterns. |
RSocketRequester.Builder |
RSocketRequester.Builder.rsocketStrategies(RSocketStrategies strategies)
Provide the
RSocketStrategies to use. |
RSocketRequester.Builder |
RSocketRequester.Builder.setupMetadata(Object value,
MimeType mimeType)
Add metadata entry to the setup payload.
|
Modifier and Type | Method and Description |
---|---|
protected CompositeMessageCondition |
RSocketMessageHandler.getCondition(AnnotatedElement element) |
MimeType |
RSocketMessageHandler.getDefaultDataMimeType()
Return the configured
defaultDataMimeType , or null . |
static FrameType |
RSocketFrameTypeMessageCondition.getFrameType(Message<?> message)
Find the RSocket frame type in the message headers.
|
Modifier and Type | Method and Description |
---|---|
protected void |
RSocketMessageHandler.handleNoMatch(RouteMatcher.Route destination,
Message<?> message) |
void |
RSocketMessageHandler.setDefaultDataMimeType(MimeType mimeType)
Configure the default content type to use for data payloads if the
SETUP frame did not specify one. |
void |
RSocketMessageHandler.setRouteMatcher(RouteMatcher routeMatcher)
Set the
RouteMatcher to use for mapping messages to handlers
based on the route patterns they're configured with. |
Modifier and Type | Method and Description |
---|---|
Object |
SimpAttributes.getAttribute(String name)
Return the value for the attribute of the given name, if any.
|
static SimpAttributes |
SimpAttributesContextHolder.getAttributes()
Return the SimpAttributes currently bound to the thread.
|
String |
SimpMessageHeaderAccessor.getDestination() |
static String |
SimpMessageHeaderAccessor.getDestination(Map<String,Object> headers) |
MessageHeaderInitializer |
SimpMessagingTemplate.getHeaderInitializer()
Return the configured header initializer.
|
static long[] |
SimpMessageHeaderAccessor.getHeartbeat(Map<String,Object> headers) |
SimpMessageTypeMessageCondition |
SimpMessageTypeMessageCondition.getMatchingCondition(Message<?> message) |
SimpMessageMappingInfo |
SimpMessageMappingInfo.getMatchingCondition(Message<?> message) |
SimpMessageType |
SimpMessageHeaderAccessor.getMessageType() |
static SimpMessageType |
SimpMessageHeaderAccessor.getMessageType(Map<String,Object> headers) |
Map<String,Object> |
SimpMessageHeaderAccessor.getSessionAttributes()
Return the attributes associated with the current session.
|
static Map<String,Object> |
SimpMessageHeaderAccessor.getSessionAttributes(Map<String,Object> headers) |
String |
SimpMessageHeaderAccessor.getSessionId()
Return the id of the current session.
|
static String |
SimpMessageHeaderAccessor.getSessionId(Map<String,Object> headers) |
String |
SimpMessageHeaderAccessor.getSubscriptionId() |
static String |
SimpMessageHeaderAccessor.getSubscriptionId(Map<String,Object> headers) |
Principal |
SimpMessageHeaderAccessor.getUser()
Return the user associated with the current session.
|
static Principal |
SimpMessageHeaderAccessor.getUser(Map<String,Object> headers) |
Object |
SimpSessionScope.remove(String name) |
Object |
SimpSessionScope.resolveContextualObject(String key) |
Modifier and Type | Method and Description |
---|---|
void |
SimpMessagingTemplate.convertAndSendToUser(String user,
String destination,
Object payload,
Map<String,Object> headers) |
void |
SimpMessageSendingOperations.convertAndSendToUser(String user,
String destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Send a message to the given user.
|
void |
SimpMessageSendingOperations.convertAndSendToUser(String user,
String destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor)
Send a message to the given user.
|
void |
SimpMessagingTemplate.convertAndSendToUser(String user,
String destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
SimpMessagingTemplate.convertAndSendToUser(String user,
String destination,
Object payload,
Map<String,Object> headers,
MessagePostProcessor postProcessor) |
void |
SimpMessagingTemplate.convertAndSendToUser(String user,
String destination,
Object payload,
MessagePostProcessor postProcessor) |
boolean |
SimpMessageMappingInfo.equals(Object other) |
String |
SimpMessageHeaderAccessor.getDetailedLogMessage(Object payload) |
protected Map<String,Object> |
SimpMessagingTemplate.processHeadersToSend(Map<String,Object> headers)
Creates a new map and puts the given headers under the key
NATIVE_HEADERS NATIVE_HEADERS NATIVE_HEADERS . |
static void |
SimpAttributesContextHolder.setAttributes(SimpAttributes attributes)
Bind the given SimpAttributes to the current thread.
|
void |
SimpMessageHeaderAccessor.setDestination(String destination) |
void |
SimpMessagingTemplate.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of all
messages created through the SimpMessagingTemplate . |
void |
SimpMessageHeaderAccessor.setSessionAttributes(Map<String,Object> attributes)
A static alternative for access to the session attributes header.
|
void |
SimpMessageHeaderAccessor.setSessionId(String sessionId) |
void |
SimpMessageHeaderAccessor.setSubscriptionId(String subscriptionId) |
void |
SimpMessageHeaderAccessor.setUser(Principal principal) |
Constructor and Description |
---|
SimpMessageHeaderAccessor(SimpMessageType messageType,
Map<String,List<String>> externalSourceHeaders)
A constructor for creating new message headers.
|
Modifier and Type | Method and Description |
---|---|
protected String |
SimpAnnotationMethodMessageHandler.getDestination(Message<?> message) |
MessageHeaderInitializer |
SimpAnnotationMethodMessageHandler.getHeaderInitializer()
Return the configured header initializer.
|
MessageHeaderInitializer |
SubscriptionMethodReturnValueHandler.getHeaderInitializer()
Return the configured header initializer.
|
MessageHeaderInitializer |
SendToMethodReturnValueHandler.getHeaderInitializer()
Return the configured header initializer.
|
protected SimpMessageMappingInfo |
SimpAnnotationMethodMessageHandler.getMappingForMethod(Method method,
Class<?> handlerType) |
protected SimpMessageMappingInfo |
SimpAnnotationMethodMessageHandler.getMatchingMapping(SimpMessageMappingInfo mapping,
Message<?> message) |
protected String |
SendToMethodReturnValueHandler.getUserName(Message<?> message,
MessageHeaders headers) |
Validator |
SimpAnnotationMethodMessageHandler.getValidator()
Return the configured Validator instance.
|
Modifier and Type | Method and Description |
---|---|
protected String |
SimpAnnotationMethodMessageHandler.getLookupDestination(String destination) |
protected String[] |
SendToMethodReturnValueHandler.getTargetDestinations(Annotation annotation,
Message<?> message,
String defaultPrefix) |
void |
SubscriptionMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
void |
SendToMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
Message<?> message) |
void |
SimpAnnotationMethodMessageHandler.setDestinationPrefixes(Collection<String> prefixes)
When this property is configured only messages to destinations matching
one of the configured prefixes are eligible for handling.
|
void |
SimpAnnotationMethodMessageHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to pass on to
HandlerMethodReturnValueHandlers
that send messages from controller return values. |
void |
SubscriptionMethodReturnValueHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of all
messages sent to the client outbound channel. |
void |
SendToMethodReturnValueHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of all
messages sent to the client outbound channel. |
void |
SimpAnnotationMethodMessageHandler.setValidator(Validator validator)
Set the Validator instance used for validating
@Payload arguments. |
Modifier and Type | Method and Description |
---|---|
ApplicationEventPublisher |
AbstractBrokerMessageHandler.getApplicationEventPublisher() |
MessageHeaderInitializer |
SimpleBrokerMessageHandler.getHeaderInitializer()
Return the configured header initializer.
|
long[] |
SimpleBrokerMessageHandler.getHeartbeatValue()
The configured value for the heart-beat settings.
|
static Runnable |
OrderedMessageChannelDecorator.getNextMessageTask(Message<?> message)
Obtain the task to release the next message, if found.
|
String |
DefaultSubscriptionRegistry.getSelectorHeaderName()
Return the name for the selector header name.
|
TaskScheduler |
SimpleBrokerMessageHandler.getTaskScheduler()
Return the configured TaskScheduler.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
AbstractBrokerMessageHandler.checkDestinationPrefix(String destination)
Whether a message with the given destination should be processed.
|
protected void |
SimpleBrokerMessageHandler.sendMessageToSubscribers(String destination,
Message<?> message) |
void |
AbstractBrokerMessageHandler.setApplicationEventPublisher(ApplicationEventPublisher publisher) |
void |
SimpleBrokerMessageHandler.setCacheLimit(Integer cacheLimit)
When configured, the specified cache limit is passed down to the
underlying SubscriptionRegistry, overriding any default there.
|
void |
SimpleBrokerMessageHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers
of all messages sent to the client outbound channel. |
void |
SimpleBrokerMessageHandler.setHeartbeatValue(long[] heartbeat)
Configure the value for the heart-beat settings.
|
void |
SimpleBrokerMessageHandler.setPathMatcher(PathMatcher pathMatcher)
When configured, the given PathMatcher is passed down to the underlying
SubscriptionRegistry to use for matching destination to subscriptions.
|
void |
DefaultSubscriptionRegistry.setSelectorHeaderName(String selectorHeaderName)
Configure the name of a header that a subscription message can have for
the purpose of filtering messages matched to the subscription.
|
void |
SimpleBrokerMessageHandler.setSelectorHeaderName(String selectorHeaderName)
Configure the name of a header that a subscription message can have for
the purpose of filtering messages matched to the subscription.
|
void |
SimpleBrokerMessageHandler.setTaskScheduler(TaskScheduler taskScheduler)
Configure the
TaskScheduler to
use for providing heartbeat support. |
void |
AbstractBrokerMessageHandler.setUserDestinationPredicate(Predicate<String> predicate)
Configure a Predicate to identify messages with a user destination.
|
Constructor and Description |
---|
AbstractBrokerMessageHandler(SubscribableChannel inboundChannel,
MessageChannel outboundChannel,
SubscribableChannel brokerChannel,
Collection<String> destinationPrefixes)
Constructor with destination prefixes to match to destinations of messages.
|
Modifier and Type | Method and Description |
---|---|
protected SimpUserRegistry |
AbstractMessageBrokerConfiguration.createLocalUserRegistry()
Deprecated.
as of 5.1 in favor of
AbstractMessageBrokerConfiguration.createLocalUserRegistry(Integer) |
ApplicationContext |
AbstractMessageBrokerConfiguration.getApplicationContext() |
protected Collection<String> |
MessageBrokerRegistry.getApplicationDestinationPrefixes() |
protected PathMatcher |
MessageBrokerRegistry.getPathMatcher() |
PathMatcher |
AbstractMessageBrokerConfiguration.getPathMatcher(AbstractSubscribableChannel clientInboundChannel,
AbstractSubscribableChannel clientOutboundChannel)
Provide access to the configured PatchMatcher for access from other
configuration classes.
|
protected SimpleBrokerMessageHandler |
MessageBrokerRegistry.getSimpleBroker(SubscribableChannel brokerChannel) |
protected StompBrokerRelayMessageHandler |
MessageBrokerRegistry.getStompBrokerRelay(SubscribableChannel brokerChannel) |
protected String |
MessageBrokerRegistry.getUserDestinationBroadcast() |
protected String |
StompBrokerRelayRegistration.getUserDestinationBroadcast() |
protected String |
MessageBrokerRegistry.getUserDestinationPrefix() |
protected String |
MessageBrokerRegistry.getUserRegistryBroadcast() |
protected String |
StompBrokerRelayRegistration.getUserRegistryBroadcast() |
protected Integer |
MessageBrokerRegistry.getUserRegistryOrder() |
Validator |
AbstractMessageBrokerConfiguration.getValidator()
Override this method to provide a custom
Validator . |
AbstractBrokerMessageHandler |
AbstractMessageBrokerConfiguration.simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel,
AbstractSubscribableChannel clientOutboundChannel,
AbstractSubscribableChannel brokerChannel,
UserDestinationResolver userDestinationResolver) |
AbstractBrokerMessageHandler |
AbstractMessageBrokerConfiguration.stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel,
AbstractSubscribableChannel clientOutboundChannel,
AbstractSubscribableChannel brokerChannel,
UserDestinationMessageHandler userDestinationMessageHandler,
MessageHandler userRegistryMessageHandler,
UserDestinationResolver userDestinationResolver) |
MessageHandler |
AbstractMessageBrokerConfiguration.userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel,
AbstractSubscribableChannel clientOutboundChannel,
SimpUserRegistry userRegistry,
SimpMessagingTemplate brokerMessagingTemplate,
TaskScheduler scheduler) |
Modifier and Type | Method and Description |
---|---|
protected abstract SimpUserRegistry |
AbstractMessageBrokerConfiguration.createLocalUserRegistry(Integer order)
Create the user registry that provides access to local users.
|
void |
AbstractMessageBrokerConfiguration.setApplicationContext(ApplicationContext applicationContext) |
ChannelRegistration |
ChannelRegistration.setInterceptors(ChannelInterceptor... interceptors)
Deprecated.
as of 4.3.12, in favor of
ChannelRegistration.interceptors(ChannelInterceptor...) |
void |
SimpleBrokerRegistration.setSelectorHeaderName(String selectorHeaderName)
Configure the name of a header that a subscription message can have for
the purpose of filtering messages matched to the subscription.
|
StompBrokerRelayRegistration |
StompBrokerRelayRegistration.setTaskScheduler(TaskScheduler taskScheduler)
Some STOMP clients (e.g.
|
AbstractBrokerMessageHandler |
AbstractMessageBrokerConfiguration.stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel,
AbstractSubscribableChannel clientOutboundChannel,
AbstractSubscribableChannel brokerChannel,
UserDestinationMessageHandler userDestinationMessageHandler,
MessageHandler userRegistryMessageHandler,
UserDestinationResolver userDestinationResolver) |
TaskExecutorRegistration |
ChannelRegistration.taskExecutor(ThreadPoolTaskExecutor taskExecutor)
Configure the thread pool backing this message channel using a custom
ThreadPoolTaskExecutor.
|
Constructor and Description |
---|
AbstractBrokerRegistration(SubscribableChannel clientInboundChannel,
MessageChannel clientOutboundChannel,
String[] destinationPrefixes)
Create a new broker registration.
|
Modifier and Type | Method and Description |
---|---|
String[] |
StompHeaders.getAcceptVersion()
Get the accept-version header.
|
String |
StompHeaders.getAck()
Get the ack header.
|
String |
StompHeaderAccessor.getAck() |
StompCommand |
StompHeaderAccessor.getCommand()
Return the STOMP command, or
null if not yet set. |
static StompCommand |
StompHeaderAccessor.getCommand(Map<String,Object> headers)
Return the STOMP command from the given headers, or
null if not set. |
Integer |
StompHeaderAccessor.getContentLength() |
static Integer |
StompHeaderAccessor.getContentLength(Map<String,List<String>> nativeHeaders) |
MimeType |
StompHeaders.getContentType()
Return the content-type header value.
|
String |
StompHeaders.getDestination()
Get the destination header.
|
Integer |
BufferingStompDecoder.getExpectedContentLength()
Get the expected content length of the currently buffered, incomplete STOMP frame.
|
String |
StompHeaders.getFirst(String headerName)
Return the first header value for the given header name, if any.
|
MessageHeaderInitializer |
StompDecoder.getHeaderInitializer()
Return the configured
MessageHeaderInitializer , if any. |
MessageHeaderInitializer |
StompBrokerRelayMessageHandler.getHeaderInitializer()
Return the configured header initializer.
|
long[] |
StompHeaders.getHeartbeat()
Get the heartbeat header.
|
String |
StompHeaders.getHost()
Get the host header.
|
String |
StompHeaderAccessor.getHost() |
String |
StompHeaders.getId()
Get the id header.
|
String |
StompHeaders.getLogin()
Get the login header.
|
String |
StompHeaderAccessor.getLogin() |
String |
StompHeaderAccessor.getMessage() |
String |
StompHeaders.getMessageId()
Get the message-id header.
|
String |
StompHeaderAccessor.getMessageId() |
String |
StompHeaderAccessor.getNack() |
protected Map<String,List<String>> |
StompHeaderAccessor.getNativeHeaders() |
String |
StompHeaders.getPasscode()
Get the passcode header.
|
String |
StompHeaderAccessor.getPasscode()
Return the passcode header value, or
null if not set. |
static String |
StompHeaderAccessor.getPasscode(Map<String,Object> headers)
Return the passcode header value, or
null if not set. |
String |
StompHeaders.getReceipt()
Get the receipt header.
|
String |
StompHeaderAccessor.getReceipt() |
String |
StompHeaders.getReceiptId()
Get the receipt header.
|
String |
StompSession.Receiptable.getReceiptId()
Return the receipt id, or
null if the STOMP frame for which
the handle was returned did not have a "receipt" header. |
String |
StompHeaderAccessor.getReceiptId() |
String |
StompHeaders.getServer()
Get the server header.
|
String |
StompHeaders.getSession()
Get the session header.
|
String |
StompHeaders.getSubscription()
Get the subscription header.
|
String |
StompSession.Subscription.getSubscriptionId()
Return the id for the subscription.
|
TaskScheduler |
StompBrokerRelayMessageHandler.getTaskScheduler() |
TaskScheduler |
DefaultStompSession.getTaskScheduler()
Return the configured TaskScheduler to use for receipt tracking.
|
TaskScheduler |
StompClientSupport.getTaskScheduler()
The configured TaskScheduler.
|
TcpOperations<byte[]> |
StompBrokerRelayMessageHandler.getTcpClient()
Get the configured TCP client (never
null unless not configured
invoked and this method is invoked before the handler is started and
hence a default implementation initialized). |
String |
StompHeaderAccessor.getVersion() |
String |
StompBrokerRelayMessageHandler.getVirtualHost()
Return the configured virtual host value.
|
Modifier and Type | Method and Description |
---|---|
void |
StompHeaders.add(String headerName,
String headerValue)
Add the given, single header value under the given name.
|
ListenableFuture<StompSession> |
ReactorNettyTcpStompClient.connect(StompHeaders connectHeaders,
StompSessionHandler handler)
An overloaded version of
ReactorNettyTcpStompClient.connect(StompSessionHandler) that
accepts headers to use for the STOMP CONNECT frame. |
protected ConnectionHandlingStompSession |
StompClientSupport.createSession(StompHeaders connectHeaders,
StompSessionHandler handler)
Factory method for create and configure a new session.
|
List<Message<byte[]>> |
StompDecoder.decode(ByteBuffer byteBuffer,
MultiValueMap<String,String> partialMessageHeaders)
Decodes one or more STOMP frames from the given
buffer and returns
a list of Messages . |
void |
DefaultStompSession.disconnect(StompHeaders headers) |
boolean |
StompHeaders.equals(Object other) |
String |
StompHeaderAccessor.getDetailedLogMessage(Object payload) |
void |
StompSessionHandler.handleException(StompSession session,
StompCommand command,
StompHeaders headers,
byte[] payload,
Throwable exception)
Handle any exception arising while processing a STOMP frame such as a
failure to convert the payload or an unhandled exception in the
application
StompFrameHandler . |
void |
StompSessionHandlerAdapter.handleException(StompSession session,
StompCommand command,
StompHeaders headers,
byte[] payload,
Throwable exception)
This implementation is empty.
|
void |
StompFrameHandler.handleFrame(StompHeaders headers,
Object payload)
Handle a STOMP frame with the payload converted to the target type returned
from
StompFrameHandler.getPayloadType(StompHeaders) . |
void |
StompSessionHandlerAdapter.handleFrame(StompHeaders headers,
Object payload)
This implementation is empty.
|
protected StompHeaders |
StompClientSupport.processConnectHeaders(StompHeaders connectHeaders)
Further initialize the StompHeaders, for example setting the heart-beat
header if necessary.
|
static StompHeaders |
StompHeaders.readOnlyStompHeaders(Map<String,List<String>> headers)
Return a
StompHeaders object that can only be read, not written to. |
void |
StompHeaders.set(String headerName,
String headerValue)
Set the given, single header value under the given name.
|
void |
StompHeaders.setAcceptVersion(String... acceptVersions)
Set the accept-version header.
|
void |
StompHeaders.setAck(String ack)
Set the ack header to one of "auto", "client", or "client-individual".
|
void |
StompHeaderAccessor.setAck(String ack) |
void |
StompHeaders.setContentType(MimeType mimeType)
Set the content-type header.
|
void |
StompHeaders.setDestination(String destination)
Set the destination header.
|
void |
StompHeaderAccessor.setDestination(String destination) |
void |
StompDecoder.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of
Messages from decoded STOMP frames. |
void |
StompBrokerRelayMessageHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of all
messages created through the StompBrokerRelayMessageHandler that
are sent to the client outbound message channel. |
void |
StompHeaders.setHeartbeat(long[] heartbeat)
Set the heartbeat header.
|
void |
StompHeaders.setHost(String host)
Set the host header.
|
void |
StompHeaderAccessor.setHost(String host) |
void |
StompHeaders.setId(String id)
Set the id header.
|
void |
StompHeaders.setLogin(String login)
Set the login header.
|
void |
StompHeaderAccessor.setLogin(String login) |
void |
StompHeaderAccessor.setMessage(String content) |
void |
StompHeaders.setMessageId(String messageId)
Set the message-id header.
|
void |
StompHeaderAccessor.setMessageId(String id) |
void |
StompHeaderAccessor.setNack(String nack) |
void |
StompHeaders.setPasscode(String passcode)
Set the passcode header.
|
void |
StompHeaderAccessor.setPasscode(String passcode) |
void |
StompHeaders.setReceipt(String receipt)
Set the receipt header.
|
void |
StompHeaderAccessor.setReceipt(String receiptId) |
void |
StompHeaders.setReceiptId(String receiptId)
Set the receipt-id header.
|
void |
StompHeaderAccessor.setReceiptId(String receiptId) |
void |
StompHeaders.setServer(String server)
Set the server header.
|
void |
StompHeaders.setSession(String session)
Set the session header.
|
void |
StompHeaders.setSubscription(String subscription)
Set the login header.
|
void |
StompHeaderAccessor.setSubscriptionId(String subscriptionId) |
void |
StompBrokerRelayMessageHandler.setSystemSubscriptions(Map<String,MessageHandler> subscriptions)
Configure one more destinations to subscribe to on the shared "system"
connection along with MessageHandler's to handle received messages.
|
void |
StompBrokerRelayMessageHandler.setTaskScheduler(TaskScheduler taskScheduler)
Configure the
TaskScheduler to use to reset client-to-broker
message count in the current heartbeat period. |
void |
DefaultStompSession.setTaskScheduler(TaskScheduler taskScheduler)
Configure the TaskScheduler to use for receipt tracking.
|
void |
StompClientSupport.setTaskScheduler(TaskScheduler taskScheduler)
Configure a scheduler to use for heartbeats and for receipt tracking.
|
void |
StompBrokerRelayMessageHandler.setTcpClient(TcpOperations<byte[]> tcpClient)
Configure a TCP client for managing TCP connections to the STOMP broker.
|
void |
StompHeaderAccessor.setVersion(String version) |
void |
StompBrokerRelayMessageHandler.setVirtualHost(String virtualHost)
Set the value of the "host" header to use in STOMP CONNECT frames.
|
void |
StompSession.Subscription.unsubscribe(StompHeaders headers)
Alternative to
StompSession.Subscription.unsubscribe() with additional custom headers
to send to the server. |
Modifier and Type | Method and Description |
---|---|
String |
UserDestinationMessageHandler.getBroadcastDestination()
Return the configured destination for unresolved messages.
|
MessageHeaderInitializer |
UserDestinationMessageHandler.getHeaderInitializer()
Return the configured header initializer.
|
Principal |
SimpUser.getPrincipal()
Return the user associated with the session, if available.
|
SimpSession |
SimpUser.getSession(String sessionId)
Look up the session for the given id.
|
protected String |
DefaultUserDestinationResolver.getTargetDestination(String sourceDestination,
String actualDestination,
String sessionId,
String user)
This method determines how to translate the source "user" destination to an
actual target destination for the given active user session.
|
String |
UserDestinationResult.getUser()
The user for this user destination.
|
SimpUser |
MultiServerUserRegistry.getUser(String userName) |
SimpUser |
SimpUserRegistry.getUser(String userName)
Get the user for the given name.
|
UserDestinationResult |
DefaultUserDestinationResolver.resolveDestination(Message<?> message) |
UserDestinationResult |
UserDestinationResolver.resolveDestination(Message<?> message)
Resolve the given message with a user destination to one or more messages
with actual destinations, one for each active user session.
|
Modifier and Type | Method and Description |
---|---|
protected String |
DefaultUserDestinationResolver.getTargetDestination(String sourceDestination,
String actualDestination,
String sessionId,
String user)
This method determines how to translate the source "user" destination to an
actual target destination for the given active user session.
|
void |
UserDestinationMessageHandler.setBroadcastDestination(String destination)
Set a destination to broadcast messages to that remain unresolved because
the user is not connected.
|
void |
UserDestinationMessageHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a custom
MessageHeaderInitializer to initialize the
headers of resolved target messages. |
void |
DefaultUserDestinationResolver.setPathMatcher(PathMatcher pathMatcher)
Deprecated.
as of 4.3.14 this property is no longer used and is replaced
by
DefaultUserDestinationResolver.setRemoveLeadingSlash(boolean) that indicates more explicitly
whether to keep the leading slash which may or may not be the case
regardless of how the PathMatcher is configured. |
boolean |
MultiServerUserRegistry.supportsSourceType(Class<?> sourceType) |
Constructor and Description |
---|
UserDestinationResult(String sourceDestination,
Set<String> targetDestinations,
String subscribeDestination,
String user) |
Modifier and Type | Method and Description |
---|---|
Message<?> |
AbstractMessageChannel.ChannelInterceptorChain.applyPostReceive(Message<?> message,
MessageChannel channel) |
Message<?> |
AbstractMessageChannel.ChannelInterceptorChain.applyPreSend(Message<?> message,
MessageChannel channel) |
default Message<?> |
ExecutorChannelInterceptor.beforeHandle(Message<?> message,
MessageChannel channel,
MessageHandler handler)
Invoked inside the
Runnable submitted to the Executor just before
calling the target MessageHandler to handle the message. |
static MessageHeaderAccessor |
MessageHeaderAccessor.getAccessor(Message<?> message)
Return the original
MessageHeaderAccessor used to create the headers
of the given Message , or null if that's not available or if
its type does not match the required type. |
static <T extends MessageHeaderAccessor> |
MessageHeaderAccessor.getAccessor(Message<?> message,
Class<T> requiredType)
Return the original
MessageHeaderAccessor used to create the headers
of the given Message , or null if that's not available or if
its type does not match the required type. |
static <T extends MessageHeaderAccessor> |
MessageHeaderAccessor.getAccessor(MessageHeaders messageHeaders,
Class<T> requiredType)
A variation of
MessageHeaderAccessor.getAccessor(org.springframework.messaging.Message, Class)
with a MessageHeaders instance instead of a Message . |
MimeType |
MessageHeaderAccessor.getContentType() |
Object |
MessageHeaderAccessor.getErrorChannel() |
Executor |
ExecutorSubscribableChannel.getExecutor() |
String |
NativeMessageHeaderAccessor.getFirstNativeHeader(String headerName)
Return the first value for the specified native header, if present.
|
static String |
NativeMessageHeaderAccessor.getFirstNativeHeader(String headerName,
Map<String,Object> headers)
Return the first value for the specified native header,
or
null if none. |
Object |
MessageHeaderAccessor.getHeader(String headerName)
Retrieve the value for the header with the given name.
|
protected <V> V |
AbstractHeaderMapper.getHeaderIfAvailable(Map<String,Object> headers,
String name,
Class<V> type)
Return the header value, or
null if it does not exist
or does not match the requested type . |
UUID |
MessageHeaderAccessor.getId() |
IdGenerator |
IdTimestampMessageHeaderInitializer.getIdGenerator()
Return the configured
IdGenerator , if any. |
List<String> |
NativeMessageHeaderAccessor.getNativeHeader(String headerName)
Return all values for the specified native header, if present.
|
protected Map<String,List<String>> |
NativeMessageHeaderAccessor.getNativeHeaders()
Subclasses can use this method to access the "native" headers sub-map.
|
Message<?> |
ErrorMessage.getOriginalMessage()
Return the original message (if available) at the point in the stack
where the ErrorMessage was created.
|
Object |
MessageHeaderAccessor.getReplyChannel() |
Long |
MessageHeaderAccessor.getTimestamp() |
default Message<?> |
ChannelInterceptor.postReceive(Message<?> message,
MessageChannel channel)
Invoked immediately after a Message has been retrieved but before
it is returned to the caller.
|
default Message<?> |
ChannelInterceptor.preSend(Message<?> message,
MessageChannel channel)
Invoked before the Message is actually sent to the channel.
|
List<String> |
NativeMessageHeaderAccessor.removeNativeHeader(String headerName)
Remove the specified native header value replacing existing values.
|
Modifier and Type | Method and Description |
---|---|
void |
NativeMessageHeaderAccessor.addNativeHeader(String name,
String value)
Add the specified native header value to existing values.
|
void |
NativeMessageHeaderAccessor.addNativeHeaders(MultiValueMap<String,String> headers)
Add the specified native headers to existing values.
|
default void |
ExecutorChannelInterceptor.afterMessageHandled(Message<?> message,
MessageChannel channel,
MessageHandler handler,
Exception ex)
Invoked inside the
Runnable submitted to the Executor after calling
the target MessageHandler regardless of the outcome (i.e. |
default void |
ChannelInterceptor.afterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex)
Invoked after the completion of a receive regardless of any exception that
have been raised thus allowing for proper resource cleanup.
|
default void |
ChannelInterceptor.afterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex)
Invoked after the completion of a receive regardless of any exception that
have been raised thus allowing for proper resource cleanup.
|
void |
ChannelInterceptorAdapter.afterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex)
Deprecated.
|
void |
ChannelInterceptorAdapter.afterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex)
Deprecated.
|
default void |
ChannelInterceptor.afterSendCompletion(Message<?> message,
MessageChannel channel,
boolean sent,
Exception ex)
Invoked after the completion of a send regardless of any exception that
have been raised thus allowing for proper resource cleanup.
|
void |
ChannelInterceptorAdapter.afterSendCompletion(Message<?> message,
MessageChannel channel,
boolean sent,
Exception ex)
Deprecated.
|
void |
MessageHeaderAccessor.copyHeaders(Map<String,?> headersToCopy)
Copy the name-value pairs from the provided Map.
|
MessageBuilder<T> |
MessageBuilder.copyHeaders(Map<String,?> headersToCopy)
Copy the name-value pairs from the provided Map.
|
void |
NativeMessageHeaderAccessor.copyHeaders(Map<String,?> headersToCopy) |
void |
MessageHeaderAccessor.copyHeadersIfAbsent(Map<String,?> headersToCopy)
Copy the name-value pairs from the provided Map.
|
MessageBuilder<T> |
MessageBuilder.copyHeadersIfAbsent(Map<String,?> headersToCopy)
Copy the name-value pairs from the provided Map.
|
void |
NativeMessageHeaderAccessor.copyHeadersIfAbsent(Map<String,?> headersToCopy) |
boolean |
GenericMessage.equals(Object other) |
static <T extends MessageHeaderAccessor> |
MessageHeaderAccessor.getAccessor(Message<?> message,
Class<T> requiredType)
Return the original
MessageHeaderAccessor used to create the headers
of the given Message , or null if that's not available or if
its type does not match the required type. |
static <T extends MessageHeaderAccessor> |
MessageHeaderAccessor.getAccessor(MessageHeaders messageHeaders,
Class<T> requiredType)
A variation of
MessageHeaderAccessor.getAccessor(org.springframework.messaging.Message, Class)
with a MessageHeaders instance instead of a Message . |
String |
MessageHeaderAccessor.getDetailedLogMessage(Object payload)
Return a more detailed message for logging purposes.
|
protected String |
MessageHeaderAccessor.getDetailedPayloadLogMessage(Object payload) |
void |
MessageHeaderAccessor.setHeader(String name,
Object value)
Set the value for the given header name.
|
MessageBuilder<T> |
MessageBuilder.setHeader(String headerName,
Object headerValue)
Set the value for the given header name.
|
void |
IdTimestampMessageHeaderInitializer.setIdGenerator(IdGenerator idGenerator)
Configure the IdGenerator strategy to initialize
MessageHeaderAccessor
instances with. |
void |
AbstractHeaderMapper.setInboundPrefix(String inboundPrefix)
Specify a prefix to be appended to the message header name for any
user-defined property that is being mapped into the MessageHeaders.
|
void |
NativeMessageHeaderAccessor.setNativeHeader(String name,
String value)
Set the specified native header value replacing existing values.
|
void |
NativeMessageHeaderAccessor.setNativeHeaderValues(String name,
List<String> values)
Variant of
NativeMessageHeaderAccessor.addNativeHeader(String, String) for all values. |
void |
AbstractHeaderMapper.setOutboundPrefix(String outboundPrefix)
Specify a prefix to be appended to the protocol property name for any
user-defined message header that is being mapped into the protocol-specific
Message.
|
void |
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex) |
void |
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion(Message<?> message,
MessageChannel channel,
Exception ex) |
void |
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterSendCompletion(Message<?> message,
MessageChannel channel,
boolean sent,
Exception ex) |
protected void |
MessageHeaderAccessor.verifyType(String headerName,
Object headerValue) |
protected void |
MessageHeaderAccessor.verifyType(String headerName,
Object headerValue) |
Constructor and Description |
---|
ExecutorSubscribableChannel(Executor executor)
Create a new
ExecutorSubscribableChannel instance
where messages will be sent via the specified executor. |
MessageHeaderAccessor(Message<?> message)
A constructor accepting the headers of an existing message to copy.
|
NativeMessageHeaderAccessor(Map<String,List<String>> nativeHeaders)
Protected constructor to create an instance with the given native headers.
|
NativeMessageHeaderAccessor(Message<?> message)
Protected constructor that copies headers from another message.
|
Modifier and Type | Method and Description |
---|---|
Long |
ReconnectStrategy.getTimeToNextAttempt(int attemptCount)
Return the time to the next attempt to reconnect.
|
Modifier and Type | Method and Description |
---|---|
InetSocketAddress |
MockServerHttpRequest.getLocalAddress() |
HttpMethod |
MockServerHttpRequest.getMethod() |
InetSocketAddress |
MockServerHttpRequest.getRemoteAddress() |
protected SslInfo |
MockServerHttpRequest.initSslInfo() |
Modifier and Type | Method and Description |
---|---|
Object |
SimpleNamingContext.addToEnvironment(String propName,
Object propVal)
Deprecated.
|
static SimpleNamingContextBuilder |
SimpleNamingContextBuilder.getCurrentContextBuilder()
Deprecated.
Checks if a SimpleNamingContextBuilder is active.
|
Modifier and Type | Method and Description |
---|---|
InitialContextFactory |
SimpleNamingContextBuilder.createInitialContextFactory(Hashtable<?,?> environment)
Deprecated.
Simple InitialContextFactoryBuilder implementation,
creating a new SimpleNamingContext instance.
|
Constructor and Description |
---|
SimpleNamingContext(String root,
Hashtable<String,Object> boundObjects,
Hashtable<String,Object> env)
Deprecated.
Create a new naming context with the given naming root,
the given name/object map, and the JNDI environment entries.
|
Modifier and Type | Method and Description |
---|---|
Object |
MockPageContext.findAttribute(String name) |
AsyncContext |
MockHttpServletRequest.getAsyncContext() |
Object |
MockPageContext.getAttribute(String name) |
Object |
MockServletContext.getAttribute(String name) |
Object |
MockPageContext.getAttribute(String name,
int scope) |
String |
MockHttpServletRequest.getAuthType() |
String |
MockHttpServletRequest.getCharacterEncoding() |
ClassLoader |
MockServletContext.getClassLoader() |
String |
MockSessionCookieConfig.getComment() |
byte[] |
MockHttpServletRequest.getContentAsByteArray()
Get the content of the request body as a byte array.
|
String |
MockHttpServletRequest.getContentAsString()
Get the content of the request body as a
String , using the configured
character encoding. |
String |
MockHttpServletResponse.getContentType() |
String |
MockPart.getContentType() |
String |
MockHttpServletRequest.getContentType() |
String |
MockMultipartFile.getContentType() |
Cookie |
MockHttpServletResponse.getCookie(String name) |
Cookie[] |
MockHttpServletRequest.getCookies() |
String |
MockAsyncContext.getDispatchedPath() |
String |
MockSessionCookieConfig.getDomain() |
ELContext |
MockPageContext.getELContext() |
String |
MockHttpServletResponse.getErrorMessage() |
Exception |
MockPageContext.getException() |
ZonedDateTime |
MockCookie.getExpires()
Get the "Expires" attribute for this cookie.
|
FilterRegistration |
MockServletContext.getFilterRegistration(String filterName)
This method always returns
null . |
String |
MockHttpServletResponse.getForwardedUrl() |
String |
MockHttpServletResponse.getHeader(String name)
Return the primary value for the given header as a String, if any.
|
String |
MockPart.getHeader(String name) |
String |
MockHttpServletRequest.getHeader(String name) |
Object |
MockHttpServletResponse.getHeaderValue(String name)
Return the primary value for the given header, if any.
|
String |
MockHttpServletResponse.getIncludedUrl() |
MappingMatch |
MockHttpServletMapping.getMappingMatch() |
String |
MockHttpServletRequest.getMethod() |
String |
MockServletContext.getMimeType(String filePath) |
String |
MockSessionCookieConfig.getName() |
String |
MockHttpServletRequest.getParameter(String name) |
Part |
MockHttpServletRequest.getPart(String name) |
String |
MockSessionCookieConfig.getPath() |
String |
MockHttpServletRequest.getPathInfo() |
String |
MockHttpServletRequest.getPathTranslated() |
String |
MockHttpServletRequest.getQueryString() |
String |
MockServletContext.getRealPath(String path) |
String |
MockHttpServletResponse.getRedirectedUrl() |
String |
MockHttpServletRequest.getRemoteUser() |
ServletRequest |
MockFilterChain.getRequest()
Return the request that
MockFilterChain.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse) has been called with. |
String |
MockServletContext.getRequestCharacterEncoding() |
String |
MockHttpServletRequest.getRequestedSessionId() |
String |
MockHttpServletRequest.getRequestURI() |
URL |
MockServletContext.getResource(String path) |
InputStream |
MockServletContext.getResourceAsStream(String path) |
Set<String> |
MockServletContext.getResourcePaths(String path) |
ServletResponse |
MockAsyncContext.getResponse() |
ServletResponse |
MockFilterChain.getResponse()
Return the response that
MockFilterChain.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse) has been called with. |
String |
MockServletContext.getResponseCharacterEncoding() |
String |
MockCookie.getSameSite()
Get the "SameSite" attribute for this cookie.
|
Servlet |
MockServletContext.getServlet(String name)
Deprecated.
|
ServletRegistration |
MockServletContext.getServletRegistration(String servletName)
This method always returns
null . |
HttpSession |
MockHttpServletRequest.getSession() |
HttpSession |
MockHttpServletRequest.getSession(boolean create) |
String |
MockPart.getSubmittedFileName() |
Principal |
MockHttpServletRequest.getUserPrincipal() |
VariableResolver |
MockPageContext.getVariableResolver()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
MockHttpServletResponse.addHeader(String name,
String value) |
void |
MockHttpServletRequest.addParameter(String name,
String value)
Add a single value for the specified HTTP parameter.
|
void |
MockAsyncContext.dispatch(ServletContext context,
String path) |
void |
MockHttpServletRequest.setAsyncContext(MockAsyncContext asyncContext) |
void |
MockPageContext.setAttribute(String name,
Object value) |
void |
MockServletContext.setAttribute(String name,
Object value) |
void |
MockHttpSession.setAttribute(String name,
Object value) |
void |
MockHttpServletRequest.setAttribute(String name,
Object value) |
void |
MockPageContext.setAttribute(String name,
Object value,
int scope) |
void |
MockHttpServletRequest.setAuthType(String authType) |
void |
MockHttpServletRequest.setCharacterEncoding(String characterEncoding) |
void |
MockSessionCookieConfig.setComment(String comment) |
void |
MockHttpServletRequest.setContent(byte[] content)
Set the content of the request body as a byte array.
|
void |
MockHttpServletResponse.setContentType(String contentType) |
void |
MockHttpServletRequest.setContentType(String contentType) |
void |
MockHttpServletRequest.setCookies(Cookie... cookies) |
void |
MockSessionCookieConfig.setDomain(String domain) |
void |
MockCookie.setExpires(ZonedDateTime expires)
Set the "Expires" attribute for this cookie.
|
void |
MockHttpServletResponse.setForwardedUrl(String forwardedUrl) |
void |
MockHttpServletResponse.setHeader(String name,
String value) |
void |
MockHttpServletResponse.setIncludedUrl(String includedUrl) |
void |
MockHttpServletResponse.setLocale(Locale locale) |
void |
MockHttpServletRequest.setMethod(String method) |
void |
MockSessionCookieConfig.setName(String name) |
void |
MockSessionCookieConfig.setPath(String path) |
void |
MockHttpServletRequest.setPathInfo(String pathInfo) |
void |
MockHttpServletRequest.setQueryString(String queryString) |
void |
MockHttpServletRequest.setRemoteUser(String remoteUser) |
void |
MockServletContext.setRequestCharacterEncoding(String requestCharacterEncoding) |
void |
MockHttpServletRequest.setRequestedSessionId(String requestedSessionId) |
void |
MockHttpServletRequest.setRequestURI(String requestURI) |
void |
MockServletContext.setResponseCharacterEncoding(String responseCharacterEncoding) |
void |
MockCookie.setSameSite(String sameSite)
Set the "SameSite" attribute for this cookie.
|
void |
MockHttpServletRequest.setUserPrincipal(Principal userPrincipal) |
AsyncContext |
MockHttpServletRequest.startAsync(ServletRequest request,
ServletResponse response) |
Constructor and Description |
---|
MockAsyncContext(ServletRequest request,
ServletResponse response) |
MockBodyContent(String content,
HttpServletResponse response,
Writer targetWriter)
Create a MockBodyContent for the given response.
|
MockBodyContent(String content,
HttpServletResponse response,
Writer targetWriter)
Create a MockBodyContent for the given response.
|
MockFilterConfig(ServletContext servletContext)
Create a new MockFilterConfig.
|
MockFilterConfig(ServletContext servletContext,
String filterName)
Create a new MockFilterConfig.
|
MockHttpServletMapping(String matchValue,
String pattern,
String servletName,
MappingMatch match) |
MockHttpServletRequest(ServletContext servletContext)
Create a new
MockHttpServletRequest with the supplied ServletContext . |
MockHttpServletRequest(ServletContext servletContext,
String method,
String requestURI)
|
MockHttpServletRequest(ServletContext servletContext,
String method,
String requestURI)
|
MockHttpServletRequest(ServletContext servletContext,
String method,
String requestURI)
|
MockHttpServletRequest(String method,
String requestURI)
Create a new
MockHttpServletRequest with a default
MockServletContext . |
MockHttpServletRequest(String method,
String requestURI)
Create a new
MockHttpServletRequest with a default
MockServletContext . |
MockHttpSession(ServletContext servletContext)
Create a new MockHttpSession.
|
MockHttpSession(ServletContext servletContext,
String id)
Create a new MockHttpSession.
|
MockHttpSession(ServletContext servletContext,
String id)
Create a new MockHttpSession.
|
MockJspWriter(HttpServletResponse response,
Writer targetWriter)
Create a MockJspWriter for the given response.
|
MockJspWriter(HttpServletResponse response,
Writer targetWriter)
Create a MockJspWriter for the given response.
|
MockMultipartFile(String name,
byte[] content)
Create a new MockMultipartFile with the given content.
|
MockMultipartFile(String name,
String originalFilename,
String contentType,
byte[] content)
Create a new MockMultipartFile with the given content.
|
MockMultipartFile(String name,
String originalFilename,
String contentType,
byte[] content)
Create a new MockMultipartFile with the given content.
|
MockMultipartFile(String name,
String originalFilename,
String contentType,
byte[] content)
Create a new MockMultipartFile with the given content.
|
MockMultipartFile(String name,
String originalFilename,
String contentType,
InputStream contentStream)
Create a new MockMultipartFile with the given content.
|
MockMultipartFile(String name,
String originalFilename,
String contentType,
InputStream contentStream)
Create a new MockMultipartFile with the given content.
|
MockMultipartHttpServletRequest(ServletContext servletContext)
Create a new
MockMultipartHttpServletRequest with the supplied ServletContext . |
MockPageContext(ServletContext servletContext)
Create new MockPageContext with a default
MockHttpServletRequest ,
MockHttpServletResponse , MockServletConfig . |
MockPageContext(ServletContext servletContext,
HttpServletRequest request)
Create new MockPageContext with a MockHttpServletResponse,
MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request)
Create new MockPageContext with a MockHttpServletResponse,
MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response)
Create new MockPageContext with a MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response)
Create new MockPageContext with a MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response)
Create new MockPageContext with a MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
ServletConfig servletConfig)
Create new MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
ServletConfig servletConfig)
Create new MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
ServletConfig servletConfig)
Create new MockServletConfig.
|
MockPageContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
ServletConfig servletConfig)
Create new MockServletConfig.
|
MockPart(String name,
byte[] content)
Constructor for a part with byte[] content only.
|
MockPart(String name,
String filename,
byte[] content)
Constructor for a part with a filename and byte[] content.
|
MockPart(String name,
String filename,
byte[] content)
Constructor for a part with a filename and byte[] content.
|
MockServletConfig(ServletContext servletContext)
Create a new MockServletConfig.
|
MockServletConfig(ServletContext servletContext,
String servletName)
Create a new MockServletConfig.
|
MockServletContext(ResourceLoader resourceLoader)
Create a new
MockServletContext , using the specified ResourceLoader
and no base path. |
MockServletContext(String resourceBasePath,
ResourceLoader resourceLoader)
Create a new
MockServletContext using the supplied resource base
path and resource loader. |
Constructor and Description |
---|
MockWebSession(Clock clock) |
Modifier and Type | Method and Description |
---|---|
Object |
ObjectRetrievalFailureException.getIdentifier()
Return the identifier of the object that was not found.
|
Object |
ObjectOptimisticLockingFailureException.getIdentifier()
Return the identifier of the object for which the locking failed.
|
Class<?> |
ObjectRetrievalFailureException.getPersistentClass()
Return the persistent class of the object that was not found.
|
Class<?> |
ObjectOptimisticLockingFailureException.getPersistentClass()
Return the persistent class of the object for which the locking failed.
|
String |
ObjectRetrievalFailureException.getPersistentClassName()
Return the name of the persistent class of the object that was not found.
|
String |
ObjectOptimisticLockingFailureException.getPersistentClassName()
Return the name of the persistent class of the object for which the locking failed.
|
Constructor and Description |
---|
ObjectOptimisticLockingFailureException(Class<?> persistentClass,
Object identifier,
String msg,
Throwable cause)
Create a new ObjectOptimisticLockingFailureException for the given object,
with the given explicit message.
|
ObjectOptimisticLockingFailureException(Class<?> persistentClass,
Object identifier,
Throwable cause)
Create a new ObjectOptimisticLockingFailureException for the given object,
with the default "optimistic locking failed" message.
|
ObjectOptimisticLockingFailureException(String persistentClassName,
Object identifier,
String msg,
Throwable cause)
Create a new ObjectOptimisticLockingFailureException for the given object,
with the given explicit message.
|
ObjectOptimisticLockingFailureException(String persistentClassName,
Object identifier,
Throwable cause)
Create a new ObjectOptimisticLockingFailureException for the given object,
with the default "optimistic locking failed" message.
|
ObjectRetrievalFailureException(Class<?> persistentClass,
Object identifier,
String msg,
Throwable cause)
Create a new ObjectRetrievalFailureException for the given object,
with the given explicit message and exception.
|
ObjectRetrievalFailureException(String persistentClassName,
Object identifier,
String msg,
Throwable cause)
Create a new ObjectRetrievalFailureException for the given object,
with the given explicit message and exception.
|
Modifier and Type | Method and Description |
---|---|
protected <T> T |
HibernateTemplate.doExecute(HibernateCallback<T> action,
boolean enforceNativeSession)
Execute the action specified by the given action object within a Session.
|
T |
HibernateCallback.doInHibernate(Session session)
Gets called by
HibernateTemplate.execute with an active
Hibernate Session . |
<T> T |
HibernateTemplate.execute(HibernateCallback<T> action) |
<T> T |
HibernateOperations.execute(HibernateCallback<T> action)
Execute the action specified by the given action object within a
Session . |
<T> T |
HibernateTemplate.executeWithNativeSession(HibernateCallback<T> action)
Execute the action specified by the given action object within a
native
Session . |
<T> T |
HibernateTemplate.get(Class<T> entityClass,
Serializable id) |
<T> T |
HibernateOperations.get(Class<T> entityClass,
Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
<T> T |
HibernateTemplate.get(Class<T> entityClass,
Serializable id,
LockMode lockMode) |
<T> T |
HibernateOperations.get(Class<T> entityClass,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
Object |
HibernateTemplate.get(String entityName,
Serializable id) |
Object |
HibernateOperations.get(String entityName,
Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
Object |
HibernateTemplate.get(String entityName,
Serializable id,
LockMode lockMode) |
Object |
HibernateOperations.get(String entityName,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
DataSource |
HibernateTransactionManager.getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
|
static DataSource |
SessionFactoryUtils.getDataSource(SessionFactory sessionFactory)
Determine the DataSource of the given SessionFactory.
|
Interceptor |
HibernateTransactionManager.getEntityInterceptor()
Return the current Hibernate entity interceptor, or
null if none. |
String[] |
HibernateTemplate.getFilterNames()
Return the names of Hibernate filters to be activated, if any.
|
SessionFactory |
LocalSessionFactoryBean.getObject() |
FlushMode |
SessionHolder.getPreviousFlushMode() |
String |
HibernateTemplate.getQueryCacheRegion()
Return the name of the cache region for queries executed by this template.
|
SessionFactory |
HibernateTemplate.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create
Hibernate Sessions.
|
SessionFactory |
HibernateTransactionManager.getSessionFactory()
Return the SessionFactory that this instance should manage transactions for.
|
Transaction |
SessionHolder.getTransaction() |
DataAccessException |
HibernateExceptionTranslator.translateExceptionIfPossible(RuntimeException ex) |
Modifier and Type | Method and Description |
---|---|
int |
HibernateTemplate.bulkUpdate(String queryString,
Object... values)
Deprecated.
|
static void |
SessionFactoryUtils.closeSession(Session session)
Perform actual closing of the Hibernate Session,
catching and logging any cleanup exceptions thrown.
|
void |
HibernateTemplate.delete(Object entity,
LockMode lockMode) |
void |
HibernateTemplate.delete(String entityName,
Object entity,
LockMode lockMode) |
protected void |
HibernateTransactionManager.doResume(Object transaction,
Object suspendedResources) |
boolean |
SpringFlushSynchronization.equals(Object other) |
List<?> |
HibernateTemplate.find(String queryString,
Object... values)
Deprecated.
|
<T> List<T> |
HibernateTemplate.findByExample(String entityName,
T exampleEntity,
int firstResult,
int maxResults) |
List<?> |
HibernateTemplate.findByNamedQuery(String queryName,
Object... values)
Deprecated.
|
List<?> |
HibernateTemplate.findByNamedQueryAndNamedParam(String queryName,
String[] paramNames,
Object[] values)
Deprecated.
|
List<?> |
HibernateTemplate.findByNamedQueryAndNamedParam(String queryName,
String[] paramNames,
Object[] values)
Deprecated.
|
<T> T |
HibernateTemplate.get(Class<T> entityClass,
Serializable id,
LockMode lockMode) |
Object |
HibernateTemplate.get(String entityName,
Serializable id,
LockMode lockMode) |
Iterator<?> |
HibernateTemplate.iterate(String queryString,
Object... values)
Deprecated.
|
<T> T |
HibernateTemplate.load(Class<T> entityClass,
Serializable id,
LockMode lockMode) |
Object |
HibernateTemplate.load(String entityName,
Serializable id,
LockMode lockMode) |
void |
HibernateTemplate.refresh(Object entity,
LockMode lockMode) |
void |
HibernateTransactionManager.setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for.
|
void |
HibernateTransactionManager.setEntityInterceptor(Interceptor entityInterceptor)
Set a Hibernate entity interceptor that allows to inspect and change
property values before writing to and reading from the database.
|
void |
HibernateTemplate.setFilterNames(String... filterNames)
Set one or more names of Hibernate filters to be activated for all
Sessions that this accessor works with.
|
void |
SessionHolder.setPreviousFlushMode(FlushMode previousFlushMode) |
void |
HibernateTemplate.setQueryCacheRegion(String queryCacheRegion)
Set the name of the cache region for queries executed by this template.
|
void |
HibernateTemplate.setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create
Hibernate Sessions.
|
void |
HibernateTransactionManager.setSessionFactory(SessionFactory sessionFactory)
Set the SessionFactory that this instance should manage transactions for.
|
void |
SessionHolder.setTransaction(Transaction transaction) |
void |
HibernateTemplate.update(Object entity,
LockMode lockMode) |
void |
HibernateTemplate.update(String entityName,
Object entity,
LockMode lockMode) |
Constructor and Description |
---|
HibernateSystemException(HibernateException cause)
Create a new HibernateSystemException,
wrapping an arbitrary HibernateException.
|
LocalSessionFactoryBuilder(DataSource dataSource)
Create a new LocalSessionFactoryBuilder for the given DataSource.
|
LocalSessionFactoryBuilder(DataSource dataSource,
ClassLoader classLoader)
Create a new LocalSessionFactoryBuilder for the given DataSource.
|
LocalSessionFactoryBuilder(DataSource dataSource,
ResourceLoader resourceLoader)
Create a new LocalSessionFactoryBuilder for the given DataSource.
|
LocalSessionFactoryBuilder(DataSource dataSource,
ResourceLoader resourceLoader,
org.hibernate.boot.MetadataSources metadataSources)
Create a new LocalSessionFactoryBuilder for the given DataSource.
|
Modifier and Type | Method and Description |
---|---|
HibernateTemplate |
HibernateDaoSupport.getHibernateTemplate()
Return the HibernateTemplate for this DAO,
pre-initialized with the SessionFactory or set explicitly.
|
SessionFactory |
HibernateDaoSupport.getSessionFactory()
Return the Hibernate SessionFactory used by this DAO.
|
SessionFactory |
OpenSessionInterceptor.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
|
SessionFactory |
OpenSessionInViewInterceptor.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
|
Object |
OpenSessionInterceptor.invoke(MethodInvocation invocation) |
protected Session |
OpenSessionInterceptor.openSession()
Deprecated.
as of 5.0, in favor of
OpenSessionInterceptor.openSession(SessionFactory) |
Modifier and Type | Method and Description |
---|---|
void |
OpenSessionInViewInterceptor.afterCompletion(WebRequest request,
Exception ex)
Unbind the Hibernate
Session from the thread and close it. |
void |
OpenSessionInViewInterceptor.postHandle(WebRequest request,
ModelMap model) |
void |
HibernateDaoSupport.setHibernateTemplate(HibernateTemplate hibernateTemplate)
Set the HibernateTemplate for this DAO explicitly,
as an alternative to specifying a SessionFactory.
|
void |
OpenSessionInterceptor.setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
|
void |
OpenSessionInViewInterceptor.setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
|
Modifier and Type | Method and Description |
---|---|
Object |
JpaDialect.beginTransaction(EntityManager entityManager,
TransactionDefinition definition)
Begin the given JPA transaction, applying the semantics specified by the
given Spring transaction definition (in particular, an isolation level
and a timeout).
|
Object |
DefaultJpaDialect.beginTransaction(EntityManager entityManager,
TransactionDefinition definition)
This implementation invokes the standard JPA
Transaction.begin
method. |
static DataAccessException |
EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(RuntimeException ex)
Convert the given runtime exception to an appropriate exception from the
org.springframework.dao hierarchy. |
static EntityManager |
EntityManagerFactoryUtils.doGetTransactionalEntityManager(EntityManagerFactory emf,
Map<?,?> properties)
Obtain a JPA EntityManager from the given factory.
|
static EntityManager |
EntityManagerFactoryUtils.doGetTransactionalEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
boolean synchronizedWithTransaction)
Obtain a JPA EntityManager from the given factory.
|
AsyncTaskExecutor |
AbstractEntityManagerFactoryBean.getBootstrapExecutor()
Return the asynchronous executor for background bootstrapping, if any.
|
DataSource |
EntityManagerFactoryInfo.getDataSource()
Return the JDBC DataSource that this EntityManagerFactory
obtains its JDBC Connections from.
|
DataSource |
LocalContainerEntityManagerFactoryBean.getDataSource() |
DataSource |
JpaTransactionManager.getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
|
DataSource |
AbstractEntityManagerFactoryBean.getDataSource() |
EntityManagerFactory |
JpaTransactionManager.getEntityManagerFactory()
Return the EntityManagerFactory that this instance should manage transactions for.
|
EntityManagerFactory |
EntityManagerFactoryAccessor.getEntityManagerFactory()
Return the JPA EntityManagerFactory that should be used to create
EntityManagers.
|
Class<? extends EntityManager> |
EntityManagerFactoryInfo.getEntityManagerInterface()
Return the (potentially vendor-specific) EntityManager interface
that this factory's EntityManagers will implement.
|
Class<? extends EntityManager> |
AbstractEntityManagerFactoryBean.getEntityManagerInterface() |
ConnectionHandle |
JpaDialect.getJdbcConnection(EntityManager entityManager,
boolean readOnly)
Retrieve the JDBC Connection that the given JPA EntityManager uses underneath,
if accessing a relational database.
|
ConnectionHandle |
DefaultJpaDialect.getJdbcConnection(EntityManager entityManager,
boolean readOnly)
This implementation always returns
null ,
indicating that no JDBC Connection can be provided. |
JpaDialect |
EntityManagerFactoryInfo.getJpaDialect()
Return the vendor-specific JpaDialect implementation for this
EntityManagerFactory, or
null if not known. |
JpaDialect |
AbstractEntityManagerFactoryBean.getJpaDialect() |
default JpaDialect |
JpaVendorAdapter.getJpaDialect()
Return the vendor-specific JpaDialect implementation for this
provider, or
null if there is none. |
JpaVendorAdapter |
AbstractEntityManagerFactoryBean.getJpaVendorAdapter()
Return the JpaVendorAdapter implementation for this EntityManagerFactory,
or
null if not known. |
EntityManagerFactory |
AbstractEntityManagerFactoryBean.getObject()
Return the singleton EntityManagerFactory.
|
PersistenceProvider |
EntityManagerFactoryInfo.getPersistenceProvider()
Return the underlying PersistenceProvider that the underlying
EntityManagerFactory was created with.
|
PersistenceProvider |
AbstractEntityManagerFactoryBean.getPersistenceProvider() |
default String |
JpaVendorAdapter.getPersistenceProviderRootPackage()
Return the name of the persistence provider's root package
(e.g.
|
PersistenceUnitInfo |
EntityManagerFactoryInfo.getPersistenceUnitInfo()
Return the PersistenceUnitInfo used to create this
EntityManagerFactory, if the in-container API was used.
|
PersistenceUnitInfo |
LocalContainerEntityManagerFactoryBean.getPersistenceUnitInfo() |
PersistenceUnitInfo |
AbstractEntityManagerFactoryBean.getPersistenceUnitInfo() |
String |
EntityManagerFactoryInfo.getPersistenceUnitName()
Return the name of the persistence unit used to create this
EntityManagerFactory, or
null if it is an unnamed default. |
String |
LocalContainerEntityManagerFactoryBean.getPersistenceUnitName() |
String |
JpaTransactionManager.getPersistenceUnitName()
Return the name of the persistence unit to manage transactions for, if any.
|
String |
AbstractEntityManagerFactoryBean.getPersistenceUnitName() |
String |
EntityManagerFactoryAccessor.getPersistenceUnitName()
Return the name of the persistence unit to access the EntityManagerFactory for, if any.
|
protected SavepointManager |
EntityManagerHolder.getSavepointManager() |
protected EntityManager |
EntityManagerFactoryAccessor.getTransactionalEntityManager()
Obtain the transactional EntityManager for this accessor's EntityManagerFactory, if any.
|
static EntityManager |
EntityManagerFactoryUtils.getTransactionalEntityManager(EntityManagerFactory emf)
Obtain a JPA EntityManager from the given factory.
|
static EntityManager |
EntityManagerFactoryUtils.getTransactionalEntityManager(EntityManagerFactory emf,
Map<?,?> properties)
Obtain a JPA EntityManager from the given factory.
|
Object |
JpaDialect.prepareTransaction(EntityManager entityManager,
boolean readOnly,
String name)
Prepare a JPA transaction, applying the specified semantics.
|
Object |
DefaultJpaDialect.prepareTransaction(EntityManager entityManager,
boolean readOnly,
String name) |
DataAccessException |
AbstractEntityManagerFactoryBean.translateExceptionIfPossible(RuntimeException ex)
Implementation of the PersistenceExceptionTranslator interface, as
autodetected by Spring's PersistenceExceptionTranslationPostProcessor.
|
DataAccessException |
DefaultJpaDialect.translateExceptionIfPossible(RuntimeException ex)
This implementation delegates to EntityManagerFactoryUtils.
|
Modifier and Type | Method and Description |
---|---|
void |
JpaDialect.cleanupTransaction(Object transactionData)
Clean up the transaction via the given transaction data.
|
void |
DefaultJpaDialect.cleanupTransaction(Object transactionData)
This implementation does nothing, since the default
beginTransaction
implementation does not require any cleanup. |
static void |
EntityManagerFactoryUtils.closeEntityManager(EntityManager em)
Close the given JPA EntityManager,
catching and logging any cleanup exceptions thrown.
|
static EntityManager |
ExtendedEntityManagerCreator.createContainerManagedEntityManager(EntityManagerFactory emf,
Map<?,?> properties)
Create a container-managed extended EntityManager proxy.
|
static EntityManager |
ExtendedEntityManagerCreator.createContainerManagedEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
boolean synchronizedWithTransaction)
Create a container-managed extended EntityManager proxy.
|
protected EntityManagerFactory |
AbstractEntityManagerFactoryBean.createEntityManagerFactoryProxy(EntityManagerFactory emf)
Create a proxy for the given
EntityManagerFactory . |
EntityManager |
EntityManagerFactoryInfo.createNativeEntityManager(Map<?,?> properties)
Create a native JPA EntityManager to be used as the framework-managed
resource behind an application-level EntityManager handle.
|
EntityManager |
AbstractEntityManagerFactoryBean.createNativeEntityManager(Map<?,?> properties) |
static EntityManager |
SharedEntityManagerCreator.createSharedEntityManager(EntityManagerFactory emf,
Map<?,?> properties)
Create a transactional EntityManager proxy for the given EntityManagerFactory.
|
static EntityManager |
SharedEntityManagerCreator.createSharedEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
boolean synchronizedWithTransaction)
Create a transactional EntityManager proxy for the given EntityManagerFactory.
|
static EntityManager |
SharedEntityManagerCreator.createSharedEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
boolean synchronizedWithTransaction,
Class<?>... entityManagerInterfaces)
Create a transactional EntityManager proxy for the given EntityManagerFactory.
|
static EntityManager |
SharedEntityManagerCreator.createSharedEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
Class<?>... entityManagerInterfaces)
Create a transactional EntityManager proxy for the given EntityManagerFactory.
|
static EntityManager |
EntityManagerFactoryUtils.doGetTransactionalEntityManager(EntityManagerFactory emf,
Map<?,?> properties,
boolean synchronizedWithTransaction)
Obtain a JPA EntityManager from the given factory.
|
protected void |
JpaTransactionManager.doResume(Object transaction,
Object suspendedResources) |
static EntityManagerFactory |
EntityManagerFactoryUtils.findEntityManagerFactory(ListableBeanFactory beanFactory,
String unitName)
Find an EntityManagerFactory with the given name in the given
Spring application context (represented as ListableBeanFactory).
|
static EntityManager |
EntityManagerFactoryUtils.getTransactionalEntityManager(EntityManagerFactory emf,
Map<?,?> properties)
Obtain a JPA EntityManager from the given factory.
|
Object |
JpaDialect.prepareTransaction(EntityManager entityManager,
boolean readOnly,
String name)
Prepare a JPA transaction, applying the specified semantics.
|
Object |
DefaultJpaDialect.prepareTransaction(EntityManager entityManager,
boolean readOnly,
String name) |
void |
AbstractEntityManagerFactoryBean.setBootstrapExecutor(AsyncTaskExecutor bootstrapExecutor)
Specify an asynchronous executor for background bootstrapping,
e.g.
|
void |
LocalContainerEntityManagerFactoryBean.setDataSource(DataSource dataSource)
Specify the JDBC DataSource that the JPA persistence provider is supposed
to use for accessing the database.
|
void |
JpaTransactionManager.setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for.
|
void |
JpaTransactionManager.setEntityManagerFactory(EntityManagerFactory emf)
Set the EntityManagerFactory that this instance should manage transactions for.
|
void |
EntityManagerFactoryAccessor.setEntityManagerFactory(EntityManagerFactory emf)
Set the JPA EntityManagerFactory that should be used to create
EntityManagers.
|
void |
AbstractEntityManagerFactoryBean.setEntityManagerInterface(Class<? extends EntityManager> emInterface)
Specify the (potentially vendor-specific) EntityManager interface
that this factory's EntityManagers are supposed to implement.
|
void |
JpaTransactionManager.setJpaDialect(JpaDialect jpaDialect)
Set the JPA dialect to use for this transaction manager.
|
void |
AbstractEntityManagerFactoryBean.setJpaDialect(JpaDialect jpaDialect)
Specify the vendor-specific JpaDialect implementation to associate with
this EntityManagerFactory.
|
void |
JpaTransactionManager.setJpaProperties(Properties jpaProperties)
Specify JPA properties, to be passed into
EntityManagerFactory.createEntityManager(Map) (if any). |
void |
JpaTransactionManager.setJpaPropertyMap(Map<String,?> jpaProperties)
Specify JPA properties as a Map, to be passed into
EntityManagerFactory.createEntityManager(Map) (if any). |
void |
AbstractEntityManagerFactoryBean.setJpaPropertyMap(Map<String,?> jpaProperties)
Specify JPA properties as a Map, to be passed into
Persistence.createEntityManagerFactory (if any). |
void |
EntityManagerFactoryAccessor.setJpaPropertyMap(Map<String,Object> jpaProperties)
Specify JPA properties as a Map, to be passed into
EntityManagerFactory.createEntityManager(Map) (if any). |
void |
AbstractEntityManagerFactoryBean.setJpaVendorAdapter(JpaVendorAdapter jpaVendorAdapter)
Specify the JpaVendorAdapter implementation for the desired JPA provider,
if any.
|
void |
LocalContainerEntityManagerFactoryBean.setJtaDataSource(DataSource jtaDataSource)
Specify the JDBC DataSource that the JPA persistence provider is supposed
to use for accessing the database.
|
void |
AbstractEntityManagerFactoryBean.setPersistenceProvider(PersistenceProvider persistenceProvider)
Set the PersistenceProvider instance to use for creating the
EntityManagerFactory.
|
void |
LocalContainerEntityManagerFactoryBean.setPersistenceUnitName(String persistenceUnitName)
Uses the specified persistence unit name as the name of the default
persistence unit, if applicable.
|
void |
JpaTransactionManager.setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to manage transactions for.
|
void |
AbstractEntityManagerFactoryBean.setPersistenceUnitName(String persistenceUnitName)
Specify the name of the EntityManagerFactory configuration.
|
void |
EntityManagerFactoryAccessor.setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to access the EntityManagerFactory for.
|
protected void |
EntityManagerHolder.setSavepointManager(SavepointManager savepointManager) |
Constructor and Description |
---|
EntityManagerHolder(EntityManager entityManager) |
Modifier and Type | Method and Description |
---|---|
ClassLoader |
MutablePersistenceUnitInfo.getClassLoader()
This implementation returns the default ClassLoader.
|
DataSourceLookup |
DefaultPersistenceUnitManager.getDataSourceLookup()
Return the JDBC DataSourceLookup that provides DataSources for the
persistence provider, resolving data source names in
persistence.xml
against Spring-managed DataSource instances. |
DataSource |
DefaultPersistenceUnitManager.getDefaultDataSource()
Return the JDBC DataSource that the JPA persistence provider is supposed to use
for accessing the database if none has been specified in
persistence.xml . |
DataSource |
DefaultPersistenceUnitManager.getDefaultJtaDataSource()
Return the JTA-aware DataSource that the JPA persistence provider is supposed to use
for accessing the database if none has been specified in
persistence.xml . |
DataSource |
MutablePersistenceUnitInfo.getJtaDataSource() |
LoadTimeWeaver |
DefaultPersistenceUnitManager.getLoadTimeWeaver()
Return the Spring LoadTimeWeaver to use for class instrumentation according
to the JPA class transformer contract.
|
DataSource |
MutablePersistenceUnitInfo.getNonJtaDataSource() |
String |
MutablePersistenceUnitInfo.getPersistenceProviderClassName() |
String |
MutablePersistenceUnitInfo.getPersistenceProviderPackageName() |
protected MutablePersistenceUnitInfo |
DefaultPersistenceUnitManager.getPersistenceUnitInfo(String persistenceUnitName)
Return the specified PersistenceUnitInfo from this manager's cache
of processed persistence units, keeping it in the cache (i.e.
|
String |
MutablePersistenceUnitInfo.getPersistenceUnitName() |
PersistenceUnitPostProcessor[] |
DefaultPersistenceUnitManager.getPersistenceUnitPostProcessors()
Return the PersistenceUnitPostProcessors to be applied to each
PersistenceUnitInfo that has been parsed by this manager.
|
URL |
MutablePersistenceUnitInfo.getPersistenceUnitRootUrl() |
Modifier and Type | Method and Description |
---|---|
void |
DefaultPersistenceUnitManager.setDataSourceLookup(DataSourceLookup dataSourceLookup)
Specify the JDBC DataSourceLookup that provides DataSources for the
persistence provider, resolving data source names in
persistence.xml
against Spring-managed DataSource instances. |
void |
DefaultPersistenceUnitManager.setDefaultDataSource(DataSource defaultDataSource)
Specify the JDBC DataSource that the JPA persistence provider is supposed to use
for accessing the database if none has been specified in
persistence.xml . |
void |
DefaultPersistenceUnitManager.setDefaultJtaDataSource(DataSource defaultJtaDataSource)
Specify the JDBC DataSource that the JPA persistence provider is supposed to use
for accessing the database if none has been specified in
persistence.xml . |
void |
MutablePersistenceUnitInfo.setJtaDataSource(DataSource jtaDataSource) |
void |
DefaultPersistenceUnitManager.setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver)
Specify the Spring LoadTimeWeaver to use for class instrumentation according
to the JPA class transformer contract.
|
void |
MutablePersistenceUnitInfo.setNonJtaDataSource(DataSource nonJtaDataSource) |
void |
MutablePersistenceUnitInfo.setPersistenceProviderClassName(String persistenceProviderClassName) |
void |
MutablePersistenceUnitInfo.setPersistenceProviderPackageName(String persistenceProviderPackageName) |
void |
MutablePersistenceUnitInfo.setPersistenceUnitName(String persistenceUnitName) |
void |
DefaultPersistenceUnitManager.setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor... postProcessors)
Set the PersistenceUnitPostProcessors to be applied to each
PersistenceUnitInfo that has been parsed by this manager.
|
void |
MutablePersistenceUnitInfo.setPersistenceUnitRootUrl(URL persistenceUnitRootUrl) |
Modifier and Type | Method and Description |
---|---|
protected String |
OpenEntityManagerInViewFilter.getEntityManagerFactoryBeanName()
Return the bean name of the EntityManagerFactory to fetch from Spring's
root application context.
|
EntityManager |
SharedEntityManagerBean.getObject() |
protected EntityManager |
PersistenceAnnotationBeanPostProcessor.getPersistenceContext(String unitName,
boolean extended)
Return a specified persistence context for the given unit name, as defined
through the "persistenceContexts" (or "extendedPersistenceContexts") map.
|
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.getPersistenceUnit(String unitName)
Return a specified persistence unit for the given unit name,
as defined through the "persistenceUnits" map.
|
protected String |
OpenEntityManagerInViewFilter.getPersistenceUnitName()
Return the name of the persistence unit to access the EntityManagerFactory for, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
OpenEntityManagerInViewInterceptor.afterCompletion(WebRequest request,
Exception ex) |
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.findDefaultEntityManagerFactory(String requestingBeanName)
Find a single default EntityManagerFactory in the Spring application context.
|
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.findEntityManagerFactory(String unitName,
String requestingBeanName)
Find an EntityManagerFactory with the given name in the current Spring
application context, falling back to a single default EntityManagerFactory
(if any) in case of no unit name specified.
|
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.findEntityManagerFactory(String unitName,
String requestingBeanName)
Find an EntityManagerFactory with the given name in the current Spring
application context, falling back to a single default EntityManagerFactory
(if any) in case of no unit name specified.
|
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.findNamedEntityManagerFactory(String unitName,
String requestingBeanName)
Find an EntityManagerFactory with the given name in the current
Spring application context.
|
protected EntityManager |
PersistenceAnnotationBeanPostProcessor.getPersistenceContext(String unitName,
boolean extended)
Return a specified persistence context for the given unit name, as defined
through the "persistenceContexts" (or "extendedPersistenceContexts") map.
|
protected EntityManagerFactory |
PersistenceAnnotationBeanPostProcessor.getPersistenceUnit(String unitName)
Return a specified persistence unit for the given unit name,
as defined through the "persistenceUnits" map.
|
void |
OpenEntityManagerInViewInterceptor.postHandle(WebRequest request,
ModelMap model) |
void |
PersistenceAnnotationBeanPostProcessor.setDefaultPersistenceUnitName(String unitName)
Specify the default persistence unit name, to be used in case
of no unit name specified in an
@PersistenceUnit /
@PersistenceContext annotation. |
void |
OpenEntityManagerInViewFilter.setEntityManagerFactoryBeanName(String entityManagerFactoryBeanName)
Set the bean name of the EntityManagerFactory to fetch from Spring's
root application context.
|
void |
OpenEntityManagerInViewFilter.setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to access the EntityManagerFactory for.
|
Modifier and Type | Method and Description |
---|---|
Object |
EclipseLinkJpaDialect.beginTransaction(EntityManager entityManager,
TransactionDefinition definition) |
protected Class<?> |
HibernateJpaVendorAdapter.determineDatabaseDialectClass(Database database)
Determine the Hibernate database dialect class for the given target database.
|
protected String |
EclipseLinkJpaVendorAdapter.determineTargetDatabaseName(Database database)
Determine the EclipseLink target database name for the given database.
|
protected String |
AbstractJpaVendorAdapter.getDatabasePlatform()
Return the name of the target database to operate on.
|
JpaDialect |
AbstractJpaVendorAdapter.getJpaDialect() |
SessionFactory |
HibernateJpaSessionFactoryBean.getObject()
Deprecated.
|
String |
AbstractJpaVendorAdapter.getPersistenceProviderRootPackage() |
protected FlushMode |
HibernateJpaDialect.prepareFlushMode(Session session,
boolean readOnly) |
DataAccessException |
HibernateJpaDialect.translateExceptionIfPossible(RuntimeException ex) |
Modifier and Type | Method and Description |
---|---|
void |
HibernateJpaDialect.cleanupTransaction(Object transactionData) |
Object |
HibernateJpaDialect.prepareTransaction(EntityManager entityManager,
boolean readOnly,
String name) |
void |
AbstractJpaVendorAdapter.setDatabasePlatform(String databasePlatform)
Specify the name of the target database to operate on.
|
Modifier and Type | Method and Description |
---|---|
Class<?>[] |
Jaxb2Marshaller.getClassesToBeBound()
Return the list of Java classes to be recognized by a newly created JAXBContext.
|
String |
Jaxb2Marshaller.getContextPath()
Return the JAXB context path.
|
String[] |
Jaxb2Marshaller.getPackagesToScan()
Return the packages to search for JAXB2 annotations.
|
Modifier and Type | Method and Description |
---|---|
void |
Jaxb2Marshaller.marshal(Object graph,
Result result,
MimeContainer mimeContainer) |
void |
Jaxb2Marshaller.setClassesToBeBound(Class<?>... classesToBeBound)
Set the list of Java classes to be recognized by a newly created JAXBContext.
|
void |
Jaxb2Marshaller.setContextPath(String contextPath)
Set a JAXB context path.
|
void |
Jaxb2Marshaller.setPackagesToScan(String... packagesToScan)
Set the packages to search for classes with JAXB2 annotations in the classpath.
|
Object |
Jaxb2Marshaller.unmarshal(Source source,
MimeContainer mimeContainer) |
Modifier and Type | Method and Description |
---|---|
protected void |
JibxMarshaller.marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
DataHandler |
MimeContainer.getAttachment(String contentId)
Return the attachment with the given content id, or
null if not found. |
Modifier and Type | Method and Description |
---|---|
void |
MimeMarshaller.marshal(Object graph,
Result result,
MimeContainer mimeContainer)
Marshals the object graph with the given root into the provided
Result ,
writing binary data to a MimeContainer . |
Object |
MimeUnmarshaller.unmarshal(Source source,
MimeContainer mimeContainer)
Unmarshals the given provided
Source into an object graph,
reading binary attachments from a MimeContainer . |
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractMarshaller.getDefaultEncoding()
Determine the default encoding to use for marshalling or unmarshalling from
a byte stream, or
null if none. |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
AbstractMarshaller.marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler)
Abstract template method for marshalling the given object graph to a SAX
ContentHandler . |
Modifier and Type | Method and Description |
---|---|
void |
XStreamMarshaller.marshalOutputStream(Object graph,
OutputStream outputStream,
com.thoughtworks.xstream.converters.DataHolder dataHolder) |
protected void |
XStreamMarshaller.marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler) |
void |
XStreamMarshaller.marshalWriter(Object graph,
Writer writer,
com.thoughtworks.xstream.converters.DataHolder dataHolder) |
Object |
XStreamMarshaller.unmarshalInputStream(InputStream inputStream,
com.thoughtworks.xstream.converters.DataHolder dataHolder) |
Object |
XStreamMarshaller.unmarshalReader(Reader reader,
com.thoughtworks.xstream.converters.DataHolder dataHolder) |
Modifier and Type | Method and Description |
---|---|
String |
UncategorizedR2dbcException.getSql()
Return the SQL that led to the problem (if known).
|
Constructor and Description |
---|
UncategorizedR2dbcException(String msg,
String sql,
io.r2dbc.spi.R2dbcException ex)
Constructor for
UncategorizedSQLException . |
Modifier and Type | Method and Description |
---|---|
protected Boolean |
SingleConnectionFactory.getAutoCommitValue()
Return whether the returned
Connection 's "autoCommit" setting should
be overridden. |
io.r2dbc.spi.ConnectionFactory |
R2dbcTransactionManager.getConnectionFactory()
Return the R2DBC
ConnectionFactory that this instance manages transactions for. |
protected io.r2dbc.spi.IsolationLevel |
R2dbcTransactionManager.resolveIsolationLevel(int isolationLevel)
Resolve the isolation level constant to a R2DBC
IsolationLevel . |
Modifier and Type | Method and Description |
---|---|
static DataAccessException |
ConnectionFactoryUtils.convertR2dbcException(String task,
String sql,
io.r2dbc.spi.R2dbcException ex)
Translate the given
R2dbcException into a generic DataAccessException . |
protected reactor.core.publisher.Mono<Void> |
R2dbcTransactionManager.doResume(TransactionSynchronizationManager synchronizationManager,
Object transaction,
Object suspendedResources) |
protected void |
ConnectionHolder.setConnection(io.r2dbc.spi.Connection connection)
Override the existing Connection with the given
Connection . |
void |
R2dbcTransactionManager.setConnectionFactory(io.r2dbc.spi.ConnectionFactory connectionFactory)
Set the R2DBC
ConnectionFactory that this instance should manage transactions
for. |
Modifier and Type | Method and Description |
---|---|
static reactor.core.publisher.Mono<Void> |
ScriptUtils.executeSqlScript(io.r2dbc.spi.Connection connection,
EncodedResource resource,
DataBufferFactory dataBufferFactory,
boolean continueOnError,
boolean ignoreFailedDrops,
String[] commentPrefixes,
String separator,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter)
Execute the given SQL script.
|
static reactor.core.publisher.Mono<Void> |
ScriptUtils.executeSqlScript(io.r2dbc.spi.Connection connection,
EncodedResource resource,
DataBufferFactory dataBufferFactory,
boolean continueOnError,
boolean ignoreFailedDrops,
String commentPrefix,
String separator,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter)
Execute the given SQL script.
|
void |
ResourceDatabasePopulator.setSqlScriptEncoding(Charset sqlScriptEncoding)
Specify the encoding for the configured SQL scripts,
if different from the platform encoding.
|
void |
ResourceDatabasePopulator.setSqlScriptEncoding(String sqlScriptEncoding)
Specify the encoding for the configured SQL scripts,
if different from the platform encoding.
|
Constructor and Description |
---|
ResourceDatabasePopulator(boolean continueOnError,
boolean ignoreFailedDrops,
String sqlScriptEncoding,
Resource... scripts)
Construct a new
ResourceDatabasePopulator with the supplied values. |
ScriptException(String message,
Throwable cause)
Create a new
ScriptException . |
ScriptParseException(String message,
EncodedResource resource)
Create a new
ScriptParseException . |
ScriptParseException(String message,
EncodedResource resource,
Throwable cause)
Create a new
ScriptParseException . |
ScriptParseException(String message,
EncodedResource resource,
Throwable cause)
Create a new
ScriptParseException . |
Modifier and Type | Method and Description |
---|---|
protected Object |
ColumnMapRowMapper.getColumnValue(io.r2dbc.spi.Row row,
int index)
Retrieve a R2DBC object value for the specified column.
|
String |
SqlProvider.getSql()
Return the SQL string for this object, i.e.
|
Object |
Parameter.getValue()
Return the column value (can be
null ). |
Modifier and Type | Method and Description |
---|---|
static Parameter |
Parameter.fromOrEmpty(Object value,
Class<?> type)
|
Modifier and Type | Method and Description |
---|---|
BindMarkersFactory |
BindMarkersFactoryResolver.BindMarkerFactoryProvider.getBindMarkers(io.r2dbc.spi.ConnectionFactory connectionFactory)
Return a
BindMarkersFactory for a ConnectionFactory . |
abstract Object |
Bindings.Binding.getValue()
Return the binding value.
|
Modifier and Type | Method and Description |
---|---|
Object |
HessianProxyFactoryBean.getObject()
Deprecated.
|
Object |
HessianClientInterceptor.invoke(MethodInvocation invocation)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
HessianClientInterceptor.setProxyFactory(com.caucho.hessian.client.HessianProxyFactory proxyFactory)
Deprecated.
Set the HessianProxyFactory instance to use.
|
void |
HessianExporter.setSerializerFactory(com.caucho.hessian.io.SerializerFactory serializerFactory)
Deprecated.
Specify the Hessian SerializerFactory to use.
|
Modifier and Type | Method and Description |
---|---|
protected RemoteAccessException |
HttpInvokerClientInterceptor.convertHttpInvokerAccessException(Throwable ex)
Deprecated.
Convert the given HTTP invoker access exception to an appropriate
Spring
RemoteAccessException . |
protected org.apache.http.client.config.RequestConfig |
HttpComponentsHttpInvokerRequestExecutor.createRequestConfig(HttpInvokerClientConfiguration config)
Deprecated.
Create a
RequestConfig for the given configuration. |
protected ClassLoader |
AbstractHttpInvokerRequestExecutor.getBeanClassLoader()
Deprecated.
Return the bean ClassLoader that this executor is supposed to use.
|
String |
HttpInvokerClientInterceptor.getCodebaseUrl()
Deprecated.
Return the codebase URL to download classes from if not found locally.
|
String |
HttpInvokerClientConfiguration.getCodebaseUrl()
Deprecated.
Return the codebase URL to download classes from if not found locally.
|
Object |
HttpInvokerProxyFactoryBean.getObject()
Deprecated.
|
Object |
HttpInvokerClientInterceptor.invoke(MethodInvocation methodInvocation)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected ObjectInputStream |
AbstractHttpInvokerRequestExecutor.createObjectInputStream(InputStream is,
String codebaseUrl)
Deprecated.
Create an ObjectInputStream for the given InputStream and codebase.
|
protected RemoteInvocationResult |
AbstractHttpInvokerRequestExecutor.readRemoteInvocationResult(InputStream is,
String codebaseUrl)
Deprecated.
Deserialize a RemoteInvocationResult object from the given InputStream.
|
void |
HttpInvokerClientInterceptor.setCodebaseUrl(String codebaseUrl)
Deprecated.
Set the codebase URL to download classes from if not found locally.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
JaxWsPortClientInterceptor.doInvoke(MethodInvocation invocation)
Perform a JAX-WS service invocation based on the given method invocation.
|
protected Object |
JaxWsPortClientInterceptor.doInvoke(MethodInvocation invocation,
Object portStub)
Perform a JAX-WS service invocation on the given port stub.
|
protected ClassLoader |
JaxWsPortClientInterceptor.getBeanClassLoader()
Return the bean ClassLoader to use for this interceptor.
|
String |
JaxWsPortClientInterceptor.getEndpointAddress()
Return the endpoint address to specify on the stub.
|
Service |
JaxWsPortClientInterceptor.getJaxWsService()
Return a reference to an existing JAX-WS Service instance, if any.
|
String |
LocalJaxWsServiceFactory.getNamespaceUri()
Return the namespace URI of the service.
|
Object |
JaxWsPortProxyFactoryBean.getObject() |
Service |
LocalJaxWsServiceFactoryBean.getObject() |
String |
JaxWsPortClientInterceptor.getPassword()
Return the password to specify on the stub.
|
String |
JaxWsPortClientInterceptor.getPortName()
Return the name of the port.
|
protected QName |
JaxWsPortClientInterceptor.getPortQName()
Return the prepared QName for the port.
|
protected Object |
JaxWsPortClientInterceptor.getPortStub()
Return the underlying JAX-WS port stub that this interceptor delegates to
for each method invocation on the proxy.
|
Class<?> |
JaxWsPortClientInterceptor.getServiceInterface()
Return the interface of the service that this factory should create a proxy for.
|
String |
LocalJaxWsServiceFactory.getServiceName()
Return the name of the service.
|
String |
JaxWsPortClientInterceptor.getSoapActionUri()
Return the SOAP action URI to specify on the stub.
|
String |
JaxWsPortClientInterceptor.getUsername()
Return the username to specify on the stub.
|
URL |
LocalJaxWsServiceFactory.getWsdlDocumentUrl()
Return the URL of the WSDL document that describes the service.
|
Object |
JaxWsPortClientInterceptor.invoke(MethodInvocation invocation) |
Modifier and Type | Method and Description |
---|---|
protected Object |
JaxWsPortClientInterceptor.doInvoke(MethodInvocation invocation,
Object portStub)
Perform a JAX-WS service invocation on the given port stub.
|
protected Object |
JaxWsPortClientInterceptor.getPortStub(Service service,
QName portQName)
Obtain the port stub from the given JAX-WS Service.
|
void |
JaxWsPortClientInterceptor.setBeanClassLoader(ClassLoader classLoader)
Set the bean ClassLoader to use for this interceptor: primarily for
building a client proxy in the
JaxWsPortProxyFactoryBean subclass. |
void |
JaxWsPortClientInterceptor.setEndpointAddress(String endpointAddress)
Set the endpoint address to specify on the stub.
|
void |
JaxWsPortClientInterceptor.setJaxWsService(Service jaxWsService)
Set a reference to an existing JAX-WS Service instance,
for example obtained via
JndiObjectFactoryBean . |
void |
LocalJaxWsServiceFactory.setNamespaceUri(String namespaceUri)
Set the namespace URI of the service.
|
void |
JaxWsPortClientInterceptor.setPassword(String password)
Set the password to specify on the stub.
|
void |
JaxWsPortClientInterceptor.setPortName(String portName)
Set the name of the port.
|
void |
JaxWsPortClientInterceptor.setServiceInterface(Class<?> serviceInterface)
Set the interface of the service that this factory should create a proxy for.
|
void |
LocalJaxWsServiceFactory.setServiceName(String serviceName)
Set the name of the service to look up.
|
void |
JaxWsPortClientInterceptor.setSoapActionUri(String soapActionUri)
Set the SOAP action URI to specify on the stub.
|
void |
JaxWsPortClientInterceptor.setUsername(String username)
Set the username to specify on the stub.
|
void |
LocalJaxWsServiceFactory.setWsdlDocumentUrl(URL wsdlDocumentUrl)
Set the URL of the WSDL document that describes the service.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
JndiRmiClientInterceptor.doInvoke(MethodInvocation invocation,
Object stub)
Deprecated.
Perform the given invocation on the given RMI stub.
|
protected Object |
RmiClientInterceptor.doInvoke(MethodInvocation invocation,
Remote stub)
Deprecated.
Perform the given invocation on the given RMI stub.
|
protected Object |
RmiClientInterceptor.doInvoke(MethodInvocation methodInvocation,
RmiInvocationHandler invocationHandler)
Deprecated.
Apply the given AOP method invocation to the given
RmiInvocationHandler . |
String |
RmiInvocationHandler.getTargetInterfaceName()
Deprecated.
Return the name of the target interface that this invoker operates on.
|
Object |
RmiClientInterceptor.invoke(MethodInvocation invocation)
Deprecated.
Fetches an RMI stub and delegates to
doInvoke . |
Object |
JndiRmiClientInterceptor.invoke(MethodInvocation invocation)
Deprecated.
Fetches an RMI stub and delegates to
JndiRmiClientInterceptor.doInvoke(org.aopalliance.intercept.MethodInvocation, java.lang.Object) . |
Object |
RmiInvocationHandler.invoke(RemoteInvocation invocation)
Deprecated.
Apply the given invocation to the target object.
|
static Object |
RmiClientInterceptorUtils.invokeRemoteMethod(MethodInvocation invocation,
Object stub)
Deprecated.
Perform a raw method invocation on the given RMI stub,
letting reflection exceptions through as-is.
|
protected Object |
RmiClientInterceptor.refreshAndRetry(MethodInvocation invocation)
Deprecated.
Refresh the RMI stub and retry the given invocation.
|
protected Object |
JndiRmiClientInterceptor.refreshAndRetry(MethodInvocation invocation)
Deprecated.
Refresh the RMI stub and retry the given invocation.
|
Modifier and Type | Method and Description |
---|---|
protected Registry |
RmiRegistryFactoryBean.getRegistry(int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry.
|
protected Registry |
RmiRegistryFactoryBean.getRegistry(int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry.
|
protected Registry |
RmiServiceExporter.getRegistry(int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry for this exporter.
|
protected Registry |
RmiServiceExporter.getRegistry(int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry for this exporter.
|
protected Registry |
RmiRegistryFactoryBean.getRegistry(String registryHost,
int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry.
|
protected Registry |
RmiRegistryFactoryBean.getRegistry(String registryHost,
int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry.
|
protected Registry |
RmiServiceExporter.getRegistry(String registryHost,
int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry for this exporter.
|
protected Registry |
RmiServiceExporter.getRegistry(String registryHost,
int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Deprecated.
Locate or create the RMI registry for this exporter.
|
Constructor and Description |
---|
CodebaseAwareObjectInputStream(InputStream in,
ClassLoader classLoader,
boolean acceptProxyClasses)
Deprecated.
Create a new CodebaseAwareObjectInputStream for the given InputStream and codebase.
|
CodebaseAwareObjectInputStream(InputStream in,
ClassLoader classLoader,
String codebaseUrl)
Deprecated.
Create a new CodebaseAwareObjectInputStream for the given InputStream and codebase.
|
Modifier and Type | Method and Description |
---|---|
Serializable |
RemoteInvocation.getAttribute(String key)
Retrieve the attribute for the given key, if any.
|
Map<String,Serializable> |
RemoteInvocation.getAttributes()
Return the attributes Map.
|
Throwable |
RemoteInvocationResult.getException()
Return the exception thrown by an unsuccessful invocation
of the target method, if any.
|
Object |
RemoteInvocationResult.getValue()
Return the result value returned by a successful invocation
of the target method, if any.
|
Object |
RemoteInvocationTraceInterceptor.invoke(MethodInvocation invocation) |
protected ClassLoader |
RemotingSupport.overrideThreadContextClassLoader()
Override the thread context ClassLoader with the environment's bean ClassLoader
if necessary, i.e.
|
Object |
RemoteInvocationResult.recreate()
Recreate the invocation result, either returning the result value
in case of a successful invocation of the target method, or
rethrowing the exception thrown by the target method.
|
protected Object |
RemoteInvocationBasedAccessor.recreateRemoteInvocationResult(RemoteInvocationResult result)
Recreate the invocation result contained in the given RemoteInvocationResult object.
|
Modifier and Type | Method and Description |
---|---|
protected void |
RemotingSupport.resetThreadContextClassLoader(ClassLoader original)
Reset the original thread context ClassLoader if necessary.
|
void |
RemoteInvocation.setAttributes(Map<String,Serializable> attributes)
Set the attributes Map.
|
void |
RemoteInvocationResult.setException(Throwable exception)
Set the exception thrown by an unsuccessful invocation of the
target method, if any.
|
void |
RemoteInvocationResult.setValue(Object value)
Set the result value returned by a successful invocation of the
target method, if any.
|
Constructor and Description |
---|
RemoteInvocationResult(Object value)
Create a new RemoteInvocationResult for the given result value.
|
RemoteInvocationResult(Throwable exception)
Create a new RemoteInvocationResult for the given exception.
|
Modifier and Type | Method and Description |
---|---|
Date |
TriggerContext.lastActualExecutionTime()
Return the last actual execution time of the task,
or
null if not scheduled before. |
Date |
TriggerContext.lastCompletionTime()
Return the last completion time of the task,
or
null if not scheduled before. |
Date |
TriggerContext.lastScheduledExecutionTime()
Return the last scheduled execution time of the task,
or
null if not scheduled before. |
Date |
Trigger.nextExecutionTime(TriggerContext triggerContext)
Determine the next execution time according to the given trigger context.
|
ScheduledFuture<?> |
TaskScheduler.schedule(Runnable task,
Trigger trigger)
Schedule the given
Runnable , invoking it whenever the trigger
indicates a next execution time. |
Modifier and Type | Field and Description |
---|---|
protected AnnotationAttributes |
AbstractAsyncConfiguration.enableAsync |
protected Supplier<AsyncUncaughtExceptionHandler> |
AbstractAsyncConfiguration.exceptionHandler |
protected Supplier<Executor> |
AbstractAsyncConfiguration.executor |
Modifier and Type | Method and Description |
---|---|
V |
AsyncResult.get() |
V |
AsyncResult.get(long timeout,
TimeUnit unit) |
default Executor |
AsyncConfigurer.getAsyncExecutor()
The
Executor instance to be used when processing async
method invocations. |
AsyncUncaughtExceptionHandler |
AsyncConfigurerSupport.getAsyncUncaughtExceptionHandler() |
default AsyncUncaughtExceptionHandler |
AsyncConfigurer.getAsyncUncaughtExceptionHandler()
The
AsyncUncaughtExceptionHandler instance to be used
when an exception is thrown during an asynchronous method execution
with void return type. |
protected String |
AnnotationAsyncExecutionInterceptor.getExecutorQualifier(Method method)
Return the qualifier or bean name of the executor to be used when executing the
given method, specified via
Async.value() at the method or declaring
class level. |
String[] |
AsyncConfigurationSelector.selectImports(AdviceMode adviceMode)
Returns
ProxyAsyncConfiguration or AspectJAsyncConfiguration
for PROXY and ASPECTJ values of EnableAsync.mode() ,
respectively. |
Modifier and Type | Method and Description |
---|---|
protected Advice |
AsyncAnnotationAdvisor.buildAdvice(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) |
protected Advice |
AsyncAnnotationAdvisor.buildAdvice(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) |
void |
AsyncAnnotationBeanPostProcessor.configure(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Configure this post-processor with the given executor and exception handler suppliers,
applying the corresponding default if a supplier is not resolvable.
|
void |
AsyncAnnotationBeanPostProcessor.configure(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Configure this post-processor with the given executor and exception handler suppliers,
applying the corresponding default if a supplier is not resolvable.
|
Constructor and Description |
---|
AnnotationAsyncExecutionInterceptor(Executor defaultExecutor)
Create a new
AnnotationAsyncExecutionInterceptor with the given executor
and a simple AsyncUncaughtExceptionHandler . |
AnnotationAsyncExecutionInterceptor(Executor defaultExecutor,
AsyncUncaughtExceptionHandler exceptionHandler)
Create a new
AnnotationAsyncExecutionInterceptor with the given executor. |
AsyncAnnotationAdvisor(Executor executor,
AsyncUncaughtExceptionHandler exceptionHandler)
Create a new
AsyncAnnotationAdvisor for the given task executor. |
AsyncAnnotationAdvisor(Executor executor,
AsyncUncaughtExceptionHandler exceptionHandler)
Create a new
AsyncAnnotationAdvisor for the given task executor. |
AsyncAnnotationAdvisor(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Create a new
AsyncAnnotationAdvisor for the given task executor. |
AsyncAnnotationAdvisor(Supplier<Executor> executor,
Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
Create a new
AsyncAnnotationAdvisor for the given task executor. |
AsyncResult(V value)
Create a new AsyncResult holder.
|
Modifier and Type | Method and Description |
---|---|
TimerManager |
TimerManagerFactoryBean.getObject()
Deprecated.
|
TimerListener |
ScheduledTimerListener.getTimerListener()
Deprecated.
Return the TimerListener to schedule.
|
protected TimerManager |
TimerManagerAccessor.getTimerManager()
Deprecated.
Return the configured TimerManager, if any.
|
ScheduledFuture<?> |
TimerManagerTaskScheduler.schedule(Runnable task,
Trigger trigger)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
ScheduledTimerListener.setTimerListener(TimerListener timerListener)
Deprecated.
Set the TimerListener to schedule.
|
Modifier and Type | Method and Description |
---|---|
ForkJoinPool |
ForkJoinPoolFactoryBean.getObject() |
ExecutorService |
ThreadPoolExecutorFactoryBean.getObject() |
ScheduledExecutorService |
ScheduledExecutorFactoryBean.getObject() |
ScheduledFuture<?> |
ThreadPoolTaskScheduler.schedule(Runnable task,
Trigger trigger) |
ScheduledFuture<?> |
ConcurrentTaskScheduler.schedule(Runnable task,
Trigger trigger) |
Modifier and Type | Method and Description |
---|---|
void |
ConcurrentTaskExecutor.setConcurrentExecutor(Executor executor)
Specify the
Executor to delegate to. |
void |
ExecutorConfigurationSupport.setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)
Set the RejectedExecutionHandler to use for the ExecutorService.
|
void |
ConcurrentTaskScheduler.setScheduledExecutor(ScheduledExecutorService scheduledExecutor)
Specify the
ScheduledExecutorService to delegate to. |
void |
ExecutorConfigurationSupport.setThreadFactory(ThreadFactory threadFactory)
Set the ThreadFactory to use for the ExecutorService's thread pool.
|
void |
ExecutorConfigurationSupport.setThreadNamePrefix(String threadNamePrefix) |
void |
ScheduledExecutorTask.setTimeUnit(TimeUnit timeUnit)
Specify the time unit for the delay and period values.
|
Constructor and Description |
---|
ConcurrentTaskExecutor(Executor executor)
Create a new ConcurrentTaskExecutor, using the given
Executor . |
Modifier and Type | Method and Description |
---|---|
TaskExecutor |
TaskExecutorFactoryBean.getObject() |
TaskScheduler |
ScheduledTaskRegistrar.getScheduler()
Return the
TaskScheduler instance for this registrar (may be null ). |
BeanDefinition |
AnnotationDrivenBeanDefinitionParser.parse(Element element,
ParserContext parserContext) |
ScheduledTask |
ScheduledTaskRegistrar.scheduleCronTask(CronTask task)
Schedule the specified cron task, either right away if possible
or on initialization of the scheduler.
|
ScheduledTask |
ScheduledTaskRegistrar.scheduleFixedDelayTask(FixedDelayTask task)
Schedule the specified fixed-delay task, either right away if possible
or on initialization of the scheduler.
|
ScheduledTask |
ScheduledTaskRegistrar.scheduleFixedDelayTask(IntervalTask task)
Deprecated.
as of 5.0.2, in favor of
ScheduledTaskRegistrar.scheduleFixedDelayTask(FixedDelayTask) |
ScheduledTask |
ScheduledTaskRegistrar.scheduleFixedRateTask(FixedRateTask task)
Schedule the specified fixed-rate task, either right away if possible
or on initialization of the scheduler.
|
ScheduledTask |
ScheduledTaskRegistrar.scheduleFixedRateTask(IntervalTask task)
Deprecated.
as of 5.0.2, in favor of
ScheduledTaskRegistrar.scheduleFixedRateTask(FixedRateTask) |
ScheduledTask |
ScheduledTaskRegistrar.scheduleTriggerTask(TriggerTask task)
Schedule the specified trigger task, either right away if possible
or on initialization of the scheduler.
|
Modifier and Type | Method and Description |
---|---|
void |
ScheduledTaskRegistrar.setScheduler(Object scheduler)
Set the
TaskScheduler to register scheduled tasks with, or a
ScheduledExecutorService to be wrapped as a
TaskScheduler . |
Modifier and Type | Field and Description |
---|---|
protected ResourceLoader |
SchedulerAccessor.resourceLoader |
Modifier and Type | Method and Description |
---|---|
static DataSource |
SchedulerFactoryBean.getConfigTimeDataSource()
Return the
DataSource for the currently configured Quartz Scheduler,
to be used by LocalDataSourceJobStore . |
static DataSource |
SchedulerFactoryBean.getConfigTimeNonTransactionalDataSource()
Return the non-transactional
DataSource for the currently configured
Quartz Scheduler, to be used by LocalDataSourceJobStore . |
static ResourceLoader |
SchedulerFactoryBean.getConfigTimeResourceLoader()
Return the
ResourceLoader for the currently configured Quartz Scheduler,
to be used by ResourceLoaderClassLoadHelper . |
static Executor |
SchedulerFactoryBean.getConfigTimeTaskExecutor()
Return the
Executor for the currently configured Quartz Scheduler,
to be used by LocalTaskExecutorThreadPool . |
org.quartz.Scheduler |
SchedulerFactoryBean.getObject() |
org.quartz.JobDetail |
MethodInvokingJobDetailFactoryBean.getObject() |
org.quartz.JobDetail |
JobDetailFactoryBean.getObject() |
org.quartz.CronTrigger |
CronTriggerFactoryBean.getObject() |
org.quartz.SimpleTrigger |
SimpleTriggerFactoryBean.getObject() |
URL |
ResourceLoaderClassLoadHelper.getResource(String name) |
InputStream |
ResourceLoaderClassLoadHelper.getResourceAsStream(String name) |
Modifier and Type | Method and Description |
---|---|
protected org.quartz.Scheduler |
SchedulerFactoryBean.createScheduler(org.quartz.SchedulerFactory schedulerFactory,
String schedulerName)
Create the Scheduler instance for the given factory and scheduler name.
|
Constructor and Description |
---|
ResourceLoaderClassLoadHelper(ResourceLoader resourceLoader)
Create a new ResourceLoaderClassLoadHelper for the given ResourceLoader.
|
Modifier and Type | Method and Description |
---|---|
Date |
SimpleTriggerContext.lastActualExecutionTime() |
Date |
SimpleTriggerContext.lastCompletionTime() |
Date |
SimpleTriggerContext.lastScheduledExecutionTime() |
<T extends Temporal & Comparable<? super T>> |
CronExpression.next(T temporal)
Calculate the next
Temporal that matches this expression. |
Modifier and Type | Method and Description |
---|---|
static DelegatingErrorHandlingRunnable |
TaskUtils.decorateTaskWithErrorHandler(Runnable task,
ErrorHandler errorHandler,
boolean isRepeatingTask)
Decorate the task for error handling.
|
boolean |
CronTrigger.equals(Object other) |
boolean |
PeriodicTrigger.equals(Object other) |
boolean |
CronExpression.equals(Object other) |
boolean |
CronSequenceGenerator.equals(Object other)
Deprecated.
|
static boolean |
CronExpression.isValidExpression(String expression)
Determine whether the given string represents a valid cron expression.
|
static boolean |
CronSequenceGenerator.isValidExpression(String expression)
Deprecated.
Determine whether the specified expression represents a valid cron pattern.
|
Constructor and Description |
---|
PeriodicTrigger(long period,
TimeUnit timeUnit)
Create a trigger with the given period and time unit.
|
Modifier and Type | Method and Description |
---|---|
Object |
ScriptEvaluator.evaluate(ScriptSource script)
Evaluate the given script.
|
Object |
ScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments)
Evaluate the given script with the given arguments.
|
Object |
ScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Factory method for creating the scripted Java object.
|
Class<?> |
ScriptFactory.getScriptedObjectType(ScriptSource scriptSource)
Determine the type of the scripted Java object.
|
Class<?>[] |
ScriptFactory.getScriptInterfaces()
Return the business interfaces that the script is supposed to implement.
|
ScriptSource |
ScriptCompilationException.getScriptSource()
Return the source for the offending script.
|
String |
ScriptSource.suggestedClassName()
Determine a class name for the underlying script.
|
Modifier and Type | Method and Description |
---|---|
Object |
ScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments)
Evaluate the given script with the given arguments.
|
Object |
ScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Factory method for creating the scripted Java object.
|
Modifier and Type | Method and Description |
---|---|
Object |
BshScriptEvaluator.evaluate(ScriptSource script) |
Object |
BshScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments) |
Object |
BshScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Load and parse the BeanShell script via
BshScriptUtils . |
Class<?> |
BshScriptFactory.getScriptedObjectType(ScriptSource scriptSource) |
Class<?>[] |
BshScriptFactory.getScriptInterfaces() |
Modifier and Type | Method and Description |
---|---|
static Object |
BshScriptUtils.createBshObject(String scriptSource,
Class<?>... scriptInterfaces)
Create a new BeanShell-scripted object from the given script source,
using the default ClassLoader.
|
static Object |
BshScriptUtils.createBshObject(String scriptSource,
Class<?>[] scriptInterfaces,
ClassLoader classLoader)
Create a new BeanShell-scripted object from the given script source.
|
static Object |
BshScriptUtils.createBshObject(String scriptSource,
Class<?>[] scriptInterfaces,
ClassLoader classLoader)
Create a new BeanShell-scripted object from the given script source.
|
Object |
BshScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments) |
Object |
BshScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Load and parse the BeanShell script via
BshScriptUtils . |
Constructor and Description |
---|
BshScriptFactory(String scriptSourceLocator,
Class<?>... scriptInterfaces)
Create a new BshScriptFactory for the given script source.
|
Modifier and Type | Method and Description |
---|---|
Object |
GroovyScriptEvaluator.evaluate(ScriptSource script) |
Object |
GroovyScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments) |
protected Object |
GroovyScriptFactory.executeScript(ScriptSource scriptSource,
Class<?> scriptClass)
Instantiate the given Groovy script class and run it if necessary.
|
Object |
GroovyScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Loads and parses the Groovy script via the GroovyClassLoader.
|
Class<?> |
GroovyScriptFactory.getScriptedObjectType(ScriptSource scriptSource) |
Class<?>[] |
GroovyScriptFactory.getScriptInterfaces()
Groovy scripts determine their interfaces themselves,
hence we don't need to explicitly expose interfaces here.
|
Modifier and Type | Method and Description |
---|---|
protected groovy.lang.GroovyClassLoader |
GroovyScriptFactory.buildGroovyClassLoader(ClassLoader classLoader)
Build a
GroovyClassLoader for the given ClassLoader . |
Object |
GroovyScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> arguments) |
Object |
GroovyScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Loads and parses the Groovy script via the GroovyClassLoader.
|
void |
GroovyScriptEvaluator.setCompilerConfiguration(org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration)
Set a custom compiler configuration for this evaluator.
|
Constructor and Description |
---|
GroovyScriptEvaluator(ClassLoader classLoader)
Construct a new GroovyScriptEvaluator.
|
GroovyScriptFactory(String scriptSourceLocator,
org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration)
Create a new GroovyScriptFactory for the given script source,
specifying a strategy interface that can create a custom MetaClass
to supply missing methods and otherwise change the behavior of the object.
|
GroovyScriptFactory(String scriptSourceLocator,
GroovyObjectCustomizer groovyObjectCustomizer)
Create a new GroovyScriptFactory for the given script source,
specifying a strategy interface that can create a custom MetaClass
to supply missing methods and otherwise change the behavior of the object.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
StandardScriptFactory.adaptToInterfaces(Object script,
ScriptSource scriptSource,
Class<?>... actualInterfaces) |
Object |
StandardScriptEvaluator.evaluate(ScriptSource script) |
Object |
StandardScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> argumentBindings) |
Object |
StandardScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Load and parse the script via JSR-223's ScriptEngine.
|
Class<?> |
StandardScriptFactory.getScriptedObjectType(ScriptSource scriptSource) |
Class<?>[] |
StandardScriptFactory.getScriptInterfaces() |
Class<?> |
ScriptFactoryPostProcessor.predictBeanType(Class<?> beanClass,
String beanName) |
protected ScriptEngine |
StandardScriptFactory.retrieveScriptEngine(ScriptSource scriptSource) |
String |
ResourceScriptSource.suggestedClassName() |
String |
StaticScriptSource.suggestedClassName() |
Modifier and Type | Method and Description |
---|---|
protected Object |
StandardScriptFactory.adaptToInterfaces(Object script,
ScriptSource scriptSource,
Class<?>... actualInterfaces) |
protected Class<?> |
ScriptFactoryPostProcessor.createConfigInterface(BeanDefinition bd,
Class<?>[] interfaces)
Create a config interface for the given bean definition, defining setter
methods for the defined property values as well as an init method and
a destroy method (if defined).
|
protected Object |
ScriptFactoryPostProcessor.createRefreshableProxy(TargetSource ts,
Class<?>[] interfaces,
boolean proxyTargetClass)
Create a refreshable proxy for the given AOP TargetSource.
|
protected BeanDefinition |
ScriptFactoryPostProcessor.createScriptedObjectBeanDefinition(BeanDefinition bd,
String scriptFactoryBeanName,
ScriptSource scriptSource,
Class<?>[] interfaces)
Create a bean definition for the scripted object, based on the given script
definition, extracting the definition data that is relevant for the scripted
object (that is, everything but bean class and constructor arguments).
|
Object |
StandardScriptEvaluator.evaluate(ScriptSource script,
Map<String,Object> argumentBindings) |
Object |
StandardScriptFactory.getScriptedObject(ScriptSource scriptSource,
Class<?>... actualInterfaces)
Load and parse the script via JSR-223's ScriptEngine.
|
void |
ResourceScriptSource.setEncoding(String encoding)
Set the encoding used for reading the script resource.
|
Constructor and Description |
---|
StandardScriptFactory(String scriptEngineName,
String scriptSourceLocator,
Class<?>... scriptInterfaces)
Create a new StandardScriptFactory for the given script source.
|
StandardScriptFactory(String scriptEngineName,
String scriptSourceLocator,
Class<?>... scriptInterfaces)
Create a new StandardScriptFactory for the given script source.
|
StaticScriptSource(String script,
String className)
Create a new StaticScriptSource for the given script.
|
Modifier and Type | Method and Description |
---|---|
String |
ProfileValueSource.get(String key)
Get the profile value indicated by the specified key.
|
Modifier and Type | Method and Description |
---|---|
ContextCustomizer |
ContextCustomizerFactory.createContextCustomizer(Class<?> testClass,
List<ContextConfigurationAttributes> configAttributes)
Create a
ContextCustomizer that should be used to customize a
ConfigurableApplicationContext
before it is refreshed. |
static <T extends Annotation> |
TestContextAnnotationUtils.findAnnotationDescriptor(Class<?> clazz,
Class<T> annotationType)
Find the
TestContextAnnotationUtils.AnnotationDescriptor for the supplied annotationType
on the supplied Class , traversing its annotations, interfaces,
superclasses, and enclosing classes if no annotation can be found on the
given class itself. |
static TestContextAnnotationUtils.UntypedAnnotationDescriptor |
TestContextAnnotationUtils.findAnnotationDescriptorForTypes(Class<?> clazz,
Class<? extends Annotation>... annotationTypes)
Find the
TestContextAnnotationUtils.UntypedAnnotationDescriptor for the first Class
in the inheritance hierarchy of the specified clazz (including
the specified clazz itself) which declares at least one of the
specified annotationTypes . |
static <T extends Annotation> |
TestContextAnnotationUtils.findMergedAnnotation(Class<?> clazz,
Class<T> annotationType)
Find the first annotation of the specified
annotationType within
the annotation hierarchy above the supplied class, merge that
annotation's attributes with matching attributes from annotations
in lower levels of the annotation hierarchy, and synthesize the result back
into an annotation of the specified annotationType . |
static NestedTestConfiguration.EnclosingConfiguration |
NestedTestConfiguration.EnclosingConfiguration.from(String name)
Get the
EnclosingConfiguration enum constant with the supplied
name, ignoring case. |
static TestConstructor.AutowireMode |
TestConstructor.AutowireMode.from(String name)
Get the
AutowireMode enum constant with the supplied name,
ignoring case. |
String |
ContextConfigurationAttributes.getName()
Get the name of the context hierarchy level that was declared via
@ContextConfiguration . |
MergedContextConfiguration |
MergedContextConfiguration.getParent()
Get the
MergedContextConfiguration for the parent application context
in a context hierarchy. |
ApplicationContext |
MergedContextConfiguration.getParentApplicationContext()
Get the parent
ApplicationContext for the context defined by this
MergedContextConfiguration from the context cache. |
Throwable |
TestContext.getTestException()
Get the exception that was thrown during execution
of the test method.
|
TestContextAnnotationUtils.AnnotationDescriptor<T> |
TestContextAnnotationUtils.AnnotationDescriptor.next()
Find the next
TestContextAnnotationUtils.AnnotationDescriptor for the specified annotation
type in the hierarchy above the root declaring class of this descriptor. |
TestContextAnnotationUtils.UntypedAnnotationDescriptor |
TestContextAnnotationUtils.UntypedAnnotationDescriptor.next()
Find the next
TestContextAnnotationUtils.UntypedAnnotationDescriptor for the specified
annotation types in the hierarchy above the
root declaring class of this
descriptor. |
Modifier and Type | Method and Description |
---|---|
void |
TestContextManager.afterTestExecution(Object testInstance,
Method testMethod,
Throwable exception)
Hook for post-processing a test immediately after execution of
the test method in the supplied
test context — for example, for timing
or logging purposes.
|
void |
TestContextManager.afterTestMethod(Object testInstance,
Method testMethod,
Throwable exception)
Hook for post-processing a test after execution of after
lifecycle callbacks of the underlying test framework — for example,
tearing down test fixtures, ending a transaction, etc.
|
void |
CacheAwareContextLoaderDelegate.closeContext(MergedContextConfiguration mergedContextConfiguration,
DirtiesContext.HierarchyMode hierarchyMode)
Remove the application context for the
supplied
MergedContextConfiguration from the ContextCache
and close it if it is
an instance of ConfigurableApplicationContext . |
boolean |
ContextConfigurationAttributes.equals(Object other)
Determine if the supplied object is equal to this
ContextConfigurationAttributes instance by comparing both object's
declaring class,
locations,
annotated classes,
inheritLocations flag,
context initializer classes,
inheritInitializers flag, and the
ContextLoader class . |
boolean |
MergedContextConfiguration.equals(Object other)
Determine if the supplied object is equal to this
MergedContextConfiguration
instance by comparing both object's locations,
annotated classes,
context initializer classes,
active profiles,
property source locations,
property source properties,
parents, and the fully qualified names of their
ContextLoaders . |
static NestedTestConfiguration.EnclosingConfiguration |
NestedTestConfiguration.EnclosingConfiguration.from(String name)
Get the
EnclosingConfiguration enum constant with the supplied
name, ignoring case. |
static TestConstructor.AutowireMode |
TestConstructor.AutowireMode.from(String name)
Get the
AutowireMode enum constant with the supplied name,
ignoring case. |
void |
TestContext.markApplicationContextDirty(DirtiesContext.HierarchyMode hierarchyMode)
Call this method to signal that the application
context associated with this test context is dirty and should be
removed from the context cache.
|
protected static String |
MergedContextConfiguration.nullSafeClassName(ContextLoader contextLoader)
Generate a null-safe
String representation of the supplied
ContextLoader based solely on the fully qualified name of the
loader or "null" if the supplied loader is null . |
void |
TestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException)
Update this test context to reflect the state of the currently executing test.
|
void |
TestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException)
Update this test context to reflect the state of the currently executing test.
|
void |
TestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException)
Update this test context to reflect the state of the currently executing test.
|
Constructor and Description |
---|
ContextConfigurationAttributes(Class<?> declaringClass,
String[] locations,
Class<?>[] classes,
boolean inheritLocations,
Class<? extends ApplicationContextInitializer<?>>[] initializers,
boolean inheritInitializers,
String name,
Class<? extends ContextLoader> contextLoaderClass)
Construct a new
ContextConfigurationAttributes instance for the
test class that declared the
@ContextConfiguration annotation and its
corresponding attributes. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
MergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
String[] activeProfiles,
ContextLoader contextLoader)
Create a new
MergedContextConfiguration instance for the
supplied parameters. |
Modifier and Type | Method and Description |
---|---|
ApplicationContext |
DefaultContextCache.get(MergedContextConfiguration key)
Obtain a cached
ApplicationContext for the given key. |
ApplicationContext |
ContextCache.get(MergedContextConfiguration key)
Obtain a cached
ApplicationContext for the given key. |
Modifier and Type | Method and Description |
---|---|
void |
DefaultCacheAwareContextLoaderDelegate.closeContext(MergedContextConfiguration mergedContextConfiguration,
DirtiesContext.HierarchyMode hierarchyMode) |
void |
DefaultContextCache.remove(MergedContextConfiguration key,
DirtiesContext.HierarchyMode hierarchyMode)
Remove the context with the given key from the cache and explicitly
close
it if it is an instance of
ConfigurableApplicationContext . |
void |
ContextCache.remove(MergedContextConfiguration key,
DirtiesContext.HierarchyMode hierarchyMode)
Remove the context with the given key from the cache and explicitly
close
it if it is an instance of
ConfigurableApplicationContext . |
Modifier and Type | Method and Description |
---|---|
static ApplicationEvents |
ApplicationEventsHolder.getApplicationEvents()
Get the
ApplicationEvents for the current thread. |
Modifier and Type | Method and Description |
---|---|
Object |
SpringExtension.resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
org.junit.jupiter.api.extension.ExtensionContext extensionContext)
Resolve a value for the
Parameter in the supplied ParameterContext by
retrieving the corresponding dependency from the test's ApplicationContext . |
Modifier and Type | Field and Description |
---|---|
protected ApplicationContext |
AbstractJUnit4SpringContextTests.applicationContext
The
ApplicationContext that was injected into this test instance
via AbstractJUnit4SpringContextTests.setApplicationContext(ApplicationContext) . |
Modifier and Type | Method and Description |
---|---|
protected Class<? extends Throwable> |
SpringJUnit4ClassRunner.getExpectedException(FrameworkMethod frameworkMethod)
Get the
exception that the supplied test method is expected to throw. |
Constructor and Description |
---|
ProfileValueChecker(Statement next,
Class<?> testClass,
Method testMethod)
Construct a new
ProfileValueChecker statement. |
Modifier and Type | Method and Description |
---|---|
String |
PropertyProvider.get(String name)
Get the value of the named property.
|
Object |
DefaultTestContext.getAttribute(String name) |
Throwable |
DefaultTestContext.getTestException() |
Object |
DefaultTestContext.removeAttribute(String name) |
protected Class<? extends ContextLoader> |
AbstractTestContextBootstrapper.resolveExplicitContextLoaderClass(List<ContextConfigurationAttributes> configAttributesList)
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractDirtiesContextTestExecutionListener.dirtyContext(TestContext testContext,
DirtiesContext.HierarchyMode hierarchyMode)
Mark the application context of the supplied
test context as
dirty
and set
REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true . |
static boolean |
TestConstructorUtils.isAutowirableConstructor(Constructor<?> constructor,
Class<?> testClass,
PropertyProvider fallbackPropertyProvider)
Determine if the supplied constructor for the given test class is
autowirable.
|
static boolean |
TestConstructorUtils.isAutowirableConstructor(Executable executable,
Class<?> testClass,
PropertyProvider fallbackPropertyProvider)
Determine if the supplied executable for the given test class is an
autowirable constructor.
|
void |
DefaultTestContext.markApplicationContextDirty(DirtiesContext.HierarchyMode hierarchyMode)
Mark the application context associated
with this test context as dirty (i.e., by removing it from the
context cache and closing it).
|
String[] |
AbstractDelegatingSmartContextLoader.processLocations(Class<?> clazz,
String... locations)
AbstractDelegatingSmartContextLoader does not support the
ContextLoader.processLocations(Class, String...) method. |
void |
DefaultTestContext.setAttribute(String name,
Object value) |
void |
DefaultTestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException) |
void |
DefaultTestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException) |
void |
DefaultTestContext.updateState(Object testInstance,
Method testMethod,
Throwable testException) |
Modifier and Type | Field and Description |
---|---|
protected ApplicationContext |
AbstractTestNGSpringContextTests.applicationContext
The
ApplicationContext that was injected into this test instance
via AbstractTestNGSpringContextTests.setApplicationContext(ApplicationContext) . |
Modifier and Type | Method and Description |
---|---|
protected PlatformTransactionManager |
TransactionalTestExecutionListener.getTransactionManager(TestContext testContext)
Get the transaction manager
to use for the supplied test context.
|
protected PlatformTransactionManager |
TransactionalTestExecutionListener.getTransactionManager(TestContext testContext,
String qualifier)
|
static DataSource |
TestContextTransactionUtils.retrieveDataSource(TestContext testContext,
String name)
Retrieve the
DataSource to use for the supplied test context. |
static PlatformTransactionManager |
TestContextTransactionUtils.retrieveTransactionManager(TestContext testContext,
String name)
Retrieve the transaction manager
to use for the supplied test context.
|
Modifier and Type | Method and Description |
---|---|
protected PlatformTransactionManager |
TransactionalTestExecutionListener.getTransactionManager(TestContext testContext,
String qualifier)
|
static DataSource |
TestContextTransactionUtils.retrieveDataSource(TestContext testContext,
String name)
Retrieve the
DataSource to use for the supplied test context. |
static PlatformTransactionManager |
TestContextTransactionUtils.retrieveTransactionManager(TestContext testContext,
String name)
Retrieve the transaction manager
to use for the supplied test context.
|
Modifier and Type | Method and Description |
---|---|
boolean |
WebMergedContextConfiguration.equals(Object other)
Determine if the supplied object is equal to this
WebMergedContextConfiguration
instance by comparing both object's locations,
annotated classes,
context initializer classes,
active profiles,
resource base path,
parents, and the fully qualified names of their
ContextLoaders . |
Constructor and Description |
---|
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
Set<ContextCustomizer> contextCustomizers,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
WebMergedContextConfiguration(Class<?> testClass,
String[] locations,
Class<?>[] classes,
Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
String[] activeProfiles,
String[] propertySourceLocations,
String[] propertySourceProperties,
String resourceBasePath,
ContextLoader contextLoader,
CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
MergedContextConfiguration parent)
Create a new
WebMergedContextConfiguration instance for the
supplied parameters. |
Modifier and Type | Method and Description |
---|---|
Object |
JsonPathExpectationsHelper.evaluateJsonPath(String content)
Evaluate the JSON path and return the resulting value.
|
<T> T |
XpathExpectationsHelper.evaluateXpath(byte[] content,
String encoding,
Class<T> targetClass)
Evaluate the XPath and return the resulting value.
|
protected <T> T |
XpathExpectationsHelper.evaluateXpath(Document document,
QName evaluationType,
Class<T> expectedClass)
Apply the XPath expression to given document.
|
static <T extends Annotation> |
MetaAnnotationUtils.findAnnotationDescriptor(Class<?> clazz,
Class<T> annotationType)
Deprecated.
Find the
MetaAnnotationUtils.AnnotationDescriptor for the supplied annotationType
on the supplied Class , traversing its annotations, interfaces, and
superclasses if no annotation can be found on the given class itself. |
static MetaAnnotationUtils.UntypedAnnotationDescriptor |
MetaAnnotationUtils.findAnnotationDescriptorForTypes(Class<?> clazz,
Class<? extends Annotation>... annotationTypes)
Deprecated.
Find the
MetaAnnotationUtils.UntypedAnnotationDescriptor for the first Class
in the inheritance hierarchy of the specified clazz (including
the specified clazz itself) which declares at least one of the
specified annotationTypes . |
Annotation |
MetaAnnotationUtils.AnnotationDescriptor.getComposedAnnotation() |
Class<? extends Annotation> |
MetaAnnotationUtils.AnnotationDescriptor.getComposedAnnotationType() |
static Object |
ReflectionTestUtils.getField(Class<?> targetClass,
String name)
|
static Object |
ReflectionTestUtils.getField(Object targetObject,
Class<?> targetClass,
String name)
|
static Object |
ReflectionTestUtils.getField(Object targetObject,
String name)
|
static Object |
ReflectionTestUtils.invokeGetterMethod(Object target,
String name)
Invoke the getter method with the given
name on the supplied
target object with the supplied value . |
static <T> T |
ReflectionTestUtils.invokeMethod(Class<?> targetClass,
String name,
Object... args)
Invoke the static method with the given
name on the supplied target
class with the supplied arguments. |
static <T> T |
ReflectionTestUtils.invokeMethod(Object targetObject,
Class<?> targetClass,
String name,
Object... args)
Invoke the method with the given
name on the provided
targetObject /targetClass with the supplied arguments. |
static <T> T |
ReflectionTestUtils.invokeMethod(Object target,
String name,
Object... args)
Invoke the method with the given
name on the supplied target
object with the supplied arguments. |
Modifier and Type | Method and Description |
---|---|
void |
XpathExpectationsHelper.assertBoolean(byte[] content,
String encoding,
boolean expectedValue)
Apply the XPath expression and assert the resulting content as a Boolean.
|
static void |
AssertionErrors.assertEquals(String message,
Object expected,
Object actual)
Assert two objects are equal and raise an
AssertionError otherwise. |
static void |
AssertionErrors.assertEquals(String message,
Object expected,
Object actual)
Assert two objects are equal and raise an
AssertionError otherwise. |
void |
XpathExpectationsHelper.assertNode(byte[] content,
String encoding,
Matcher<? super Node> matcher)
Parse the content, evaluate the XPath expression as a
Node ,
and assert it with the given Matcher<Node> . |
void |
XpathExpectationsHelper.assertNodeCount(byte[] content,
String encoding,
int expectedCount)
Apply the XPath expression and assert the resulting content as an integer.
|
void |
XpathExpectationsHelper.assertNodeCount(byte[] content,
String encoding,
Matcher<? super Integer> matcher)
Apply the XPath expression and assert the resulting content with the
given Hamcrest matcher.
|
void |
XpathExpectationsHelper.assertNodeList(byte[] content,
String encoding,
Matcher<? super NodeList> matcher)
Parse the content, evaluate the XPath expression as a
NodeList ,
and assert it with the given Matcher<NodeList> . |
static void |
AssertionErrors.assertNotEquals(String message,
Object expected,
Object actual)
Assert two objects are not equal and raise an
AssertionError otherwise. |
static void |
AssertionErrors.assertNotEquals(String message,
Object expected,
Object actual)
Assert two objects are not equal and raise an
AssertionError otherwise. |
static void |
AssertionErrors.assertNotNull(String message,
Object object)
Assert that the given object is not
null and raise an
AssertionError otherwise. |
static void |
AssertionErrors.assertNull(String message,
Object object)
Assert that the given object is
null and raise an
AssertionError otherwise. |
void |
XpathExpectationsHelper.assertNumber(byte[] content,
String encoding,
Double expectedValue)
Apply the XPath expression and assert the resulting content as a Double.
|
void |
XpathExpectationsHelper.assertNumber(byte[] content,
String encoding,
Matcher<? super Double> matcher)
Apply the XPath expression and assert the resulting content with the
given Hamcrest matcher.
|
void |
XpathExpectationsHelper.assertString(byte[] content,
String encoding,
Matcher<? super String> matcher)
Apply the XPath expression and assert the resulting content with the
given Hamcrest matcher.
|
void |
XpathExpectationsHelper.assertString(byte[] content,
String encoding,
String expectedValue)
Apply the XPath expression and assert the resulting content as a String.
|
void |
JsonPathExpectationsHelper.assertValue(String content,
Object expectedValue)
Evaluate the JSON path expression against the supplied
content
and assert that the result is equal to the expected value. |
void |
XpathExpectationsHelper.doesNotExist(byte[] content,
String encoding)
Apply the XPath expression and assert the resulting content does not exist.
|
<T> T |
XpathExpectationsHelper.evaluateXpath(byte[] content,
String encoding,
Class<T> targetClass)
Evaluate the XPath and return the resulting value.
|
void |
XpathExpectationsHelper.exists(byte[] content,
String encoding)
Apply the XPath expression and assert the resulting content exists.
|
static void |
AssertionErrors.fail(String message,
Object expected,
Object actual)
Fail a test with the given message passing along expected and actual
values to be appended to the message.
|
static void |
AssertionErrors.fail(String message,
Object expected,
Object actual)
Fail a test with the given message passing along expected and actual
values to be appended to the message.
|
static Object |
ReflectionTestUtils.getField(Object targetObject,
Class<?> targetClass,
String name)
|
static Object |
ReflectionTestUtils.getField(Object targetObject,
Class<?> targetClass,
String name)
|
static <T> T |
ReflectionTestUtils.invokeMethod(Object targetObject,
Class<?> targetClass,
String name,
Object... args)
Invoke the method with the given
name on the provided
targetObject /targetClass with the supplied arguments. |
static <T> T |
ReflectionTestUtils.invokeMethod(Object targetObject,
Class<?> targetClass,
String name,
Object... args)
Invoke the method with the given
name on the provided
targetObject /targetClass with the supplied arguments. |
static void |
ReflectionTestUtils.invokeSetterMethod(Object target,
String name,
Object value,
Class<?> type)
Invoke the setter method with the given
name on the supplied
target object with the supplied value . |
static void |
ReflectionTestUtils.invokeSetterMethod(Object target,
String name,
Object value,
Class<?> type)
Invoke the setter method with the given
name on the supplied
target object with the supplied value . |
protected Document |
XpathExpectationsHelper.parseXmlByteArray(byte[] xml,
String encoding)
Parse the given XML content to a
Document . |
static void |
ReflectionTestUtils.setField(Class<?> targetClass,
String name,
Object value)
|
static void |
ReflectionTestUtils.setField(Class<?> targetClass,
String name,
Object value,
Class<?> type)
|
static void |
ReflectionTestUtils.setField(Class<?> targetClass,
String name,
Object value,
Class<?> type)
|
static void |
ReflectionTestUtils.setField(Class<?> targetClass,
String name,
Object value,
Class<?> type)
|
static void |
ReflectionTestUtils.setField(Object targetObject,
Class<?> targetClass,
String name,
Object value,
Class<?> type)
Set the field with the given
name /type
on the provided targetObject /targetClass to the supplied
value . |
static void |
ReflectionTestUtils.setField(Object targetObject,
Class<?> targetClass,
String name,
Object value,
Class<?> type)
Set the field with the given
name /type
on the provided targetObject /targetClass to the supplied
value . |
static void |
ReflectionTestUtils.setField(Object targetObject,
Class<?> targetClass,
String name,
Object value,
Class<?> type)
Set the field with the given
name /type
on the provided targetObject /targetClass to the supplied
value . |
static void |
ReflectionTestUtils.setField(Object targetObject,
Class<?> targetClass,
String name,
Object value,
Class<?> type)
Set the field with the given
name /type
on the provided targetObject /targetClass to the supplied
value . |
static void |
ReflectionTestUtils.setField(Object targetObject,
Class<?> targetClass,
String name,
Object value,
Class<?> type)
Set the field with the given
name /type
on the provided targetObject /targetClass to the supplied
value . |
static void |
ReflectionTestUtils.setField(Object targetObject,
String name,
Object value)
|
static void |
ReflectionTestUtils.setField(Object targetObject,
String name,
Object value,
Class<?> type)
|
static void |
ReflectionTestUtils.setField(Object targetObject,
String name,
Object value,
Class<?> type)
|
static void |
ReflectionTestUtils.setField(Object targetObject,
String name,
Object value,
Class<?> type)
|
Constructor and Description |
---|
AnnotationDescriptor(Class<?> rootDeclaringClass,
Class<?> declaringClass,
Annotation composedAnnotation,
T annotation) |
UntypedAnnotationDescriptor(Class<?> rootDeclaringClass,
Class<?> declaringClass,
Annotation composedAnnotation,
Annotation annotation) |
XpathExpectationsHelper(String expression,
Map<String,String> namespaces,
Object... args)
XpathExpectationsHelper constructor.
|
Modifier and Type | Method and Description |
---|---|
RequestExpectation |
AbstractRequestExpectationManager.RequestExpectationGroup.findExpectation(ClientHttpRequest request)
Return a matching expectation, or
null if none match. |
protected ResponseCreator |
DefaultRequestExpectation.getResponseCreator() |
protected ClientHttpResponse |
AbstractRequestExpectationManager.validateRequestInternal(ClientHttpRequest request)
Deprecated.
as of 5.0.3, subclasses should implement
AbstractRequestExpectationManager.matchRequest(ClientHttpRequest)
instead and return only the matched expectation, leaving the call to create the response
as a separate step (to be invoked by this class). |
Modifier and Type | Method and Description |
---|---|
ClientHttpResponse |
DefaultRequestExpectation.createResponse(ClientHttpRequest request)
Note that as of 5.0.3, the creation of the response, which may block
intentionally, is separated from request count tracking, and this
method no longer increments the count transparently.
|
ClientHttpResponse |
ResponseCreator.createResponse(ClientHttpRequest request)
Create a response for the given request.
|
Constructor and Description |
---|
XpathRequestMatchers(String expression,
Map<String,String> namespaces,
Object... args)
Class constructor, not for direct instantiation.
|
Modifier and Type | Method and Description |
---|---|
ClientHttpResponse |
DefaultResponseCreator.createResponse(ClientHttpRequest request) |
static DefaultResponseCreator |
MockRestResponseCreators.withSuccess(byte[] body,
MediaType contentType)
ResponseCreator for a 200 response (OK) with byte[] body. |
static DefaultResponseCreator |
MockRestResponseCreators.withSuccess(Resource body,
MediaType contentType)
ResponseCreator for a 200 response (OK) content with Resource -based body. |
static DefaultResponseCreator |
MockRestResponseCreators.withSuccess(String body,
MediaType contentType)
ResponseCreator for a 200 response (OK) with String body. |
Modifier and Type | Method and Description |
---|---|
Object |
ExchangeResult.getMockServerResult()
Return the result from the mock server exchange, if applicable, for
further assertions on the state of the server response.
|
byte[] |
ExchangeResult.getRequestBodyContent()
Return the raw request body content written through the request.
|
T |
EntityExchangeResult.getResponseBody()
Return the entity extracted from the response body.
|
byte[] |
ExchangeResult.getResponseBodyContent()
Return the raw request body content written to the response.
|
String |
ExchangeResult.getUriTemplate()
Return the original URI template used to prepare the request, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
WebTestClientConfigurer.afterConfigurerAdded(WebTestClient.Builder builder,
WebHttpHandlerBuilder httpHandlerBuilder,
ClientHttpConnector connector)
Invoked once only, immediately (i.e.
|
void |
WebTestClientConfigurer.afterConfigurerAdded(WebTestClient.Builder builder,
WebHttpHandlerBuilder httpHandlerBuilder,
ClientHttpConnector connector)
Invoked once only, immediately (i.e.
|
boolean |
JsonPathAssertions.equals(Object obj) |
XpathAssertions |
WebTestClient.BodyContentSpec.xpath(String expression,
Map<String,String> namespaces,
Object... args)
Access to response body assertions with specific namespaces using an
XPath expression to inspect a specific subset of the body.
|
Modifier and Type | Method and Description |
---|---|
Object |
MvcResult.getHandler()
Return the executed handler.
|
HandlerInterceptor[] |
MvcResult.getInterceptors()
Return interceptors around the handler.
|
ModelAndView |
MvcResult.getModelAndView()
Return the
ModelAndView prepared by the handler. |
Exception |
MvcResult.getResolvedException()
Return any exception raised by a handler and successfully resolved
through a
HandlerExceptionResolver . |
Modifier and Type | Method and Description |
---|---|
protected MockMvc |
MockMvcBuilderSupport.createMockMvc(Filter[] filters,
MockServletConfig servletConfig,
WebApplicationContext webAppContext,
RequestBuilder defaultRequestBuilder,
Charset defaultResponseCharacterEncoding,
List<ResultMatcher> globalResultMatchers,
List<ResultHandler> globalResultHandlers,
List<DispatcherServletCustomizer> dispatcherServletCustomizers)
Delegates to
MockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of the MockMvc instance and configures that instance
with the supplied defaultResponseCharacterEncoding . |
protected MockMvc |
MockMvcBuilderSupport.createMockMvc(Filter[] filters,
MockServletConfig servletConfig,
WebApplicationContext webAppContext,
RequestBuilder defaultRequestBuilder,
Charset defaultResponseCharacterEncoding,
List<ResultMatcher> globalResultMatchers,
List<ResultHandler> globalResultHandlers,
List<DispatcherServletCustomizer> dispatcherServletCustomizers)
Delegates to
MockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of the MockMvc instance and configures that instance
with the supplied defaultResponseCharacterEncoding . |
protected MockMvc |
MockMvcBuilderSupport.createMockMvc(Filter[] filters,
MockServletConfig servletConfig,
WebApplicationContext webAppContext,
RequestBuilder defaultRequestBuilder,
Charset defaultResponseCharacterEncoding,
List<ResultMatcher> globalResultMatchers,
List<ResultHandler> globalResultHandlers,
List<DispatcherServletCustomizer> dispatcherServletCustomizers)
Delegates to
MockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of the MockMvc instance and configures that instance
with the supplied defaultResponseCharacterEncoding . |
protected MockMvc |
MockMvcBuilderSupport.createMockMvc(Filter[] filters,
MockServletConfig servletConfig,
WebApplicationContext webAppContext,
RequestBuilder defaultRequestBuilder,
List<ResultMatcher> globalResultMatchers,
List<ResultHandler> globalResultHandlers,
List<DispatcherServletCustomizer> dispatcherServletCustomizers) |
protected MockMvc |
MockMvcBuilderSupport.createMockMvc(Filter[] filters,
MockServletConfig servletConfig,
WebApplicationContext webAppContext,
RequestBuilder defaultRequestBuilder,
List<ResultMatcher> globalResultMatchers,
List<ResultHandler> globalResultHandlers,
List<DispatcherServletCustomizer> dispatcherServletCustomizers) |
Modifier and Type | Method and Description |
---|---|
MockMvcWebTestClient.ControllerSpec |
MockMvcWebTestClient.ControllerSpec.mappedInterceptors(String[] pathPatterns,
HandlerInterceptor... interceptors)
Add interceptors for specific patterns.
|
Constructor and Description |
---|
MockMvcWebConnection(MockMvc mockMvc,
com.gargoylesoftware.htmlunit.WebClient webClient,
String contextPath)
Create a new instance with the specified context path.
|
Modifier and Type | Method and Description |
---|---|
MockHttpServletRequestBuilder |
MockHttpServletRequestBuilder.locale(Locale locale)
Set the locale of the request, overriding any previous locales.
|
Object |
MockHttpServletRequestBuilder.merge(Object parent)
Merges the properties of the "parent" RequestBuilder accepting values
only if not already set in "this" instance.
|
Object |
MockMultipartHttpServletRequestBuilder.merge(Object parent) |
MockHttpServletRequestBuilder |
MockHttpServletRequestBuilder.pathInfo(String pathInfo)
Specify the portion of the requestURI that represents the pathInfo.
|
Modifier and Type | Method and Description |
---|---|
ResultMatcher |
RequestResultMatchers.asyncResult(Object expectedResult)
Assert the result from asynchronous processing.
|
ResultMatcher |
FlashAttributeResultMatchers.attribute(String name,
Object value)
Assert a flash attribute's value.
|
ResultMatcher |
ModelResultMatchers.attribute(String name,
Object value)
Assert a model attribute value.
|
ResultMatcher |
RequestResultMatchers.attribute(String name,
Object expectedValue)
Assert a request attribute value.
|
static ResultMatcher |
MockMvcResultMatchers.forwardedUrl(String expectedUrl)
Asserts the request was forwarded to the given URL.
|
protected void |
PrintingResultHandler.printHandler(Object handler,
HandlerInterceptor[] interceptors)
Print the handler.
|
protected void |
PrintingResultHandler.printHandler(Object handler,
HandlerInterceptor[] interceptors)
Print the handler.
|
protected void |
PrintingResultHandler.printModelAndView(ModelAndView mav)
Print the ModelAndView.
|
protected void |
PrintingResultHandler.printResolvedException(Exception resolvedException)
Print exceptions resolved through a HandlerExceptionResolver.
|
void |
PrintingResultHandler.ResultValuePrinter.printValue(String label,
Object value) |
ResultMatcher |
RequestResultMatchers.sessionAttribute(String name,
Object value)
Assert a session attribute value.
|
ResultMatcher |
JsonPathResultMatchers.value(Object expectedValue)
Evaluate the JSON path expression against the response content and
assert that the result is equal to the supplied value.
|
Constructor and Description |
---|
XpathResultMatchers(String expression,
Map<String,String> namespaces,
Object... args)
Protected constructor, not for direct instantiation.
|
Modifier and Type | Method and Description |
---|---|
RequestPostProcessor |
MockMvcConfigurerAdapter.beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
WebApplicationContext cxt) |
default RequestPostProcessor |
MockMvcConfigurer.beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
WebApplicationContext context)
Invoked when the MockMvc instance is about to be created with the MockMvc
builder and the Spring WebApplicationContext that will be passed to the
DispatcherServlet . |
Modifier and Type | Method and Description |
---|---|
StandaloneMockMvcBuilder |
StandaloneMockMvcBuilder.addMappedInterceptors(String[] pathPatterns,
HandlerInterceptor... interceptors)
Add interceptors mapped to a set of path patterns.
|
protected Map<String,Object> |
StandaloneMockMvcBuilder.extendMvcSingletons(ServletContext servletContext)
This method could be used from a subclass to register additional Spring
MVC infrastructure such as additional
HandlerMapping ,
HandlerAdapter , and others. |
Modifier and Type | Method and Description |
---|---|
Throwable |
TransactionSystemException.getApplicationException()
Return the application exception that was thrown before this transaction exception,
if any.
|
default String |
TransactionDefinition.getName()
Return the name of this transaction.
|
Throwable |
TransactionSystemException.getOriginalException()
Return the exception that was the first to be thrown within the failed transaction:
i.e.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TransactionSystemException.contains(Class<?> exType) |
reactor.core.publisher.Mono<ReactiveTransaction> |
ReactiveTransactionManager.getReactiveTransaction(TransactionDefinition definition)
Emit a currently active reactive transaction or create a new one, according to
the specified propagation behavior.
|
TransactionStatus |
PlatformTransactionManager.getTransaction(TransactionDefinition definition)
Return a currently active transaction or create a new one, according to
the specified propagation behavior.
|
Modifier and Type | Field and Description |
---|---|
protected AnnotationAttributes |
AbstractTransactionManagementConfiguration.enableTx |
protected TransactionManager |
AbstractTransactionManagementConfiguration.txManager
Default transaction manager, as configured through a
TransactionManagementConfigurer . |
Modifier and Type | Method and Description |
---|---|
protected TransactionAttribute |
AnnotationTransactionAttributeSource.determineTransactionAttribute(AnnotatedElement element)
Determine the transaction attribute for the given method or class.
|
protected TransactionAttribute |
AnnotationTransactionAttributeSource.findTransactionAttribute(Class<?> clazz) |
protected TransactionAttribute |
AnnotationTransactionAttributeSource.findTransactionAttribute(Method method) |
TransactionAttribute |
SpringTransactionAnnotationParser.parseTransactionAnnotation(AnnotatedElement element) |
TransactionAttribute |
Ejb3TransactionAnnotationParser.parseTransactionAnnotation(AnnotatedElement element) |
TransactionAttribute |
JtaTransactionAnnotationParser.parseTransactionAnnotation(AnnotatedElement element) |
TransactionAttribute |
TransactionAnnotationParser.parseTransactionAnnotation(AnnotatedElement element)
Parse the transaction attribute for the given method or class,
based on an annotation type understood by this parser.
|
Modifier and Type | Method and Description |
---|---|
boolean |
SpringTransactionAnnotationParser.equals(Object other) |
boolean |
AnnotationTransactionAttributeSource.equals(Object other) |
boolean |
Ejb3TransactionAnnotationParser.equals(Object other) |
boolean |
JtaTransactionAnnotationParser.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
JtaTransactionManager |
JtaTransactionManagerFactoryBean.getObject() |
Modifier and Type | Method and Description |
---|---|
default void |
TransactionalApplicationListener.SynchronizationCallback.postProcessEvent(ApplicationEvent event,
Throwable ex)
Called after a transactional event listener invocation.
|
Modifier and Type | Method and Description |
---|---|
protected TransactionAttribute |
AbstractFallbackTransactionAttributeSource.computeTransactionAttribute(Method method,
Class<?> targetClass)
Same signature as
AbstractFallbackTransactionAttributeSource.getTransactionAttribute(java.lang.reflect.Method, java.lang.Class<?>) , but doesn't cache the result. |
protected static TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.currentTransactionInfo()
Subclasses can use this to return the current TransactionInfo.
|
protected TransactionManager |
TransactionAspectSupport.determineTransactionManager(TransactionAttribute txAttr)
Determine the specific transaction manager to use for the given transaction.
|
protected abstract TransactionAttribute |
AbstractFallbackTransactionAttributeSource.findTransactionAttribute(Class<?> clazz)
Subclasses need to implement this to return the transaction attribute for the
given class, if any.
|
protected abstract TransactionAttribute |
AbstractFallbackTransactionAttributeSource.findTransactionAttribute(Method method)
Subclasses need to implement this to return the transaction attribute for the
given method, if any.
|
protected BeanFactory |
TransactionAspectSupport.getBeanFactory()
Return the BeanFactory to use for retrieving
TransactionManager beans. |
String |
DefaultTransactionAttribute.getDescriptor()
Return a descriptor for this transaction attribute,
or
null if none. |
String |
DelegatingTransactionAttribute.getQualifier() |
String |
TransactionAttribute.getQualifier()
Return a qualifier value associated with this transaction attribute.
|
String |
DefaultTransactionAttribute.getQualifier()
Return a qualifier value associated with this transaction attribute.
|
String |
DefaultTransactionAttribute.getTimeoutString()
Return the timeout to apply, if any,
as a String value that resolves to a number of seconds.
|
TransactionAttribute |
TransactionAspectSupport.TransactionInfo.getTransactionAttribute() |
TransactionAttribute |
MethodMapTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
NameMatchTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
TransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass)
Return the transaction attribute for the given method,
or
null if the method is non-transactional. |
TransactionAttribute |
MatchAlwaysTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
AbstractFallbackTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass)
Determine the transaction attribute for this method invocation.
|
TransactionAttribute |
CompositeTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttributeSource |
TransactionAspectSupport.getTransactionAttributeSource()
Return the transaction attribute source.
|
TransactionManager |
TransactionAspectSupport.getTransactionManager()
Return the default transaction manager, or
null if unknown. |
protected String |
TransactionAspectSupport.getTransactionManagerBeanName()
Return the name of the default transaction manager bean.
|
TransactionStatus |
TransactionAspectSupport.TransactionInfo.getTransactionStatus() |
Object |
TransactionInterceptor.invoke(MethodInvocation invocation) |
protected Object |
TransactionAspectSupport.invokeWithinTransaction(Method method,
Class<?> targetClass,
TransactionAspectSupport.InvocationCallback invocation)
General delegate for around-advice-based subclasses, delegating to several other template
methods on this class.
|
protected String |
TransactionAspectSupport.methodIdentification(Method method,
Class<?> targetClass)
Convenience method to return a String representation of this Method
for use in logging.
|
Object |
TransactionAspectSupport.InvocationCallback.proceedWithInvocation() |
Modifier and Type | Method and Description |
---|---|
protected void |
TransactionAspectSupport.cleanupTransactionInfo(TransactionAspectSupport.TransactionInfo txInfo)
Reset the TransactionInfo ThreadLocal.
|
protected void |
TransactionAspectSupport.commitTransactionAfterReturning(TransactionAspectSupport.TransactionInfo txInfo)
Execute after successful completion of call, but not after an exception was handled.
|
protected void |
TransactionAspectSupport.completeTransactionAfterThrowing(TransactionAspectSupport.TransactionInfo txInfo,
Throwable ex)
Handle a throwable, completing the transaction.
|
protected TransactionAttribute |
AbstractFallbackTransactionAttributeSource.computeTransactionAttribute(Method method,
Class<?> targetClass)
Same signature as
AbstractFallbackTransactionAttributeSource.getTransactionAttribute(java.lang.reflect.Method, java.lang.Class<?>) , but doesn't cache the result. |
protected TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.createTransactionIfNecessary(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification)
Create a transaction if necessary based on the given TransactionAttribute.
|
protected TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.createTransactionIfNecessary(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification)
Create a transaction if necessary based on the given TransactionAttribute.
|
protected TransactionManager |
TransactionAspectSupport.determineTransactionManager(TransactionAttribute txAttr)
Determine the specific transaction manager to use for the given transaction.
|
boolean |
MethodMapTransactionAttributeSource.equals(Object other) |
boolean |
NameMatchTransactionAttributeSource.equals(Object other) |
boolean |
RollbackRuleAttribute.equals(Object other) |
boolean |
MatchAlwaysTransactionAttributeSource.equals(Object other) |
protected Object |
AbstractFallbackTransactionAttributeSource.getCacheKey(Method method,
Class<?> targetClass)
Determine a cache key for the given method and target class.
|
TransactionAttribute |
MethodMapTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
NameMatchTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
TransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass)
Return the transaction attribute for the given method,
or
null if the method is non-transactional. |
TransactionAttribute |
MatchAlwaysTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
TransactionAttribute |
AbstractFallbackTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass)
Determine the transaction attribute for this method invocation.
|
TransactionAttribute |
CompositeTransactionAttributeSource.getTransactionAttribute(Method method,
Class<?> targetClass) |
protected void |
MethodMapTransactionAttributeSource.initMethodMap(Map<String,TransactionAttribute> methodMap)
Initialize the specified
"methodMap" , if any. |
protected Object |
TransactionAspectSupport.invokeWithinTransaction(Method method,
Class<?> targetClass,
TransactionAspectSupport.InvocationCallback invocation)
General delegate for around-advice-based subclasses, delegating to several other template
methods on this class.
|
protected String |
TransactionAspectSupport.methodIdentification(Method method,
Class<?> targetClass)
Convenience method to return a String representation of this Method
for use in logging.
|
void |
TransactionAspectSupport.TransactionInfo.newTransactionStatus(TransactionStatus status) |
protected TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.prepareTransactionInfo(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification,
TransactionStatus status)
Prepare a TransactionInfo for the given attribute and status object.
|
protected TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.prepareTransactionInfo(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification,
TransactionStatus status)
Prepare a TransactionInfo for the given attribute and status object.
|
protected TransactionAspectSupport.TransactionInfo |
TransactionAspectSupport.prepareTransactionInfo(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification,
TransactionStatus status)
Prepare a TransactionInfo for the given attribute and status object.
|
void |
DefaultTransactionAttribute.resolveAttributeStrings(StringValueResolver resolver)
Resolve attribute values that are defined as resolvable Strings:
DefaultTransactionAttribute.setTimeoutString(java.lang.String) , DefaultTransactionAttribute.setQualifier(java.lang.String) , DefaultTransactionAttribute.setLabels(java.util.Collection<java.lang.String>) . |
void |
TransactionAspectSupport.setBeanFactory(BeanFactory beanFactory)
Set the BeanFactory to use for retrieving
TransactionManager beans. |
void |
DefaultTransactionAttribute.setDescriptor(String descriptor)
Set a descriptor for this transaction attribute,
e.g.
|
void |
DefaultTransactionAttribute.setQualifier(String qualifier)
Associate a qualifier value with this transaction attribute.
|
void |
DefaultTransactionAttribute.setTimeoutString(String timeoutString)
Set the timeout to apply, if any,
as a String value that resolves to a number of seconds.
|
void |
TransactionAspectSupport.setTransactionAttributeSource(TransactionAttributeSource transactionAttributeSource)
Set the transaction attribute source which is used to find transaction
attributes.
|
void |
TransactionAspectSupport.setTransactionManager(TransactionManager transactionManager)
Specify the default transaction manager to use to drive transactions.
|
void |
TransactionAspectSupport.setTransactionManagerBeanName(String transactionManagerBeanName)
Specify the name of the default transaction manager bean.
|
Constructor and Description |
---|
TransactionInfo(PlatformTransactionManager transactionManager,
TransactionAttribute transactionAttribute,
String joinpointIdentification) |
TransactionInfo(PlatformTransactionManager transactionManager,
TransactionAttribute transactionAttribute,
String joinpointIdentification) |
Modifier and Type | Method and Description |
---|---|
<T> T |
WebSphereUowTransactionManager.execute(TransactionDefinition definition,
TransactionCallback<T> callback) |
protected TransactionManager |
JtaTransactionManager.findTransactionManager(UserTransaction ut)
Find the JTA TransactionManager through autodetection: checking whether the
UserTransaction object implements the TransactionManager, and checking the
fallback JNDI locations.
|
protected TransactionSynchronizationRegistry |
JtaTransactionManager.findTransactionSynchronizationRegistry(UserTransaction ut,
TransactionManager tm)
Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection:
checking whether the UserTransaction object or TransactionManager object
implements it, and checking Java EE 5's standard JNDI location.
|
protected UserTransaction |
JtaTransactionManager.findUserTransaction()
Find the JTA UserTransaction through a default JNDI lookup:
"java:comp/UserTransaction".
|
Properties |
JtaTransactionManager.getJndiEnvironment()
Return the JNDI environment to use for JNDI lookups.
|
TransactionManager |
JtaTransactionManager.getTransactionManager()
Return the JTA TransactionManager that this transaction manager uses, if any.
|
TransactionSynchronizationRegistry |
JtaTransactionManager.getTransactionSynchronizationRegistry()
Return the JTA 1.1 TransactionSynchronizationRegistry that this transaction manager uses, if any.
|
UserTransaction |
JtaTransactionManager.getUserTransaction()
Return the JTA UserTransaction that this transaction manager uses.
|
protected TransactionManager |
WebLogicJtaTransactionManager.retrieveTransactionManager() |
protected TransactionManager |
JtaTransactionManager.retrieveTransactionManager()
Allows subclasses to retrieve the JTA TransactionManager in a vendor-specific manner.
|
protected TransactionSynchronizationRegistry |
JtaTransactionManager.retrieveTransactionSynchronizationRegistry()
Allows subclasses to retrieve the JTA 1.1 TransactionSynchronizationRegistry
in a vendor-specific manner.
|
protected UserTransaction |
WebLogicJtaTransactionManager.retrieveUserTransaction() |
protected UserTransaction |
JtaTransactionManager.retrieveUserTransaction()
Allows subclasses to retrieve the JTA UserTransaction in a vendor-specific manner.
|
Modifier and Type | Method and Description |
---|---|
Transaction |
WebLogicJtaTransactionManager.createTransaction(String name,
int timeout) |
Transaction |
TransactionFactory.createTransaction(String name,
int timeout)
Create an active Transaction object based on the given name and timeout.
|
Transaction |
SimpleTransactionFactory.createTransaction(String name,
int timeout) |
Transaction |
JtaTransactionManager.createTransaction(String name,
int timeout) |
protected void |
WebLogicJtaTransactionManager.doJtaResume(JtaTransactionObject txObject,
Object suspendedTransaction) |
protected void |
JtaTransactionManager.doJtaResume(JtaTransactionObject txObject,
Object suspendedTransaction)
Perform a JTA resume on the JTA TransactionManager.
|
protected void |
JtaTransactionManager.doResume(Object transaction,
Object suspendedResources) |
<T> T |
WebSphereUowTransactionManager.execute(TransactionDefinition definition,
TransactionCallback<T> callback) |
protected TransactionManager |
JtaTransactionManager.findTransactionManager(UserTransaction ut)
Find the JTA TransactionManager through autodetection: checking whether the
UserTransaction object implements the TransactionManager, and checking the
fallback JNDI locations.
|
protected TransactionSynchronizationRegistry |
JtaTransactionManager.findTransactionSynchronizationRegistry(UserTransaction ut,
TransactionManager tm)
Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection:
checking whether the UserTransaction object or TransactionManager object
implements it, and checking Java EE 5's standard JNDI location.
|
protected TransactionSynchronizationRegistry |
JtaTransactionManager.findTransactionSynchronizationRegistry(UserTransaction ut,
TransactionManager tm)
Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection:
checking whether the UserTransaction object or TransactionManager object
implements it, and checking Java EE 5's standard JNDI location.
|
void |
JtaTransactionManager.setJndiEnvironment(Properties jndiEnvironment)
Set the JNDI environment to use for JNDI lookups.
|
void |
JtaTransactionManager.setTransactionManager(TransactionManager transactionManager)
Set the JTA TransactionManager to use as direct reference.
|
void |
JtaTransactionManager.setTransactionSynchronizationRegistry(TransactionSynchronizationRegistry transactionSynchronizationRegistry)
Set the JTA 1.1 TransactionSynchronizationRegistry to use as direct reference.
|
void |
JtaTransactionManager.setUserTransaction(UserTransaction userTransaction)
Set the JTA UserTransaction to use as direct reference.
|
Constructor and Description |
---|
SpringJtaSynchronizationAdapter(TransactionSynchronization springSynchronization,
TransactionManager jtaTransactionManager)
Create a new SpringJtaSynchronizationAdapter for the given Spring
TransactionSynchronization and JTA TransactionManager.
|
SpringJtaSynchronizationAdapter(TransactionSynchronization springSynchronization,
UserTransaction jtaUserTransaction)
Create a new SpringJtaSynchronizationAdapter for the given Spring
TransactionSynchronization and JTA TransactionManager.
|
Modifier and Type | Method and Description |
---|---|
Integer |
TransactionSynchronizationManager.getCurrentTransactionIsolationLevel()
Return the isolation level for the current transaction, if any.
|
Integer |
TransactionContext.getCurrentTransactionIsolationLevel() |
String |
TransactionSynchronizationManager.getCurrentTransactionName()
Return the name of the current transaction, or
null if none set. |
String |
TransactionContext.getCurrentTransactionName() |
TransactionContext |
TransactionContext.getParent() |
Object |
TransactionSynchronizationManager.getResource(Object key)
Retrieve a resource for the given key that is bound to the current context.
|
Object |
GenericReactiveTransaction.getSuspendedResources()
Return the holder for resources that have been suspended for this transaction,
if any.
|
Set<TransactionSynchronization> |
TransactionContext.getSynchronizations() |
Object |
TransactionSynchronizationManager.unbindResourceIfPossible(Object key)
Unbind a resource for the given key from the current context.
|
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<Void> |
AbstractReactiveTransactionManager.doResume(TransactionSynchronizationManager synchronizationManager,
Object transaction,
Object suspendedResources)
Resume the resources of the current transaction.
|
reactor.core.publisher.Mono<ReactiveTransaction> |
AbstractReactiveTransactionManager.getReactiveTransaction(TransactionDefinition definition)
This implementation handles propagation behavior.
|
void |
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(Integer isolationLevel)
Expose an isolation level for the current transaction.
|
void |
TransactionContext.setCurrentTransactionIsolationLevel(Integer currentTransactionIsolationLevel) |
void |
TransactionSynchronizationManager.setCurrentTransactionName(String name)
Expose the name of the current transaction, if any.
|
void |
TransactionContext.setCurrentTransactionName(String currentTransactionName) |
void |
TransactionContext.setSynchronizations(Set<TransactionSynchronization> synchronizations) |
Constructor and Description |
---|
GenericReactiveTransaction(Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean readOnly,
boolean debug,
Object suspendedResources)
Create a new
DefaultReactiveTransactionStatus instance. |
GenericReactiveTransaction(Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean readOnly,
boolean debug,
Object suspendedResources)
Create a new
DefaultReactiveTransactionStatus instance. |
Modifier and Type | Method and Description |
---|---|
Object |
TransactionCallbackWithoutResult.doInTransaction(TransactionStatus status) |
T |
TransactionCallback.doInTransaction(TransactionStatus status)
Gets called by
TransactionTemplate.execute(org.springframework.transaction.support.TransactionCallback<T>) within a transactional context. |
<T> T |
TransactionTemplate.execute(TransactionCallback<T> action) |
<T> T |
TransactionOperations.execute(TransactionCallback<T> action)
Execute the action specified by the given callback object within a transaction.
|
<T> T |
CallbackPreferringPlatformTransactionManager.execute(TransactionDefinition definition,
TransactionCallback<T> callback)
Execute the action specified by the given callback object within a transaction.
|
String |
SimpleTransactionScope.getConversationId() |
static Integer |
TransactionSynchronizationManager.getCurrentTransactionIsolationLevel()
Return the isolation level for the current transaction, if any.
|
static String |
TransactionSynchronizationManager.getCurrentTransactionName()
Return the name of the current transaction, or
null if none set. |
Date |
ResourceHolderSupport.getDeadline()
Return the expiration deadline of this object.
|
String |
DelegatingTransactionDefinition.getName() |
String |
DefaultTransactionDefinition.getName() |
static Object |
TransactionSynchronizationManager.getResource(Object key)
Retrieve a resource for the given key that is bound to the current thread.
|
protected Object |
AbstractTransactionStatus.getSavepoint()
Get the savepoint for this transaction, if any.
|
Object |
DefaultTransactionStatus.getSuspendedResources()
Return the holder for resources that have been suspended for this transaction,
if any.
|
PlatformTransactionManager |
TransactionTemplate.getTransactionManager()
Return the transaction management strategy to be used.
|
Object |
SimpleTransactionScope.remove(String name) |
Object |
SimpleTransactionScope.resolveContextualObject(String key) |
protected AbstractPlatformTransactionManager.SuspendedResourcesHolder |
AbstractPlatformTransactionManager.suspend(Object transaction)
Suspend the given transaction.
|
static Object |
TransactionSynchronizationManager.unbindResourceIfPossible(Object key)
Unbind a resource for the given key from the current thread.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractPlatformTransactionManager.doResume(Object transaction,
Object suspendedResources)
Resume the resources of the current transaction.
|
boolean |
TransactionTemplate.equals(Object other) |
boolean |
DelegatingTransactionDefinition.equals(Object other) |
boolean |
DefaultTransactionDefinition.equals(Object other)
This implementation compares the
toString() results. |
<T> T |
CallbackPreferringPlatformTransactionManager.execute(TransactionDefinition definition,
TransactionCallback<T> callback)
Execute the action specified by the given callback object within a transaction.
|
TransactionStatus |
AbstractPlatformTransactionManager.getTransaction(TransactionDefinition definition)
This implementation handles propagation behavior.
|
static void |
TransactionSynchronizationUtils.invokeAfterCommit(List<TransactionSynchronization> synchronizations)
Actually invoke the
afterCommit methods of the
given Spring TransactionSynchronization objects. |
static void |
TransactionSynchronizationUtils.invokeAfterCompletion(List<TransactionSynchronization> synchronizations,
int completionStatus)
Actually invoke the
afterCompletion methods of the
given Spring TransactionSynchronization objects. |
protected DefaultTransactionStatus |
AbstractPlatformTransactionManager.newTransactionStatus(TransactionDefinition definition,
Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean debug,
Object suspendedResources)
Create a TransactionStatus instance for the given arguments.
|
protected DefaultTransactionStatus |
AbstractPlatformTransactionManager.newTransactionStatus(TransactionDefinition definition,
Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean debug,
Object suspendedResources)
Create a TransactionStatus instance for the given arguments.
|
protected DefaultTransactionStatus |
AbstractPlatformTransactionManager.prepareTransactionStatus(TransactionDefinition definition,
Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean debug,
Object suspendedResources)
Create a new TransactionStatus for the given arguments,
also initializing transaction synchronization as appropriate.
|
protected DefaultTransactionStatus |
AbstractPlatformTransactionManager.prepareTransactionStatus(TransactionDefinition definition,
Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean debug,
Object suspendedResources)
Create a new TransactionStatus for the given arguments,
also initializing transaction synchronization as appropriate.
|
protected void |
AbstractPlatformTransactionManager.resume(Object transaction,
AbstractPlatformTransactionManager.SuspendedResourcesHolder resourcesHolder)
Resume the given transaction.
|
protected void |
AbstractPlatformTransactionManager.resume(Object transaction,
AbstractPlatformTransactionManager.SuspendedResourcesHolder resourcesHolder)
Resume the given transaction.
|
static void |
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(Integer isolationLevel)
Expose an isolation level for the current transaction.
|
static void |
TransactionSynchronizationManager.setCurrentTransactionName(String name)
Expose the name of the current transaction, if any.
|
protected void |
AbstractTransactionStatus.setSavepoint(Object savepoint)
Set a savepoint for this transaction.
|
void |
TransactionTemplate.setTransactionManager(PlatformTransactionManager transactionManager)
Set the transaction management strategy to be used.
|
protected AbstractPlatformTransactionManager.SuspendedResourcesHolder |
AbstractPlatformTransactionManager.suspend(Object transaction)
Suspend the given transaction.
|
Constructor and Description |
---|
DefaultTransactionStatus(Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean readOnly,
boolean debug,
Object suspendedResources)
Create a new
DefaultTransactionStatus instance. |
DefaultTransactionStatus(Object transaction,
boolean newTransaction,
boolean newSynchronization,
boolean readOnly,
boolean debug,
Object suspendedResources)
Create a new
DefaultTransactionStatus instance. |
Modifier and Type | Method and Description |
---|---|
Object |
ConcurrentModel.getAttribute(String attributeName) |
Object |
ModelMap.getAttribute(String attributeName)
Return the attribute value for the given name, if any.
|
Object |
Model.getAttribute(String attributeName)
Return the attribute value for the given name, if any.
|
Object |
ConcurrentModel.put(String key,
Object value) |
Modifier and Type | Method and Description |
---|---|
ConcurrentModel |
ConcurrentModel.addAllAttributes(Collection<?> attributeValues)
Copy all attributes in the supplied
Collection into this
Map , using attribute name generation for each element. |
ModelMap |
ModelMap.addAllAttributes(Collection<?> attributeValues)
Copy all attributes in the supplied
Collection into this
Map , using attribute name generation for each element. |
ExtendedModelMap |
ExtendedModelMap.addAllAttributes(Collection<?> attributeValues) |
ConcurrentModel |
ConcurrentModel.addAllAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map . |
ModelMap |
ModelMap.addAllAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map . |
ExtendedModelMap |
ExtendedModelMap.addAllAttributes(Map<String,?> attributes) |
ConcurrentModel |
ConcurrentModel.addAttribute(String attributeName,
Object attributeValue)
Add the supplied attribute under the supplied name.
|
ModelMap |
ModelMap.addAttribute(String attributeName,
Object attributeValue)
Add the supplied attribute under the supplied name.
|
ExtendedModelMap |
ExtendedModelMap.addAttribute(String attributeName,
Object attributeValue) |
Model |
Model.addAttribute(String attributeName,
Object attributeValue)
Add the supplied attribute under the supplied name.
|
ConcurrentModel |
ConcurrentModel.mergeAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map ,
with existing objects of the same name taking precedence (i.e. |
ModelMap |
ModelMap.mergeAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map ,
with existing objects of the same name taking precedence (i.e. |
ExtendedModelMap |
ExtendedModelMap.mergeAttributes(Map<String,?> attributes) |
Object |
ConcurrentModel.put(String key,
Object value) |
Constructor and Description |
---|
ModelMap(String attributeName,
Object attributeValue)
Construct a new
ModelMap containing the supplied attribute
under the supplied name. |
Modifier and Type | Method and Description |
---|---|
ThemeSource |
HierarchicalThemeSource.getParentThemeSource()
Return the parent of this ThemeSource, or
null if none. |
Theme |
ThemeSource.getTheme(String themeName)
Return the Theme instance for the given theme name.
|
Modifier and Type | Method and Description |
---|---|
void |
HierarchicalThemeSource.setParentThemeSource(ThemeSource parent)
Set the parent that will be used to try to resolve theme messages
that this object can't resolve.
|
Modifier and Type | Method and Description |
---|---|
ThemeSource |
DelegatingThemeSource.getParentThemeSource() |
ThemeSource |
ResourceBundleThemeSource.getParentThemeSource() |
Theme |
DelegatingThemeSource.getTheme(String themeName) |
Theme |
ResourceBundleThemeSource.getTheme(String themeName)
This implementation returns a SimpleTheme instance, holding a
ResourceBundle-based MessageSource whose basename corresponds to
the given theme name (prefixed by the configured "basenamePrefix").
|
Modifier and Type | Method and Description |
---|---|
void |
ResourceBundleThemeSource.setBasenamePrefix(String basenamePrefix)
Set the prefix that gets applied to the ResourceBundle basenames,
i.e.
|
void |
ResourceBundleThemeSource.setBeanClassLoader(ClassLoader beanClassLoader) |
void |
ResourceBundleThemeSource.setDefaultEncoding(String defaultEncoding)
Set the default charset to use for parsing resource bundle files.
|
void |
DelegatingThemeSource.setParentThemeSource(ThemeSource parentThemeSource) |
void |
ResourceBundleThemeSource.setParentThemeSource(ThemeSource parent) |
Modifier and Type | Method and Description |
---|---|
Object |
SpringTemplateLoader.findTemplateSource(String name) |
protected freemarker.cache.TemplateLoader |
FreeMarkerConfigurationFactory.getAggregateTemplateLoader(List<freemarker.cache.TemplateLoader> templateLoaders)
Return a TemplateLoader based on the given TemplateLoader list.
|
freemarker.template.Configuration |
FreeMarkerConfigurationFactoryBean.getObject() |
Modifier and Type | Field and Description |
---|---|
protected Class<?> |
MethodInvoker.targetClass |
Modifier and Type | Method and Description |
---|---|
V |
LinkedCaseInsensitiveMap.computeIfAbsent(String key,
Function<? super String,? extends V> mappingFunction) |
static String[] |
StringUtils.concatenateStringArrays(String[] array1,
String[] array2)
Concatenate the given
String arrays into one,
with overlapping array elements included twice. |
String |
StopWatch.currentTaskName()
Get the name of the currently running task, if any.
|
static Object |
SerializationUtils.deserialize(byte[] bytes)
Deserialize the byte array into an object.
|
static Class<?> |
ClassUtils.determineCommonAncestor(Class<?> clazz1,
Class<?> clazz2)
Determine the common ancestor of the given classes, if any.
|
<T> T |
ConcurrentReferenceHashMap.Segment.doTask(int hash,
Object key,
org.springframework.util.ConcurrentReferenceHashMap.Task<T> task)
Apply an update operation to this segment.
|
static Class<?> |
CollectionUtils.findCommonElementType(Collection<?> collection)
Find the common element type of the given Collection, if any.
|
static Field |
ReflectionUtils.findField(Class<?> clazz,
String name)
|
static Field |
ReflectionUtils.findField(Class<?> clazz,
String name,
Class<?> type)
|
static <E> E |
CollectionUtils.findFirstMatch(Collection<?> source,
Collection<E> candidates)
Return the first element in '
candidates ' that is contained in
'source '. |
protected Method |
MethodInvoker.findMatchingMethod()
Find a matching method with the specified name for the specified arguments.
|
static Method |
ReflectionUtils.findMethod(Class<?> clazz,
String name)
Attempt to find a
Method on the supplied class with the supplied name
and no parameters. |
static Method |
ReflectionUtils.findMethod(Class<?> clazz,
String name,
Class<?>... paramTypes)
Attempt to find a
Method on the supplied class with the supplied name
and parameter types. |
static Object |
CollectionUtils.findValueOfType(Collection<?> collection,
Class<?>[] types)
Find a single value of one of the given types in the given Collection:
searching the Collection for a value of the first type, then
searching for a value of the second type, etc.
|
static <T> T |
CollectionUtils.findValueOfType(Collection<?> collection,
Class<T> type)
Find a single value of the given type in the given Collection.
|
static <T> T |
CollectionUtils.firstElement(List<T> list)
Retrieve the first element of the given List, accessing the zero index.
|
static <T> T |
CollectionUtils.firstElement(Set<T> set)
Retrieve the first element of the given Set, using
SortedSet.first()
or otherwise using the iterator. |
ConcurrentReferenceHashMap.Entry<K,V> |
ConcurrentReferenceHashMap.Reference.get()
Return the referenced entry, or
null if the entry is no longer available. |
V |
ConcurrentReferenceHashMap.get(Object key) |
List<V> |
MultiValueMapAdapter.get(Object key) |
V |
LinkedCaseInsensitiveMap.get(Object key) |
Charset |
MimeType.getCharset()
Return the character set, as indicated by a
charset parameter, if any. |
static <T> Constructor<T> |
ClassUtils.getConstructorIfAvailable(Class<T> clazz,
Class<?>... paramTypes)
Determine whether the given class has a public constructor with the given signature,
and return it if available (else return
null ). |
static ClassLoader |
ClassUtils.getDefaultClassLoader()
Return the default ClassLoader to use: typically the thread context
ClassLoader, if available; the ClassLoader that loaded the ClassUtils
class will be used as fallback.
|
static String |
ClassUtils.getDescriptiveType(Object value)
Return a descriptive name for the given object's type: usually simply
the class name, but component type class name + "[]" for arrays,
and an appended list of implemented interfaces for JDK proxies.
|
static Object |
ReflectionUtils.getField(Field field,
Object target)
Get the field represented by the supplied
field object on the
specified target object . |
static String |
StringUtils.getFilename(String path)
Extract the filename from the given Java resource path,
e.g.
|
static String |
StringUtils.getFilenameExtension(String path)
Extract the filename extension from the given Java resource path,
e.g.
|
V |
MultiValueMapAdapter.getFirst(K key) |
V |
MultiValueMap.getFirst(K key)
Return the first value for the given key.
|
K |
ConcurrentReferenceHashMap.Entry.getKey() |
static Method |
ClassUtils.getMethodIfAvailable(Class<?> clazz,
String methodName,
Class<?>... paramTypes)
Determine whether the given class has a public method with the given signature,
and return it if available (else return
null ). |
ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.Reference.getNext()
Return the next reference in the chain, or
null if none. |
V |
ConcurrentReferenceHashMap.getOrDefault(Object key,
V defaultValue) |
V |
LinkedCaseInsensitiveMap.getOrDefault(Object key,
V defaultValue) |
String |
MimeType.getParameter(String name)
Return a generic parameter value, given a parameter name.
|
protected ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.getReference(Object key,
ConcurrentReferenceHashMap.Restructure restructure)
Return a
ConcurrentReferenceHashMap.Reference to the ConcurrentReferenceHashMap.Entry for the specified key ,
or null if not found. |
ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.Segment.getReference(Object key,
int hash,
ConcurrentReferenceHashMap.Restructure restructure) |
static Method |
ClassUtils.getStaticMethod(Class<?> clazz,
String methodName,
Class<?>... args)
Return a public static method of a class.
|
String |
MimeType.getSubtypeSuffix()
Return the subtype suffix as defined in RFC 6839.
|
Class<?> |
MethodInvoker.getTargetClass()
Return the target class on which to call the target method.
|
String |
MethodInvoker.getTargetMethod()
Return the name of the method to be invoked.
|
Object |
MethodInvoker.getTargetObject()
Return the target object on which to call the target method.
|
ThreadGroup |
CustomizableThreadCreator.getThreadGroup()
Return the thread group that threads should be created in
(or
null for the default group). |
V |
ConcurrentReferenceHashMap.Entry.getValue() |
Object |
MethodInvoker.invoke()
Invoke the specified method.
|
static Object |
ReflectionUtils.invokeMethod(Method method,
Object target)
Invoke the specified
Method against the supplied target object with no arguments. |
static Object |
ReflectionUtils.invokeMethod(Method method,
Object target,
Object... args)
Invoke the specified
Method against the supplied target object with the
supplied arguments. |
static <T> T |
CollectionUtils.lastElement(List<T> list)
Retrieve the last element of the given List, accessing the highest index.
|
static <T> T |
CollectionUtils.lastElement(Set<T> set)
Retrieve the last element of the given Set, using
SortedSet.last()
or otherwise iterating over all elements (assuming a linked set). |
Map<String,String> |
RouteMatcher.matchAndExtract(String pattern,
RouteMatcher.Route route)
Match the pattern to the route and extract template variables.
|
Map<String,String> |
SimpleRouteMatcher.matchAndExtract(String pattern,
RouteMatcher.Route route) |
static String[] |
StringUtils.mergeStringArrays(String[] array1,
String[] array2)
Deprecated.
as of 4.3.15, in favor of manual merging via
LinkedHashSet
(with every entry included at most once, even entries within the first array) |
static ClassLoader |
ClassUtils.overrideThreadContextClassLoader(ClassLoader classLoaderToUse)
Override the thread context ClassLoader with the environment's bean ClassLoader
if necessary, i.e.
|
static Locale |
StringUtils.parseLocale(String localeValue)
Parse the given
String value into a Locale , accepting
the Locale.toString() format as well as BCP 47 language tags as
specified by Locale.forLanguageTag(java.lang.String) . |
static Locale |
StringUtils.parseLocaleString(String localeString)
Parse the given
String representation into a Locale . |
ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.ReferenceManager.pollForPurge()
Return any reference that has been garbage collected and can be purged from the
underlying structure or
null if no references need purging. |
List<V> |
MultiValueMapAdapter.put(K key,
List<V> value) |
V |
ConcurrentReferenceHashMap.put(K key,
V value) |
V |
LinkedCaseInsensitiveMap.put(String key,
V value) |
V |
ConcurrentReferenceHashMap.putIfAbsent(K key,
V value) |
V |
LinkedCaseInsensitiveMap.putIfAbsent(String key,
V value) |
static String |
StringUtils.quote(String str)
Quote the given
String with single quotes. |
static Object |
StringUtils.quoteIfString(Object obj)
Turn the given Object into a
String with single quotes
if it is a String ; keeping the Object as-is else. |
V |
ConcurrentReferenceHashMap.remove(Object key) |
List<V> |
MultiValueMapAdapter.remove(Object key) |
V |
LinkedCaseInsensitiveMap.remove(Object key) |
V |
ConcurrentReferenceHashMap.replace(K key,
V value) |
String |
PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder(String placeholderName)
Resolve the supplied placeholder name to the replacement value.
|
static Class<?> |
ClassUtils.resolvePrimitiveClassName(String name)
Resolve the given class name as primitive class, if appropriate,
according to the JVM's naming rules for primitive classes.
|
String |
StringValueResolver.resolveStringValue(String strVal)
Resolve the given String value, for example parsing placeholders.
|
static byte[] |
SerializationUtils.serialize(Object object)
Serialize the given object to a byte array.
|
V |
ConcurrentReferenceHashMap.Entry.setValue(V value) |
static String[] |
StringUtils.split(String toSplit,
String delimiter)
Split a
String at the first occurrence of the delimiter. |
static Properties |
StringUtils.splitArrayElementsIntoProperties(String[] array,
String delimiter)
Take an array of strings and split each element based on the given delimiter.
|
static Properties |
StringUtils.splitArrayElementsIntoProperties(String[] array,
String delimiter,
String charsToDelete)
Take an array of strings and split each element based on the given delimiter.
|
static Object |
ObjectUtils.unwrapOptional(Object obj)
Unwrap the given object which is potentially a
Optional . |
Modifier and Type | Method and Description |
---|---|
void |
MultiValueMapAdapter.add(K key,
V value) |
void |
MultiValueMap.add(K key,
V value)
Add the given single value to the current list of values for the given key.
|
default void |
MultiValueMap.addIfAbsent(K key,
V value)
|
static <A,O extends A> |
ObjectUtils.addObjectToArray(A[] array,
O obj)
Append the given object to the given array, returning a new array
consisting of the input array contents plus the given object.
|
static <A,O extends A> |
ObjectUtils.addObjectToArray(A[] array,
O obj)
Append the given object to the given array, returning a new array
consisting of the input array contents plus the given object.
|
static String[] |
StringUtils.addStringToArray(String[] array,
String str)
Append the given
String to the given String array,
returning a new array consisting of the input array contents plus
the given String . |
static String |
StringUtils.arrayToCommaDelimitedString(Object[] arr)
Convert a
String array into a comma delimited String
(i.e., CSV). |
static String |
StringUtils.arrayToDelimitedString(Object[] arr,
String delim)
Convert a
String array into a delimited String (e.g. |
static List<?> |
CollectionUtils.arrayToList(Object source)
Convert the supplied array into a List.
|
static String |
ClassUtils.classNamesToString(Collection<Class<?>> classes)
Build a String that consists of the names of the classes/interfaces
in the given collection.
|
static String |
ClassUtils.classPackageAsResourcePath(Class<?> clazz)
Given an input class object, return a string which consists of the
class's package name as a pathname, i.e., all dots ('.') are replaced by
slashes ('/').
|
static String |
StringUtils.collectionToCommaDelimitedString(Collection<?> coll)
Convert a
Collection into a delimited String (e.g., CSV). |
static String |
StringUtils.collectionToDelimitedString(Collection<?> coll,
String delim)
Convert a
Collection into a delimited String (e.g. |
static String |
StringUtils.collectionToDelimitedString(Collection<?> coll,
String delim,
String prefix,
String suffix)
Convert a
Collection to a delimited String (e.g. |
static Set<String> |
StringUtils.commaDelimitedListToSet(String str)
Convert a comma delimited list (e.g., a row from a CSV file) into a set.
|
static String[] |
StringUtils.commaDelimitedListToStringArray(String str)
Convert a comma delimited list (e.g., a row from a CSV file) into an
array of strings.
|
static String[] |
StringUtils.concatenateStringArrays(String[] array1,
String[] array2)
Concatenate the given
String arrays into one,
with overlapping array elements included twice. |
static String[] |
StringUtils.concatenateStringArrays(String[] array1,
String[] array2)
Concatenate the given
String arrays into one,
with overlapping array elements included twice. |
static boolean |
CollectionUtils.contains(Enumeration<?> enumeration,
Object element)
Check whether the given Enumeration contains the given element.
|
static boolean |
CollectionUtils.contains(Iterator<?> iterator,
Object element)
Check whether the given Iterator contains the given element.
|
static boolean |
ObjectUtils.containsElement(Object[] array,
Object element)
Check whether the given array contains the given element.
|
static boolean |
CollectionUtils.containsInstance(Collection<?> collection,
Object element)
Check whether the given Collection contains the given element instance.
|
boolean |
ConcurrentReferenceHashMap.containsKey(Object key) |
static boolean |
StringUtils.containsWhitespace(CharSequence str)
Check whether the given
CharSequence contains any whitespace characters. |
static boolean |
StringUtils.containsWhitespace(String str)
Check whether the given
String contains any whitespace characters. |
static byte[] |
StreamUtils.copyToByteArray(InputStream in)
Copy the contents of the given InputStream into a new byte array.
|
static byte[] |
FileCopyUtils.copyToByteArray(InputStream in)
Copy the contents of the given InputStream into a new byte array.
|
static String |
StreamUtils.copyToString(InputStream in,
Charset charset)
Copy the contents of the given InputStream into a String.
|
static String |
FileCopyUtils.copyToString(Reader in)
Copy the contents of the given Reader into a String.
|
static Class<?> |
ClassUtils.createCompositeInterface(Class<?>[] interfaces,
ClassLoader classLoader)
Create a composite interface Class for the given interfaces,
implementing the given interfaces in one single Class.
|
ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.ReferenceManager.createReference(ConcurrentReferenceHashMap.Entry<K,V> entry,
int hash,
ConcurrentReferenceHashMap.Reference<K,V> next)
Factory method used to create a new
ConcurrentReferenceHashMap.Reference . |
static String |
StringUtils.deleteAny(String inString,
String charsToDelete)
Delete any character in a given
String . |
static boolean |
FileSystemUtils.deleteRecursively(File root)
Delete the supplied
File - for directories,
recursively delete any nested directories or files as well. |
static boolean |
FileSystemUtils.deleteRecursively(Path root)
Delete the supplied
Path — for directories,
recursively delete any nested directories or files as well. |
static String[] |
StringUtils.delimitedListToStringArray(String str,
String delimiter)
Take a
String that is a delimited list and convert it into a
String array. |
static String[] |
StringUtils.delimitedListToStringArray(String str,
String delimiter)
Take a
String that is a delimited list and convert it into a
String array. |
static String[] |
StringUtils.delimitedListToStringArray(String str,
String delimiter,
String charsToDelete)
Take a
String that is a delimited list and convert it into
a String array. |
static String[] |
StringUtils.delimitedListToStringArray(String str,
String delimiter,
String charsToDelete)
Take a
String that is a delimited list and convert it into
a String array. |
static String[] |
StringUtils.delimitedListToStringArray(String str,
String delimiter,
String charsToDelete)
Take a
String that is a delimited list and convert it into
a String array. |
static Object |
SerializationUtils.deserialize(byte[] bytes)
Deserialize the byte array into an object.
|
static Class<?> |
ClassUtils.determineCommonAncestor(Class<?> clazz1,
Class<?> clazz2)
Determine the common ancestor of the given classes, if any.
|
static Class<?> |
ClassUtils.determineCommonAncestor(Class<?> clazz1,
Class<?> clazz2)
Determine the common ancestor of the given classes, if any.
|
static void |
Assert.doesNotContain(String textToSearch,
String substring)
Deprecated.
as of 4.3.7, in favor of
Assert.doesNotContain(String, String, String) |
static void |
Assert.doesNotContain(String textToSearch,
String substring,
String message)
Assert that the given text does not contain the given substring.
|
static void |
Assert.doesNotContain(String textToSearch,
String substring,
Supplier<String> messageSupplier)
Assert that the given text does not contain the given substring.
|
protected boolean |
AntPathMatcher.doMatch(String pattern,
String path,
boolean fullMatch,
Map<String,String> uriTemplateVariables)
Actually match the given
path against the given pattern . |
protected boolean |
AntPathMatcher.doMatch(String pattern,
String path,
boolean fullMatch,
Map<String,String> uriTemplateVariables)
Actually match the given
path against the given pattern . |
<T> T |
ConcurrentReferenceHashMap.Segment.doTask(int hash,
Object key,
org.springframework.util.ConcurrentReferenceHashMap.Task<T> task)
Apply an update operation to this segment.
|
static void |
ReflectionUtils.doWithFields(Class<?> clazz,
ReflectionUtils.FieldCallback fc,
ReflectionUtils.FieldFilter ff)
Invoke the given callback on all fields in the target class, going up the
class hierarchy to get all declared fields.
|
static void |
ReflectionUtils.doWithMethods(Class<?> clazz,
ReflectionUtils.MethodCallback mc,
ReflectionUtils.MethodFilter mf)
Perform the given callback operation on all matching methods of the given
class and superclasses (or given interface and super-interfaces).
|
static boolean |
StringUtils.endsWithIgnoreCase(String str,
String suffix)
Test if the given
String ends with the specified suffix,
ignoring upper/lower case. |
static boolean |
StringUtils.endsWithIgnoreCase(String str,
String suffix)
Test if the given
String ends with the specified suffix,
ignoring upper/lower case. |
boolean |
ConcurrentReferenceHashMap.Entry.equals(Object other) |
boolean |
AutoPopulatingList.equals(Object other) |
boolean |
MimeType.equals(Object other) |
boolean |
MultiValueMapAdapter.equals(Object other) |
boolean |
LinkedCaseInsensitiveMap.equals(Object other) |
boolean |
MimeType.equalsTypeAndSubtype(MimeType other)
Similar to
MimeType.equals(Object) but based on the type and subtype
only, i.e. |
static Field |
ReflectionUtils.findField(Class<?> clazz,
String name,
Class<?> type)
|
static Field |
ReflectionUtils.findField(Class<?> clazz,
String name,
Class<?> type)
|
static Method |
ReflectionUtils.findMethod(Class<?> clazz,
String name,
Class<?>... paramTypes)
Attempt to find a
Method on the supplied class with the supplied name
and parameter types. |
static <T> T |
CollectionUtils.findValueOfType(Collection<?> collection,
Class<T> type)
Find a single value of the given type in the given Collection.
|
static <T> T |
CollectionUtils.firstElement(List<T> list)
Retrieve the first element of the given List, accessing the zero index.
|
static <T> T |
CollectionUtils.firstElement(Set<T> set)
Retrieve the first element of the given Set, using
SortedSet.first()
or otherwise using the iterator. |
static Class<?> |
ClassUtils.forName(String name,
ClassLoader classLoader)
Replacement for
Class.forName() that also returns Class instances
for primitives (e.g. |
V |
ConcurrentReferenceHashMap.get(Object key) |
static Class<?>[] |
ClassUtils.getAllInterfacesForClass(Class<?> clazz,
ClassLoader classLoader)
Return all interfaces that the given class implements as an array,
including ones implemented by superclasses.
|
static Set<Class<?>> |
ClassUtils.getAllInterfacesForClassAsSet(Class<?> clazz,
ClassLoader classLoader)
Return all interfaces that the given class implements as a Set,
including ones implemented by superclasses.
|
static String |
ClassUtils.getDescriptiveType(Object value)
Return a descriptive name for the given object's type: usually simply
the class name, but component type class name + "[]" for arrays,
and an appended list of implemented interfaces for JDK proxies.
|
static String |
ObjectUtils.getDisplayString(Object obj)
Return a content-based String representation if
obj is
not null ; otherwise returns an empty String. |
static Object |
ReflectionUtils.getField(Field field,
Object target)
Get the field represented by the supplied
field object on the
specified target object . |
static String |
StringUtils.getFilename(String path)
Extract the filename from the given Java resource path,
e.g.
|
static String |
StringUtils.getFilenameExtension(String path)
Extract the filename extension from the given Java resource path,
e.g.
|
protected int |
ConcurrentReferenceHashMap.getHash(Object o)
Get the hash for a given object, apply an additional hash function to reduce
collisions.
|
static Method |
ClassUtils.getInterfaceMethodIfPossible(Method method,
Class<?> targetClass)
Determine a corresponding interface method for the given method handle, if possible.
|
static Method |
ClassUtils.getMethod(Class<?> clazz,
String methodName,
Class<?>... paramTypes)
Determine whether the given class has a public method with the given signature,
and return it if available (else throws an
IllegalStateException ). |
static Method |
ClassUtils.getMethodIfAvailable(Class<?> clazz,
String methodName,
Class<?>... paramTypes)
Determine whether the given class has a public method with the given signature,
and return it if available (else return
null ). |
static Method |
ClassUtils.getMostSpecificMethod(Method method,
Class<?> targetClass)
Given a method, which may come from an interface, and a target class used
in the current reflective invocation, find the corresponding target method
if there is one — for example, the method may be
IFoo.bar() ,
and the target class may be DefaultFoo . |
V |
ConcurrentReferenceHashMap.getOrDefault(Object key,
V defaultValue) |
V |
ConcurrentReferenceHashMap.getOrDefault(Object key,
V defaultValue) |
static String |
ClassUtils.getQualifiedMethodName(Method method,
Class<?> clazz)
Return the qualified name of the given method, consisting of
fully qualified interface/class name + "." + method name.
|
protected ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.getReference(Object key,
ConcurrentReferenceHashMap.Restructure restructure)
Return a
ConcurrentReferenceHashMap.Reference to the ConcurrentReferenceHashMap.Entry for the specified key ,
or null if not found. |
ConcurrentReferenceHashMap.Reference<K,V> |
ConcurrentReferenceHashMap.Segment.getReference(Object key,
int hash,
ConcurrentReferenceHashMap.Restructure restructure) |
static Method[] |
ReflectionUtils.getUniqueDeclaredMethods(Class<?> leafClass,
ReflectionUtils.MethodFilter mf)
Get the unique set of declared methods on the leaf class and all superclasses.
|
static boolean |
StringUtils.hasLength(CharSequence str)
Check that the given
CharSequence is neither null nor
of length 0. |
static void |
Assert.hasLength(String text)
Deprecated.
as of 4.3.7, in favor of
Assert.hasLength(String, String) |
static boolean |
StringUtils.hasLength(String str)
Check that the given
String is neither null nor of length 0. |
static void |
Assert.hasLength(String text,
String message)
Assert that the given String is not empty; that is,
it must not be
null and not the empty String. |
static void |
Assert.hasLength(String text,
Supplier<String> messageSupplier)
Assert that the given String is not empty; that is,
it must not be
null and not the empty String. |
static boolean |
StringUtils.hasText(CharSequence str)
Check whether the given
CharSequence contains actual text. |
static void |
Assert.hasText(String text)
Deprecated.
as of 4.3.7, in favor of
Assert.hasText(String, String) |
static boolean |
StringUtils.hasText(String str)
Check whether the given
String contains actual text. |
static void |
Assert.hasText(String text,
String message)
Assert that the given String contains valid text content; that is, it must not
be
null and must contain at least one non-whitespace character. |
static void |
Assert.hasText(String text,
Supplier<String> messageSupplier)
Assert that the given String contains valid text content; that is, it must not
be
null and must contain at least one non-whitespace character. |
static String |
ObjectUtils.identityToString(Object obj)
Return a String representation of an object's overall identity.
|
boolean |
MimeType.includes(MimeType other)
Indicate whether this MIME Type includes the given MIME Type.
|
static Object |
ReflectionUtils.invokeMethod(Method method,
Object target)
Invoke the specified
Method against the supplied target object with no arguments. |
static Object |
ReflectionUtils.invokeMethod(Method method,
Object target,
Object... args)
Invoke the specified
Method against the supplied target object with the
supplied arguments. |
static Object |
ReflectionUtils.invokeMethod(Method method,
Object target,
Object... args)
Invoke the specified
Method against the supplied target object with the
supplied arguments. |
static boolean |
ObjectUtils.isArray(Object obj)
Determine whether the given object is an array:
either an Object array or a primitive array.
|
static void |
Assert.isAssignable(Class<?> superType,
Class<?> subType,
String message)
Assert that
superType.isAssignableFrom(subType) is true . |
static void |
Assert.isAssignable(Class<?> superType,
Class<?> subType,
Supplier<String> messageSupplier)
Assert that
superType.isAssignableFrom(subType) is true . |
static boolean |
TypeUtils.isAssignableBound(Type lhsType,
Type rhsType) |
static boolean |
TypeUtils.isAssignableBound(Type lhsType,
Type rhsType) |
static boolean |
ClassUtils.isAssignableValue(Class<?> type,
Object value)
Determine if the given type is assignable from the given value,
assuming setting by reflection.
|
static boolean |
ClassUtils.isCacheSafe(Class<?> clazz,
ClassLoader classLoader)
Check whether the given class is cache-safe in the given context,
i.e.
|
static boolean |
ClassUtils.isCglibProxyClass(Class<?> clazz)
Deprecated.
as of 5.2, in favor of custom (possibly narrower) checks
or simply a check for containing
ClassUtils.CGLIB_CLASS_SEPARATOR |
static boolean |
ClassUtils.isCglibProxyClassName(String className)
Deprecated.
as of 5.2, in favor of custom (possibly narrower) checks
or simply a check for containing
ClassUtils.CGLIB_CLASS_SEPARATOR |
boolean |
MimeType.isCompatibleWith(MimeType other)
Indicate whether this MIME Type is compatible with the given MIME Type.
|
static boolean |
ObjectUtils.isCompatibleWithThrowsClause(Throwable ex,
Class<?>... declaredExceptions)
Check whether the given exception is compatible with the specified
exception types, as declared in a throws clause.
|
static boolean |
CollectionUtils.isEmpty(Collection<?> collection)
Return
true if the supplied Collection is null or empty. |
static boolean |
CollectionUtils.isEmpty(Map<?,?> map)
Return
true if the supplied Map is null or empty. |
static boolean |
ObjectUtils.isEmpty(Object obj)
Determine whether the given object is empty.
|
static boolean |
StringUtils.isEmpty(Object str)
Deprecated.
as of 5.3, in favor of
StringUtils.hasLength(String) and
StringUtils.hasText(String) (or ObjectUtils.isEmpty(Object) ) |
static boolean |
ObjectUtils.isEmpty(Object[] array)
Determine whether the given array is empty:
i.e.
|
static boolean |
ReflectionUtils.isEqualsMethod(Method method)
Determine whether the given method is an "equals" method.
|
static boolean |
ReflectionUtils.isHashCodeMethod(Method method)
Determine whether the given method is a "hashCode" method.
|
static void |
Assert.isInstanceOf(Class<?> type,
Object obj)
Assert that the provided object is an instance of the provided class.
|
static void |
Assert.isInstanceOf(Class<?> type,
Object obj,
String message)
Assert that the provided object is an instance of the provided class.
|
static void |
Assert.isInstanceOf(Class<?> type,
Object obj,
Supplier<String> messageSupplier)
Assert that the provided object is an instance of the provided class.
|
static void |
Assert.isNull(Object object)
Deprecated.
as of 4.3.7, in favor of
Assert.isNull(Object, String) |
static void |
Assert.isNull(Object object,
String message)
Assert that an object is
null . |
static void |
Assert.isNull(Object object,
Supplier<String> messageSupplier)
Assert that an object is
null . |
static boolean |
ReflectionUtils.isObjectMethod(Method method)
Determine whether the given method is originally declared by
Object . |
boolean |
AntPathMatcher.isPattern(String path) |
static boolean |
ClassUtils.isPresent(String className,
ClassLoader classLoader)
Determine whether the
Class identified by the supplied name is present
and can be loaded. |
static boolean |
ReflectionUtils.isToStringMethod(Method method)
Determine whether the given method is a "toString" method.
|
static boolean |
ResourceUtils.isUrl(String resourceLocation)
Return whether the given resource location is a URL:
either a special "classpath" pseudo URL or a standard URL.
|
static boolean |
ClassUtils.isVisible(Class<?> clazz,
ClassLoader classLoader)
Check whether the given class is visible in the given ClassLoader.
|
static <T> T |
CollectionUtils.lastElement(List<T> list)
Retrieve the last element of the given List, accessing the highest index.
|
static <T> T |
CollectionUtils.lastElement(Set<T> set)
Retrieve the last element of the given Set, using
SortedSet.last()
or otherwise iterating over all elements (assuming a linked set). |
static boolean |
StringUtils.matchesCharacter(String str,
char singleCharacter)
Test if the given
String matches the given single character. |
static boolean |
ClassUtils.matchesTypeName(Class<?> clazz,
String typeName)
Check whether the given class matches the user-specified type name.
|
boolean |
AntPathMatcher.AntPathStringMatcher.matchStrings(String str,
Map<String,String> uriTemplateVariables)
Main entry point.
|
static <E> void |
CollectionUtils.mergeArrayIntoCollection(Object array,
Collection<E> collection)
Merge the given array into the given Collection.
|
static <K,V> void |
CollectionUtils.mergePropertiesIntoMap(Properties props,
Map<K,V> map)
Merge the given Properties instance into the given Map,
copying all properties (key-value pairs) over.
|
static String[] |
StringUtils.mergeStringArrays(String[] array1,
String[] array2)
Deprecated.
as of 4.3.15, in favor of manual merging via
LinkedHashSet
(with every entry included at most once, even entries within the first array) |
static String[] |
StringUtils.mergeStringArrays(String[] array1,
String[] array2)
Deprecated.
as of 4.3.15, in favor of manual merging via
LinkedHashSet
(with every entry included at most once, even entries within the first array) |
static void |
Assert.noNullElements(Collection<?> collection,
String message)
Assert that a collection contains no
null elements. |
static void |
Assert.noNullElements(Collection<?> collection,
Supplier<String> messageSupplier)
Assert that a collection contains no
null elements. |
static void |
Assert.noNullElements(Object[] array)
Deprecated.
as of 4.3.7, in favor of
Assert.noNullElements(Object[], String) |
static void |
Assert.noNullElements(Object[] array,
String message)
Assert that an array contains no
null elements. |
static void |
Assert.noNullElements(Object[] array,
Supplier<String> messageSupplier)
Assert that an array contains no
null elements. |
static void |
Assert.notEmpty(Collection<?> collection)
Deprecated.
as of 4.3.7, in favor of
Assert.notEmpty(Collection, String) |
static void |
Assert.notEmpty(Collection<?> collection,
String message)
Assert that a collection contains elements; that is, it must not be
null and must contain at least one element. |
static void |
Assert.notEmpty(Collection<?> collection,
Supplier<String> messageSupplier)
Assert that a collection contains elements; that is, it must not be
null and must contain at least one element. |
static void |
Assert.notEmpty(Map<?,?> map)
Deprecated.
as of 4.3.7, in favor of
Assert.notEmpty(Map, String) |
static void |
Assert.notEmpty(Map<?,?> map,
String message)
Assert that a Map contains entries; that is, it must not be
null
and must contain at least one entry. |
static void |
Assert.notEmpty(Map<?,?> map,
Supplier<String> messageSupplier)
Assert that a Map contains entries; that is, it must not be
null
and must contain at least one entry. |
static void |
Assert.notEmpty(Object[] array)
Deprecated.
as of 4.3.7, in favor of
Assert.notEmpty(Object[], String) |
static void |
Assert.notEmpty(Object[] array,
String message)
Assert that an array contains elements; that is, it must not be
null and must contain at least one element. |
static void |
Assert.notEmpty(Object[] array,
Supplier<String> messageSupplier)
Assert that an array contains elements; that is, it must not be
null and must contain at least one element. |
static void |
Assert.notNull(Object object)
Deprecated.
as of 4.3.7, in favor of
Assert.notNull(Object, String) |
static void |
Assert.notNull(Object object,
String message)
Assert that an object is not
null . |
static void |
Assert.notNull(Object object,
Supplier<String> messageSupplier)
Assert that an object is not
null . |
static String |
ObjectUtils.nullSafeClassName(Object obj)
Determine the class name for the given object.
|
static String |
ObjectUtils.nullSafeConciseToString(Object obj)
Generate a null-safe, concise string representation of the supplied object
as described below.
|
static boolean |
ObjectUtils.nullSafeEquals(Object o1,
Object o2)
Determine if the given objects are equal, returning
true if
both are null or false if only one is null . |
static boolean |
ObjectUtils.nullSafeEquals(Object o1,
Object o2)
Determine if the given objects are equal, returning
true if
both are null or false if only one is null . |
static int |
ObjectUtils.nullSafeHashCode(boolean[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(byte[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(char[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(double[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(float[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(int[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(long[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(Object obj)
Return as hash code for the given object; typically the value of
Object#hashCode() }. |
static int |
ObjectUtils.nullSafeHashCode(Object[] array)
Return a hash code based on the contents of the specified array.
|
static int |
ObjectUtils.nullSafeHashCode(short[] array)
Return a hash code based on the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(boolean[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(byte[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(char[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(double[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(float[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(int[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(long[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(Object obj)
Return a String representation of the specified Object.
|
static String |
ObjectUtils.nullSafeToString(Object[] array)
Return a String representation of the contents of the specified array.
|
static String |
ObjectUtils.nullSafeToString(short[] array)
Return a String representation of the contents of the specified array.
|
static ClassLoader |
ClassUtils.overrideThreadContextClassLoader(ClassLoader classLoaderToUse)
Override the thread context ClassLoader with the environment's bean ClassLoader
if necessary, i.e.
|
static <T extends Number> |
NumberUtils.parseNumber(String text,
Class<T> targetClass,
NumberFormat numberFormat)
Parse the given
text into a Number instance of the
given target class, using the supplied NumberFormat . |
protected String |
PropertyPlaceholderHelper.parseStringValue(String value,
PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver,
Set<String> visitedPlaceholders) |
V |
ConcurrentReferenceHashMap.put(K key,
V value) |
V |
ConcurrentReferenceHashMap.put(K key,
V value) |
V |
LinkedCaseInsensitiveMap.put(String key,
V value) |
V |
ConcurrentReferenceHashMap.putIfAbsent(K key,
V value) |
V |
ConcurrentReferenceHashMap.putIfAbsent(K key,
V value) |
V |
LinkedCaseInsensitiveMap.putIfAbsent(String key,
V value) |
static String |
StringUtils.quote(String str)
Quote the given
String with single quotes. |
static Object |
StringUtils.quoteIfString(Object obj)
Turn the given Object into a
String with single quotes
if it is a String ; keeping the Object as-is else. |
V |
ConcurrentReferenceHashMap.remove(Object key) |
boolean |
ConcurrentReferenceHashMap.remove(Object key,
Object value) |
boolean |
ConcurrentReferenceHashMap.remove(Object key,
Object value) |
V |
ConcurrentReferenceHashMap.replace(K key,
V value) |
V |
ConcurrentReferenceHashMap.replace(K key,
V value) |
boolean |
ConcurrentReferenceHashMap.replace(K key,
V oldValue,
V newValue) |
boolean |
ConcurrentReferenceHashMap.replace(K key,
V oldValue,
V newValue) |
boolean |
ConcurrentReferenceHashMap.replace(K key,
V oldValue,
V newValue) |
static String |
StringUtils.replace(String inString,
String oldPattern,
String newPattern)
Replace all occurrences of a substring within a string with another string.
|
static Class<?> |
ClassUtils.resolveClassName(String className,
ClassLoader classLoader)
Resolve the given class name into a Class instance.
|
static Class<?> |
ClassUtils.resolvePrimitiveClassName(String name)
Resolve the given class name as primitive class, if appropriate,
according to the JVM's naming rules for primitive classes.
|
static byte[] |
SerializationUtils.serialize(Object object)
Serialize the given object to a byte array.
|
void |
MultiValueMapAdapter.set(K key,
V value) |
void |
MultiValueMap.set(K key,
V value)
Set the given single value under the given key.
|
static void |
ReflectionUtils.setField(Field field,
Object target,
Object value)
Set the field represented by the supplied field object on
the specified target object to the specified
value . |
static void |
ReflectionUtils.setField(Field field,
Object target,
Object value)
Set the field represented by the supplied field object on
the specified target object to the specified
value . |
void |
AntPathMatcher.setPathSeparator(String pathSeparator)
Set the path separator to use for pattern parsing.
|
void |
MethodInvoker.setTargetClass(Class<?> targetClass)
Set the target class on which to call the target method.
|
void |
MethodInvoker.setTargetMethod(String targetMethod)
Set the name of the method to be invoked.
|
void |
MethodInvoker.setTargetObject(Object targetObject)
Set the target object on which to call the target method.
|
void |
CustomizableThreadCreator.setThreadGroup(ThreadGroup threadGroup)
Specify the thread group that threads should be created in.
|
void |
CustomizableThreadCreator.setThreadNamePrefix(String threadNamePrefix)
Specify the prefix to use for the names of newly created threads.
|
V |
ConcurrentReferenceHashMap.Entry.setValue(V value) |
static boolean |
PatternMatchUtils.simpleMatch(String[] patterns,
String str)
Match a String against the given patterns, supporting the following simple
pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an
arbitrary number of pattern parts), as well as direct equality.
|
static boolean |
PatternMatchUtils.simpleMatch(String pattern,
String str)
Match a String against the given pattern, supporting the following simple
pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an
arbitrary number of pattern parts), as well as direct equality.
|
static boolean |
PatternMatchUtils.simpleMatch(String pattern,
String str)
Match a String against the given pattern, supporting the following simple
pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an
arbitrary number of pattern parts), as well as direct equality.
|
static String[] |
StringUtils.split(String toSplit,
String delimiter)
Split a
String at the first occurrence of the delimiter. |
static String[] |
StringUtils.split(String toSplit,
String delimiter)
Split a
String at the first occurrence of the delimiter. |
static Properties |
StringUtils.splitArrayElementsIntoProperties(String[] array,
String delimiter,
String charsToDelete)
Take an array of strings and split each element based on the given delimiter.
|
static boolean |
StringUtils.startsWithIgnoreCase(String str,
String prefix)
Test if the given
String starts with the specified prefix,
ignoring upper/lower case. |
static boolean |
StringUtils.startsWithIgnoreCase(String str,
String prefix)
Test if the given
String starts with the specified prefix,
ignoring upper/lower case. |
static Class<?>[] |
ClassUtils.toClassArray(Collection<Class<?>> collection)
Copy the given
Collection into a Class array. |
static <E> Iterator<E> |
CollectionUtils.toIterator(Enumeration<E> enumeration)
Adapt an
Enumeration to an Iterator . |
static String[] |
StringUtils.tokenizeToStringArray(String str,
String delimiters)
|
static String[] |
StringUtils.tokenizeToStringArray(String str,
String delimiters,
boolean trimTokens,
boolean ignoreEmptyTokens)
|
static Object[] |
ObjectUtils.toObjectArray(Object source)
Convert the given array (which may be a primitive array) to an
object array (if necessary of primitive wrapper objects).
|
static String[] |
StringUtils.toStringArray(Collection<String> collection)
Copy the given
Collection into a String array. |
static String[] |
StringUtils.toStringArray(Enumeration<String> enumeration)
Copy the given
Enumeration into a String array. |
static Object |
ObjectUtils.unwrapOptional(Object obj)
Unwrap the given object which is potentially a
Optional . |
Constructor and Description |
---|
CustomizableThreadCreator(String threadNamePrefix)
Create a new CustomizableThreadCreator with the given thread name prefix.
|
Entry(K key,
V value) |
Entry(K key,
V value) |
InstanceFilter(Collection<? extends T> includes,
Collection<? extends T> excludes,
boolean matchIfEmpty)
Create a new instance based on includes/excludes collections.
|
InstanceFilter(Collection<? extends T> includes,
Collection<? extends T> excludes,
boolean matchIfEmpty)
Create a new instance based on includes/excludes collections.
|
LinkedCaseInsensitiveMap(int expectedSize,
Locale locale)
Create a new LinkedCaseInsensitiveMap that wraps a
LinkedHashMap
with an initial capacity that can accommodate the specified number of
elements without any immediate resize/rehash operations to be expected,
storing case-insensitive keys according to the given Locale (in lower case). |
LinkedCaseInsensitiveMap(Locale locale)
Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys
according to the given Locale (in lower case).
|
MimeType(MimeType other,
Map<String,String> parameters)
Copy-constructor that copies the type and subtype of the given
MimeType ,
and allows for different parameter. |
MimeType(String type,
String subtype,
Map<String,String> parameters)
Create a new
MimeType for the given type, subtype, and parameters. |
PropertyPlaceholderHelper(String placeholderPrefix,
String placeholderSuffix,
String valueSeparator,
boolean ignoreUnresolvablePlaceholders)
Creates a new
PropertyPlaceholderHelper that uses the supplied prefix and suffix. |
Modifier and Type | Method and Description |
---|---|
int |
NullSafeComparator.compare(T o1,
T o2) |
int |
NullSafeComparator.compare(T o1,
T o2) |
boolean |
CompoundComparator.equals(Object other)
Deprecated.
|
boolean |
BooleanComparator.equals(Object other) |
boolean |
InvertibleComparator.equals(Object other)
Deprecated.
|
boolean |
NullSafeComparator.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
protected abstract T |
FutureAdapter.adapt(S adapteeResult)
Adapts the given adaptee's result into T.
|
T |
FutureAdapter.get() |
T |
SettableListenableFuture.get()
Retrieve the value.
|
T |
FutureAdapter.get(long timeout,
TimeUnit unit) |
T |
SettableListenableFuture.get(long timeout,
TimeUnit unit)
Retrieve the value.
|
Modifier and Type | Method and Description |
---|---|
void |
SuccessCallback.onSuccess(T result)
Called when the
ListenableFuture completes with success. |
boolean |
SettableListenableFuture.set(T value)
Set the value of this future.
|
void |
ListenableFutureCallbackRegistry.success(T result)
Trigger a
SuccessCallback.onSuccess(Object) call on all
added callbacks with the given result. |
Constructor and Description |
---|
ListenableFutureTask(Runnable runnable,
T result)
Create a
ListenableFutureTask that will, upon running,
execute the given Runnable , and arrange that FutureTask.get()
will return the given result on successful completion. |
Modifier and Type | Method and Description |
---|---|
T |
SingletonSupplier.get()
Get the shared singleton instance for this supplier.
|
static <T> SingletonSupplier<T> |
SingletonSupplier.ofNullable(Supplier<T> supplier)
Build a
SingletonSupplier with the given supplier. |
static <T> SingletonSupplier<T> |
SingletonSupplier.ofNullable(T instance)
Build a
SingletonSupplier with the given singleton instance. |
static <T> T |
SupplierUtils.resolve(Supplier<T> supplier)
Resolve the given
Supplier , getting its result or immediately
returning null if the supplier itself was null . |
Modifier and Type | Method and Description |
---|---|
static <T> SingletonSupplier<T> |
SingletonSupplier.ofNullable(Supplier<T> supplier)
Build a
SingletonSupplier with the given supplier. |
static <T> SingletonSupplier<T> |
SingletonSupplier.ofNullable(T instance)
Build a
SingletonSupplier with the given singleton instance. |
static <T> T |
SupplierUtils.resolve(Supplier<T> supplier)
Resolve the given
Supplier , getting its result or immediately
returning null if the supplier itself was null . |
Constructor and Description |
---|
SingletonSupplier(Supplier<? extends T> instanceSupplier,
Supplier<? extends T> defaultSupplier)
Build a
SingletonSupplier with the given instance supplier
and a default supplier for the case when the instance is null . |
SingletonSupplier(T instance,
Supplier<? extends T> defaultSupplier)
Build a
SingletonSupplier with the given singleton instance
and a default supplier for the case when the instance is null . |
Modifier and Type | Method and Description |
---|---|
boolean |
DataSize.equals(Object other) |
static DataSize |
DataSize.parse(CharSequence text,
DataUnit defaultUnit)
|
Modifier and Type | Method and Description |
---|---|
static Element |
DomUtils.getChildElementByTagName(Element ele,
String childEleName)
Utility method that returns the first child element identified by its name.
|
static String |
DomUtils.getChildElementValueByTagName(Element ele,
String childEleName)
Utility method that returns the first child element value identified by its name.
|
String |
SimpleNamespaceContext.getPrefix(String namespaceUri) |
static XMLEventReader |
StaxUtils.getXMLEventReader(Source source)
Return the
XMLEventReader for the given StAX Source. |
static XMLEventWriter |
StaxUtils.getXMLEventWriter(Result result)
Return the
XMLEventWriter for the given StAX Result. |
static XMLStreamReader |
StaxUtils.getXMLStreamReader(Source source)
Return the
XMLStreamReader for the given StAX Source. |
static XMLStreamWriter |
StaxUtils.getXMLStreamWriter(Result result)
Return the
XMLStreamWriter for the given StAX Result. |
Modifier and Type | Method and Description |
---|---|
void |
SimpleNamespaceContext.removeBinding(String prefix)
Remove the given prefix from this context.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
PropertyEditor |
DataBinder.findCustomEditor(Class<?> requiredType,
String propertyPath) |
PropertyEditor |
BindException.findEditor(String field,
Class valueType) |
PropertyEditor |
AbstractBindingResult.findEditor(String field,
Class<?> valueType)
This implementation delegates to the
PropertyEditorRegistry 's
editor lookup facility, if available. |
PropertyEditor |
BindingResult.findEditor(String field,
Class<?> valueType)
Find a custom property editor for the given type and property.
|
PropertyEditor |
AbstractPropertyBindingResult.findEditor(String field,
Class<?> valueType)
This implementation exposes a PropertyEditor adapter for a Formatter,
if applicable.
|
protected Object |
AbstractBindingResult.formatFieldValue(String field,
Object value)
Format the given value for the specified field.
|
protected abstract Object |
AbstractBindingResult.getActualFieldValue(String field)
Extract the actual field value for the given field.
|
protected Object |
MapBindingResult.getActualFieldValue(String field) |
protected Object |
AbstractPropertyBindingResult.getActualFieldValue(String field)
Fetches the field value from the PropertyAccessor.
|
String[] |
DataBinder.getAllowedFields()
Return the field patterns that should be allowed for binding.
|
static BindingResult |
BindingResultUtils.getBindingResult(Map<?,?> model,
String name)
Find the BindingResult for the given name in the given model.
|
ConversionService |
DataBinder.getConversionService()
Return the associated ConversionService, if any.
|
protected PropertyEditor |
AbstractPropertyBindingResult.getCustomEditor(String fixedField)
Retrieve the custom PropertyEditor for the given field, if any.
|
String[] |
DataBinder.getDisallowedFields()
Return the field patterns that should not be allowed for binding.
|
FieldError |
AbstractBindingResult.getFieldError() |
FieldError |
BindException.getFieldError() |
FieldError |
AbstractErrors.getFieldError() |
FieldError |
Errors.getFieldError()
Get the first error associated with a field, if any.
|
FieldError |
AbstractBindingResult.getFieldError(String field) |
FieldError |
BindException.getFieldError(String field) |
FieldError |
AbstractErrors.getFieldError(String field) |
FieldError |
Errors.getFieldError(String field)
Get the first error associated with the given field, if any.
|
Class<?> |
AbstractBindingResult.getFieldType(String field)
This default implementation determines the type based on the actual
field value, if any.
|
Class<?> |
BindException.getFieldType(String field) |
Class<?> |
AbstractPropertyBindingResult.getFieldType(String field)
Determines the field type from the property type.
|
Class<?> |
AbstractErrors.getFieldType(String field) |
Class<?> |
Errors.getFieldType(String field)
Determine the type of the given field, as far as possible.
|
Object |
AbstractBindingResult.getFieldValue(String field) |
Object |
BindException.getFieldValue(String field) |
Object |
Errors.getFieldValue(String field)
Return the current value of the given field, either the current
bean property value or a rejected update from the last binding.
|
ObjectError |
AbstractBindingResult.getGlobalError() |
ObjectError |
BindException.getGlobalError() |
ObjectError |
AbstractErrors.getGlobalError() |
ObjectError |
Errors.getGlobalError()
Get the first global error, if any.
|
PropertyEditorRegistry |
AbstractBindingResult.getPropertyEditorRegistry()
This implementation returns
null . |
PropertyEditorRegistry |
BindException.getPropertyEditorRegistry() |
PropertyEditorRegistry |
BindingResult.getPropertyEditorRegistry()
Return the underlying PropertyEditorRegistry.
|
Object |
AbstractBindingResult.getRawFieldValue(String field) |
Object |
BindException.getRawFieldValue(String field) |
Object |
BindingResult.getRawFieldValue(String field)
Extract the raw field value for the given field.
|
Object |
FieldError.getRejectedValue()
Return the rejected field value.
|
String[] |
DataBinder.getRequiredFields()
Return the fields that are required for each binding process.
|
abstract Object |
AbstractBindingResult.getTarget()
Return the wrapped target object.
|
Object |
BindException.getTarget() |
Object |
DataBinder.getTarget()
Return the wrapped target object.
|
Object |
BindingResult.getTarget()
Return the wrapped target object, which may be a bean, an object with
public fields, a Map - depending on the concrete binding strategy.
|
Object |
BeanPropertyBindingResult.getTarget() |
Object |
DirectFieldBindingResult.getTarget() |
Validator |
DataBinder.getValidator()
Return the primary Validator to apply after each binding step, if any.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
Field field) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
MethodParameter methodParam) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
<T> T |
DataBinder.convertIfNecessary(Object value,
Class<T> requiredType,
TypeDescriptor typeDescriptor) |
protected void |
AbstractErrors.doSetNestedPath(String nestedPath)
Actually set the nested path.
|
boolean |
FieldError.equals(Object other) |
boolean |
AbstractBindingResult.equals(Object other) |
boolean |
BindException.equals(Object other) |
boolean |
ObjectError.equals(Object other) |
PropertyEditor |
DataBinder.findCustomEditor(Class<?> requiredType,
String propertyPath) |
PropertyEditor |
DataBinder.findCustomEditor(Class<?> requiredType,
String propertyPath) |
PropertyEditor |
BindException.findEditor(String field,
Class valueType) |
PropertyEditor |
BindException.findEditor(String field,
Class valueType) |
PropertyEditor |
AbstractBindingResult.findEditor(String field,
Class<?> valueType)
This implementation delegates to the
PropertyEditorRegistry 's
editor lookup facility, if available. |
PropertyEditor |
AbstractBindingResult.findEditor(String field,
Class<?> valueType)
This implementation delegates to the
PropertyEditorRegistry 's
editor lookup facility, if available. |
PropertyEditor |
BindingResult.findEditor(String field,
Class<?> valueType)
Find a custom property editor for the given type and property.
|
PropertyEditor |
BindingResult.findEditor(String field,
Class<?> valueType)
Find a custom property editor for the given type and property.
|
PropertyEditor |
AbstractPropertyBindingResult.findEditor(String field,
Class<?> valueType)
This implementation exposes a PropertyEditor adapter for a Formatter,
if applicable.
|
PropertyEditor |
AbstractPropertyBindingResult.findEditor(String field,
Class<?> valueType)
This implementation exposes a PropertyEditor adapter for a Formatter,
if applicable.
|
protected String |
AbstractErrors.fixedField(String field)
Transform the given field into its full path,
regarding the nested path of this instance.
|
String |
MessageCodeFormatter.format(String errorCode,
String objectName,
String field)
Build and return a message code consisting of the given fields,
usually delimited by
DefaultMessageCodesResolver.CODE_SEPARATOR . |
String |
MessageCodeFormatter.format(String errorCode,
String objectName,
String field)
Build and return a message code consisting of the given fields,
usually delimited by
DefaultMessageCodesResolver.CODE_SEPARATOR . |
protected Object |
AbstractBindingResult.formatFieldValue(String field,
Object value)
Format the given value for the specified field.
|
protected Object |
AbstractPropertyBindingResult.formatFieldValue(String field,
Object value)
Formats the field value based on registered PropertyEditors.
|
Class<?> |
AbstractBindingResult.getFieldType(String field)
This default implementation determines the type based on the actual
field value, if any.
|
Class<?> |
AbstractPropertyBindingResult.getFieldType(String field)
Determines the field type from the property type.
|
static void |
ValidationUtils.invokeValidator(Validator validator,
Object target,
Errors errors,
Object... validationHints)
|
void |
AbstractBindingResult.recordFieldValue(String field,
Class<?> type,
Object value) |
void |
BindException.recordFieldValue(String field,
Class<?> type,
Object value) |
default void |
BindingResult.recordFieldValue(String field,
Class<?> type,
Object value)
Record the given value for the specified field.
|
void |
DataBinder.registerCustomEditor(Class<?> requiredType,
String field,
PropertyEditor propertyEditor) |
void |
DataBinder.registerCustomEditor(Class<?> requiredType,
String field,
PropertyEditor propertyEditor) |
void |
AbstractBindingResult.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
AbstractBindingResult.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
BindException.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
BindException.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
Errors.reject(String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
Errors.reject(String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
static void |
ValidationUtils.rejectIfEmpty(Errors errors,
String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Reject the given field with the given error code, error arguments
and default message if the value is empty.
|
static void |
ValidationUtils.rejectIfEmpty(Errors errors,
String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Reject the given field with the given error code, error arguments
and default message if the value is empty.
|
static void |
ValidationUtils.rejectIfEmptyOrWhitespace(Errors errors,
String field,
String errorCode,
Object[] errorArgs)
Reject the given field with the given error code and error arguments
if the value is empty or just contains whitespace.
|
static void |
ValidationUtils.rejectIfEmptyOrWhitespace(Errors errors,
String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Reject the given field with the given error code, error arguments
and default message if the value is empty or just contains whitespace.
|
static void |
ValidationUtils.rejectIfEmptyOrWhitespace(Errors errors,
String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Reject the given field with the given error code, error arguments
and default message if the value is empty or just contains whitespace.
|
void |
BindException.rejectValue(String field,
String errorCode) |
void |
AbstractErrors.rejectValue(String field,
String errorCode) |
void |
Errors.rejectValue(String field,
String errorCode)
Register a field error for the specified field of the current object
(respecting the current nested path, if any), using the given error
description.
|
void |
AbstractBindingResult.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
AbstractBindingResult.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
AbstractBindingResult.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
BindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
BindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
BindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
Errors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a field error for the specified field of the current object
(respecting the current nested path, if any), using the given error
description.
|
void |
Errors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a field error for the specified field of the current object
(respecting the current nested path, if any), using the given error
description.
|
void |
Errors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a field error for the specified field of the current object
(respecting the current nested path, if any), using the given error
description.
|
void |
BindException.rejectValue(String field,
String errorCode,
String defaultMessage) |
void |
AbstractErrors.rejectValue(String field,
String errorCode,
String defaultMessage) |
void |
Errors.rejectValue(String field,
String errorCode,
String defaultMessage)
Register a field error for the specified field of the current object
(respecting the current nested path, if any), using the given error
description.
|
String[] |
AbstractBindingResult.resolveMessageCodes(String errorCode,
String field) |
String[] |
MessageCodesResolver.resolveMessageCodes(String errorCode,
String objectName,
String field,
Class<?> fieldType)
Build message codes for the given error code and field specification.
|
String[] |
DefaultMessageCodesResolver.resolveMessageCodes(String errorCode,
String objectName,
String field,
Class<?> fieldType)
Build the code list for the given code and field: an
object/field-specific code, a field-specific code, a plain error code.
|
void |
DataBinder.setAllowedFields(String... allowedFields)
Register field patterns that should be allowed for binding.
|
void |
DataBinder.setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting
property values, as an alternative to JavaBeans PropertyEditors.
|
void |
DataBinder.setDisallowedFields(String... disallowedFields)
Register field patterns that should not be allowed for binding.
|
void |
DefaultMessageCodesResolver.setMessageCodeFormatter(MessageCodeFormatter formatter)
Specify the format for message codes built by this resolver.
|
void |
DataBinder.setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Set the strategy to use for resolving errors into message codes.
|
void |
AbstractErrors.setNestedPath(String nestedPath) |
void |
DefaultMessageCodesResolver.setPrefix(String prefix)
Specify a prefix to be applied to any code built by this resolver.
|
void |
DataBinder.setRequiredFields(String... requiredFields)
Register fields that are required for each binding process.
|
void |
DataBinder.setValidator(Validator validator)
Set the Validator to apply after each binding step.
|
default void |
SmartValidator.validateValue(Class<?> targetType,
String fieldName,
Object value,
Errors errors,
Object... validationHints)
Validate the supplied value for the specified field on the target type,
reporting the same validation errors as if the value would be bound to
the field on an instance of the target class.
|
Constructor and Description |
---|
BeanPropertyBindingResult(Object target,
String objectName)
Create a new
BeanPropertyBindingResult for the given target. |
BeanPropertyBindingResult(Object target,
String objectName,
boolean autoGrowNestedPaths,
int autoGrowCollectionLimit)
Create a new
BeanPropertyBindingResult for the given target. |
DataBinder(Object target)
Create a new DataBinder instance, with default object name.
|
DataBinder(Object target,
String objectName)
Create a new DataBinder instance.
|
DirectFieldBindingResult(Object target,
String objectName)
Create a new
DirectFieldBindingResult for the given target. |
DirectFieldBindingResult(Object target,
String objectName,
boolean autoGrowNestedPaths)
Create a new
DirectFieldBindingResult for the given target. |
FieldError(String objectName,
String field,
Object rejectedValue,
boolean bindingFailure,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new FieldError instance.
|
FieldError(String objectName,
String field,
Object rejectedValue,
boolean bindingFailure,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new FieldError instance.
|
FieldError(String objectName,
String field,
Object rejectedValue,
boolean bindingFailure,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new FieldError instance.
|
FieldError(String objectName,
String field,
Object rejectedValue,
boolean bindingFailure,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new FieldError instance.
|
ObjectError(String objectName,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new instance of the ObjectError class.
|
ObjectError(String objectName,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new instance of the ObjectError class.
|
ObjectError(String objectName,
String[] codes,
Object[] arguments,
String defaultMessage)
Create a new instance of the ObjectError class.
|
Modifier and Type | Method and Description |
---|---|
static Object[] |
ValidationAnnotationUtils.determineValidationHints(Annotation ann)
Determine any validation hints by the given annotation.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
SpringValidatorAdapter.getRejectedValue(String field,
ConstraintViolation<Object> violation,
BindingResult bindingResult)
Extract the rejected value behind the given constraint violation,
for exposure through the Spring errors representation.
|
Object |
MethodValidationInterceptor.invoke(MethodInvocation invocation) |
Modifier and Type | Method and Description |
---|---|
protected Advice |
MethodValidationPostProcessor.createMethodValidationAdvice(Validator validator)
Create AOP advice for method validation purposes, to be applied
with a pointcut for the specified 'validated' annotation.
|
void |
LocalValidatorFactoryBean.setValidationPropertyMap(Map<String,String> validationProperties)
Specify bean validation properties to be passed to the validation provider as a Map.
|
<T> T |
LocalValidatorFactoryBean.unwrap(Class<T> type) |
<T> T |
SpringValidatorAdapter.unwrap(Class<T> type) |
void |
SpringValidatorAdapter.validateValue(Class<?> targetType,
String fieldName,
Object value,
Errors errors,
Object... validationHints) |
Modifier and Type | Method and Description |
---|---|
Object |
BindingAwareConcurrentModel.put(String key,
Object value) |
Modifier and Type | Method and Description |
---|---|
Object |
BindingAwareConcurrentModel.put(String key,
Object value) |
Object |
BindingAwareModelMap.put(String key,
Object value) |
Modifier and Type | Method and Description |
---|---|
MediaType |
HttpMediaTypeNotSupportedException.getContentType()
Return the HTTP request content type method that caused the failure.
|
String |
HttpSessionRequiredException.getExpectedAttribute()
Return the name of the expected session attribute, if any.
|
Set<HttpMethod> |
HttpRequestMethodNotSupportedException.getSupportedHttpMethods()
Return the actually supported HTTP methods as
HttpMethod instances,
or null if not known. |
String[] |
HttpRequestMethodNotSupportedException.getSupportedMethods()
Return the actually supported HTTP methods, or
null if not known. |
Modifier and Type | Method and Description |
---|---|
void |
SpringServletContainerInitializer.onStartup(Set<Class<?>> webAppInitializerClasses,
ServletContext servletContext)
Delegate the
ServletContext to any WebApplicationInitializer
implementations present on the application classpath. |
Constructor and Description |
---|
HttpMediaTypeNotSupportedException(MediaType contentType,
List<MediaType> supportedMediaTypes)
Create a new HttpMediaTypeNotSupportedException.
|
HttpMediaTypeNotSupportedException(MediaType contentType,
List<MediaType> supportedMediaTypes,
String msg)
Create a new HttpMediaTypeNotSupportedException.
|
HttpRequestMethodNotSupportedException(String method,
Collection<String> supportedMethods)
Create a new HttpRequestMethodNotSupportedException.
|
HttpRequestMethodNotSupportedException(String method,
String[] supportedMethods)
Create a new HttpRequestMethodNotSupportedException.
|
HttpRequestMethodNotSupportedException(String method,
String[] supportedMethods,
String msg)
Create a new HttpRequestMethodNotSupportedException.
|
Modifier and Type | Method and Description |
---|---|
MediaType |
PathExtensionContentNegotiationStrategy.getMediaTypeForResource(Resource resource)
Deprecated.
|
protected String |
PathExtensionContentNegotiationStrategy.getMediaTypeKey(NativeWebRequest webRequest)
Deprecated.
|
protected abstract String |
AbstractMappingContentNegotiationStrategy.getMediaTypeKey(NativeWebRequest request)
Extract a key from the request to use to look up media types.
|
protected String |
ParameterContentNegotiationStrategy.getMediaTypeKey(NativeWebRequest request) |
ContentNegotiationManager |
ContentNegotiationManagerFactoryBean.getObject() |
<T extends ContentNegotiationStrategy> |
ContentNegotiationManager.getStrategy(Class<T> strategyType)
Find a
ContentNegotiationStrategy of the given type. |
protected MediaType |
ServletPathExtensionContentNegotiationStrategy.handleNoMatch(NativeWebRequest webRequest,
String extension)
Deprecated.
Resolve file extension via
ServletContext.getMimeType(String)
and also delegate to base class for a potential
MediaTypeFactory lookup. |
protected MediaType |
AbstractMappingContentNegotiationStrategy.handleNoMatch(NativeWebRequest request,
String key)
Override to provide handling when a key is not resolved via.
|
protected MediaType |
MappingMediaTypeFileExtensionResolver.lookupMediaType(String extension)
Use this method for a reverse lookup from extension to MediaType.
|
Modifier and Type | Method and Description |
---|---|
void |
ContentNegotiationManagerFactoryBean.addMediaTypes(Map<String,MediaType> mediaTypes)
An alternative to
ContentNegotiationManagerFactoryBean.setMediaTypes(java.util.Properties) for programmatic registrations. |
List<MediaType> |
AbstractMappingContentNegotiationStrategy.resolveMediaTypeKey(NativeWebRequest webRequest,
String key)
An alternative to
AbstractMappingContentNegotiationStrategy.resolveMediaTypes(NativeWebRequest) that accepts
an already extracted key. |
void |
ContentNegotiationManagerFactoryBean.setStrategies(List<ContentNegotiationStrategy> strategies)
Set the exact list of strategies to use.
|
Constructor and Description |
---|
AbstractMappingContentNegotiationStrategy(Map<String,MediaType> mediaTypes)
Create an instance with the given map of file extensions and media types.
|
MappingMediaTypeFileExtensionResolver(Map<String,MediaType> mediaTypes)
Create an instance with the given map of file extensions and media types.
|
PathExtensionContentNegotiationStrategy(Map<String,MediaType> mediaTypes)
Deprecated.
Create an instance with the given map of file extensions and media types.
|
ServletPathExtensionContentNegotiationStrategy(ServletContext servletContext,
Map<String,MediaType> mediaTypes)
Deprecated.
Create an instance with the given extension-to-MediaType lookup.
|
Modifier and Type | Method and Description |
---|---|
static Boolean |
ServletRequestUtils.getBooleanParameter(ServletRequest request,
String name)
Get a Boolean parameter, or
null if not present. |
static Double |
ServletRequestUtils.getDoubleParameter(ServletRequest request,
String name)
Get a Double parameter, or
null if not present. |
Object |
WebDataBinder.getEmptyValue(Class<?> fieldType)
Determine an empty value for the specified field.
|
protected Object |
WebDataBinder.getEmptyValue(String field,
Class<?> fieldType)
Determine an empty value for the specified field.
|
String |
WebDataBinder.getFieldDefaultPrefix()
Return the prefix for parameters that mark default fields.
|
FieldError |
EscapedErrors.getFieldError() |
FieldError |
EscapedErrors.getFieldError(String field) |
String |
WebDataBinder.getFieldMarkerPrefix()
Return the prefix for parameters that mark potentially empty fields.
|
Class<?> |
EscapedErrors.getFieldType(String field) |
Object |
EscapedErrors.getFieldValue(String field) |
static Float |
ServletRequestUtils.getFloatParameter(ServletRequest request,
String name)
Get a Float parameter, or
null if not present. |
ObjectError |
EscapedErrors.getGlobalError() |
static Integer |
ServletRequestUtils.getIntParameter(ServletRequest request,
String name)
Get an Integer parameter, or
null if not present. |
static Long |
ServletRequestUtils.getLongParameter(ServletRequest request,
String name)
Get a Long parameter, or
null if not present. |
static String |
ServletRequestUtils.getStringParameter(ServletRequest request,
String name)
Get a String parameter, or
null if not present. |
Modifier and Type | Method and Description |
---|---|
protected Object |
WebDataBinder.getEmptyValue(String field,
Class<?> fieldType)
Determine an empty value for the specified field.
|
void |
EscapedErrors.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
EscapedErrors.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
EscapedErrors.rejectValue(String field,
String errorCode) |
void |
EscapedErrors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
EscapedErrors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
EscapedErrors.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
EscapedErrors.rejectValue(String field,
String errorCode,
String defaultMessage) |
void |
WebDataBinder.setFieldDefaultPrefix(String fieldDefaultPrefix)
Specify a prefix that can be used for parameters that indicate default
value fields, having "prefix + field" as name.
|
void |
WebDataBinder.setFieldMarkerPrefix(String fieldMarkerPrefix)
Specify a prefix that can be used for parameters that mark potentially
empty fields, having "prefix + field" as name.
|
Constructor and Description |
---|
ServletRequestDataBinder(Object target)
Create a new ServletRequestDataBinder instance, with default object name.
|
ServletRequestDataBinder(Object target,
String objectName)
Create a new ServletRequestDataBinder instance.
|
ServletRequestParameterPropertyValues(ServletRequest request,
String prefix)
Create new ServletRequestPropertyValues using the given prefix and
the default prefix separator (the underscore character "_").
|
ServletRequestParameterPropertyValues(ServletRequest request,
String prefix,
String prefixSeparator)
Create new ServletRequestPropertyValues supplying both prefix and
prefix separator.
|
ServletRequestParameterPropertyValues(ServletRequest request,
String prefix,
String prefixSeparator)
Create new ServletRequestPropertyValues supplying both prefix and
prefix separator.
|
WebDataBinder(Object target)
Create a new WebDataBinder instance, with default object name.
|
WebDataBinder(Object target,
String objectName)
Create a new WebDataBinder instance.
|
Modifier and Type | Method and Description |
---|---|
PropertyEditor |
WebExchangeBindException.findEditor(String field,
Class valueType) |
BindingErrorProcessor |
ConfigurableWebBindingInitializer.getBindingErrorProcessor()
Return the strategy to use for processing binding errors.
|
ConversionService |
ConfigurableWebBindingInitializer.getConversionService()
Return the ConversionService which will apply to every DataBinder.
|
FieldError |
WebExchangeBindException.getFieldError() |
FieldError |
WebExchangeBindException.getFieldError(String field) |
Class<?> |
WebExchangeBindException.getFieldType(String field) |
Object |
WebExchangeBindException.getFieldValue(String field) |
ObjectError |
WebExchangeBindException.getGlobalError() |
MessageCodesResolver |
ConfigurableWebBindingInitializer.getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.
|
PropertyEditorRegistrar[] |
ConfigurableWebBindingInitializer.getPropertyEditorRegistrars()
Return the PropertyEditorRegistrars to be applied to every DataBinder.
|
PropertyEditorRegistry |
WebExchangeBindException.getPropertyEditorRegistry() |
Object |
WebExchangeBindException.getRawFieldValue(String field) |
Object |
WebExchangeBindException.getTarget() |
Validator |
ConfigurableWebBindingInitializer.getValidator()
Return the Validator to apply after each binding step, if any.
|
Object |
WebArgumentResolver.resolveArgument(MethodParameter methodParameter,
NativeWebRequest webRequest)
Resolve an argument for the given handler method parameter within the given web request.
|
Object |
DefaultSessionAttributeStore.retrieveAttribute(WebRequest request,
String attributeName) |
Object |
SessionAttributeStore.retrieveAttribute(WebRequest request,
String attributeName)
Retrieve the specified attribute from the backend session.
|
Modifier and Type | Method and Description |
---|---|
WebDataBinder |
WebDataBinderFactory.createBinder(NativeWebRequest webRequest,
Object target,
String objectName)
Create a
WebDataBinder for the given object. |
WebDataBinder |
DefaultDataBinderFactory.createBinder(NativeWebRequest webRequest,
Object target,
String objectName)
Create a new
WebDataBinder for the given target object and
initialize it through a WebBindingInitializer . |
protected WebDataBinder |
DefaultDataBinderFactory.createBinderInstance(Object target,
String objectName,
NativeWebRequest webRequest)
Extension point to create the WebDataBinder instance.
|
boolean |
WebExchangeBindException.equals(Object other) |
PropertyEditor |
WebExchangeBindException.findEditor(String field,
Class valueType) |
PropertyEditor |
WebExchangeBindException.findEditor(String field,
Class valueType) |
void |
WebExchangeBindException.recordFieldValue(String field,
Class<?> type,
Object value) |
void |
WebExchangeBindException.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
WebExchangeBindException.reject(String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
WebExchangeBindException.rejectValue(String field,
String errorCode) |
void |
WebExchangeBindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
WebExchangeBindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
WebExchangeBindException.rejectValue(String field,
String errorCode,
Object[] errorArgs,
String defaultMessage) |
void |
WebExchangeBindException.rejectValue(String field,
String errorCode,
String defaultMessage) |
void |
DefaultSessionAttributeStore.setAttributeNamePrefix(String attributeNamePrefix)
Specify a prefix to use for the attribute names in the backend session.
|
void |
ConfigurableWebBindingInitializer.setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor)
Set the strategy to use for processing binding errors, that is,
required field errors and
PropertyAccessException s. |
void |
ConfigurableWebBindingInitializer.setConversionService(ConversionService conversionService)
Specify a ConversionService which will apply to every DataBinder.
|
void |
ConfigurableWebBindingInitializer.setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Set the strategy to use for resolving errors into message codes.
|
void |
ConfigurableWebBindingInitializer.setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars)
Specify multiple PropertyEditorRegistrars to be applied to every DataBinder.
|
void |
ConfigurableWebBindingInitializer.setValidator(Validator validator)
Set the Validator to apply after each binding step.
|
Constructor and Description |
---|
DefaultDataBinderFactory(WebBindingInitializer initializer)
Create a new
DefaultDataBinderFactory instance. |
WebExchangeDataBinder(Object target)
Create a new instance, with default object name.
|
WebExchangeDataBinder(Object target,
String objectName)
Create a new instance.
|
WebRequestDataBinder(Object target)
Create a new WebRequestDataBinder instance, with default object name.
|
WebRequestDataBinder(Object target,
String objectName)
Create a new WebRequestDataBinder instance.
|
Modifier and Type | Method and Description |
---|---|
protected <T> T |
RestTemplate.doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
T |
ResponseExtractor.extractData(ClientHttpResponse response)
Extract data from the given
ClientHttpResponse and return it. |
protected Charset |
DefaultResponseErrorHandler.getCharset(ClientHttpResponse response)
Determine the charset of the response (for inclusion in a status exception).
|
<T> T |
RestOperations.getForObject(String url,
Class<T> responseType,
Map<String,?> uriVariables)
Retrieve a representation by doing a GET on the URI template.
|
<T> T |
RestTemplate.getForObject(String url,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> T |
RestOperations.getForObject(String url,
Class<T> responseType,
Object... uriVariables)
Retrieve a representation by doing a GET on the specified URL.
|
<T> T |
RestTemplate.getForObject(String url,
Class<T> responseType,
Object... uriVariables) |
<T> T |
RestOperations.getForObject(URI url,
Class<T> responseType)
Retrieve a representation by doing a GET on the URL.
|
<T> T |
RestTemplate.getForObject(URI url,
Class<T> responseType) |
HttpHeaders |
UnknownContentTypeException.getResponseHeaders()
Return the HTTP response headers.
|
HttpHeaders |
RestClientResponseException.getResponseHeaders()
Return the HTTP response headers.
|
<T> T |
RestOperations.patchForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> T |
RestOperations.patchForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables) |
<T> T |
RestOperations.patchForObject(URI url,
Object request,
Class<T> responseType)
Update a resource by PATCHing the given object to the URL,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(URI url,
Object request,
Class<T> responseType) |
URI |
RestOperations.postForLocation(String url,
Object request,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template, and return the value of
the
Location header. |
URI |
RestTemplate.postForLocation(String url,
Object request,
Map<String,?> uriVariables) |
URI |
RestOperations.postForLocation(String url,
Object request,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template, and return the value of
the
Location header. |
URI |
RestTemplate.postForLocation(String url,
Object request,
Object... uriVariables) |
URI |
RestOperations.postForLocation(URI url,
Object request)
Create a new resource by POSTing the given object to the URL, and return the value of the
Location header. |
URI |
RestTemplate.postForLocation(URI url,
Object request) |
<T> T |
RestOperations.postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> T |
RestOperations.postForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables) |
<T> T |
RestOperations.postForObject(URI url,
Object request,
Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(URI url,
Object request,
Class<T> responseType) |
Modifier and Type | Method and Description |
---|---|
static HttpClientErrorException |
HttpClientErrorException.create(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create
HttpClientErrorException or an HTTP status specific subclass. |
static HttpServerErrorException |
HttpServerErrorException.create(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create an
HttpServerErrorException or an HTTP status specific subclass. |
static HttpClientErrorException |
HttpClientErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpClientErrorException.create(HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
static HttpClientErrorException |
HttpClientErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpClientErrorException.create(HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
static HttpServerErrorException |
HttpServerErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpServerErrorException.create(String, HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
static HttpServerErrorException |
HttpServerErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpServerErrorException.create(String, HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
protected <T> ListenableFuture<T> |
AsyncRestTemplate.doExecute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
Execute the given method on the provided URI.
|
protected <T> ListenableFuture<T> |
AsyncRestTemplate.doExecute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
Execute the given method on the provided URI.
|
protected <T> T |
RestTemplate.doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
protected <T> T |
RestTemplate.doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
protected <T> T |
RestTemplate.doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
<T> ResponseEntity<T> |
RestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, writing the given request entity to the request,
and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Map<String,?> uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the
given request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Map<String,?> uriVariables)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Object... uriVariables)
Execute the HTTP method to the given URI template, writing the given request entity to the request,
and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Object... uriVariables) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Object... uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the
given request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Object... uriVariables)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Map<String,?> uriVariables) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Map<String,?> uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Map<String,?> uriVariables)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Object... uriVariables)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Object... uriVariables) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Object... uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Object... uriVariables)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType)
Execute the HTTP method to the given URI template, writing the given request entity to the request,
and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the
given request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType)
Deprecated.
|
<T> ListenableFuture<T> |
AsyncRestOperations.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, preparing the
request with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestOperations.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, preparing the
request with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Deprecated.
|
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Deprecated.
|
<T> ListenableFuture<T> |
AsyncRestOperations.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, preparing the
request with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestOperations.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Deprecated.
Asynchronously execute the HTTP method to the given URI template, preparing the
request with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Deprecated.
|
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(String url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Deprecated.
|
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestOperations.execute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
Asynchronously execute the HTTP method to the given URL, preparing the request
with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestOperations.execute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
Asynchronously execute the HTTP method to the given URL, preparing the request
with the
AsyncRequestCallback , and reading the response with a
ResponseExtractor . |
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
|
<T> ListenableFuture<T> |
AsyncRestTemplate.execute(URI url,
HttpMethod method,
AsyncRequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Deprecated.
|
<T> T |
RestOperations.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestOperations.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
<T> T |
RestTemplate.execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback , and reading the response with a ResponseExtractor . |
protected <T> AsyncRequestCallback |
AsyncRestTemplate.httpEntityCallback(HttpEntity<T> requestBody)
Deprecated.
Returns a request callback implementation that writes the given object to the
request stream.
|
protected <T> AsyncRequestCallback |
AsyncRestTemplate.httpEntityCallback(HttpEntity<T> request,
Type responseType)
Deprecated.
Returns a request callback implementation that writes the given object to the
request stream.
|
<T> RequestCallback |
RestTemplate.httpEntityCallback(Object requestBody)
Return a
RequestCallback implementation that writes the given
object to the request stream. |
<T> RequestCallback |
RestTemplate.httpEntityCallback(Object requestBody,
Type responseType)
Return a
RequestCallback implementation that:
Sets the request Accept header based on the given response
type, cross-checked against the configured message converters. |
<T> T |
RestOperations.patchForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> T |
RestOperations.patchForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables) |
<T> T |
RestOperations.patchForObject(URI url,
Object request,
Class<T> responseType)
Update a resource by PATCHing the given object to the URL,
and return the representation found in the response.
|
<T> T |
RestTemplate.patchForObject(URI url,
Object request,
Class<T> responseType) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.postForEntity(String url,
HttpEntity<?> request,
Class<T> responseType,
Map<String,?> uriVariables)
Deprecated.
Create a new resource by POSTing the given object to the URI template,
and asynchronously returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.postForEntity(String url,
HttpEntity<?> request,
Class<T> responseType,
Map<String,?> uriVariables)
Deprecated.
|
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.postForEntity(String url,
HttpEntity<?> request,
Class<T> responseType,
Object... uriVariables)
Deprecated.
Create a new resource by POSTing the given object to the URI template,
and asynchronously returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.postForEntity(String url,
HttpEntity<?> request,
Class<T> responseType,
Object... uriVariables)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.postForEntity(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the response as
HttpEntity . |
<T> ResponseEntity<T> |
RestTemplate.postForEntity(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> ResponseEntity<T> |
RestOperations.postForEntity(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.postForEntity(String url,
Object request,
Class<T> responseType,
Object... uriVariables) |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestOperations.postForEntity(URI url,
HttpEntity<?> request,
Class<T> responseType)
Deprecated.
Create a new resource by POSTing the given object to the URL,
and asynchronously returns the response as
ResponseEntity . |
<T> ListenableFuture<ResponseEntity<T>> |
AsyncRestTemplate.postForEntity(URI url,
HttpEntity<?> request,
Class<T> responseType)
Deprecated.
|
<T> ResponseEntity<T> |
RestOperations.postForEntity(URI url,
Object request,
Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and return the response as
ResponseEntity . |
<T> ResponseEntity<T> |
RestTemplate.postForEntity(URI url,
Object request,
Class<T> responseType) |
ListenableFuture<URI> |
AsyncRestOperations.postForLocation(String url,
HttpEntity<?> request,
Map<String,?> uriVariables)
Deprecated.
Create a new resource by POSTing the given object to the URI template, and
asynchronously returns the value of the
Location header. |
ListenableFuture<URI> |
AsyncRestTemplate.postForLocation(String url,
HttpEntity<?> request,
Map<String,?> uriVars)
Deprecated.
|
ListenableFuture<URI> |
AsyncRestOperations.postForLocation(String url,
HttpEntity<?> request,
Object... uriVariables)
Deprecated.
Create a new resource by POSTing the given object to the URI template, and
asynchronously returns the value of the
Location header. |
ListenableFuture<URI> |
AsyncRestTemplate.postForLocation(String url,
HttpEntity<?> request,
Object... uriVars)
Deprecated.
|
URI |
RestOperations.postForLocation(String url,
Object request,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template, and return the value of
the
Location header. |
URI |
RestTemplate.postForLocation(String url,
Object request,
Map<String,?> uriVariables) |
URI |
RestOperations.postForLocation(String url,
Object request,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template, and return the value of
the
Location header. |
URI |
RestTemplate.postForLocation(String url,
Object request,
Object... uriVariables) |
ListenableFuture<URI> |
AsyncRestOperations.postForLocation(URI url,
HttpEntity<?> request)
Deprecated.
Create a new resource by POSTing the given object to the URL, and asynchronously
returns the value of the
Location header. |
ListenableFuture<URI> |
AsyncRestTemplate.postForLocation(URI url,
HttpEntity<?> request)
Deprecated.
|
URI |
RestOperations.postForLocation(URI url,
Object request)
Create a new resource by POSTing the given object to the URL, and return the value of the
Location header. |
URI |
RestTemplate.postForLocation(URI url,
Object request) |
<T> T |
RestOperations.postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables) |
<T> T |
RestOperations.postForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables) |
<T> T |
RestOperations.postForObject(URI url,
Object request,
Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and return the representation found in the response.
|
<T> T |
RestTemplate.postForObject(URI url,
Object request,
Class<T> responseType) |
ListenableFuture<?> |
AsyncRestOperations.put(String url,
HttpEntity<?> request,
Map<String,?> uriVariables)
Deprecated.
Creates a new resource by PUTting the given object to URI template.
|
ListenableFuture<?> |
AsyncRestTemplate.put(String url,
HttpEntity<?> request,
Map<String,?> uriVars)
Deprecated.
|
ListenableFuture<?> |
AsyncRestOperations.put(String url,
HttpEntity<?> request,
Object... uriVariables)
Deprecated.
Create or update a resource by PUTting the given object to the URI.
|
ListenableFuture<?> |
AsyncRestTemplate.put(String url,
HttpEntity<?> request,
Object... uriVars)
Deprecated.
|
void |
RestOperations.put(String url,
Object request,
Map<String,?> uriVariables)
Creates a new resource by PUTting the given object to URI template.
|
void |
RestTemplate.put(String url,
Object request,
Map<String,?> uriVariables) |
void |
RestOperations.put(String url,
Object request,
Object... uriVariables)
Create or update a resource by PUTting the given object to the URI.
|
void |
RestTemplate.put(String url,
Object request,
Object... uriVariables) |
ListenableFuture<?> |
AsyncRestOperations.put(URI url,
HttpEntity<?> request)
Deprecated.
Creates a new resource by PUTting the given object to URL.
|
ListenableFuture<?> |
AsyncRestTemplate.put(URI url,
HttpEntity<?> request)
Deprecated.
|
void |
RestOperations.put(URI url,
Object request)
Creates a new resource by PUTting the given object to URL.
|
void |
RestTemplate.put(URI url,
Object request) |
Constructor and Description |
---|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, and content.
|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, and content.
|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content.
|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content.
|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content.
|
HttpClientErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content,
and a prepared message.
|
HttpClientErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content,
and a prepared message.
|
HttpClientErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content,
and a prepared message.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
byte[] body,
Charset charset)
Constructor with a status code and status text, and content.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
byte[] body,
Charset charset)
Constructor with a status code and status text, and content.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, and content.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, and content.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, and content.
|
HttpServerErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, content, and a
prepared message.
|
HttpServerErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, content, and a
prepared message.
|
HttpServerErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, content, and a
prepared message.
|
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, and content. |
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, and content. |
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
RestClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of with the given response data.
|
RestClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of with the given response data.
|
RestClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of with the given response data.
|
UnknownHttpStatusCodeException(int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(String message,
int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(String message,
int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(String message,
int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
Modifier and Type | Method and Description |
---|---|
protected abstract WebApplicationContext |
AbstractContextLoaderInitializer.createRootApplicationContext()
Create the "root" application context to be provided to the
ContextLoaderListener . |
String[] |
ConfigurableWebApplicationContext.getConfigLocations()
Return the config locations for this web application context,
or
null if none specified. |
static WebApplicationContext |
ContextLoader.getCurrentWebApplicationContext()
Obtain the Spring root web application context for the current thread
(i.e.
|
String |
ConfigurableWebApplicationContext.getNamespace()
Return the namespace for this web application context, if any.
|
protected ApplicationContextInitializer<?>[] |
AbstractContextLoaderInitializer.getRootApplicationContextInitializers()
Specify application context initializers to be applied to the root application
context that the
ContextLoaderListener is being created with. |
ServletConfig |
ConfigurableWebApplicationContext.getServletConfig()
Return the ServletConfig for this web application context, if any.
|
ServletContext |
WebApplicationContext.getServletContext()
Return the standard Servlet API ServletContext for this application.
|
protected ApplicationContext |
ContextLoader.loadParentContext(ServletContext servletContext)
Template method with default implementation (which may be overridden by a
subclass), to load or obtain an ApplicationContext instance which will be
used as the parent context of the root WebApplicationContext.
|
Modifier and Type | Method and Description |
---|---|
void |
ConfigurableWebEnvironment.initPropertySources(ServletContext servletContext,
ServletConfig servletConfig)
Replace any stub property source
instances acting as placeholders with real servlet context/config property sources
using the given parameters.
|
void |
ConfigurableWebEnvironment.initPropertySources(ServletContext servletContext,
ServletConfig servletConfig)
Replace any stub property source
instances acting as placeholders with real servlet context/config property sources
using the given parameters.
|
void |
ContextLoader.setContextInitializers(ApplicationContextInitializer<?>... initializers)
Specify which
ApplicationContextInitializer instances should be used
to initialize the application context used by this ContextLoader . |
void |
ConfigurableWebApplicationContext.setNamespace(String namespace)
Set the namespace for this web application context,
to be used for building a default context config location.
|
void |
ConfigurableWebApplicationContext.setServletConfig(ServletConfig servletConfig)
Set the ServletConfig for this web application context.
|
void |
ConfigurableWebApplicationContext.setServletContext(ServletContext servletContext)
Set the ServletContext for this web application context.
|
Modifier and Type | Method and Description |
---|---|
Object |
RequestAttributes.getAttribute(String name,
int scope)
Return the value for the scoped attribute of the given name, if any.
|
String |
RequestScope.getConversationId()
There is no conversation id concept for a request, so this method
returns
null . |
String |
FacesWebRequest.getHeader(String headerName) |
String |
ServletWebRequest.getHeader(String headerName) |
String |
WebRequest.getHeader(String headerName)
Return the request header of the given name, or
null if none. |
String[] |
FacesWebRequest.getHeaderValues(String headerName) |
String[] |
ServletWebRequest.getHeaderValues(String headerName) |
String[] |
WebRequest.getHeaderValues(String headerName)
Return the request header values for the given header name,
or
null if none. |
HttpMethod |
ServletWebRequest.getHttpMethod()
Return the HTTP method of the request.
|
<T> T |
NativeWebRequest.getNativeRequest(Class<T> requiredType)
Return the underlying native request object, if available.
|
Object |
NativeWebRequest.getNativeResponse()
Return the underlying native response object, if any.
|
<T> T |
NativeWebRequest.getNativeResponse(Class<T> requiredType)
Return the underlying native response object, if available.
|
String |
FacesWebRequest.getParameter(String paramName) |
String |
ServletWebRequest.getParameter(String paramName) |
String |
WebRequest.getParameter(String paramName)
Return the request parameter of the given name, or
null if none. |
String[] |
FacesWebRequest.getParameterValues(String paramName) |
String[] |
ServletWebRequest.getParameterValues(String paramName) |
String[] |
WebRequest.getParameterValues(String paramName)
Return the request parameter values for the given parameter name,
or
null if none. |
String |
FacesWebRequest.getRemoteUser() |
String |
ServletWebRequest.getRemoteUser() |
String |
WebRequest.getRemoteUser()
Return the remote user for this request, if any.
|
static RequestAttributes |
RequestContextHolder.getRequestAttributes()
Return the RequestAttributes currently bound to the thread.
|
HttpServletResponse |
ServletRequestAttributes.getResponse()
Exposes the native
HttpServletResponse that we're wrapping (if any). |
protected HttpSession |
ServletRequestAttributes.getSession(boolean allowCreate)
Exposes the
HttpSession that we're wrapping. |
Principal |
FacesWebRequest.getUserPrincipal() |
Principal |
ServletWebRequest.getUserPrincipal() |
Principal |
WebRequest.getUserPrincipal()
Return the user principal for this request, if any.
|
Object |
AbstractRequestAttributesScope.remove(String name) |
Object |
SessionScope.remove(String name) |
Object |
AbstractRequestAttributesScope.resolveContextualObject(String key) |
Object |
RequestAttributes.resolveReference(String key)
Resolve the contextual reference for the given key, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
WebRequestInterceptor.afterCompletion(WebRequest request,
Exception ex)
Callback after completion of request processing, that is, after rendering
the view.
|
boolean |
FacesWebRequest.checkNotModified(String eTag) |
boolean |
FacesWebRequest.checkNotModified(String etag,
long lastModifiedTimestamp) |
boolean |
ServletWebRequest.checkNotModified(String etag,
long lastModifiedTimestamp) |
boolean |
WebRequest.checkNotModified(String etag,
long lastModifiedTimestamp)
Check whether the requested resource has been modified given the
supplied
ETag (entity tag) and last-modified timestamp,
as determined by the application. |
<T> T |
FacesWebRequest.getNativeRequest(Class<T> requiredType) |
<T> T |
ServletWebRequest.getNativeRequest(Class<T> requiredType) |
<T> T |
NativeWebRequest.getNativeRequest(Class<T> requiredType)
Return the underlying native request object, if available.
|
<T> T |
FacesWebRequest.getNativeResponse(Class<T> requiredType) |
<T> T |
ServletWebRequest.getNativeResponse(Class<T> requiredType) |
<T> T |
NativeWebRequest.getNativeResponse(Class<T> requiredType)
Return the underlying native response object, if available.
|
protected boolean |
ServletRequestAttributes.isImmutableSessionAttribute(String name,
Object value)
Determine whether the given value is to be considered as an immutable session
attribute, that is, doesn't have to be re-set via
session.setAttribute
since its value cannot meaningfully change internally. |
void |
WebRequestInterceptor.postHandle(WebRequest request,
ModelMap model)
Intercept the execution of a request handler after its successful
invocation, right before view rendering (if any).
|
static void |
RequestContextHolder.setRequestAttributes(RequestAttributes attributes)
Bind the given RequestAttributes to the current thread,
not exposing it as inheritable for child threads.
|
static void |
RequestContextHolder.setRequestAttributes(RequestAttributes attributes,
boolean inheritable)
Bind the given RequestAttributes to the current thread.
|
Constructor and Description |
---|
ServletRequestAttributes(HttpServletRequest request,
HttpServletResponse response)
Create a new ServletRequestAttributes instance for the given request.
|
ServletWebRequest(HttpServletRequest request,
HttpServletResponse response)
Create a new ServletWebRequest instance for the given request/response pair.
|
Modifier and Type | Method and Description |
---|---|
AsyncWebRequest |
WebAsyncManager.getAsyncWebRequest()
Return the current
AsyncWebRequest . |
CallableProcessingInterceptor |
WebAsyncManager.getCallableInterceptor(Object key)
Get the
CallableProcessingInterceptor registered under the given key. |
Object |
WebAsyncManager.getConcurrentResult()
Get the result from concurrent handling.
|
Object[] |
WebAsyncManager.getConcurrentResultContext()
Get the additional processing context saved at the start of concurrent handling.
|
DeferredResultProcessingInterceptor |
WebAsyncManager.getDeferredResultInterceptor(Object key)
Get the
DeferredResultProcessingInterceptor registered under the given key. |
AsyncTaskExecutor |
WebAsyncTask.getExecutor()
Return the AsyncTaskExecutor to use for concurrent handling,
or
null if none specified. |
Object |
DeferredResult.getResult()
Return the result, or
null if the result wasn't set. |
Long |
WebAsyncTask.getTimeout()
Return the timeout value in milliseconds, or
null if no timeout is set. |
Modifier and Type | Method and Description |
---|---|
void |
AsyncWebRequest.setTimeout(Long timeout)
Set the time required for concurrent handling to complete.
|
Constructor and Description |
---|
DeferredResult(Long timeoutValue,
Object timeoutResult)
Create a DeferredResult with a timeout value and a default result to use
in case of timeout.
|
DeferredResult(Long timeoutValue,
Supplier<?> timeoutResult)
Variant of
DeferredResult(Long, Object) that accepts a dynamic
fallback value based on a Supplier . |
WebAsyncTask(Long timeout,
AsyncTaskExecutor executor,
Callable<V> callable)
Create a
WebAsyncTask with a timeout value, an executor instance, and a Callable. |
WebAsyncTask(Long timeout,
String executorName,
Callable<V> callable)
Create a
WebAsyncTask with a timeout value, an executor name, and a Callable . |
Modifier and Type | Method and Description |
---|---|
static WebApplicationContext |
WebApplicationContextUtils.findWebApplicationContext(ServletContext sc)
Find a unique
WebApplicationContext for this web app: either the
root web app context (preferred) or a unique WebApplicationContext
among the registered ServletContext attributes (typically coming
from a single DispatcherServlet in the current web application). |
Object |
ContextExposingHttpServletRequest.getAttribute(String name) |
protected BeanNameGenerator |
AnnotationConfigWebApplicationContext.getBeanNameGenerator()
Return the custom
BeanNameGenerator for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner , if any. |
String |
ServletContextScope.getConversationId() |
Throwable |
RequestHandledEvent.getFailureCause()
Return the cause of failure, if any.
|
String |
ServletContextResource.getFilename()
This implementation returns the name of the file that this ServletContext
resource refers to.
|
String |
AbstractRefreshableWebApplicationContext.getNamespace() |
String |
StaticWebApplicationContext.getNamespace() |
String |
GenericWebApplicationContext.getNamespace() |
Object |
ServletContextAttributeFactoryBean.getObject() |
String |
ServletContextParameterFactoryBean.getObject() |
String |
ServletConfigPropertySource.getProperty(String name) |
String |
ServletContextPropertySource.getProperty(String name) |
Object |
GroovyWebApplicationContext.getProperty(String property) |
protected ScopeMetadataResolver |
AnnotationConfigWebApplicationContext.getScopeMetadataResolver()
Return the custom
ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner , if any. |
protected ServletConfig |
ServletContextAwareProcessor.getServletConfig()
Returns the
ServletConfig to be injected or null . |
ServletConfig |
AbstractRefreshableWebApplicationContext.getServletConfig() |
ServletConfig |
StaticWebApplicationContext.getServletConfig() |
ServletConfig |
GenericWebApplicationContext.getServletConfig() |
protected ServletContext |
WebApplicationObjectSupport.getServletContext()
Return the current ServletContext.
|
protected ServletContext |
ServletContextAwareProcessor.getServletContext()
Returns the
ServletContext to be injected or null . |
ServletContext |
AbstractRefreshableWebApplicationContext.getServletContext() |
ServletContext |
StaticWebApplicationContext.getServletContext() |
ServletContext |
GenericWebApplicationContext.getServletContext() |
String |
RequestHandledEvent.getSessionId()
Return the id of the HTTP session, if any.
|
Theme |
AbstractRefreshableWebApplicationContext.getTheme(String themeName) |
Theme |
StaticWebApplicationContext.getTheme(String themeName) |
Theme |
GenericWebApplicationContext.getTheme(String themeName) |
String |
RequestHandledEvent.getUserName()
Return the name of the user that was associated with the request
(usually the UserPrincipal).
|
protected WebApplicationContext |
WebApplicationObjectSupport.getWebApplicationContext()
Return the current application context as WebApplicationContext.
|
static WebApplicationContext |
WebApplicationContextUtils.getWebApplicationContext(ServletContext sc)
Find the root
WebApplicationContext for this web app, typically
loaded via ContextLoaderListener . |
static WebApplicationContext |
WebApplicationContextUtils.getWebApplicationContext(ServletContext sc,
String attrName)
Find a custom
WebApplicationContext for this web app. |
Object |
ServletContextScope.remove(String name) |
Object |
ServletContextScope.resolveContextualObject(String key) |
Modifier and Type | Method and Description |
---|---|
boolean |
ServletContextResource.equals(Object other)
This implementation compares the underlying ServletContext resource locations.
|
void |
StandardServletEnvironment.initPropertySources(ServletContext servletContext,
ServletConfig servletConfig) |
void |
StandardServletEnvironment.initPropertySources(ServletContext servletContext,
ServletConfig servletConfig) |
static void |
WebApplicationContextUtils.initServletPropertySources(MutablePropertySources sources,
ServletContext servletContext,
ServletConfig servletConfig)
Replace
Servlet -based stub property sources with
actual instances populated with the given servletContext and
servletConfig objects. |
static void |
WebApplicationContextUtils.initServletPropertySources(MutablePropertySources sources,
ServletContext servletContext,
ServletConfig servletConfig)
Replace
Servlet -based stub property sources with
actual instances populated with the given servletContext and
servletConfig objects. |
static void |
WebApplicationContextUtils.registerEnvironmentBeans(ConfigurableListableBeanFactory bf,
ServletContext sc)
Register web-specific environment beans ("contextParameters", "contextAttributes")
with the given BeanFactory, as used by the WebApplicationContext.
|
static void |
WebApplicationContextUtils.registerEnvironmentBeans(ConfigurableListableBeanFactory bf,
ServletContext servletContext,
ServletConfig servletConfig)
Register web-specific environment beans ("contextParameters", "contextAttributes")
with the given BeanFactory, as used by the WebApplicationContext.
|
static void |
WebApplicationContextUtils.registerEnvironmentBeans(ConfigurableListableBeanFactory bf,
ServletContext servletContext,
ServletConfig servletConfig)
Register web-specific environment beans ("contextParameters", "contextAttributes")
with the given BeanFactory, as used by the WebApplicationContext.
|
static void |
WebApplicationContextUtils.registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory,
ServletContext sc)
Register web-specific scopes ("request", "session", "globalSession", "application")
with the given BeanFactory, as used by the WebApplicationContext.
|
void |
AnnotationConfigWebApplicationContext.setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
Set a custom
BeanNameGenerator for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner . |
void |
AbstractRefreshableWebApplicationContext.setNamespace(String namespace) |
void |
StaticWebApplicationContext.setNamespace(String namespace) |
void |
GenericWebApplicationContext.setNamespace(String namespace) |
void |
AnnotationConfigWebApplicationContext.setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)
Set a custom
ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner . |
void |
AbstractRefreshableWebApplicationContext.setServletConfig(ServletConfig servletConfig) |
void |
StaticWebApplicationContext.setServletConfig(ServletConfig servletConfig) |
void |
GenericWebApplicationContext.setServletConfig(ServletConfig servletConfig) |
void |
AbstractRefreshableWebApplicationContext.setServletContext(ServletContext servletContext) |
void |
StaticWebApplicationContext.setServletContext(ServletContext servletContext)
Set the ServletContext that this WebApplicationContext runs in.
|
void |
GenericWebApplicationContext.setServletContext(ServletContext servletContext)
Set the
ServletContext that this WebApplicationContext runs in. |
Constructor and Description |
---|
ContextExposingHttpServletRequest(HttpServletRequest originalRequest,
WebApplicationContext context,
Set<String> exposedContextBeanNames)
Create a new ContextExposingHttpServletRequest for the given request.
|
RequestHandledEvent(Object source,
String sessionId,
String userName,
long processingTimeMillis)
Create a new RequestHandledEvent with session information.
|
RequestHandledEvent(Object source,
String sessionId,
String userName,
long processingTimeMillis)
Create a new RequestHandledEvent with session information.
|
RequestHandledEvent(Object source,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new RequestHandledEvent with session information.
|
RequestHandledEvent(Object source,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new RequestHandledEvent with session information.
|
RequestHandledEvent(Object source,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new RequestHandledEvent with session information.
|
ServletContextAwareProcessor(ServletContext servletContext,
ServletConfig servletConfig)
Create a new ServletContextAwareProcessor for the given context and config.
|
ServletContextAwareProcessor(ServletContext servletContext,
ServletConfig servletConfig)
Create a new ServletContextAwareProcessor for the given context and config.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause,
int statusCode)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause,
int statusCode)
Create a new ServletRequestHandledEvent.
|
ServletRequestHandledEvent(Object source,
String requestUrl,
String clientAddress,
String method,
String servletName,
String sessionId,
String userName,
long processingTimeMillis,
Throwable failureCause,
int statusCode)
Create a new ServletRequestHandledEvent.
|
Modifier and Type | Method and Description |
---|---|
protected List<String> |
DefaultCorsProcessor.checkHeaders(CorsConfiguration config,
List<String> requestHeaders)
Check the headers and determine the headers for the response of a
pre-flight request.
|
List<String> |
CorsConfiguration.checkHeaders(List<String> requestHeaders)
Check the supplied request headers (or the headers listed in the
Access-Control-Request-Headers of a pre-flight request) against
the configured allowed headers. |
List<HttpMethod> |
CorsConfiguration.checkHttpMethod(HttpMethod requestMethod)
Check the HTTP request method (or the method from the
Access-Control-Request-Method header on a pre-flight request)
against the configured allowed methods. |
protected List<HttpMethod> |
DefaultCorsProcessor.checkMethods(CorsConfiguration config,
HttpMethod requestMethod)
Check the HTTP method and determine the methods for the response of a
pre-flight request.
|
protected String |
DefaultCorsProcessor.checkOrigin(CorsConfiguration config,
String requestOrigin)
Check the origin and determine the origin for the response.
|
String |
CorsConfiguration.checkOrigin(String origin)
Check the origin of the request against the configured allowed origins.
|
Boolean |
CorsConfiguration.getAllowCredentials()
Return the configured
allowCredentials flag, or null if none. |
List<String> |
CorsConfiguration.getAllowedHeaders()
Return the allowed actual request headers, or
null if none. |
List<String> |
CorsConfiguration.getAllowedMethods()
Return the allowed HTTP methods, or
null in which case
only "GET" and "HEAD" allowed. |
List<String> |
CorsConfiguration.getAllowedOriginPatterns()
Return the configured origins patterns to allow, or
null if none. |
List<String> |
CorsConfiguration.getAllowedOrigins()
Return the configured origins to allow, or
null if none. |
Boolean |
CorsConfiguration.getAllowPrivateNetwork()
Return the configured
allowPrivateNetwork flag, or null if none. |
CorsConfiguration |
CorsConfigurationSource.getCorsConfiguration(HttpServletRequest request)
Return a
CorsConfiguration based on the incoming request. |
CorsConfiguration |
UrlBasedCorsConfigurationSource.getCorsConfiguration(HttpServletRequest request) |
List<String> |
CorsConfiguration.getExposedHeaders()
Return the configured response headers to expose, or
null if none. |
Long |
CorsConfiguration.getMaxAge()
Return the configured
maxAge value, or null if none. |
Modifier and Type | Method and Description |
---|---|
void |
CorsConfiguration.addAllowedOrigin(String origin)
Variant of
CorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>) for adding one origin at a time. |
void |
CorsConfiguration.addAllowedOriginPattern(String originPattern)
Variant of
CorsConfiguration.setAllowedOriginPatterns(java.util.List<java.lang.String>) for adding one origin at a time. |
List<String> |
CorsConfiguration.checkHeaders(List<String> requestHeaders)
Check the supplied request headers (or the headers listed in the
Access-Control-Request-Headers of a pre-flight request) against
the configured allowed headers. |
List<HttpMethod> |
CorsConfiguration.checkHttpMethod(HttpMethod requestMethod)
Check the HTTP request method (or the method from the
Access-Control-Request-Method header on a pre-flight request)
against the configured allowed methods. |
protected List<HttpMethod> |
DefaultCorsProcessor.checkMethods(CorsConfiguration config,
HttpMethod requestMethod)
Check the HTTP method and determine the methods for the response of a
pre-flight request.
|
protected String |
DefaultCorsProcessor.checkOrigin(CorsConfiguration config,
String requestOrigin)
Check the origin and determine the origin for the response.
|
String |
CorsConfiguration.checkOrigin(String origin)
Check the origin of the request against the configured allowed origins.
|
CorsConfiguration |
CorsConfiguration.combine(CorsConfiguration other)
Combine the non-null properties of the supplied
CorsConfiguration with this one. |
boolean |
DefaultCorsProcessor.processRequest(CorsConfiguration config,
HttpServletRequest request,
HttpServletResponse response) |
boolean |
CorsProcessor.processRequest(CorsConfiguration configuration,
HttpServletRequest request,
HttpServletResponse response)
Process a request given a
CorsConfiguration . |
void |
CorsConfiguration.setAllowCredentials(Boolean allowCredentials)
Whether user credentials are supported.
|
void |
CorsConfiguration.setAllowedHeaders(List<String> allowedHeaders)
Set the list of headers that a pre-flight request can list as allowed
for use during an actual request.
|
void |
CorsConfiguration.setAllowedMethods(List<String> allowedMethods)
Set the HTTP methods to allow, e.g.
|
CorsConfiguration |
CorsConfiguration.setAllowedOriginPatterns(List<String> allowedOriginPatterns)
Alternative to
CorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>) that supports more flexible
origins patterns with "*" anywhere in the host name in addition to port
lists. |
void |
CorsConfiguration.setAllowedOrigins(List<String> origins)
A list of origins for which cross-origin requests are allowed.
|
void |
CorsConfiguration.setAllowPrivateNetwork(Boolean allowPrivateNetwork)
Whether private network access is supported for user-agents restricting such access by default.
|
void |
UrlBasedCorsConfigurationSource.setCorsConfigurations(Map<String,CorsConfiguration> corsConfigurations)
Set the CORS configuration mappings.
|
void |
CorsConfiguration.setExposedHeaders(List<String> exposedHeaders)
Set the list of response headers that an actual response might have
and can be exposed to the client.
|
void |
CorsConfiguration.setMaxAge(Long maxAge)
Configure how long, in seconds, the response from a pre-flight request
can be cached by clients.
|
Modifier and Type | Method and Description |
---|---|
protected List<String> |
DefaultCorsProcessor.checkHeaders(CorsConfiguration config,
List<String> requestHeaders)
Check the headers and determine the headers for the response of a
pre-flight request.
|
protected List<HttpMethod> |
DefaultCorsProcessor.checkMethods(CorsConfiguration config,
HttpMethod requestMethod)
Check the HTTP method and determine the methods for the response of a
pre-flight request.
|
protected String |
DefaultCorsProcessor.checkOrigin(CorsConfiguration config,
String requestOrigin)
Check the origin and determine the origin for the response.
|
CorsConfiguration |
CorsConfigurationSource.getCorsConfiguration(ServerWebExchange exchange)
Return a
CorsConfiguration based on the incoming request. |
CorsConfiguration |
UrlBasedCorsConfigurationSource.getCorsConfiguration(ServerWebExchange exchange) |
Modifier and Type | Method and Description |
---|---|
protected List<HttpMethod> |
DefaultCorsProcessor.checkMethods(CorsConfiguration config,
HttpMethod requestMethod)
Check the HTTP method and determine the methods for the response of a
pre-flight request.
|
protected String |
DefaultCorsProcessor.checkOrigin(CorsConfiguration config,
String requestOrigin)
Check the origin and determine the origin for the response.
|
boolean |
DefaultCorsProcessor.process(CorsConfiguration config,
ServerWebExchange exchange) |
boolean |
CorsProcessor.process(CorsConfiguration configuration,
ServerWebExchange exchange)
Process a request using the given
CorsConfiguration . |
void |
UrlBasedCorsConfigurationSource.setCorsConfigurations(Map<String,CorsConfiguration> configMap)
Set CORS configuration based on URL patterns.
|
Modifier and Type | Method and Description |
---|---|
protected WebApplicationContext |
DelegatingFilterProxy.findWebApplicationContext()
Return the
WebApplicationContext passed in at construction time, if available. |
String |
DelegatingFilterProxy.getContextAttribute()
Return the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext from which to load the delegate Filter bean. |
String |
CharacterEncodingFilter.getEncoding()
Return the configured encoding for requests and/or responses.
|
FilterConfig |
GenericFilterBean.getFilterConfig()
Make the FilterConfig of this filter available, if any.
|
protected String |
GenericFilterBean.getFilterName()
Make the name of this filter available to subclasses.
|
protected Predicate<String> |
AbstractRequestLoggingFilter.getHeaderPredicate()
The configured
headerPredicate . |
protected String |
AbstractRequestLoggingFilter.getMessagePayload(HttpServletRequest request)
Extracts the message payload portion of the message created by
AbstractRequestLoggingFilter.createMessage(HttpServletRequest, String, String) when
AbstractRequestLoggingFilter.isIncludePayload() returns true. |
protected String |
DelegatingFilterProxy.getTargetBeanName()
Return the name of the target bean in the Spring application context.
|
Modifier and Type | Method and Description |
---|---|
void |
DelegatingFilterProxy.setContextAttribute(String contextAttribute)
Set the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext from which to load the delegate Filter bean. |
void |
CharacterEncodingFilter.setEncoding(String encoding)
Set the encoding to use for requests.
|
void |
AbstractRequestLoggingFilter.setHeaderPredicate(Predicate<String> headerPredicate)
Configure a predicate for selecting which headers should be logged if
AbstractRequestLoggingFilter.setIncludeHeaders(boolean) is set to true . |
void |
DelegatingFilterProxy.setTargetBeanName(String targetBeanName)
Set the name of the target bean in the Spring application context.
|
Constructor and Description |
---|
DelegatingFilterProxy(String targetBeanName,
WebApplicationContext wac)
Create a new
DelegatingFilterProxy that will retrieve the named target
bean from the given Spring WebApplicationContext . |
Modifier and Type | Method and Description |
---|---|
NavigationHandler |
DecoratingNavigationHandler.getDecoratedNavigationHandler()
Return the fixed original NavigationHandler decorated by this handler, if any
(that is, if passed in through the constructor).
|
static Object |
FacesContextUtils.getSessionMutex(FacesContext fc)
Return the best available mutex for the given session:
that is, an object to synchronize on for the given session.
|
static WebApplicationContext |
FacesContextUtils.getWebApplicationContext(FacesContext fc)
Find the root
WebApplicationContext for this web app, typically
loaded via ContextLoaderListener . |
Modifier and Type | Method and Description |
---|---|
protected void |
DecoratingNavigationHandler.callNextHandlerInChain(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Method to be called by subclasses when intending to delegate to the next
handler in the NavigationHandler chain.
|
protected void |
DecoratingNavigationHandler.callNextHandlerInChain(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Method to be called by subclasses when intending to delegate to the next
handler in the NavigationHandler chain.
|
protected void |
DecoratingNavigationHandler.callNextHandlerInChain(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Method to be called by subclasses when intending to delegate to the next
handler in the NavigationHandler chain.
|
abstract void |
DecoratingNavigationHandler.handleNavigation(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Special
handleNavigation variant with explicit NavigationHandler
argument. |
abstract void |
DecoratingNavigationHandler.handleNavigation(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Special
handleNavigation variant with explicit NavigationHandler
argument. |
abstract void |
DecoratingNavigationHandler.handleNavigation(FacesContext facesContext,
String fromAction,
String outcome,
NavigationHandler originalNavigationHandler)
Special
handleNavigation variant with explicit NavigationHandler
argument. |
Modifier and Type | Method and Description |
---|---|
Iterator<FeatureDescriptor> |
SpringBeanFacesELResolver.getFeatureDescriptors(ELContext elContext,
Object base) |
Iterator<FeatureDescriptor> |
WebApplicationContextFacesELResolver.getFeatureDescriptors(ELContext elContext,
Object base) |
Class<?> |
SpringBeanFacesELResolver.getType(ELContext elContext,
Object base,
Object property) |
Class<?> |
WebApplicationContextFacesELResolver.getType(ELContext elContext,
Object base,
Object property) |
Object |
SpringBeanFacesELResolver.getValue(ELContext elContext,
Object base,
Object property) |
Object |
WebApplicationContextFacesELResolver.getValue(ELContext elContext,
Object base,
Object property) |
protected WebApplicationContext |
WebApplicationContextFacesELResolver.getWebApplicationContext(ELContext elContext)
Retrieve the
WebApplicationContext reference to expose. |
Modifier and Type | Method and Description |
---|---|
Class<?> |
SpringBeanFacesELResolver.getCommonPropertyType(ELContext elContext,
Object base) |
Iterator<FeatureDescriptor> |
SpringBeanFacesELResolver.getFeatureDescriptors(ELContext elContext,
Object base) |
Class<?> |
SpringBeanFacesELResolver.getType(ELContext elContext,
Object base,
Object property) |
Class<?> |
WebApplicationContextFacesELResolver.getType(ELContext elContext,
Object base,
Object property) |
Object |
SpringBeanFacesELResolver.getValue(ELContext elContext,
Object base,
Object property) |
Object |
WebApplicationContextFacesELResolver.getValue(ELContext elContext,
Object base,
Object property) |
boolean |
SpringBeanFacesELResolver.isReadOnly(ELContext elContext,
Object base,
Object property) |
void |
SpringBeanFacesELResolver.setValue(ELContext elContext,
Object base,
Object property,
Object value) |
Modifier and Type | Method and Description |
---|---|
protected static Object |
HandlerMethod.findProvidedArgument(MethodParameter parameter,
Object... providedArgs) |
Class<?> |
ControllerAdviceBean.getBeanType()
Return the type of the contained bean.
|
<A extends Annotation> |
HandlerMethod.getMethodAnnotation(Class<A> annotationType)
Return a single annotation on the underlying method traversing its super methods
if no annotation can be found on the given method itself.
|
HandlerMethod |
HandlerMethod.getResolvedFromHandlerMethod()
Return the HandlerMethod from which this HandlerMethod instance was
resolved via
HandlerMethod.createWithResolvedBean() . |
protected HttpStatus |
HandlerMethod.getResponseStatus()
Return the specified response status, if any.
|
protected String |
HandlerMethod.getResponseStatusReason()
Return the associated response status reason, if any.
|
Modifier and Type | Method and Description |
---|---|
boolean |
HandlerMethod.equals(Object other) |
boolean |
ControllerAdviceBean.equals(Object other) |
protected static Object |
HandlerMethod.findProvidedArgument(MethodParameter parameter,
Object... providedArgs) |
MethodParameter |
HandlerMethod.getReturnValueType(Object returnValue)
Return the actual return value type.
|
boolean |
ControllerAdviceBean.isApplicableToBeanType(Class<?> beanType)
Check whether the given bean type should be advised by this
ControllerAdviceBean . |
boolean |
HandlerTypePredicate.test(Class<?> controllerType) |
Constructor and Description |
---|
ControllerAdviceBean(String beanName,
BeanFactory beanFactory,
ControllerAdvice controllerAdvice)
Create a
ControllerAdviceBean using the given bean name,
BeanFactory , and @ControllerAdvice
annotation. |
HandlerMethod(Object bean,
Method method,
MessageSource messageSource)
Variant of
HandlerMethod(Object, Method) that
also accepts a MessageSource for use from subclasses. |
HandlerMethod(String beanName,
BeanFactory beanFactory,
MessageSource messageSource,
Method method)
Variant of
HandlerMethod(String, BeanFactory, Method) that
also accepts a MessageSource . |
Modifier and Type | Method and Description |
---|---|
protected String |
RequestParamMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
Object |
ModelAttributeMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolve the argument from the model or if not found instantiate it with
its default if it is available.
|
Object |
AbstractNamedValueMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ErrorsMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
MapMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
AbstractWebArgumentResolverAdapter.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Delegate to the
WebArgumentResolver instance. |
Object |
ModelMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ModelAttributeMethodProcessor.resolveConstructorArgument(String paramName,
Class<?> paramType,
NativeWebRequest request) |
Method |
ExceptionHandlerMethodResolver.resolveMethod(Exception exception)
Find a
Method to handle the given exception. |
Method |
ExceptionHandlerMethodResolver.resolveMethodByExceptionType(Class<? extends Throwable> exceptionType)
Find a
Method to handle the given exception type. |
Method |
ExceptionHandlerMethodResolver.resolveMethodByThrowable(Throwable exception)
Find a
Method to handle the given Throwable. |
protected abstract Object |
AbstractNamedValueMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request)
Resolve the given parameter type and value name into an argument value.
|
protected Object |
RequestHeaderMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
protected Object |
RequestParamMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
protected Object |
ExpressionValueMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest webRequest) |
Modifier and Type | Method and Description |
---|---|
void |
RequestParamMethodArgumentResolver.contributeMethodArgument(MethodParameter parameter,
Object value,
UriComponentsBuilder builder,
Map<String,Object> uriVariables,
ConversionService conversionService) |
protected String |
RequestParamMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
protected String |
RequestParamMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
protected String |
RequestParamMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
static String |
ModelFactory.getNameForReturnValue(Object returnValue,
MethodParameter returnType)
Derive the model attribute name for the given return value.
|
protected void |
AbstractNamedValueMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest)
Invoked after a value is resolved.
|
protected void |
AbstractNamedValueMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest)
Invoked after a value is resolved.
|
void |
ModelAttributeMethodProcessor.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest)
Add non-null return values to the
ModelAndViewContainer . |
void |
MapMethodProcessor.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ModelMethodProcessor.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
Object |
ModelAttributeMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolve the argument from the model or if not found instantiate it with
its default if it is available.
|
Object |
ModelAttributeMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolve the argument from the model or if not found instantiate it with
its default if it is available.
|
Object |
RequestParamMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
RequestParamMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
AbstractNamedValueMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
AbstractNamedValueMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ErrorsMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ErrorsMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
MapMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
MapMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
AbstractWebArgumentResolverAdapter.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Delegate to the
WebArgumentResolver instance. |
Object |
AbstractWebArgumentResolverAdapter.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Delegate to the
WebArgumentResolver instance. |
Object |
RequestHeaderMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
RequestHeaderMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ModelMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ModelMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
SessionStatusMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
SessionStatusMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
protected void |
ModelAttributeMethodProcessor.validateValueIfApplicable(WebDataBinder binder,
MethodParameter parameter,
Class<?> targetType,
String fieldName,
Object value)
Validate the specified candidate value if applicable.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
InvocableHandlerMethod.doInvoke(Object... args)
Invoke the handler method with the given argument values.
|
HttpStatus |
ModelAndViewContainer.getStatus()
Return the configured HTTP status, if any.
|
Object |
ModelAndViewContainer.getView()
Return the View object, or
null if we are using a view name
to be resolved by the DispatcherServlet via a ViewResolver. |
String |
ModelAndViewContainer.getViewName()
Return the view name to be resolved by the DispatcherServlet via a
ViewResolver, or
null if a View object is set. |
Object |
InvocableHandlerMethod.invokeForRequest(NativeWebRequest request,
ModelAndViewContainer mavContainer,
Object... providedArgs)
Invoke the method after resolving its argument values in the context of the given request.
|
Object |
HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. |
Object |
HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolves a method parameter into an argument value from a given request.
|
Modifier and Type | Method and Description |
---|---|
ModelAndViewContainer |
ModelAndViewContainer.addAllAttributes(Map<String,?> attributes)
Copy all attributes to the underlying model.
|
ModelAndViewContainer |
ModelAndViewContainer.addAttribute(String name,
Object value)
Add the supplied attribute to the underlying model.
|
HandlerMethodReturnValueHandlerComposite |
HandlerMethodReturnValueHandlerComposite.addHandlers(List<? extends HandlerMethodReturnValueHandler> handlers)
Add the given
HandlerMethodReturnValueHandlers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(HandlerMethodArgumentResolver... resolvers)
Add the given
HandlerMethodArgumentResolvers . |
HandlerMethodArgumentResolverComposite |
HandlerMethodArgumentResolverComposite.addResolvers(List<? extends HandlerMethodArgumentResolver> resolvers)
Add the given
HandlerMethodArgumentResolvers . |
protected Object[] |
InvocableHandlerMethod.getMethodArgumentValues(NativeWebRequest request,
ModelAndViewContainer mavContainer,
Object... providedArgs)
Get the method argument values for the current request, checking the provided
argument values and falling back to the configured argument resolvers.
|
void |
HandlerMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest)
Handle the given return value by adding attributes to the model and
setting a view or setting the
ModelAndViewContainer.setRequestHandled(boolean) flag to true
to indicate the response has been handled directly. |
void |
HandlerMethodReturnValueHandlerComposite.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest)
Iterate over registered
HandlerMethodReturnValueHandlers and invoke the one that supports it. |
Object |
InvocableHandlerMethod.invokeForRequest(NativeWebRequest request,
ModelAndViewContainer mavContainer,
Object... providedArgs)
Invoke the method after resolving its argument values in the context of the given request.
|
boolean |
AsyncHandlerMethodReturnValueHandler.isAsyncReturnValue(Object returnValue,
MethodParameter returnType)
Whether the given return value represents asynchronous computation.
|
ModelAndViewContainer |
ModelAndViewContainer.mergeAttributes(Map<String,?> attributes)
Copy attributes in the supplied
Map with existing objects of
the same name taking precedence (i.e. |
ModelAndViewContainer |
ModelAndViewContainer.removeAttributes(Map<String,?> attributes)
Remove the given attributes from the model.
|
Object |
HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. |
Object |
HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. |
Object |
HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolves a method parameter into an argument value from a given request.
|
Object |
HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Resolves a method parameter into an argument value from a given request.
|
void |
ModelAndViewContainer.setStatus(HttpStatus status)
Provide an HTTP status that will be passed on to with the
ModelAndView used for view rendering purposes. |
void |
ModelAndViewContainer.setView(Object view)
Set a View object to be used by the DispatcherServlet.
|
void |
ModelAndViewContainer.setViewName(String viewName)
Set a view name to be resolved by the DispatcherServlet via a ViewResolver.
|
Constructor and Description |
---|
CompositeUriComponentsContributor(Collection<?> contributors,
ConversionService cs)
Create an instance from a collection of
UriComponentsContributors or
HandlerMethodArgumentResolvers . |
CompositeUriComponentsContributor(Collection<?> contributors,
ConversionService cs)
Create an instance from a collection of
UriComponentsContributors or
HandlerMethodArgumentResolvers . |
InvocableHandlerMethod(Object bean,
Method method,
MessageSource messageSource)
Variant of
InvocableHandlerMethod(Object, Method) that
also accepts a MessageSource , for use in subclasses. |
Modifier and Type | Method and Description |
---|---|
String |
MultipartFile.getContentType()
Return the content type of the file.
|
MultipartFile |
MultipartRequest.getFile(String name)
Return the contents plus description of an uploaded file in this request,
or
null if it does not exist. |
String |
MultipartRequest.getMultipartContentType(String paramOrFileName)
Determine the content type of the specified request part.
|
HttpHeaders |
MultipartHttpServletRequest.getMultipartHeaders(String paramOrFileName)
Return the headers for the specified part of the multipart request.
|
String |
MultipartFile.getOriginalFilename()
Return the original filename in the client's filesystem.
|
HttpMethod |
MultipartHttpServletRequest.getRequestMethod()
Return this request's method as a convenient HttpMethod instance.
|
Constructor and Description |
---|
MaxUploadSizeExceededException(long maxUploadSize,
Throwable ex)
Constructor for MaxUploadSizeExceededException.
|
MultipartException(String msg,
Throwable cause)
Constructor for MultipartException.
|
Modifier and Type | Method and Description |
---|---|
protected org.apache.commons.fileupload.FileUpload |
CommonsFileUploadSupport.prepareFileUpload(String encoding)
Determine an appropriate FileUpload instance for the given encoding.
|
Modifier and Type | Method and Description |
---|---|
String |
DefaultMultipartHttpServletRequest.getParameter(String name) |
static Object |
MultipartResolutionDelegate.resolveMultipartArgument(String name,
MethodParameter parameter,
HttpServletRequest request) |
static MultipartRequest |
MultipartResolutionDelegate.resolveMultipartRequest(NativeWebRequest webRequest) |
Modifier and Type | Method and Description |
---|---|
void |
ByteArrayMultipartFileEditor.setValue(Object value) |
Modifier and Type | Method and Description |
---|---|
List<HandlerMapping> |
DispatcherHandler.getHandlerMappings()
|
Object |
HandlerResult.getReturnValue()
Return the value returned from the handler, if any.
|
Modifier and Type | Method and Description |
---|---|
WebExchangeDataBinder |
BindingContext.createDataBinder(ServerWebExchange exchange,
Object target,
String name)
Create a
WebExchangeDataBinder to apply data binding and
validation with on the target, command object. |
Constructor and Description |
---|
BindingContext(WebBindingInitializer initializer)
Create a new
BindingContext with the given initializer. |
HandlerResult(Object handler,
Object returnValue,
MethodParameter returnType)
Create a new
HandlerResult . |
HandlerResult(Object handler,
Object returnValue,
MethodParameter returnType,
BindingContext context)
Create a new
HandlerResult . |
HandlerResult(Object handler,
Object returnValue,
MethodParameter returnType,
BindingContext context)
Create a new
HandlerResult . |
Modifier and Type | Method and Description |
---|---|
ApplicationContext |
WebFluxConfigurationSupport.getApplicationContext() |
protected AbstractUrlHandlerMapping |
ResourceHandlerRegistry.getHandlerMapping()
Return a handler mapping with the mapped resource handlers; or
null in case
of no registrations. |
default MessageCodesResolver |
WebFluxConfigurer.getMessageCodesResolver()
Provide a custom
MessageCodesResolver to use for data binding in
annotated controller method arguments instead of the one created by
default in DataBinder . |
protected MessageCodesResolver |
WebFluxConfigurationSupport.getMessageCodesResolver()
Override this method to provide a custom
MessageCodesResolver . |
protected Map<String,Predicate<Class<?>>> |
PathMatchConfigurer.getPathPrefixes() |
default Validator |
WebFluxConfigurer.getValidator()
Provide a custom
Validator . |
protected Validator |
WebFluxConfigurationSupport.getValidator()
Override this method to provide a custom
Validator . |
WebSocketService |
WebFluxConfigurerComposite.getWebSocketService() |
default WebSocketService |
WebFluxConfigurer.getWebSocketService()
Provide the
WebSocketService to create
WebSocketHandlerAdapter
with. |
protected WebSocketService |
WebFluxConfigurationSupport.getWebSocketService() |
protected Boolean |
PathMatchConfigurer.isUseCaseSensitiveMatch() |
protected Boolean |
PathMatchConfigurer.isUseTrailingSlashMatch() |
Modifier and Type | Method and Description |
---|---|
void |
WebFluxConfigurationSupport.setApplicationContext(ApplicationContext applicationContext) |
void |
ResourceHandlerRegistry.setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider)
Configure the
ResourceUrlProvider that can be used by
ResourceTransformer instances. |
Constructor and Description |
---|
ResourceChainRegistration(boolean cacheResources,
Cache cache) |
ViewResolverRegistry(ApplicationContext applicationContext) |
Modifier and Type | Method and Description |
---|---|
ResolvableType |
UnsupportedMediaTypeException.getBodyType()
Return the body type in the context of which this exception was generated.
|
MediaType |
UnsupportedMediaTypeException.getContentType()
Return the request Content-Type header if it was parsed successfully,
or
null otherwise. |
Constructor and Description |
---|
UnsupportedMediaTypeException(MediaType contentType,
List<MediaType> supportedTypes)
Constructor for when the Content-Type can be parsed but is not supported.
|
UnsupportedMediaTypeException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType)
Constructor for when trying to encode from or decode to a specific Java type.
|
Modifier and Type | Method and Description |
---|---|
HttpRequest |
WebClientResponseException.getRequest()
Return the corresponding request.
|
Consumer<ClientHttpRequest> |
ClientRequest.httpRequest()
Return consumer(s) configured to access to the
ClientHttpRequest . |
Modifier and Type | Method and Description |
---|---|
static WebClientResponseException |
WebClientResponseException.create(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create
WebClientResponseException or an HTTP status specific subclass. |
static WebClientResponseException |
WebClientResponseException.create(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Create
WebClientResponseException or an HTTP status specific subclass. |
static WebClientResponseException |
WebClientResponseException.create(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Create
WebClientResponseException or an HTTP status specific subclass. |
boolean |
ExchangeFilterFunctions.Credentials.equals(Object other)
Deprecated.
|
Constructor and Description |
---|
UnknownHttpStatusCodeException(int statusCode,
HttpHeaders headers,
byte[] responseBody,
Charset responseCharset,
HttpRequest request)
Create a new instance of the
UnknownHttpStatusCodeException with the given
parameters. |
UnknownHttpStatusCodeException(int statusCode,
HttpHeaders headers,
byte[] responseBody,
Charset responseCharset,
HttpRequest request)
Create a new instance of the
UnknownHttpStatusCodeException with the given
parameters. |
WebClientResponseException(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with response data only, and a default message.
|
WebClientResponseException(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with response data only, and a default message.
|
WebClientResponseException(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with response data only, and a default message.
|
WebClientResponseException(int status,
String reasonPhrase,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Constructor with response data only, and a default message.
|
WebClientResponseException(int status,
String reasonPhrase,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Constructor with response data only, and a default message.
|
WebClientResponseException(int status,
String reasonPhrase,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Constructor with response data only, and a default message.
|
WebClientResponseException(int status,
String reasonPhrase,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Constructor with response data only, and a default message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset,
HttpRequest request)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset,
HttpRequest request)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset,
HttpRequest request)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset,
HttpRequest request)
Constructor with a prepared message.
|
Modifier and Type | Method and Description |
---|---|
default String |
ServerRequest.Headers.firstHeader(String headerName)
Get the first header value, if any, for the header with the given name.
|
InetSocketAddress |
ServerRequest.Headers.host()
Get the value of the
Host header, if available. |
default HttpMethod |
ServerRequest.method()
Get the HTTP method.
|
Modifier and Type | Method and Description |
---|---|
ServerRequest.Builder |
ServerRequest.Builder.contextPath(String contextPath)
Set the context path of the request.
|
RenderingResponse.Builder |
RenderingResponse.Builder.modelAttribute(String name,
Object value)
Add the supplied attribute value under the supplied name.
|
Modifier and Type | Method and Description |
---|---|
RouterFunction<?> |
RouterFunctionMapping.getRouterFunction()
Return the configured
RouterFunction . |
Modifier and Type | Method and Description |
---|---|
protected CorsConfiguration |
AbstractHandlerMapping.getCorsConfiguration(Object handler,
ServerWebExchange exchange)
Retrieve the CORS configuration for the given handler.
|
protected Object |
AbstractUrlHandlerMapping.lookupHandler(PathContainer lookupPath,
ServerWebExchange exchange)
Look up a handler instance for the given URL lookup path.
|
Modifier and Type | Method and Description |
---|---|
String |
VersionStrategy.extractVersion(String requestPath)
Extract the resource version from the request path.
|
protected String |
WebJarsResourceResolver.findWebJarResourcePath(String path) |
Resource[] |
PathResourceResolver.getAllowedLocations() |
CacheControl |
ResourceWebHandler.getCacheControl()
Return the
CacheControl instance to build
the Cache-Control HTTP response header. |
String |
TransformedResource.getFilename() |
ResourceHttpMessageWriter |
ResourceWebHandler.getResourceHttpMessageWriter()
Return the configured resource message writer.
|
ResourceUrlProvider |
ResourceTransformerSupport.getResourceUrlProvider()
Return the configured
ResourceUrlProvider . |
protected VersionStrategy |
VersionResourceResolver.getStrategyForPath(String requestPath)
Find a
VersionStrategy for the request path of the requested resource. |
Modifier and Type | Method and Description |
---|---|
protected String |
CachingResourceResolver.computeKey(ServerWebExchange exchange,
String requestPath) |
reactor.core.publisher.Mono<Resource> |
ResourceResolverChain.resolveResource(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
reactor.core.publisher.Mono<Resource> |
ResourceResolver.resolveResource(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
reactor.core.publisher.Mono<Resource> |
AbstractResourceResolver.resolveResource(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected reactor.core.publisher.Mono<Resource> |
GzipResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Deprecated.
|
protected reactor.core.publisher.Mono<Resource> |
PathResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected reactor.core.publisher.Mono<Resource> |
WebJarsResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected reactor.core.publisher.Mono<Resource> |
VersionResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected reactor.core.publisher.Mono<Resource> |
EncodedResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected reactor.core.publisher.Mono<Resource> |
CachingResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected abstract reactor.core.publisher.Mono<Resource> |
AbstractResourceResolver.resolveResourceInternal(ServerWebExchange exchange,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
void |
PathResourceResolver.setAllowedLocations(Resource... locations)
By default, when a Resource is found, the path of the resolved resource is
compared to ensure it's under the input location where it was found.
|
void |
ResourceWebHandler.setCacheControl(CacheControl cacheControl)
Set the
CacheControl instance to build
the Cache-Control HTTP response header. |
protected void |
ResourceWebHandler.setHeaders(ServerWebExchange exchange,
Resource resource,
MediaType mediaType)
Set headers on the response.
|
void |
ResourceWebHandler.setLocations(List<Resource> locations)
Set the
List of Resource paths to use as sources
for serving static resources. |
void |
ResourceWebHandler.setResourceHttpMessageWriter(ResourceHttpMessageWriter httpMessageWriter)
Configure the
ResourceHttpMessageWriter to use. |
void |
ResourceWebHandler.setResourceResolvers(List<ResourceResolver> resourceResolvers)
Configure the list of
ResourceResolvers to use. |
void |
ResourceWebHandler.setResourceTransformers(List<ResourceTransformer> resourceTransformers)
Configure the list of
ResourceTransformers to use. |
void |
ResourceTransformerSupport.setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider)
Configure a
ResourceUrlProvider to use when resolving the public
URL of links in a transformed resource (e.g. |
Modifier and Type | Method and Description |
---|---|
protected ReactiveAdapter |
HandlerResultHandlerSupport.getAdapter(HandlerResult result)
Get a
ReactiveAdapter for the top-level return value type. |
protected MediaType |
HandlerResultHandlerSupport.selectMediaType(ServerWebExchange exchange,
Supplier<List<MediaType>> producibleTypesSupplier)
Select the best media type for the current request through a content negotiation algorithm.
|
Modifier and Type | Method and Description |
---|---|
RequestCondition<?> |
RequestConditionHolder.getCondition()
Return the held request condition, or
null if not holding one. |
RequestMethodsRequestCondition |
RequestMethodsRequestCondition.getMatchingCondition(ServerWebExchange exchange)
Check if any of the HTTP request methods match the given request and
return an instance that contains the matching HTTP request method only.
|
T |
RequestCondition.getMatchingCondition(ServerWebExchange exchange)
Check if the condition matches the request returning a potentially new
instance created for the current request.
|
HeadersRequestCondition |
HeadersRequestCondition.getMatchingCondition(ServerWebExchange exchange)
Returns "this" instance if the request matches all expressions;
or
null otherwise. |
ProducesRequestCondition |
ProducesRequestCondition.getMatchingCondition(ServerWebExchange exchange)
Checks if any of the contained media type expressions match the given
request 'Content-Type' header and returns an instance that is guaranteed
to contain matching expressions only.
|
PatternsRequestCondition |
PatternsRequestCondition.getMatchingCondition(ServerWebExchange exchange)
Checks if any of the patterns match the given request and returns an instance
that is guaranteed to contain matching patterns, sorted.
|
T |
NameValueExpression.getValue() |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractRequestCondition.equals(Object other) |
Constructor and Description |
---|
RequestConditionHolder(RequestCondition<?> requestCondition)
Create a new holder to wrap the given request condition.
|
Modifier and Type | Method and Description |
---|---|
RequestedContentTypeResolver |
RequestMappingInfo.BuilderConfiguration.getContentTypeResolver() |
RequestCondition<?> |
RequestMappingInfo.getCustomCondition()
Returns the "custom" condition of this
RequestMappingInfo ; or null . |
protected abstract T |
AbstractHandlerMethodMapping.getMappingForMethod(Method method,
Class<?> handlerType)
Provide the mapping for a handler method.
|
RequestMappingInfo |
RequestMappingInfo.getMatchingCondition(ServerWebExchange exchange)
Checks if all conditions in this request mapping info match the provided request and returns
a potentially new request mapping info with conditions tailored to the current request.
|
protected abstract T |
AbstractHandlerMethodMapping.getMatchingMapping(T mapping,
ServerWebExchange exchange)
Check if a mapping matches the current request and return a (potentially
new) mapping with conditions relevant to the current request.
|
String |
RequestMappingInfo.getName()
Return the name for this mapping, or
null . |
PathPatternParser |
RequestMappingInfo.BuilderConfiguration.getPatternParser() |
protected HandlerMethod |
AbstractHandlerMethodMapping.handleNoMatch(Set<T> mappings,
ServerWebExchange exchange)
Invoked when no matching mapping is not found.
|
protected CorsConfiguration |
AbstractHandlerMethodMapping.initCorsConfiguration(Object handler,
Method method,
T mapping)
Extract and return the CORS configuration for the mapping.
|
HandlerResult |
SyncInvocableHandlerMethod.invokeForHandlerResult(ServerWebExchange exchange,
BindingContext bindingContext,
Object... providedArgs)
Invoke the method for the given exchange.
|
protected HandlerMethod |
AbstractHandlerMethodMapping.lookupHandlerMethod(ServerWebExchange exchange)
Look up the best-matching handler method for the current request.
|
Object |
SyncHandlerMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter,
BindingContext bindingContext,
ServerWebExchange exchange)
Resolve the value for the method parameter synchronously.
|
Modifier and Type | Method and Description |
---|---|
boolean |
RequestMappingInfo.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
ArgumentResolverConfigurer |
RequestMappingHandlerAdapter.getArgumentResolverConfigurer()
Return the configured resolvers for controller method arguments.
|
protected RequestCondition<?> |
RequestMappingHandlerMapping.getCustomMethodCondition(Method method)
Provide a custom method-level request condition.
|
protected RequestCondition<?> |
RequestMappingHandlerMapping.getCustomTypeCondition(Class<?> handlerType)
Provide a custom type-level request condition.
|
protected RequestMappingInfo |
RequestMappingHandlerMapping.getMappingForMethod(Method method,
Class<?> handlerType)
Uses method and type-level @
RequestMapping annotations to create
the RequestMappingInfo. |
ReactiveAdapterRegistry |
RequestMappingHandlerAdapter.getReactiveAdapterRegistry()
Return the configured registry for adapting reactive types.
|
WebBindingInitializer |
RequestMappingHandlerAdapter.getWebBindingInitializer()
Return the configured WebBindingInitializer, or
null if none. |
Object |
MatrixVariableMapMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter,
BindingContext bindingContext,
ServerWebExchange exchange) |
Object |
SessionStatusMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter,
BindingContext bindingContext,
ServerWebExchange exchange) |
protected Object |
MatrixVariableMethodArgumentResolver.resolveNamedValue(String name,
MethodParameter param,
ServerWebExchange exchange) |
protected abstract Object |
AbstractNamedValueSyncArgumentResolver.resolveNamedValue(String name,
MethodParameter param,
ServerWebExchange exchange)
Actually resolve the value synchronously.
|
Modifier and Type | Method and Description |
---|---|
protected RequestMappingInfo |
RequestMappingHandlerMapping.createRequestMappingInfo(RequestMapping requestMapping,
RequestCondition<?> customCondition)
Create a
RequestMappingInfo from the supplied
@RequestMapping annotation, which is either
a directly declared annotation, a meta-annotation, or the synthesized
result of merging annotation attributes within an annotation hierarchy. |
reactor.core.publisher.Flux<Part> |
RequestPartMethodArgumentResolver.getPartValues(MethodParameter parameter,
RequestPart requestPart,
boolean isRequired,
ServerWebExchange exchange) |
protected void |
PathVariableMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
Model model,
ServerWebExchange exchange) |
protected void |
AbstractNamedValueArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
Model model,
ServerWebExchange exchange)
Invoked after a value is resolved.
|
protected reactor.core.publisher.Mono<Object> |
AbstractMessageReaderArgumentResolver.readBody(MethodParameter bodyParam,
MethodParameter actualParam,
boolean isBodyRequired,
BindingContext bindingContext,
ServerWebExchange exchange)
Read the body from a method argument with
HttpMessageReader . |
void |
RequestMappingHandlerAdapter.setArgumentResolverConfigurer(ArgumentResolverConfigurer configurer)
Configure resolvers for controller method arguments.
|
void |
RequestMappingHandlerAdapter.setReactiveAdapterRegistry(ReactiveAdapterRegistry registry)
Configure the registry for adapting various reactive types.
|
void |
RequestMappingHandlerAdapter.setWebBindingInitializer(WebBindingInitializer webBindingInitializer)
Provide a WebBindingInitializer with "global" initialization to apply
to every DataBinder instance.
|
protected reactor.core.publisher.Mono<Void> |
AbstractMessageWriterResultHandler.writeBody(Object body,
MethodParameter bodyParameter,
MethodParameter actualParam,
ServerWebExchange exchange)
Write a given body to the response with
HttpMessageWriter . |
protected reactor.core.publisher.Mono<Void> |
AbstractMessageWriterResultHandler.writeBody(Object body,
MethodParameter bodyParameter,
MethodParameter actualParam,
ServerWebExchange exchange)
Write a given body to the response with
HttpMessageWriter . |
protected reactor.core.publisher.Mono<Void> |
AbstractMessageWriterResultHandler.writeBody(Object body,
MethodParameter bodyParameter,
ServerWebExchange exchange)
Write a given body to the response with
HttpMessageWriter . |
Modifier and Type | Method and Description |
---|---|
PropertyEditor |
BindStatus.findEditor(Class<?> valueClass)
Find a PropertyEditor for the given value class, associated with
the property that this bound status is currently bound to.
|
Object |
BindStatus.getActualValue()
Return the actual value of the field, i.e.
|
ApplicationContext |
AbstractView.getApplicationContext() |
ApplicationContext |
UrlBasedViewResolver.getApplicationContext()
Return the containing
ApplicationContext , if any. |
String |
AbstractView.getBeanName()
Get the view's name.
|
Boolean |
RequestContext.getDefaultHtmlEscape()
Return the default HTML escape setting, differentiating between no default
specified and an explicit value.
|
PropertyEditor |
BindStatus.getEditor()
Return the PropertyEditor for the property that this bind status
is currently bound to.
|
Errors |
BindStatus.getErrors()
Return the Errors instance (typically a BindingResult) that this
bind status is currently associated with.
|
Errors |
RequestContext.getErrors(String name)
Retrieve the Errors instance for the given bind object, using the
"defaultHtmlEscape" setting.
|
Errors |
RequestContext.getErrors(String name,
boolean htmlEscape)
Retrieve the Errors instance for the given bind object.
|
String |
BindStatus.getExpression()
Return a bind expression that can be used in HTML forms as input name
for the respective field, or
null if not field-specific. |
Map<String,String> |
RequestDataValueProcessor.getExtraHiddenFields(ServerWebExchange exchange)
Invoked after all form fields have been rendered.
|
String[] |
RedirectView.getHosts()
Return the configured application hosts.
|
Map<String,Object> |
RequestContext.getModel()
Return the model Map that this RequestContext encapsulates, if any.
|
protected <T> T |
RequestContext.getModelObject(String modelName)
Retrieve the model object for the given model name, either from the model
or from the request attributes.
|
String |
AbstractView.getRequestContextAttribute()
Get the name of the
RequestContext attribute for this view, if any. |
protected String |
UrlBasedViewResolver.getRequestContextAttribute()
Return the name of the
RequestContext attribute for all views, if any. |
protected RequestDataValueProcessor |
AbstractView.getRequestDataValueProcessor()
Get the
RequestDataValueProcessor to use. |
RequestDataValueProcessor |
RequestContext.getRequestDataValueProcessor()
Return the
RequestDataValueProcessor instance to apply to in form
tag libraries and to redirect URLs. |
String |
AbstractUrlBasedView.getUrl()
Return the URL of the resource that this view wraps.
|
Object |
BindStatus.getValue()
Return the current value of the field, i.e.
|
Class<?> |
BindStatus.getValueType()
Get the '
Class ' type of the field. |
protected Class<?> |
UrlBasedViewResolver.getViewClass()
Return the view class to be used to create views.
|
protected String[] |
UrlBasedViewResolver.getViewNames()
Return the view names (or name patterns) that can be handled by this
ViewResolver . |
HttpStatus |
Rendering.status()
Return the HTTP status to set the response to.
|
Object |
Rendering.view()
|
Modifier and Type | Method and Description |
---|---|
String |
RequestContext.getMessage(String code,
List<?> args)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
List<?> args,
String defaultMessage)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args,
boolean htmlEscape)
Retrieve the message for the given code.
|
String |
RequestContext.getMessage(String code,
Object[] args,
String defaultMessage)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args,
String defaultMessage,
boolean htmlEscape)
Retrieve the message for the given code.
|
protected reactor.core.publisher.Mono<Map<String,Object>> |
AbstractView.getModelAttributes(Map<String,?> model,
ServerWebExchange exchange)
Prepare the model to use for rendering.
|
reactor.core.publisher.Mono<Void> |
AbstractView.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange)
Prepare the model to render.
|
reactor.core.publisher.Mono<Void> |
AbstractView.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange)
Prepare the model to render.
|
reactor.core.publisher.Mono<Void> |
HttpMessageWriterView.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange) |
reactor.core.publisher.Mono<Void> |
HttpMessageWriterView.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange) |
reactor.core.publisher.Mono<Void> |
View.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange)
Render the view based on the given
HandlerResult . |
reactor.core.publisher.Mono<Void> |
View.render(Map<String,?> model,
MediaType contentType,
ServerWebExchange exchange)
Render the view based on the given
HandlerResult . |
protected abstract reactor.core.publisher.Mono<Void> |
AbstractView.renderInternal(Map<String,Object> renderAttributes,
MediaType contentType,
ServerWebExchange exchange)
Subclasses must implement this method to actually render the view.
|
protected reactor.core.publisher.Mono<Void> |
RedirectView.renderInternal(Map<String,Object> model,
MediaType contentType,
ServerWebExchange exchange)
Convert model to request parameters and redirect to the given URL.
|
void |
AbstractView.setApplicationContext(ApplicationContext applicationContext) |
void |
UrlBasedViewResolver.setApplicationContext(ApplicationContext applicationContext)
Accept the containing
ApplicationContext , if any. |
void |
AbstractView.setBeanName(String beanName)
Set the view's name.
|
void |
ViewResolutionResultHandler.setDefaultViews(List<View> defaultViews)
Set the default views to consider always when resolving view names and
trying to satisfy the best matching content type.
|
void |
RedirectView.setHosts(String... hosts)
Configure one or more hosts associated with the application.
|
void |
HttpMessageWriterView.setModelKeys(Set<String> modelKeys)
Set the attributes in the model that should be rendered by this view.
|
void |
UrlBasedViewResolver.setPrefix(String prefix)
Set the prefix that gets prepended to view names when building a URL.
|
void |
AbstractView.setRequestContextAttribute(String requestContextAttribute)
Set the name of the
RequestContext attribute for this view. |
void |
UrlBasedViewResolver.setRequestContextAttribute(String requestContextAttribute)
Set the name of the
RequestContext attribute for all views. |
void |
UrlBasedViewResolver.setSuffix(String suffix)
Set the suffix that gets appended to view names when building a URL.
|
void |
AbstractUrlBasedView.setUrl(String url)
Set the URL of the resource that this view wraps.
|
void |
UrlBasedViewResolver.setViewClass(Class<?> viewClass)
Set the view class that should be used to create views.
|
void |
UrlBasedViewResolver.setViewNames(String... viewNames)
Set the view names (or name patterns) that can be handled by this
ViewResolver . |
Constructor and Description |
---|
RequestContext(ServerWebExchange exchange,
Map<String,Object> model,
MessageSource messageSource,
RequestDataValueProcessor dataValueProcessor) |
Modifier and Type | Method and Description |
---|---|
protected freemarker.template.Configuration |
FreeMarkerView.getConfiguration()
Get the FreeMarker
Configuration used by this view. |
protected String |
FreeMarkerView.getEncoding()
Get the encoding for the FreeMarker template.
|
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<Map<String,Object>> |
FreeMarkerView.getModelAttributes(Map<String,?> model,
ServerWebExchange exchange)
Prepare the model to use for rendering by potentially exposing a
RequestContext for use in Spring FreeMarker macros and then
delegating to the inherited implementation of this method. |
protected reactor.core.publisher.Mono<Void> |
FreeMarkerView.renderInternal(Map<String,Object> renderAttributes,
MediaType contentType,
ServerWebExchange exchange) |
void |
FreeMarkerView.setConfiguration(freemarker.template.Configuration configuration)
Set the FreeMarker
Configuration to be used by this view. |
void |
FreeMarkerView.setEncoding(String encoding)
Set the encoding of the FreeMarker template file.
|
Modifier and Type | Method and Description |
---|---|
Charset |
ScriptTemplateConfig.getCharset()
Return the charset used to read script and template files.
|
Charset |
ScriptTemplateConfigurer.getCharset() |
ScriptEngine |
ScriptTemplateConfig.getEngine()
Return the
ScriptEngine to use by the views. |
ScriptEngine |
ScriptTemplateConfigurer.getEngine() |
String |
ScriptTemplateConfig.getEngineName()
Return the engine name that will be used to instantiate the
ScriptEngine . |
String |
ScriptTemplateConfigurer.getEngineName() |
Supplier<ScriptEngine> |
ScriptTemplateConfig.getEngineSupplier()
Return the engine supplier that will be used to instantiate the
ScriptEngine . |
Supplier<ScriptEngine> |
ScriptTemplateConfigurer.getEngineSupplier() |
String |
ScriptTemplateConfig.getRenderFunction()
Return the render function name (optional).
|
String |
ScriptTemplateConfigurer.getRenderFunction() |
String |
ScriptTemplateConfig.getRenderObject()
Return the object where the render function belongs (optional).
|
String |
ScriptTemplateConfigurer.getRenderObject() |
protected Resource |
ScriptTemplateView.getResource(String location) |
String |
ScriptTemplateConfig.getResourceLoaderPath()
Return the resource loader path(s) via a Spring resource location.
|
String |
ScriptTemplateConfigurer.getResourceLoaderPath() |
String[] |
ScriptTemplateConfig.getScripts()
Return the scripts to be loaded by the script engine (library or user provided).
|
String[] |
ScriptTemplateConfigurer.getScripts() |
Boolean |
ScriptTemplateConfig.isSharedEngine()
Return whether to use a shared engine for all threads or whether to create
thread-local engine instances for each thread.
|
Boolean |
ScriptTemplateConfigurer.isSharedEngine() |
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<Void> |
ScriptTemplateView.renderInternal(Map<String,Object> model,
MediaType contentType,
ServerWebExchange exchange) |
void |
ScriptTemplateView.setApplicationContext(ApplicationContext context) |
void |
ScriptTemplateConfigurer.setCharset(Charset charset)
Set the charset used to read script and template files.
|
void |
ScriptTemplateConfigurer.setEngine(ScriptEngine engine)
Set the
ScriptEngine to use by the view. |
void |
ScriptTemplateConfigurer.setEngineName(String engineName)
Set the engine name that will be used to instantiate the
ScriptEngine . |
void |
ScriptTemplateConfigurer.setEngineSupplier(Supplier<ScriptEngine> engineSupplier)
Set the
ScriptEngine supplier to use by the view, usually used with
ScriptTemplateConfigurer.setSharedEngine(Boolean) set to false . |
void |
ScriptTemplateConfigurer.setRenderFunction(String renderFunction)
Set the render function name (optional).
|
void |
ScriptTemplateConfigurer.setRenderObject(String renderObject)
Set the object where the render function belongs (optional).
|
void |
ScriptTemplateConfigurer.setResourceLoaderPath(String resourceLoaderPath)
Set the resource loader path(s) via a Spring resource location.
|
void |
ScriptTemplateConfigurer.setScripts(String... scriptNames)
Set the scripts to be loaded by the script engine (library or user provided).
|
void |
ScriptTemplateConfigurer.setSharedEngine(Boolean sharedEngine)
When set to
false , a new ScriptEngine instance will be created
for each request, else the same instance will be reused. |
Modifier and Type | Method and Description |
---|---|
String |
HandshakeInfo.getLogPrefix()
A log prefix used in the handshake to correlate log messages, if any.
|
<T> T |
WebSocketMessage.getNativeMessage()
Return the message from the API of the underlying WebSocket library.
|
String |
CloseStatus.getReason()
Return the reason, or
null if none. |
InetSocketAddress |
HandshakeInfo.getRemoteAddress()
For a server session this is the remote address where the handshake
request came from.
|
String |
HandshakeInfo.getSubProtocol()
The sub-protocol negotiated at handshake time, or
null if none. |
Modifier and Type | Method and Description |
---|---|
static CloseStatus |
CloseStatus.create(int code,
String reason)
Return a constant for the given code, or create a new instance if the
code does not match or there is a reason.
|
boolean |
WebSocketMessage.equals(Object other) |
boolean |
CloseStatus.equals(Object other) |
Constructor and Description |
---|
CloseStatus(int code,
String reason)
Create a new
CloseStatus instance. |
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol)
Constructor with basic information about the handshake.
|
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Deprecated.
as of 5.3.5 in favor of
HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String) |
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Deprecated.
as of 5.3.5 in favor of
HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String) |
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Deprecated.
as of 5.3.5 in favor of
HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String) |
HandshakeInfo(URI uri,
HttpHeaders headers,
MultiValueMap<String,HttpCookie> cookies,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Constructor targeting server-side use with extra information such as the
cookies, remote address, attributes, and a log prefix.
|
HandshakeInfo(URI uri,
HttpHeaders headers,
MultiValueMap<String,HttpCookie> cookies,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Constructor targeting server-side use with extra information such as the
cookies, remote address, attributes, and a log prefix.
|
HandshakeInfo(URI uri,
HttpHeaders headers,
MultiValueMap<String,HttpCookie> cookies,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Constructor targeting server-side use with extra information such as the
cookies, remote address, attributes, and a log prefix.
|
WebSocketMessage(WebSocketMessage.Type type,
DataBuffer payload,
Object nativeMessage)
Constructor for an inbound message with access to the underlying message.
|
Constructor and Description |
---|
AbstractListenerWebSocketSession(T delegate,
String id,
HandshakeInfo info,
DataBufferFactory bufferFactory,
reactor.core.publisher.MonoProcessor<Void> handlerCompletion)
Deprecated.
|
AbstractListenerWebSocketSession(T delegate,
String id,
HandshakeInfo info,
DataBufferFactory bufferFactory,
reactor.core.publisher.Sinks.Empty<Void> handlerCompletionSink)
Alternative constructor with completion sink to use to signal when the
handling of the session is complete, with success or error.
|
JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.MonoProcessor<Void> completionMono)
Deprecated.
|
JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.Sinks.Empty<Void> completionSink) |
StandardWebSocketSession(Session session,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.MonoProcessor<Void> completionMono)
Deprecated.
|
StandardWebSocketSession(Session session,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.Sinks.Empty<Void> completionSink) |
UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.MonoProcessor<Void> completionMono)
Deprecated.
|
UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel,
HandshakeInfo info,
DataBufferFactory factory,
reactor.core.publisher.Sinks.Empty<Void> completionSink) |
Modifier and Type | Method and Description |
---|---|
default reactor.core.publisher.Mono<Void> |
RequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler webSocketHandler,
String subProtocol)
Deprecated.
as of 5.1 in favor of
RequestUpgradeStrategy.upgrade(ServerWebExchange, WebSocketHandler, String, Supplier) |
default reactor.core.publisher.Mono<Void> |
RequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler webSocketHandler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory)
Upgrade to a WebSocket session and handle it with the given handler.
|
Modifier and Type | Method and Description |
---|---|
Predicate<String> |
HandshakeWebSocketService.getSessionAttributePredicate()
Return the configured predicate for initialization WebSocket session
attributes from
WebSession attributes. |
Modifier and Type | Method and Description |
---|---|
void |
HandshakeWebSocketService.setSessionAttributePredicate(Predicate<String> predicate)
Configure a predicate to use to extract
WebSession attributes
and use them to initialize the WebSocket session with. |
Modifier and Type | Method and Description |
---|---|
Long |
TomcatRequestUpgradeStrategy.getAsyncSendTimeout() |
Integer |
TomcatRequestUpgradeStrategy.getMaxBinaryMessageBufferSize() |
Long |
TomcatRequestUpgradeStrategy.getMaxSessionIdleTimeout() |
Integer |
TomcatRequestUpgradeStrategy.getMaxTextMessageBufferSize() |
org.eclipse.jetty.websocket.api.WebSocketPolicy |
JettyRequestUpgradeStrategy.getWebSocketPolicy()
Return the configured
WebSocketPolicy , if any. |
Modifier and Type | Method and Description |
---|---|
reactor.core.publisher.Mono<Void> |
TomcatRequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler handler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory) |
reactor.core.publisher.Mono<Void> |
ReactorNettyRequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler handler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory) |
reactor.core.publisher.Mono<Void> |
JettyRequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler handler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory) |
reactor.core.publisher.Mono<Void> |
Jetty10RequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler handler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory) |
reactor.core.publisher.Mono<Void> |
UndertowRequestUpgradeStrategy.upgrade(ServerWebExchange exchange,
WebSocketHandler handler,
String subProtocol,
Supplier<HandshakeInfo> handshakeInfoFactory) |
Modifier and Type | Method and Description |
---|---|
ApplicationContext |
ServerWebExchange.getApplicationContext()
Return the
ApplicationContext associated with the web application,
if it was initialized with one via
WebHttpHandlerBuilder.applicationContext(ApplicationContext) . |
default <T> T |
WebSession.getAttribute(String name)
Return the session attribute value if present.
|
default <T> T |
ServerWebExchange.getAttribute(String name)
Return the request attribute value if present.
|
ResolvableType |
UnsupportedMediaTypeStatusException.getBodyType()
Return the body type in the context of which this exception was generated.
|
MediaType |
UnsupportedMediaTypeStatusException.getContentType()
Return the request Content-Type header if it was parsed successfully,
or
null otherwise. |
Method |
ServerErrorException.getHandlerMethod()
Return the handler method associated with the error, if any.
|
MethodParameter |
ServerWebInputException.getMethodParameter()
Return the
MethodParameter associated with this error, if any. |
MethodParameter |
ServerErrorException.getMethodParameter()
Return the specific method parameter associated with the error, if any.
|
String |
ResponseStatusException.getReason()
The reason explaining the exception (potentially
null or empty). |
Modifier and Type | Method and Description |
---|---|
boolean |
ServerWebExchange.checkNotModified(String etag,
Instant lastModified)
Check whether the requested resource has been modified given the supplied
ETag (entity tag) and last-modified timestamp as determined by
the application. |
boolean |
ServerWebExchangeDecorator.checkNotModified(String etag,
Instant lastModified) |
Constructor and Description |
---|
MethodNotAllowedException(String method,
Collection<HttpMethod> supportedMethods) |
ResponseStatusException(HttpStatus status,
String reason)
Constructor with a response status and a reason to add to the exception
message as explanation.
|
ResponseStatusException(HttpStatus status,
String reason,
Throwable cause)
Constructor with a response status and a reason to add to the exception
message as explanation, as well as a nested exception.
|
ResponseStatusException(HttpStatus status,
String reason,
Throwable cause)
Constructor with a response status and a reason to add to the exception
message as explanation, as well as a nested exception.
|
ResponseStatusException(int rawStatusCode,
String reason,
Throwable cause)
Constructor with a response status and a reason to add to the exception
message as explanation, as well as a nested exception.
|
ResponseStatusException(int rawStatusCode,
String reason,
Throwable cause)
Constructor with a response status and a reason to add to the exception
message as explanation, as well as a nested exception.
|
ServerErrorException(String reason,
MethodParameter parameter,
Throwable cause)
Constructor for a 500 error with a
MethodParameter and an optional cause. |
ServerErrorException(String reason,
Method handlerMethod,
Throwable cause)
Constructor for a 500 error with a handler
Method and an optional cause. |
ServerErrorException(String reason,
Throwable cause)
Constructor for a 500 error with a reason and an optional cause.
|
ServerWebInputException(String reason,
MethodParameter parameter)
Constructor for a 400 error linked to a specific
MethodParameter . |
ServerWebInputException(String reason,
MethodParameter parameter,
Throwable cause)
Constructor for a 400 error with a root cause.
|
ServerWebInputException(String reason,
MethodParameter parameter,
Throwable cause)
Constructor for a 400 error with a root cause.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes)
Constructor for when the Content-Type can be parsed but is not supported.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
HttpMethod method)
Constructor that provides the HTTP method.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
HttpMethod method)
Constructor that provides the HTTP method.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType,
HttpMethod method)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType,
HttpMethod method)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeStatusException(MediaType contentType,
List<MediaType> supportedTypes,
ResolvableType bodyType,
HttpMethod method)
Constructor for when trying to encode from or decode to a specific Java type.
|
UnsupportedMediaTypeStatusException(String reason)
Constructor for when the specified Content-Type is invalid.
|
Modifier and Type | Method and Description |
---|---|
ApplicationContext |
DefaultServerWebExchange.getApplicationContext() |
ApplicationContext |
HttpWebHandlerAdapter.getApplicationContext()
Return the configured
ApplicationContext , if any. |
ForwardedHeaderTransformer |
HttpWebHandlerAdapter.getForwardedHeaderTransformer()
Return the configured
ForwardedHeaderTransformer . |
Modifier and Type | Method and Description |
---|---|
boolean |
DefaultServerWebExchange.checkNotModified(String etag,
Instant lastModified) |
Modifier and Type | Method and Description |
---|---|
protected HttpStatus |
ResponseStatusExceptionHandler.determineStatus(Throwable ex)
Deprecated.
as of 5.3 in favor of
ResponseStatusExceptionHandler.determineRawStatusCode(Throwable) . |
Modifier and Type | Method and Description |
---|---|
Locale |
AcceptHeaderLocaleContextResolver.getDefaultLocale()
The configured default locale, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
AcceptHeaderLocaleContextResolver.setDefaultLocale(Locale defaultLocale)
Configure a fixed default locale to fall back on if the request does not
have an "Accept-Language" header (not set by default).
|
void |
FixedLocaleContextResolver.setLocaleContext(ServerWebExchange exchange,
LocaleContext localeContext) |
void |
AcceptHeaderLocaleContextResolver.setLocaleContext(ServerWebExchange exchange,
LocaleContext locale) |
void |
LocaleContextResolver.setLocaleContext(ServerWebExchange exchange,
LocaleContext localeContext)
Set the current locale context to the given one,
potentially including a locale with associated time zone information.
|
Constructor and Description |
---|
FixedLocaleContextResolver(Locale locale,
TimeZone timeZone)
Create a FixedLocaleResolver that exposes the given locale and time zone.
|
Modifier and Type | Method and Description |
---|---|
protected LocaleContext |
FrameworkServlet.buildLocaleContext(HttpServletRequest request)
Build a LocaleContext for the given request, exposing the request's
primary locale as current locale.
|
protected ServletRequestAttributes |
FrameworkServlet.buildRequestAttributes(HttpServletRequest request,
HttpServletResponse response,
RequestAttributes previousAttributes)
Build ServletRequestAttributes for the given request (potentially also
holding a reference to the response), taking pre-bound attributes
(and their type) into consideration.
|
protected WebApplicationContext |
FrameworkServlet.findWebApplicationContext()
|
default String |
View.getContentType()
Return the content type of the view, if predetermined.
|
String |
FrameworkServlet.getContextAttribute()
Return the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext that this servlet is supposed to use. |
String |
FrameworkServlet.getContextConfigLocation()
Return the explicit context config location, if any.
|
String |
FrameworkServlet.getContextId()
Return the custom WebApplicationContext id, if any.
|
protected String |
DispatcherServlet.getDefaultViewName(HttpServletRequest request)
Translate the supplied request into a default view name.
|
protected HandlerExecutionChain |
DispatcherServlet.getHandler(HttpServletRequest request)
Return the HandlerExecutionChain for this request.
|
HandlerExecutionChain |
HandlerMapping.getHandler(HttpServletRequest request)
Return a handler and any interceptors for this request.
|
List<HandlerMapping> |
DispatcherServlet.getHandlerMappings()
Return the configured
HandlerMapping beans that were detected by
type in the WebApplicationContext or initialized based on the
default set of strategies from DispatcherServlet.properties. |
HandlerInterceptor[] |
HandlerExecutionChain.getInterceptors()
Return the array of interceptors to apply (in the given order).
|
protected Map<String,Object> |
ModelAndView.getModelInternal()
Return the model map.
|
MultipartResolver |
DispatcherServlet.getMultipartResolver()
Obtain this servlet's MultipartResolver, if any.
|
String |
HttpServletBean.getServletName()
Overridden method that simply returns
null when no
ServletConfig set yet. |
HttpStatus |
ModelAndView.getStatus()
Return the configured HTTP status for the response, if any.
|
String |
FlashMap.getTargetRequestPath()
Return the target URL path (or
null if none specified). |
ThemeSource |
DispatcherServlet.getThemeSource()
Return this servlet's ThemeSource, if any; else return
null . |
protected String |
FrameworkServlet.getUsernameForRequest(HttpServletRequest request)
Determine the username for the given request.
|
View |
ModelAndView.getView()
Return the View object, or
null if we are using a view name
to be resolved by the DispatcherServlet via a ViewResolver. |
String |
ModelAndView.getViewName()
Return the view name to be resolved by the DispatcherServlet
via a ViewResolver, or
null if we are using a View object. |
String |
RequestToViewNameTranslator.getViewName(HttpServletRequest request)
Translate the given
HttpServletRequest into a view name. |
WebApplicationContext |
FrameworkServlet.getWebApplicationContext()
Return this servlet's WebApplicationContext.
|
ModelAndView |
HandlerAdapter.handle(HttpServletRequest request,
HttpServletResponse response,
Object handler)
Use the given handler to handle this request.
|
protected ModelAndView |
DispatcherServlet.processHandlerException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Determine an error ModelAndView via the registered HandlerExceptionResolvers.
|
ModelAndView |
HandlerExceptionResolver.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Try to resolve the given exception that got thrown during handler execution,
returning a
ModelAndView that represents a specific error page if appropriate. |
View |
ViewResolver.resolveViewName(String viewName,
Locale locale)
Resolve the given view by name.
|
protected View |
DispatcherServlet.resolveViewName(String viewName,
Map<String,Object> model,
Locale locale,
HttpServletRequest request)
Resolve the given view name into a View object (to be rendered).
|
FlashMap |
FlashMapManager.retrieveAndUpdate(HttpServletRequest request,
HttpServletResponse response)
Find a FlashMap saved by a previous request that matches to the current
request, remove it from underlying storage, and also remove other
expired FlashMap instances.
|
Modifier and Type | Method and Description |
---|---|
ModelAndView |
ModelAndView.addAllObjects(Map<String,?> modelMap)
Add all attributes contained in the provided Map to the model.
|
ModelAndView |
ModelAndView.addObject(String attributeName,
Object attributeValue)
Add an attribute to the model.
|
FlashMap |
FlashMap.addTargetRequestParams(MultiValueMap<String,String> params)
Provide request parameters identifying the request for this FlashMap.
|
default void |
HandlerInterceptor.afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Callback after completion of request processing, that is, after rendering
the view.
|
protected ServletRequestAttributes |
FrameworkServlet.buildRequestAttributes(HttpServletRequest request,
HttpServletResponse response,
RequestAttributes previousAttributes)
Build ServletRequestAttributes for the given request (potentially also
holding a reference to the response), taking pre-bound attributes
(and their type) into consideration.
|
protected ServletRequestAttributes |
FrameworkServlet.buildRequestAttributes(HttpServletRequest request,
HttpServletResponse response,
RequestAttributes previousAttributes)
Build ServletRequestAttributes for the given request (potentially also
holding a reference to the response), taking pre-bound attributes
(and their type) into consideration.
|
protected WebApplicationContext |
FrameworkServlet.createWebApplicationContext(ApplicationContext parent)
Instantiate the WebApplicationContext for this servlet, either a default
XmlWebApplicationContext
or a custom context class , if set. |
protected WebApplicationContext |
FrameworkServlet.createWebApplicationContext(WebApplicationContext parent)
Instantiate the WebApplicationContext for this servlet, either a default
XmlWebApplicationContext
or a custom context class , if set. |
boolean |
FlashMap.equals(Object other) |
default void |
HandlerInterceptor.postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView)
Interception point after successful execution of a handler.
|
protected ModelAndView |
DispatcherServlet.processHandlerException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Determine an error ModelAndView via the registered HandlerExceptionResolvers.
|
void |
View.render(Map<String,?> model,
HttpServletRequest request,
HttpServletResponse response)
Render the view given the specified model.
|
ModelAndView |
HandlerExceptionResolver.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Try to resolve the given exception that got thrown during handler execution,
returning a
ModelAndView that represents a specific error page if appropriate. |
protected View |
DispatcherServlet.resolveViewName(String viewName,
Map<String,Object> model,
Locale locale,
HttpServletRequest request)
Resolve the given view name into a View object (to be rendered).
|
void |
FrameworkServlet.setContextAttribute(String contextAttribute)
Set the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext that this servlet is supposed to use. |
void |
FrameworkServlet.setContextConfigLocation(String contextConfigLocation)
Set the context config location explicitly, instead of relying on the default
location built from the namespace.
|
void |
FrameworkServlet.setContextId(String contextId)
Specify a custom WebApplicationContext id,
to be used as serialization id for the underlying BeanFactory.
|
void |
FrameworkServlet.setContextInitializers(ApplicationContextInitializer<?>... initializers)
Specify which
ApplicationContextInitializer instances should be used
to initialize the application context used by this FrameworkServlet . |
void |
LocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale)
Set the current locale to the given one.
|
void |
LocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale)
Set the current locale to the given one.
|
void |
LocaleContextResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext)
Set the current locale context to the given one,
potentially including a locale with associated time zone information.
|
void |
LocaleContextResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext)
Set the current locale context to the given one,
potentially including a locale with associated time zone information.
|
void |
ModelAndView.setStatus(HttpStatus status)
Set the HTTP status to use for the response.
|
void |
FlashMap.setTargetRequestPath(String path)
Provide a URL path to help identify the target request for this FlashMap.
|
void |
ThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName)
Set the current theme name to the given one.
|
void |
ThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName)
Set the current theme name to the given one.
|
void |
ModelAndView.setView(View view)
Set a View object for this ModelAndView.
|
void |
ModelAndView.setViewName(String viewName)
Set a view name for this ModelAndView, to be resolved by the
DispatcherServlet via a ViewResolver.
|
Constructor and Description |
---|
HandlerExecutionChain(Object handler,
HandlerInterceptor... interceptors)
Create a new HandlerExecutionChain.
|
ModelAndView(String viewName,
Map<String,?> model)
Create a new ModelAndView given a view name and a model.
|
ModelAndView(String viewName,
Map<String,?> model,
HttpStatus status)
Create a new ModelAndView given a view name, model, and HTTP status.
|
ModelAndView(String viewName,
Map<String,?> model,
HttpStatus status)
Create a new ModelAndView given a view name, model, and HTTP status.
|
ModelAndView(String viewName,
Map<String,?> model,
HttpStatus status)
Create a new ModelAndView given a view name, model, and HTTP status.
|
ModelAndView(View view,
Map<String,?> model)
Create a new ModelAndView given a View object and a model.
|
Modifier and Type | Method and Description |
---|---|
static Object |
MvcNamespaceUtils.getContentNegotiationManager(ParserContext context)
Find the
ContentNegotiationManager bean created by or registered
with the annotation-driven element. |
BeanDefinition |
CorsBeanDefinitionParser.parse(Element element,
ParserContext parserContext) |
Modifier and Type | Method and Description |
---|---|
static RuntimeBeanReference |
MvcNamespaceUtils.registerCorsConfigurations(Map<String,CorsConfiguration> corsConfigurations,
ParserContext context,
Object source)
Registers a
Map<String, CorsConfiguration> (mapped CorsConfiguration s)
under a well-known name unless already registered. |
static RuntimeBeanReference |
MvcNamespaceUtils.registerCorsConfigurations(Map<String,CorsConfiguration> corsConfigurations,
ParserContext context,
Object source)
Registers a
Map<String, CorsConfiguration> (mapped CorsConfiguration s)
under a well-known name unless already registered. |
static void |
MvcNamespaceUtils.registerDefaultComponents(ParserContext context,
Object source) |
static RuntimeBeanReference |
MvcNamespaceUtils.registerPathMatcher(RuntimeBeanReference pathMatcherRef,
ParserContext context,
Object source)
Adds an alias to an existing well-known name or registers a new instance of a
PathMatcher
under that well-known name, unless already registered. |
static RuntimeBeanReference |
MvcNamespaceUtils.registerPathMatcher(RuntimeBeanReference pathMatcherRef,
ParserContext context,
Object source)
Adds an alias to an existing well-known name or registers a new instance of a
PathMatcher
under that well-known name, unless already registered. |
static RuntimeBeanReference |
MvcNamespaceUtils.registerUrlPathHelper(RuntimeBeanReference urlPathHelperRef,
ParserContext context,
Object source)
Adds an alias to an existing well-known name or registers a new instance of a
UrlPathHelper
under that well-known name, unless already registered. |
static RuntimeBeanReference |
MvcNamespaceUtils.registerUrlPathHelper(RuntimeBeanReference urlPathHelperRef,
ParserContext context,
Object source)
Adds an alias to an existing well-known name or registers a new instance of a
UrlPathHelper
under that well-known name, unless already registered. |
Modifier and Type | Method and Description |
---|---|
protected SimpleUrlHandlerMapping |
DefaultServletHandlerConfigurer.buildHandlerMapping()
Return a handler mapping instance ordered at
Ordered.LOWEST_PRECEDENCE
containing the DefaultServletHttpRequestHandler instance mapped
to "/**" ; or null if default servlet handling was not
enabled. |
protected SimpleUrlHandlerMapping |
ViewControllerRegistry.buildHandlerMapping()
Return the
HandlerMapping that contains the registered view
controller mappings, or null for no registrations. |
HandlerMapping |
WebMvcConfigurationSupport.defaultServletHandlerMapping()
Return a handler mapping ordered at Integer.MAX_VALUE with a mapped
default servlet handler.
|
ApplicationContext |
WebMvcConfigurationSupport.getApplicationContext()
Return the associated Spring
ApplicationContext . |
protected AbstractHandlerMapping |
ResourceHandlerRegistry.getHandlerMapping()
Return a handler mapping with the mapped resource handlers; or
null in case
of no registrations. |
MessageCodesResolver |
WebMvcConfigurerAdapter.getMessageCodesResolver()
Deprecated.
Provide a custom
MessageCodesResolver for building message codes
from data binding and validation error codes. |
protected MessageCodesResolver |
DelegatingWebMvcConfiguration.getMessageCodesResolver() |
protected MessageCodesResolver |
WebMvcConfigurationSupport.getMessageCodesResolver()
Override this method to provide a custom
MessageCodesResolver . |
default MessageCodesResolver |
WebMvcConfigurer.getMessageCodesResolver()
Provide a custom
MessageCodesResolver for building message codes
from data binding and validation error codes. |
PathMatcher |
PathMatchConfigurer.getPathMatcher() |
protected Map<String,Predicate<Class<?>>> |
PathMatchConfigurer.getPathPrefixes() |
PathPatternParser |
PathMatchConfigurer.getPatternParser()
Return the
PathPatternParser to use, if configured. |
ServletContext |
WebMvcConfigurationSupport.getServletContext()
Return the associated
ServletContext . |
protected AsyncTaskExecutor |
AsyncSupportConfigurer.getTaskExecutor() |
protected Long |
AsyncSupportConfigurer.getTimeout() |
UrlPathHelper |
PathMatchConfigurer.getUrlPathHelper() |
Validator |
WebMvcConfigurerAdapter.getValidator()
Deprecated.
Provide a custom
Validator instead of the one created by default. |
protected Validator |
DelegatingWebMvcConfiguration.getValidator() |
protected Validator |
WebMvcConfigurationSupport.getValidator()
Override this method to provide a custom
Validator . |
default Validator |
WebMvcConfigurer.getValidator()
Provide a custom
Validator instead of the one created by default. |
Boolean |
PathMatchConfigurer.isUseRegisteredSuffixPatternMatch()
Deprecated.
as of 5.2.4, see deprecation note on
PathMatchConfigurer.setUseRegisteredSuffixPatternMatch(Boolean) . |
Boolean |
PathMatchConfigurer.isUseSuffixPatternMatch()
Deprecated.
as of 5.2.4, see deprecation note on
PathMatchConfigurer.setUseSuffixPatternMatch(Boolean) . |
Boolean |
PathMatchConfigurer.isUseTrailingSlashMatch()
Deprecated.
|
HandlerMapping |
WebMvcConfigurationSupport.resourceHandlerMapping(ContentNegotiationManager contentNegotiationManager,
FormattingConversionService conversionService,
ResourceUrlProvider resourceUrlProvider)
Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped
resource handlers.
|
HandlerMapping |
WebMvcConfigurationSupport.viewControllerHandlerMapping(FormattingConversionService conversionService,
ResourceUrlProvider resourceUrlProvider)
Return a handler mapping ordered at 1 to map URL paths directly to
view names.
|
Modifier and Type | Method and Description |
---|---|
void |
DefaultServletHandlerConfigurer.enable(String defaultServletName)
Enable forwarding to the "default" Servlet identified by the given name.
|
ContentNegotiationConfigurer |
ContentNegotiationConfigurer.mediaTypes(Map<String,MediaType> mediaTypes)
|
void |
WebMvcConfigurationSupport.setApplicationContext(ApplicationContext applicationContext)
Set the Spring
ApplicationContext , e.g. |
protected void |
RedirectViewControllerRegistration.setApplicationContext(ApplicationContext applicationContext) |
protected void |
ViewControllerRegistration.setApplicationContext(ApplicationContext applicationContext) |
void |
WebMvcConfigurationSupport.setServletContext(ServletContext servletContext)
Set the
ServletContext , e.g. |
void |
ContentNegotiationConfigurer.strategies(List<ContentNegotiationStrategy> strategies)
Set the exact list of strategies to use.
|
Modifier and Type | Method and Description |
---|---|
default String |
ServerRequest.Headers.firstHeader(String headerName)
Get the first header value, if any, for the header for the given name.
|
InetSocketAddress |
ServerRequest.Headers.host()
Get the value of the
Host header, if available. |
default HttpMethod |
ServerRequest.method()
Get the HTTP method.
|
ModelAndView |
ServerResponse.writeTo(HttpServletRequest request,
HttpServletResponse response,
ServerResponse.Context context)
Write this response to the given servlet response.
|
Modifier and Type | Method and Description |
---|---|
RenderingResponse.Builder |
RenderingResponse.Builder.modelAttribute(String name,
Object value)
Add the supplied attribute value under the supplied name.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
RouterFunctionMapping.getHandlerInternal(HttpServletRequest servletRequest) |
RouterFunction<?> |
RouterFunctionMapping.getRouterFunction()
Return the configured
RouterFunction . |
ModelAndView |
HandlerFunctionAdapter.handle(HttpServletRequest servletRequest,
HttpServletResponse servletResponse,
Object handler) |
Modifier and Type | Method and Description |
---|---|
void |
RouterFunctionMapping.setRouterFunction(RouterFunction<?> routerFunction)
Set the router function to map to.
|
Modifier and Type | Method and Description |
---|---|
protected Integer |
SimpleMappingExceptionResolver.determineStatusCode(HttpServletRequest request,
String viewName)
Determine the HTTP status code to apply for the given error view.
|
protected String |
SimpleMappingExceptionResolver.determineViewName(Exception ex,
HttpServletRequest request)
Determine the view name for the given exception, first checking against the
"excludedExecptions" , then searching the
"exceptionMappings" , and finally using the
"defaultErrorView" as a fallback. |
protected ModelAndView |
SimpleMappingExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Actually resolve the given exception that got thrown during on handler execution,
returning a ModelAndView that represents a specific error page if appropriate.
|
protected abstract ModelAndView |
AbstractHandlerExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Actually resolve the given exception that got thrown during handler execution,
returning a
ModelAndView that represents a specific error page if appropriate. |
protected ModelAndView |
AbstractHandlerMethodExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
protected abstract ModelAndView |
AbstractHandlerMethodExceptionResolver.doResolveHandlerMethodException(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod,
Exception ex)
Actually resolve the given exception that got thrown during on handler execution,
returning a ModelAndView that represents a specific error page if appropriate.
|
protected String |
SimpleMappingExceptionResolver.findMatchingViewName(Properties exceptionMappings,
Exception ex)
Find a matching view name in the given exception mappings.
|
protected HandlerInterceptor[] |
AbstractHandlerMapping.getAdaptedInterceptors()
Return the adapted interceptors as
HandlerInterceptor array. |
CorsConfiguration |
HandlerMappingIntrospector.getCorsConfiguration(HttpServletRequest request) |
protected CorsConfiguration |
AbstractHandlerMapping.getCorsConfiguration(Object handler,
HttpServletRequest request)
Retrieve the CORS configuration for the given handler.
|
CorsConfigurationSource |
AbstractHandlerMapping.getCorsConfigurationSource()
Return the
configured CorsConfigurationSource , if any. |
Object |
AbstractHandlerMapping.getDefaultHandler()
Return the default handler for this handler mapping,
or
null if none. |
HandlerExecutionChain |
AbstractHandlerMapping.getHandler(HttpServletRequest request)
Look up a handler for the given request, falling back to the default
handler if no specific one is found.
|
protected abstract Object |
AbstractHandlerMapping.getHandlerInternal(HttpServletRequest request)
Look up a handler for the given request, returning
null if no
specific one is found. |
protected Object |
AbstractUrlHandlerMapping.getHandlerInternal(HttpServletRequest request)
Look up a handler for the URL path of the given request.
|
protected HandlerMethod |
AbstractHandlerMethodMapping.getHandlerInternal(HttpServletRequest request)
Look up a handler method for the given request.
|
List<HandlerMethod> |
AbstractHandlerMethodMapping.getHandlerMethodsForMappingName(String mappingName)
Return the handler methods for the given mapping name.
|
protected MappedInterceptor[] |
AbstractHandlerMapping.getMappedInterceptors()
Return all configured
MappedInterceptor s as an array. |
protected abstract T |
AbstractHandlerMethodMapping.getMappingForMethod(Method method,
Class<?> handlerType)
Provide the mapping for a handler method.
|
MatchableHandlerMapping |
HandlerMappingIntrospector.getMatchableHandlerMapping(HttpServletRequest request)
Find the
HandlerMapping that would handle the given request and
return a MatchableHandlerMapping to use for path matching. |
protected abstract T |
AbstractHandlerMethodMapping.getMatchingMapping(T mapping,
HttpServletRequest request)
Check if a mapping matches the current request and return a (potentially
new) mapping with conditions relevant to the current request.
|
HandlerMethodMappingNamingStrategy<T> |
AbstractHandlerMethodMapping.getNamingStrategy()
Return the configured naming strategy or
null . |
String[] |
MappedInterceptor.getPathPatterns()
Return the patterns this interceptor is mapped to.
|
PathPatternParser |
AbstractHandlerMapping.getPatternParser()
Return the
configured
PathPatternParser , or null otherwise which indicates that
String pattern matching with AntPathMatcher is enabled instead. |
default PathPatternParser |
MatchableHandlerMapping.getPatternParser()
Return the parser of this
HandlerMapping , if configured in which
case pre-parsed patterns are used. |
Object |
AbstractUrlHandlerMapping.getRootHandler()
Return the root handler for this handler mapping (registered for "/"),
or
null if none. |
ModelAndView |
SimpleServletHandlerAdapter.handle(HttpServletRequest request,
HttpServletResponse response,
Object handler) |
protected HandlerMethod |
AbstractHandlerMethodMapping.handleNoMatch(Set<T> mappings,
String lookupPath,
HttpServletRequest request)
Invoked when no matching mapping is not found.
|
protected CorsConfiguration |
AbstractHandlerMethodMapping.initCorsConfiguration(Object handler,
Method method,
T mapping)
Extract and return the CORS configuration for the mapping.
|
protected Object |
AbstractUrlHandlerMapping.lookupHandler(RequestPath path,
String lookupPath,
HttpServletRequest request)
Look up a handler instance for the given URL path.
|
protected Object |
AbstractUrlHandlerMapping.lookupHandler(String lookupPath,
HttpServletRequest request)
Look up a handler instance for the given URL path.
|
protected HandlerMethod |
AbstractHandlerMethodMapping.lookupHandlerMethod(String lookupPath,
HttpServletRequest request)
Look up the best-matching handler method for the current request.
|
RequestMatchResult |
MatchableHandlerMapping.match(HttpServletRequest request,
String pattern)
Determine whether the request matches the given pattern.
|
RequestMatchResult |
AbstractUrlHandlerMapping.match(HttpServletRequest request,
String pattern) |
ModelAndView |
AbstractHandlerExceptionResolver.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Check whether this resolver is supposed to apply (i.e.
|
ModelAndView |
HandlerExceptionResolverComposite.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Resolve the exception by iterating over the list of configured exception resolvers.
|
Modifier and Type | Method and Description |
---|---|
void |
WebRequestHandlerInterceptorAdapter.afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
void |
MappedInterceptor.afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
protected Object |
AbstractUrlHandlerMapping.buildPathExposingHandler(Object rawHandler,
String bestMatchingPattern,
String pathWithinMapping,
Map<String,String> uriTemplateVariables)
Build a handler object for the given raw handler, exposing the actual
handler, the
HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE , as well as
the HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE before executing the handler. |
protected ModelAndView |
SimpleMappingExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Actually resolve the given exception that got thrown during on handler execution,
returning a ModelAndView that represents a specific error page if appropriate.
|
protected abstract ModelAndView |
AbstractHandlerExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Actually resolve the given exception that got thrown during handler execution,
returning a
ModelAndView that represents a specific error page if appropriate. |
protected ModelAndView |
AbstractHandlerMethodExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
protected abstract ModelAndView |
AbstractHandlerMethodExceptionResolver.doResolveHandlerMethodException(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod,
Exception ex)
Actually resolve the given exception that got thrown during on handler execution,
returning a ModelAndView that represents a specific error page if appropriate.
|
protected HandlerExecutionChain |
AbstractHandlerMapping.getCorsHandlerExecutionChain(HttpServletRequest request,
HandlerExecutionChain chain,
CorsConfiguration config)
Update the HandlerExecutionChain for CORS-related handling.
|
void |
WebRequestHandlerInterceptorAdapter.postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView) |
void |
MappedInterceptor.postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView) |
ModelAndView |
AbstractHandlerExceptionResolver.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Check whether this resolver is supposed to apply (i.e.
|
ModelAndView |
HandlerExceptionResolverComposite.resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Resolve the exception by iterating over the list of configured exception resolvers.
|
void |
AbstractHandlerMapping.setDefaultHandler(Object defaultHandler)
Set the default handler for this handler mapping.
|
void |
SimpleMappingExceptionResolver.setExceptionAttribute(String exceptionAttribute)
Set the name of the model attribute as which the exception should be exposed.
|
void |
AbstractHandlerMapping.setPatternParser(PathPatternParser patternParser)
Enable use of pre-parsed
PathPattern s as an alternative to
String pattern matching with AntPathMatcher . |
void |
AbstractHandlerMethodMapping.setPatternParser(PathPatternParser patternParser) |
void |
AbstractUrlHandlerMapping.setRootHandler(Object rootHandler)
Set the root handler for this handler mapping, that is,
the handler to be registered for the root path ("/").
|
protected boolean |
AbstractHandlerExceptionResolver.shouldApplyTo(HttpServletRequest request,
Object handler)
Check whether this resolver is supposed to apply to the given handler.
|
protected boolean |
AbstractHandlerMethodExceptionResolver.shouldApplyTo(HttpServletRequest request,
Object handler)
Checks if the handler is a
HandlerMethod and then delegates to the
base class implementation of #shouldApplyTo(HttpServletRequest, Object)
passing the bean of the HandlerMethod . |
Constructor and Description |
---|
MappedInterceptor(String[] includePatterns,
HandlerInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with include patterns only. |
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
HandlerInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
without a provided parser. |
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
HandlerInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
without a provided parser. |
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
HandlerInterceptor interceptor,
PathPatternParser parser)
Create an instance with the given include and exclude patterns along with
the target interceptor for the mappings.
|
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
HandlerInterceptor interceptor,
PathPatternParser parser)
Create an instance with the given include and exclude patterns along with
the target interceptor for the mappings.
|
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
HandlerInterceptor interceptor,
PathPatternParser parser)
Create an instance with the given include and exclude patterns along with
the target interceptor for the mappings.
|
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
WebRequestInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with a WebRequestInterceptor as the target. |
MappedInterceptor(String[] includePatterns,
String[] excludePatterns,
WebRequestInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with a WebRequestInterceptor as the target. |
MappedInterceptor(String[] includePatterns,
WebRequestInterceptor interceptor)
Variant of
MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with a WebRequestInterceptor as the target. |
Modifier and Type | Method and Description |
---|---|
protected TimeZone |
SessionLocaleResolver.determineDefaultTimeZone(HttpServletRequest request)
Determine the default time zone for the given request, called if no
TimeZone session attribute has been found. |
protected TimeZone |
CookieLocaleResolver.determineDefaultTimeZone(HttpServletRequest request)
Determine the default time zone for the given request, called if no locale
cookie has been found.
|
protected Locale |
AbstractLocaleResolver.getDefaultLocale()
Get the default
Locale that this resolver is supposed to fall back
to, if any. |
protected Locale |
CookieLocaleResolver.getDefaultLocale()
Return the fixed locale that this resolver will return if no cookie is found,
if any.
|
Locale |
AcceptHeaderLocaleResolver.getDefaultLocale()
The configured default locale, if any.
|
protected TimeZone |
CookieLocaleResolver.getDefaultTimeZone()
Return the fixed time zone that this resolver will return if no cookie is found,
if any.
|
TimeZone |
AbstractLocaleContextResolver.getDefaultTimeZone()
Get the default
TimeZone that this resolver is supposed to fall
back to, if any. |
String[] |
LocaleChangeInterceptor.getHttpMethods()
Return the configured HTTP methods.
|
protected Locale |
LocaleChangeInterceptor.parseLocaleValue(String localeValue)
Parse the given locale value as coming from a request parameter.
|
protected Locale |
CookieLocaleResolver.parseLocaleValue(String localeValue)
Parse the given locale value coming from an incoming cookie.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractLocaleResolver.setDefaultLocale(Locale defaultLocale)
Set a default
Locale that this resolver will return if no other
locale is found. |
void |
CookieLocaleResolver.setDefaultLocale(Locale defaultLocale)
Set a fixed locale that this resolver will return if no cookie is found.
|
void |
AcceptHeaderLocaleResolver.setDefaultLocale(Locale defaultLocale)
Configure a fixed default locale to fall back on if the request does not
have an "Accept-Language" header.
|
void |
CookieLocaleResolver.setDefaultTimeZone(TimeZone defaultTimeZone)
Set a fixed time zone that this resolver will return if no cookie is found.
|
void |
AbstractLocaleContextResolver.setDefaultTimeZone(TimeZone defaultTimeZone)
Set a default
TimeZone that this resolver will return if no other
time zone is found. |
void |
LocaleChangeInterceptor.setHttpMethods(String... httpMethods)
Configure the HTTP method(s) over which the locale can be changed.
|
void |
CookieLocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
CookieLocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
AbstractLocaleContextResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
AbstractLocaleContextResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
AcceptHeaderLocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
AcceptHeaderLocaleResolver.setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale) |
void |
SessionLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
void |
SessionLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
void |
FixedLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
void |
FixedLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
void |
CookieLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
void |
CookieLocaleResolver.setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext) |
Modifier and Type | Method and Description |
---|---|
HttpStatus |
ParameterizableViewController.getStatusCode()
Return the configured HTTP status code or
null . |
View |
ParameterizableViewController.getView()
Return the View object, or
null if we are using a view name
to be resolved by the DispatcherServlet via a ViewResolver. |
String |
ParameterizableViewController.getViewName()
Return the name of the view to delegate to, or
null if using a
View instance. |
ModelAndView |
HttpRequestHandlerAdapter.handle(HttpServletRequest request,
HttpServletResponse response,
Object handler) |
ModelAndView |
SimpleControllerHandlerAdapter.handle(HttpServletRequest request,
HttpServletResponse response,
Object handler) |
ModelAndView |
AbstractController.handleRequest(HttpServletRequest request,
HttpServletResponse response) |
ModelAndView |
Controller.handleRequest(HttpServletRequest request,
HttpServletResponse response)
Process the request and return a ModelAndView object which the DispatcherServlet
will render.
|
protected abstract ModelAndView |
AbstractController.handleRequestInternal(HttpServletRequest request,
HttpServletResponse response)
Template method.
|
protected CacheControl |
WebContentInterceptor.lookupCacheControl(PathContainer path)
Find a
CacheControl instance for the
given parsed path . |
protected CacheControl |
WebContentInterceptor.lookupCacheControl(String lookupPath)
Find a
CacheControl instance for the
given String lookupPath. |
protected Integer |
WebContentInterceptor.lookupCacheSeconds(PathContainer path)
Find a cacheSeconds value for the given parsed
path . |
protected Integer |
WebContentInterceptor.lookupCacheSeconds(String lookupPath)
Find a cacheSeconds instance for the given String lookupPath.
|
Modifier and Type | Method and Description |
---|---|
void |
WebContentInterceptor.afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
This implementation is empty.
|
void |
WebContentInterceptor.postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView)
This implementation is empty.
|
void |
UrlFilenameViewController.setPrefix(String prefix)
Set the prefix to prepend to the request URL filename
to build a view name.
|
void |
ParameterizableViewController.setStatusCode(HttpStatus statusCode)
Configure the HTTP status code that this controller should set on the
response.
|
void |
UrlFilenameViewController.setSuffix(String suffix)
Set the suffix to append to the request URL filename
to build a view name.
|
void |
ParameterizableViewController.setViewName(String viewName)
Set a view name for the ModelAndView to return, to be resolved by the
DispatcherServlet via a ViewResolver.
|
Modifier and Type | Method and Description |
---|---|
protected ModelAndView |
ResponseStatusExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
Modifier and Type | Method and Description |
---|---|
protected ModelAndView |
ResponseStatusExceptionResolver.applyStatusAndReason(int statusCode,
String reason,
HttpServletResponse response)
Apply the resolved status code and reason to the response.
|
protected ModelAndView |
ResponseStatusExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
ModelAndView |
ModelAndViewResolver.resolveModelAndView(Method handlerMethod,
Class<?> handlerType,
Object returnValue,
ExtendedModelMap implicitModel,
NativeWebRequest webRequest) |
protected ModelAndView |
ResponseStatusExceptionResolver.resolveResponseStatus(ResponseStatus responseStatus,
HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Template method that handles the
@ResponseStatus annotation. |
protected ModelAndView |
ResponseStatusExceptionResolver.resolveResponseStatusException(ResponseStatusException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Template method that handles an
ResponseStatusException . |
Modifier and Type | Method and Description |
---|---|
RequestCondition<?> |
RequestConditionHolder.getCondition()
Return the held request condition, or
null if not holding one. |
RequestConditionHolder |
RequestConditionHolder.getMatchingCondition(HttpServletRequest request)
Get the matching condition for the held request condition wrap it in a
new RequestConditionHolder instance.
|
ParamsRequestCondition |
ParamsRequestCondition.getMatchingCondition(HttpServletRequest request)
Returns "this" instance if the request matches all param expressions;
or
null otherwise. |
RequestMethodsRequestCondition |
RequestMethodsRequestCondition.getMatchingCondition(HttpServletRequest request)
Check if any of the HTTP request methods match the given request and
return an instance that contains the matching HTTP request method only.
|
T |
RequestCondition.getMatchingCondition(HttpServletRequest request)
Check if the condition matches the request returning a potentially new
instance created for the current request.
|
HeadersRequestCondition |
HeadersRequestCondition.getMatchingCondition(HttpServletRequest request)
Returns "this" instance if the request matches all expressions;
or
null otherwise. |
ProducesRequestCondition |
ProducesRequestCondition.getMatchingCondition(HttpServletRequest request)
Checks if any of the contained media type expressions match the given
request 'Content-Type' header and returns an instance that is guaranteed
to contain matching expressions only.
|
CompositeRequestCondition |
CompositeRequestCondition.getMatchingCondition(HttpServletRequest request)
Delegate to all contained conditions to match the request and return the
resulting "matching" condition instances.
|
PatternsRequestCondition |
PatternsRequestCondition.getMatchingCondition(HttpServletRequest request)
Checks if any of the patterns match the given request and returns an instance
that is guaranteed to contain matching patterns, sorted via
PathMatcher.getPatternComparator(String) . |
PathPatternsRequestCondition |
PathPatternsRequestCondition.getMatchingCondition(HttpServletRequest request)
Checks if any of the patterns match the given request and returns an
instance that is guaranteed to contain matching patterns, sorted.
|
ConsumesRequestCondition |
ConsumesRequestCondition.getMatchingCondition(HttpServletRequest request)
Checks if any of the contained media type expressions match the given
request 'Content-Type' header and returns an instance that is guaranteed
to contain matching expressions only.
|
T |
NameValueExpression.getValue() |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractRequestCondition.equals(Object other) |
Constructor and Description |
---|
ConsumesRequestCondition(String[] consumes,
String[] headers)
Creates a new instance with "consumes" and "header" expressions.
|
PatternsRequestCondition(String[] patterns,
boolean useTrailingSlashMatch,
PathMatcher pathMatcher)
Variant of
PatternsRequestCondition(String...) with a
PathMatcher and flag for matching trailing slashes. |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useTrailingSlashMatch)
Deprecated.
as of 5.3 in favor of
PatternsRequestCondition(String[], boolean, PathMatcher) . |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useTrailingSlashMatch)
Deprecated.
as of 5.3 in favor of
PatternsRequestCondition(String[], boolean, PathMatcher) . |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch)
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping
on the deprecation of path extension config options. |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch)
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping
on the deprecation of path extension config options. |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch,
List<String> fileExtensions)
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping
on the deprecation of path extension config options. |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch,
List<String> fileExtensions)
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping
on the deprecation of path extension config options. |
PatternsRequestCondition(String[] patterns,
UrlPathHelper urlPathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch,
List<String> fileExtensions)
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping
on the deprecation of path extension config options. |
ProducesRequestCondition(String[] produces,
String[] headers)
Creates a new instance with "produces" and "header" expressions.
|
ProducesRequestCondition(String[] produces,
String[] headers,
ContentNegotiationManager manager)
Same as
ProducesRequestCondition(String[], String[]) but also
accepting a ContentNegotiationManager . |
ProducesRequestCondition(String[] produces,
String[] headers,
ContentNegotiationManager manager)
Same as
ProducesRequestCondition(String[], String[]) but also
accepting a ContentNegotiationManager . |
RequestConditionHolder(RequestCondition<?> requestCondition)
Create a new holder to wrap the given request condition.
|
Modifier and Type | Method and Description |
---|---|
ContentNegotiationManager |
RequestMappingInfo.BuilderConfiguration.getContentNegotiationManager()
Return the ContentNegotiationManager to use for the ProducesRequestCondition,
if any.
|
RequestCondition<?> |
RequestMappingInfo.getCustomCondition()
Return the "custom" condition of this
RequestMappingInfo , or null . |
List<String> |
RequestMappingInfo.BuilderConfiguration.getFileExtensions()
Deprecated.
as of 5.2.4. See class-level note in
RequestMappingHandlerMapping on the deprecation of path
extension config options. |
protected HandlerMethod |
RequestMappingInfoHandlerMapping.getHandlerInternal(HttpServletRequest request) |
RequestMappingInfo |
RequestMappingInfo.getMatchingCondition(HttpServletRequest request)
Checks if all conditions in this request mapping info match the provided
request and returns a potentially new request mapping info with conditions
tailored to the current request.
|
String |
RequestMappingInfo.getName()
Return the name for this mapping, or
null . |
PathMatcher |
RequestMappingInfo.BuilderConfiguration.getPathMatcher()
Return a custom PathMatcher to use for the PatternsRequestCondition, if any.
|
PathPatternsRequestCondition |
RequestMappingInfo.getPathPatternsCondition()
Return the patterns condition in use when parsed patterns are
enabled . |
PathPatternParser |
RequestMappingInfo.BuilderConfiguration.getPatternParser()
|
PatternsRequestCondition |
RequestMappingInfo.getPatternsCondition()
Return the patterns condition when String pattern matching via
PathMatcher is in use. |
UrlPathHelper |
RequestMappingInfo.BuilderConfiguration.getUrlPathHelper()
Deprecated.
as of 5.3, the path is resolved externally and obtained with
ServletRequestPathUtils.getCachedPathValue(ServletRequest) ;
this method always returns UrlPathHelper.defaultInstance . |
ModelAndView |
AbstractHandlerMethodAdapter.handle(HttpServletRequest request,
HttpServletResponse response,
Object handler)
This implementation expects the handler to be an
HandlerMethod . |
protected abstract ModelAndView |
AbstractHandlerMethodAdapter.handleInternal(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod)
Use the given handler method to handle the request.
|
Modifier and Type | Method and Description |
---|---|
boolean |
RequestMappingInfo.equals(Object other) |
void |
RequestMappingInfo.BuilderConfiguration.setPathMatcher(PathMatcher pathMatcher)
Set a custom PathMatcher to use for the PatternsRequestCondition.
|
void |
RequestMappingInfo.BuilderConfiguration.setPatternParser(PathPatternParser patternParser)
Enable use of parsed
PathPattern s as described in
AbstractHandlerMapping.setPatternParser(PathPatternParser) . |
void |
RequestMappingInfo.BuilderConfiguration.setUrlPathHelper(UrlPathHelper urlPathHelper)
Deprecated.
as of 5.3, the path is resolved externally and obtained with
ServletRequestPathUtils.getCachedPathValue(ServletRequest) |
Modifier and Type | Method and Description |
---|---|
protected Object |
AbstractMessageConverterMethodArgumentResolver.adaptArgumentIfNecessary(Object arg,
MethodParameter parameter)
Adapt the given argument against the method parameter, if necessary.
|
Object |
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite(Object body,
MethodParameter returnType,
MediaType contentType,
Class<? extends HttpMessageConverter<?>> converterType,
ServerHttpRequest request,
ServerHttpResponse response) |
T |
ResponseBodyAdvice.beforeBodyWrite(T body,
MethodParameter returnType,
MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType,
ServerHttpRequest request,
ServerHttpResponse response)
Invoked after an
HttpMessageConverter is selected and just before
its write method is invoked. |
protected Object |
ServletModelAttributeMethodProcessor.createAttributeFromRequestValue(String sourceValue,
String attributeName,
MethodParameter parameter,
WebDataBinderFactory binderFactory,
NativeWebRequest request)
Create a model attribute from a String request value (e.g.
|
protected ModelAndView |
ExceptionHandlerExceptionResolver.doResolveHandlerMethodException(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod,
Exception exception)
Find an
@ExceptionHandler method and invoke it to handle the raised exception. |
protected String |
PathVariableMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
ApplicationContext |
ExceptionHandlerExceptionResolver.getApplicationContext() |
List<HandlerMethodArgumentResolver> |
RequestMappingHandlerAdapter.getArgumentResolvers()
Return the configured argument resolvers, or possibly
null if
not initialized yet via RequestMappingHandlerAdapter.afterPropertiesSet() . |
HandlerMethodArgumentResolverComposite |
ExceptionHandlerExceptionResolver.getArgumentResolvers()
Return the configured argument resolvers, or possibly
null if
not initialized yet via ExceptionHandlerExceptionResolver.afterPropertiesSet() . |
protected ConfigurableBeanFactory |
RequestMappingHandlerAdapter.getBeanFactory()
Return the owning factory of this bean instance, or
null if none. |
List<HandlerMethodArgumentResolver> |
RequestMappingHandlerAdapter.getCustomArgumentResolvers()
Return the custom argument resolvers, or
null . |
List<HandlerMethodArgumentResolver> |
ExceptionHandlerExceptionResolver.getCustomArgumentResolvers()
Return the custom argument resolvers, or
null . |
protected RequestCondition<?> |
RequestMappingHandlerMapping.getCustomMethodCondition(Method method)
Provide a custom method-level request condition.
|
List<HandlerMethodReturnValueHandler> |
RequestMappingHandlerAdapter.getCustomReturnValueHandlers()
Return the custom return value handlers, or
null . |
List<HandlerMethodReturnValueHandler> |
ExceptionHandlerExceptionResolver.getCustomReturnValueHandlers()
Return the custom return value handlers, or
null . |
protected RequestCondition<?> |
RequestMappingHandlerMapping.getCustomTypeCondition(Class<?> handlerType)
Provide a custom type-level request condition.
|
protected ServletInvocableHandlerMethod |
ExceptionHandlerExceptionResolver.getExceptionHandlerMethod(HandlerMethod handlerMethod,
Exception exception)
Find an
@ExceptionHandler method for the given exception. |
List<String> |
RequestMappingHandlerMapping.getFileExtensions()
Deprecated.
as of 5.2.4. See class-level note on the deprecation of path
extension config options.
|
List<HandlerMethodArgumentResolver> |
RequestMappingHandlerAdapter.getInitBinderArgumentResolvers()
Return the argument resolvers for
@InitBinder methods, or possibly
null if not initialized yet via RequestMappingHandlerAdapter.afterPropertiesSet() . |
protected RequestMappingInfo |
RequestMappingHandlerMapping.getMappingForMethod(Method method,
Class<?> handlerType)
Uses method and type-level @
RequestMapping annotations to create
the RequestMappingInfo. |
MediaType |
ResponseBodyEmitter.DataWithMediaType.getMediaType() |
List<ModelAndViewResolver> |
RequestMappingHandlerAdapter.getModelAndViewResolvers()
Return the configured
ModelAndViewResolvers , or null . |
String[] |
ModelAndViewMethodReturnValueHandler.getRedirectPatterns()
Return the configured redirect patterns, if any.
|
String[] |
ViewNameMethodReturnValueHandler.getRedirectPatterns()
The configured redirect patterns, if any.
|
protected String |
ServletModelAttributeMethodProcessor.getRequestValueForAttribute(String attributeName,
NativeWebRequest request)
Obtain a value from the request that may be used to instantiate the
model attribute through type conversion from String to the target type.
|
List<HandlerMethodReturnValueHandler> |
RequestMappingHandlerAdapter.getReturnValueHandlers()
Return the configured handlers, or possibly
null if not
initialized yet via RequestMappingHandlerAdapter.afterPropertiesSet() . |
HandlerMethodReturnValueHandlerComposite |
ExceptionHandlerExceptionResolver.getReturnValueHandlers()
Return the configured handlers, or possibly
null if not
initialized yet via ExceptionHandlerExceptionResolver.afterPropertiesSet() . |
Long |
ResponseBodyEmitter.getTimeout()
Return the configured timeout value, if any.
|
WebBindingInitializer |
RequestMappingHandlerAdapter.getWebBindingInitializer()
Return the configured WebBindingInitializer, or
null if none. |
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest webRequest)
Customize the response for AsyncRequestTimeoutException.
|
Object |
RequestBodyAdviceAdapter.handleEmptyBody(Object body,
HttpInputMessage inputMessage,
MethodParameter parameter,
Type targetType,
Class<? extends HttpMessageConverter<?>> converterType)
The default implementation returns the body that was passed in.
|
Object |
RequestBodyAdvice.handleEmptyBody(Object body,
HttpInputMessage inputMessage,
MethodParameter parameter,
Type targetType,
Class<? extends HttpMessageConverter<?>> converterType)
Invoked second (and last) if the body is empty.
|
ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleException(Exception ex,
WebRequest request)
Provides handling for standard Spring MVC exceptions.
|
protected ModelAndView |
RequestMappingHandlerAdapter.invokeHandlerMethod(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod)
Invoke the
RequestMapping handler method preparing a ModelAndView
if view resolution is required. |
protected <T> Object |
AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(HttpInputMessage inputMessage,
MethodParameter parameter,
Type targetType)
Create the method argument value of the expected parameter type by reading
from the given HttpInputMessage.
|
protected <T> Object |
AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(NativeWebRequest webRequest,
MethodParameter parameter,
Type paramType)
Create the method argument value of the expected parameter type by
reading from the given request.
|
Object |
HttpEntityMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
MatrixVariableMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
RequestPartMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
ServletModelAttributeMethodProcessor.resolveConstructorArgument(String paramName,
Class<?> paramType,
NativeWebRequest request) |
protected Object |
SessionAttributeMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
protected Object |
RequestAttributeMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
protected Object |
MatrixVariableMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
protected Object |
ServletCookieValueMethodArgumentResolver.resolveName(String cookieName,
MethodParameter parameter,
NativeWebRequest webRequest) |
protected Object |
PathVariableMethodArgumentResolver.resolveName(String name,
MethodParameter parameter,
NativeWebRequest request) |
Modifier and Type | Method and Description |
---|---|
protected Object |
AbstractMessageConverterMethodArgumentResolver.adaptArgumentIfNecessary(Object arg,
MethodParameter parameter)
Adapt the given argument against the method parameter, if necessary.
|
Object |
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite(Object body,
MethodParameter returnType,
MediaType contentType,
Class<? extends HttpMessageConverter<?>> converterType,
ServerHttpRequest request,
ServerHttpResponse response) |
T |
ResponseBodyAdvice.beforeBodyWrite(T body,
MethodParameter returnType,
MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType,
ServerHttpRequest request,
ServerHttpResponse response)
Invoked after an
HttpMessageConverter is selected and just before
its write method is invoked. |
protected ServletRequestDataBinder |
ServletRequestDataBinderFactory.createBinderInstance(Object target,
String objectName,
NativeWebRequest request)
Returns an instance of
ExtendedServletRequestDataBinder . |
protected RequestMappingInfo |
RequestMappingHandlerMapping.createRequestMappingInfo(RequestMapping requestMapping,
RequestCondition<?> customCondition)
Create a
RequestMappingInfo from the supplied
@RequestMapping annotation, which is either
a directly declared annotation, a meta-annotation, or the synthesized
result of merging annotation attributes within an annotation hierarchy. |
SseEmitter.SseEventBuilder |
SseEmitter.SseEventBuilder.data(Object object,
MediaType mediaType)
Add an SSE "data" line.
|
protected ModelAndView |
ExceptionHandlerExceptionResolver.doResolveHandlerMethodException(HttpServletRequest request,
HttpServletResponse response,
HandlerMethod handlerMethod,
Exception exception)
Find an
@ExceptionHandler method and invoke it to handle the raised exception. |
protected String |
PathVariableMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
protected String |
PathVariableMethodArgumentResolver.formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
Object value) |
static UriComponentsBuilder |
MvcUriComponentsBuilder.fromController(UriComponentsBuilder builder,
Class<?> controllerType)
An alternative to
MvcUriComponentsBuilder.fromController(Class) that accepts a
UriComponentsBuilder representing the base URL. |
static MvcUriComponentsBuilder.MethodArgumentBuilder |
MvcUriComponentsBuilder.fromMappingName(UriComponentsBuilder builder,
String name)
An alternative to
MvcUriComponentsBuilder.fromMappingName(String) that accepts a
UriComponentsBuilder representing the base URL. |
static UriComponentsBuilder |
MvcUriComponentsBuilder.fromMethod(UriComponentsBuilder baseUrl,
Class<?> controllerType,
Method method,
Object... args)
An alternative to
MvcUriComponentsBuilder.fromMethod(Class, Method, Object...)
that accepts a UriComponentsBuilder representing the base URL. |
protected ServletInvocableHandlerMethod |
ExceptionHandlerExceptionResolver.getExceptionHandlerMethod(HandlerMethod handlerMethod,
Exception exception)
Find an
@ExceptionHandler method for the given exception. |
protected List<MediaType> |
AbstractMessageConverterMethodProcessor.getProducibleMediaTypes(HttpServletRequest request,
Class<?> valueClass,
Type targetType)
Returns the media types that can be produced.
|
protected Class<?> |
HttpEntityMethodProcessor.getReturnValueType(Object returnValue,
MethodParameter returnType) |
protected Class<?> |
AbstractMessageConverterMethodProcessor.getReturnValueType(Object value,
MethodParameter returnType)
Return the type of the value to be written to the response.
|
Object |
RequestBodyAdviceAdapter.handleEmptyBody(Object body,
HttpInputMessage inputMessage,
MethodParameter parameter,
Type targetType,
Class<? extends HttpMessageConverter<?>> converterType)
The default implementation returns the body that was passed in.
|
Object |
RequestBodyAdvice.handleEmptyBody(Object body,
HttpInputMessage inputMessage,
MethodParameter parameter,
Type targetType,
Class<? extends HttpMessageConverter<?>> converterType)
Invoked second (and last) if the body is empty.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleExceptionInternal(Exception ex,
Object body,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
A single place to customize the response body of all exception types.
|
protected void |
PathVariableMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request) |
protected void |
PathVariableMethodArgumentResolver.handleResolvedValue(Object arg,
String name,
MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request) |
void |
CallableMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
RequestResponseBodyMethodProcessor.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
HttpEntityMethodProcessor.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ModelAndViewMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
HttpHeadersReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ResponseBodyEmitterReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
DeferredResultMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ViewMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
StreamingResponseBodyReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ModelAndViewResolverMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
ViewNameMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
void |
AsyncTaskMethodReturnValueHandler.handleReturnValue(Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) |
protected boolean |
AbstractMessageConverterMethodProcessor.isResourceType(Object value,
MethodParameter returnType)
Return whether the returned value or the declared return type extends
Resource . |
Object |
RequestResponseBodyMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Throws MethodArgumentNotValidException if validation fails.
|
Object |
RequestResponseBodyMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Throws MethodArgumentNotValidException if validation fails.
|
Object |
HttpEntityMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
HttpEntityMethodProcessor.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
MatrixVariableMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
MatrixVariableMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
ServletRequestMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ServletRequestMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
UriComponentsBuilderMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
UriComponentsBuilderMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ContinuationHandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
ContinuationHandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
PathVariableMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Return a Map with all URI template variables or an empty map.
|
Object |
PathVariableMapMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Return a Map with all URI template variables or an empty map.
|
Object |
RedirectAttributesMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
RedirectAttributesMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
RequestPartMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
RequestPartMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request,
WebDataBinderFactory binderFactory) |
Object |
ServletResponseMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Set
ModelAndViewContainer.setRequestHandled(boolean) to
false to indicate that the method signature provides access
to the response. |
Object |
ServletResponseMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
Set
ModelAndViewContainer.setRequestHandled(boolean) to
false to indicate that the method signature provides access
to the response. |
Object |
PrincipalMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
Object |
PrincipalMethodArgumentResolver.resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) |
void |
SseEmitter.send(Object object,
MediaType mediaType)
Send the object formatted as a single SSE "data" line.
|
void |
ResponseBodyEmitter.send(Object object,
MediaType mediaType)
Overloaded variant of
ResponseBodyEmitter.send(Object) that also accepts a MediaType
hint for how to serialize the given Object. |
void |
ExceptionHandlerExceptionResolver.setApplicationContext(ApplicationContext applicationContext) |
void |
RequestMappingHandlerAdapter.setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types thus overriding
the resolvers that would otherwise be configured by default.
|
void |
ExceptionHandlerExceptionResolver.setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types thus overriding
the resolvers that would otherwise be configured by default.
|
void |
RequestMappingHandlerAdapter.setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Provide resolvers for custom argument types.
|
void |
ExceptionHandlerExceptionResolver.setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Provide resolvers for custom argument types.
|
void |
RequestMappingHandlerAdapter.setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Provide handlers for custom return value types.
|
void |
ExceptionHandlerExceptionResolver.setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Provide handlers for custom return value types.
|
void |
RequestMappingHandlerAdapter.setInitBinderArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the supported argument types in
@InitBinder methods. |
void |
RequestMappingHandlerAdapter.setModelAndViewResolvers(List<ModelAndViewResolver> modelAndViewResolvers)
Provide custom
ModelAndViewResolvers . |
void |
ModelAndViewMethodReturnValueHandler.setRedirectPatterns(String... redirectPatterns)
Configure one more simple patterns (as described in
PatternMatchUtils.simpleMatch(java.lang.String, java.lang.String) )
to use in order to recognize custom redirect prefixes in addition to "redirect:". |
void |
ViewNameMethodReturnValueHandler.setRedirectPatterns(String... redirectPatterns)
Configure one more simple patterns (as described in
PatternMatchUtils.simpleMatch(java.lang.String, java.lang.String) )
to use in order to recognize custom redirect prefixes in addition to "redirect:". |
void |
RequestMappingHandlerAdapter.setRequestBodyAdvice(List<RequestBodyAdvice> requestBodyAdvice)
Add one or more
RequestBodyAdvice instances to intercept the
request before it is read and converted for @RequestBody and
HttpEntity method arguments. |
void |
RequestMappingHandlerAdapter.setResponseBodyAdvice(List<ResponseBodyAdvice<?>> responseBodyAdvice)
Add one or more
ResponseBodyAdvice instances to intercept the
response before @ResponseBody or ResponseEntity return
values are written to the response body. |
void |
ExceptionHandlerExceptionResolver.setResponseBodyAdvice(List<ResponseBodyAdvice<?>> responseBodyAdvice)
Add one or more components to be invoked after the execution of a controller
method annotated with
@ResponseBody or returning ResponseEntity
but before the body is written to the response with the selected
HttpMessageConverter . |
void |
RequestMappingHandlerAdapter.setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Configure the complete list of supported return value types thus
overriding handlers that would otherwise be configured by default.
|
void |
ExceptionHandlerExceptionResolver.setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Configure the complete list of supported return value types thus
overriding handlers that would otherwise be configured by default.
|
void |
RequestMappingHandlerAdapter.setWebBindingInitializer(WebBindingInitializer webBindingInitializer)
Provide a WebBindingInitializer with "global" initialization to apply
to every DataBinder instance.
|
protected <T> void |
AbstractMessageConverterMethodProcessor.writeWithMessageConverters(T value,
MethodParameter returnType,
ServletServerHttpRequest inputMessage,
ServletServerHttpResponse outputMessage)
Writes the given return type to the given output message.
|
Constructor and Description |
---|
AbstractMessageConverterMethodArgumentResolver(List<HttpMessageConverter<?>> converters,
List<Object> requestResponseBodyAdvice)
Constructor with converters and
Request~ and ResponseBodyAdvice . |
AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager contentNegotiationManager)
Constructor with list of converters and ContentNegotiationManager.
|
AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager,
List<Object> requestResponseBodyAdvice)
Constructor with list of converters and ContentNegotiationManager as well
as request/response body advice instances.
|
AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager,
List<Object> requestResponseBodyAdvice)
Constructor with list of converters and ContentNegotiationManager as well
as request/response body advice instances.
|
AsyncTaskMethodReturnValueHandler(BeanFactory beanFactory) |
DataWithMediaType(Object data,
MediaType mediaType) |
ExtendedServletRequestDataBinder(Object target)
Create a new instance, with default object name.
|
ExtendedServletRequestDataBinder(Object target,
String objectName)
Create a new instance.
|
HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager,
List<Object> requestResponseBodyAdvice)
Complete constructor for resolving
HttpEntity and handling
ResponseEntity . |
MethodArgumentBuilder(UriComponentsBuilder baseUrl,
Class<?> controllerType,
Method method)
Create a new
MvcUriComponentsBuilder.MethodArgumentBuilder instance. |
ModelAndViewResolverMethodReturnValueHandler(List<ModelAndViewResolver> mavResolvers)
Create a new instance.
|
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager)
Basic constructor with converters and
ContentNegotiationManager . |
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager,
List<Object> requestResponseBodyAdvice)
Complete constructor for resolving
@RequestBody and handling
@ResponseBody . |
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
ContentNegotiationManager manager,
List<Object> requestResponseBodyAdvice)
Complete constructor for resolving
@RequestBody and handling
@ResponseBody . |
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
List<Object> requestResponseBodyAdvice)
Complete constructor for resolving
@RequestBody method arguments. |
ServletCookieValueMethodArgumentResolver(ConfigurableBeanFactory beanFactory) |
ServletInvocableHandlerMethod(Object handler,
Method method,
MessageSource messageSource)
Variant of
ServletInvocableHandlerMethod(Object, Method) that
also accepts a MessageSource , e.g. |
ServletRequestDataBinderFactory(List<InvocableHandlerMethod> binderMethods,
WebBindingInitializer initializer)
Create a new instance.
|
ServletRequestDataBinderFactory(List<InvocableHandlerMethod> binderMethods,
WebBindingInitializer initializer)
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
protected ModelAndView |
DefaultHandlerExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
Modifier and Type | Method and Description |
---|---|
RedirectAttributesModelMap |
RedirectAttributesModelMap.addAllAttributes(Collection<?> attributeValues)
Copy all attributes in the supplied
Collection into this
Map , using attribute name generation for each element. |
RedirectAttributesModelMap |
RedirectAttributesModelMap.addAllAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map . |
RedirectAttributes |
RedirectAttributes.addAttribute(String attributeName,
Object attributeValue) |
RedirectAttributesModelMap |
RedirectAttributesModelMap.addAttribute(String attributeName,
Object attributeValue)
Add the supplied attribute under the supplied name.
|
RedirectAttributes |
RedirectAttributes.addFlashAttribute(String attributeName,
Object attributeValue)
Add the given flash attribute.
|
RedirectAttributes |
RedirectAttributesModelMap.addFlashAttribute(String attributeName,
Object attributeValue) |
protected ModelAndView |
DefaultHandlerExceptionResolver.doResolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleAsyncRequestNotUsableException(AsyncRequestNotUsableException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case of an I/O failure from the ServletOutputStream.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where an async request timed out.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleBindException(BindException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where an @ModelAttribute method
argument has binding or validation errors and is not followed by another
method argument of type
BindingResult . |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleConversionNotSupported(ConversionNotSupportedException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case when a
WebDataBinder conversion cannot occur. |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where no message converters
were found that were acceptable for the client (expressed via the
Accept header). |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where no message converters
were found for the PUT or POSTed content.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where a message converter
cannot read from an HTTP request.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleHttpMessageNotWritable(HttpMessageNotWritableException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where a
message converter
cannot write to an HTTP request.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where no request handler method was found for the particular HTTP request method.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleMethodArgumentNotValidException(MethodArgumentNotValidException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where an argument annotated with
@Valid such as
an RequestBody or RequestPart argument fails validation. |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleMissingPathVariable(MissingPathVariableException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case when a declared path variable does not match any extracted URI variable.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleMissingServletRequestParameter(MissingServletRequestParameterException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case when a required parameter is missing.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleMissingServletRequestPartException(MissingServletRequestPartException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where an @RequestPart, a
MultipartFile ,
or a javax.servlet.http.Part argument is required but is missing. |
protected ModelAndView |
DefaultHandlerExceptionResolver.handleNoHandlerFoundException(NoHandlerFoundException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case where no handler was found during the dispatch.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleServletRequestBindingException(ServletRequestBindingException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case when an unrecoverable binding exception occurs - e.g.
|
protected ModelAndView |
DefaultHandlerExceptionResolver.handleTypeMismatch(TypeMismatchException ex,
HttpServletRequest request,
HttpServletResponse response,
Object handler)
Handle the case when a
WebDataBinder conversion error occurs. |
RedirectAttributesModelMap |
RedirectAttributesModelMap.mergeAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map ,
with existing objects of the same name taking precedence (i.e. |
Object |
RedirectAttributesModelMap.put(String key,
Object value) |
void |
RedirectAttributesModelMap.putAll(Map<? extends String,? extends Object> map) |
Constructor and Description |
---|
RedirectAttributesModelMap(DataBinder dataBinder)
Constructor with a DataBinder.
|
Modifier and Type | Method and Description |
---|---|
String |
AbstractVersionStrategy.extractVersion(String requestPath) |
String |
AbstractVersionStrategy.PrefixVersionPathStrategy.extractVersion(String requestPath) |
String |
AbstractVersionStrategy.FileNameVersionPathStrategy.extractVersion(String requestPath) |
String |
VersionPathStrategy.extractVersion(String requestPath)
Extract the resource version from the request path.
|
protected String |
WebJarsResourceResolver.findWebJarResourcePath(String path) |
Resource[] |
PathResourceResolver.getAllowedLocations() |
ContentNegotiationManager |
ResourceHttpRequestHandler.getContentNegotiationManager()
Deprecated.
as of 5.2.4
|
CorsConfiguration |
ResourceHttpRequestHandler.getCorsConfiguration(HttpServletRequest request)
Return the specified CORS configuration.
|
String |
TransformedResource.getFilename() |
String |
ResourceUrlProvider.getForLookupPath(String lookupPath)
Compare the given path against configured resource handler mappings and
if a match is found use the
ResourceResolver chain of the matched
ResourceHttpRequestHandler to resolve the URL path to expose for
public use. |
String |
ResourceUrlProvider.getForRequestUrl(HttpServletRequest request,
String requestUrl)
A variation on
ResourceUrlProvider.getForLookupPath(String) that accepts a full request
URL path (i.e. |
protected MediaType |
ResourceHttpRequestHandler.getMediaType(HttpServletRequest request,
Resource resource)
Determine the media type for the given request and the resource matched
to it.
|
protected Resource |
ResourceHttpRequestHandler.getResource(HttpServletRequest request) |
protected Resource |
PathResourceResolver.getResource(String resourcePath,
Resource location)
Find the resource under the given location.
|
ResourceHttpMessageConverter |
ResourceHttpRequestHandler.getResourceHttpMessageConverter()
Return the configured resource converter.
|
ResourceRegionHttpMessageConverter |
ResourceHttpRequestHandler.getResourceRegionHttpMessageConverter()
Return the configured resource region converter.
|
ResourceUrlProvider |
ResourceTransformerSupport.getResourceUrlProvider()
Return the configured
ResourceUrlProvider . |
protected VersionStrategy |
VersionResourceResolver.getStrategyForPath(String requestPath)
Find a
VersionStrategy for the request path of the requested resource. |
UrlPathHelper |
PathResourceResolver.getUrlPathHelper()
The configured
UrlPathHelper . |
UrlPathHelper |
ResourceHttpRequestHandler.getUrlPathHelper()
The configured
UrlPathHelper . |
protected PathExtensionContentNegotiationStrategy |
ResourceHttpRequestHandler.initContentNegotiationStrategy()
Deprecated.
as of 5.2.4 this method returns
null , and if a
subclass returns an actual instance, the instance is used only as a
source of media type mappings, if it contains any. Please, use
ResourceHttpRequestHandler.setMediaTypes(Map) instead, or if you need to change behavior,
you can override ResourceHttpRequestHandler.getMediaType(HttpServletRequest, Resource) . |
Resource |
ResourceResolverChain.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
Resource |
ResourceResolver.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
Resource |
AbstractResourceResolver.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected abstract Resource |
AbstractResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected String |
ResourceTransformerSupport.resolveUrlPath(String resourcePath,
HttpServletRequest request,
Resource resource,
ResourceTransformerChain transformerChain)
A transformer can use this method when a resource being transformed
contains links to other resources.
|
String |
ResourceResolverChain.resolveUrlPath(String resourcePath,
List<? extends Resource> locations)
Resolve the externally facing public URL path for clients to use
to access the resource that is located at the given internal
resource path.
|
String |
ResourceResolver.resolveUrlPath(String resourcePath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Resolve the externally facing public URL path for clients to use
to access the resource that is located at the given internal
resource path.
|
String |
AbstractResourceResolver.resolveUrlPath(String resourceUrlPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected abstract String |
AbstractResourceResolver.resolveUrlPathInternal(String resourceUrlPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
Modifier and Type | Method and Description |
---|---|
protected String |
CachingResourceResolver.computeKey(HttpServletRequest request,
String requestPath) |
Resource |
ResourceResolverChain.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
Resource |
ResourceResolver.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Resolve the supplied request and request path to a
Resource that
exists under one of the given resource locations. |
Resource |
AbstractResourceResolver.resolveResource(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected Resource |
GzipResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain)
Deprecated.
|
protected Resource |
PathResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected Resource |
WebJarsResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected Resource |
VersionResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected Resource |
EncodedResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected Resource |
CachingResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
protected abstract Resource |
AbstractResourceResolver.resolveResourceInternal(HttpServletRequest request,
String requestPath,
List<? extends Resource> locations,
ResourceResolverChain chain) |
void |
PathResourceResolver.setAllowedLocations(Resource... locations)
By default, when a Resource is found, the path of the resolved resource is
compared to ensure it's under the input location where it was found.
|
void |
ResourceHttpRequestHandler.setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
Deprecated.
as of 5.2.4 in favor of using
ResourceHttpRequestHandler.setMediaTypes(Map)
with mappings possibly obtained from
ContentNegotiationManager.getMediaTypeMappings() . |
void |
ResourceUrlProvider.setHandlerMap(Map<String,ResourceHttpRequestHandler> handlerMap)
Manually configure the resource mappings.
|
protected void |
ResourceHttpRequestHandler.setHeaders(HttpServletResponse response,
Resource resource,
MediaType mediaType)
Set headers on the given servlet response.
|
void |
ResourceHttpRequestHandler.setResourceHttpMessageConverter(ResourceHttpMessageConverter messageConverter)
Configure the
ResourceHttpMessageConverter to use. |
void |
ResourceHttpRequestHandler.setResourceRegionHttpMessageConverter(ResourceRegionHttpMessageConverter messageConverter)
Configure the
ResourceRegionHttpMessageConverter to use. |
void |
ResourceHttpRequestHandler.setResourceResolvers(List<ResourceResolver> resourceResolvers)
Configure the list of
ResourceResolvers to use. |
void |
ResourceHttpRequestHandler.setResourceTransformers(List<ResourceTransformer> resourceTransformers)
Configure the list of
ResourceTransformers to use. |
void |
ResourceTransformerSupport.setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider)
Configure a
ResourceUrlProvider to use when resolving the public
URL of links in a transformed resource (e.g. |
void |
PathResourceResolver.setUrlPathHelper(UrlPathHelper urlPathHelper)
Provide a reference to the
UrlPathHelper used to map requests to
static resources. |
void |
ResourceHttpRequestHandler.setUrlPathHelper(UrlPathHelper urlPathHelper)
Provide a reference to the
UrlPathHelper used to map requests to
static resources. |
Modifier and Type | Method and Description |
---|---|
protected WebApplicationContext |
AbstractAnnotationConfigDispatcherServletInitializer.createRootApplicationContext()
Create the "root" application context to be provided to the
ContextLoaderListener . |
PropertyEditor |
BindStatus.findEditor(Class<?> valueClass)
Find a PropertyEditor for the given value class, associated with
the property that this bound status is currently bound to.
|
static WebApplicationContext |
RequestContextUtils.findWebApplicationContext(HttpServletRequest request)
Look for the WebApplicationContext associated with the DispatcherServlet
that has initiated request processing, and for the global context if none
was found associated with the current request.
|
static WebApplicationContext |
RequestContextUtils.findWebApplicationContext(HttpServletRequest request,
ServletContext servletContext)
Look for the WebApplicationContext associated with the DispatcherServlet
that has initiated request processing, and for the global context if none
was found associated with the current request.
|
Object |
BindStatus.getActualValue()
Return the actual value of the field, i.e.
|
protected String |
WebContentGenerator.getAllowHeader()
Return the "Allow" header value to use in response to an HTTP OPTIONS request
based on the configured
supported methods also
automatically adding "OPTIONS" to the list even if not present as a supported
method. |
CacheControl |
WebContentGenerator.getCacheControl()
Get the
CacheControl instance
that builds the Cache-Control HTTP response header. |
Boolean |
RequestContext.getDefaultHtmlEscape()
Return the default HTML escape setting, differentiating between no default specified and an explicit value.
|
PropertyEditor |
BindStatus.getEditor()
Return the PropertyEditor for the property that this bind status
is currently bound to.
|
Errors |
BindStatus.getErrors()
Return the Errors instance (typically a BindingResult) that this
bind status is currently associated with.
|
Errors |
RequestContext.getErrors(String name)
Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.
|
Errors |
RequestContext.getErrors(String name,
boolean htmlEscape)
Retrieve the Errors instance for the given bind object.
|
String |
BindStatus.getExpression()
Return a bind expression that can be used in HTML forms as input name
for the respective field, or
null if not field-specific. |
Map<String,String> |
RequestDataValueProcessor.getExtraHiddenFields(HttpServletRequest request)
Invoked after all form fields have been rendered.
|
protected TimeZone |
RequestContext.getFallbackTimeZone()
Determine the fallback time zone for this context.
|
static FlashMapManager |
RequestContextUtils.getFlashMapManager(HttpServletRequest request)
Return the
FlashMapManager instance to save flash attributes. |
protected Object |
AbstractFlashMapManager.getFlashMapsMutex(HttpServletRequest request)
Obtain a mutex for modifying the FlashMap List as handled by
AbstractFlashMapManager.retrieveFlashMaps(javax.servlet.http.HttpServletRequest) and AbstractFlashMapManager.updateFlashMaps(java.util.List<org.springframework.web.servlet.FlashMap>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) , |
static Map<String,?> |
RequestContextUtils.getInputFlashMap(HttpServletRequest request)
Return read-only "input" flash attributes from request before redirect.
|
static LocaleResolver |
RequestContextUtils.getLocaleResolver(HttpServletRequest request)
Return the
LocaleResolver that has been bound to the request by the
DispatcherServlet . |
Map<String,Object> |
RequestContext.getModel()
Return the model Map that this RequestContext encapsulates, if any.
|
protected Object |
RequestContext.getModelObject(String modelName)
Retrieve the model object for the given model name, either from the model
or from the request attributes.
|
RequestDataValueProcessor |
RequestContext.getRequestDataValueProcessor()
Return the RequestDataValueProcessor instance to use obtained from the
WebApplicationContext under the name
"requestDataValueProcessor" . |
Boolean |
RequestContext.getResponseEncodedHtmlEscape()
Return the default setting about use of response encoding for HTML escape setting,
differentiating between no default specified and an explicit value.
|
protected abstract Class<?>[] |
AbstractAnnotationConfigDispatcherServletInitializer.getRootConfigClasses()
|
protected ApplicationContextInitializer<?>[] |
AbstractDispatcherServletInitializer.getServletApplicationContextInitializers()
Specify application context initializers to be applied to the servlet-specific
application context that the
DispatcherServlet is being created with. |
protected abstract Class<?>[] |
AbstractAnnotationConfigDispatcherServletInitializer.getServletConfigClasses()
|
protected ServletContext |
RequestContext.getServletContext()
Return the underlying ServletContext.
|
protected Filter[] |
AbstractDispatcherServletInitializer.getServletFilters()
Specify filters to add and map to the
DispatcherServlet . |
String[] |
WebContentGenerator.getSupportedMethods()
Return the HTTP methods that this content generator supports.
|
static Theme |
RequestContextUtils.getTheme(HttpServletRequest request)
Retrieve the current theme from the given request, using the ThemeResolver
and ThemeSource bound to the request by the DispatcherServlet.
|
static ThemeResolver |
RequestContextUtils.getThemeResolver(HttpServletRequest request)
Return the ThemeResolver that has been bound to the request by the
DispatcherServlet.
|
static ThemeSource |
RequestContextUtils.getThemeSource(HttpServletRequest request)
Return the ThemeSource that has been bound to the request by the
DispatcherServlet.
|
TimeZone |
RequestContext.getTimeZone()
Return the current TimeZone (or
null if none derivable from the request). |
static TimeZone |
RequestContextUtils.getTimeZone(HttpServletRequest request)
Retrieve the current time zone from the given request, using the
TimeZoneAwareLocaleContext in the LocaleResolver bound to
the request by the DispatcherServlet (if available). |
Object |
BindStatus.getValue()
Return the current value of the field, i.e.
|
Class<?> |
BindStatus.getValueType()
Get the '
Class ' type of the field. |
String[] |
WebContentGenerator.getVaryByRequestHeaders()
Return the configured request header names for the "Vary" response header.
|
String |
ServletUriComponentsBuilder.removePathExtension()
Remove any path extension from the
requestURI . |
FlashMap |
AbstractFlashMapManager.retrieveAndUpdate(HttpServletRequest request,
HttpServletResponse response) |
protected List<FlashMap> |
SessionFlashMapManager.retrieveFlashMaps(HttpServletRequest request)
Retrieves saved FlashMap instances from the HTTP session, if any.
|
protected abstract List<FlashMap> |
AbstractFlashMapManager.retrieveFlashMaps(HttpServletRequest request)
Retrieve saved FlashMap instances from the underlying storage.
|
Modifier and Type | Method and Description |
---|---|
void |
RequestContext.changeTheme(Theme theme)
Change the current theme to the specified one,
storing the new theme name through the configured
ThemeResolver . |
static void |
JstlUtils.exposeLocalizationContext(HttpServletRequest request,
MessageSource messageSource)
Exposes JSTL-specific request attributes specifying locale
and resource bundle for JSTL's formatting and message tags,
using Spring's locale and MessageSource.
|
static WebApplicationContext |
RequestContextUtils.findWebApplicationContext(HttpServletRequest request,
ServletContext servletContext)
Look for the WebApplicationContext associated with the DispatcherServlet
that has initiated request processing, and for the global context if none
was found associated with the current request.
|
static MessageSource |
JstlUtils.getJstlAwareMessageSource(ServletContext servletContext,
MessageSource messageSource)
Checks JSTL's "javax.servlet.jsp.jstl.fmt.localizationContext"
context-param and creates a corresponding child message source,
with the provided Spring-defined MessageSource as parent.
|
String |
RequestContext.getMessage(String code,
List<?> args)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
List<?> args,
String defaultMessage)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args,
boolean htmlEscape)
Retrieve the message for the given code.
|
String |
RequestContext.getMessage(String code,
Object[] args,
String defaultMessage)
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
|
String |
RequestContext.getMessage(String code,
Object[] args,
String defaultMessage,
boolean htmlEscape)
Retrieve the message for the given code.
|
String |
RequestContext.getThemeMessage(String code,
List<?> args)
Retrieve the theme message for the given code.
|
String |
RequestContext.getThemeMessage(String code,
List<?> args,
String defaultMessage)
Retrieve the theme message for the given code.
|
String |
RequestContext.getThemeMessage(String code,
Object[] args)
Retrieve the theme message for the given code.
|
String |
RequestContext.getThemeMessage(String code,
Object[] args,
String defaultMessage)
Retrieve the theme message for the given code.
|
String |
RequestDataValueProcessor.processFormFieldValue(HttpServletRequest request,
String name,
String value,
String type)
Invoked when a form field value is rendered.
|
void |
WebContentGenerator.setCacheControl(CacheControl cacheControl)
Set the
CacheControl instance to build
the Cache-Control HTTP response header. |
void |
WebContentGenerator.setSupportedMethods(String... methods)
Set the HTTP methods that this content generator should support.
|
void |
WebContentGenerator.setVaryByRequestHeaders(String... varyByRequestHeaders)
Configure one or more request header names (e.g.
|
Constructor and Description |
---|
JspAwareRequestContext(PageContext pageContext,
Map<String,Object> model)
Create a new JspAwareRequestContext for the given page context,
using the given model attributes for Errors retrieval.
|
RequestContext(HttpServletRequest request,
HttpServletResponse response,
ServletContext servletContext,
Map<String,Object> model)
Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.
|
RequestContext(HttpServletRequest request,
HttpServletResponse response,
ServletContext servletContext,
Map<String,Object> model)
Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.
|
RequestContext(HttpServletRequest request,
HttpServletResponse response,
ServletContext servletContext,
Map<String,Object> model)
Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.
|
RequestContext(HttpServletRequest request,
Map<String,Object> model)
Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.
|
RequestContext(HttpServletRequest request,
ServletContext servletContext)
Create a new RequestContext for the given request, using the request attributes for Errors retrieval.
|
Modifier and Type | Method and Description |
---|---|
PropertyEditor |
EditorAwareTag.getEditor()
Retrieve the PropertyEditor for the property that this tag is
currently bound to.
|
PropertyEditor |
BindTag.getEditor() |
Errors |
BindErrorsTag.getErrors()
Retrieve the Errors instance that this tag is currently bound to.
|
Errors |
BindTag.getErrors()
Retrieve the Errors instance that this tag is currently bound to.
|
String |
Param.getName()
Return the raw parameter name.
|
String |
NestedPathTag.getPath()
Return the path that this tag applies to.
|
String |
BindTag.getProperty()
Retrieve the property that this tag is currently bound to,
or
null if bound to an object rather than a specific property. |
String |
Param.getValue()
Return the raw parameter value.
|
protected Object[] |
MessageTag.resolveArguments(Object arguments)
Resolve the given arguments Object into an arguments array.
|
Modifier and Type | Method and Description |
---|---|
void |
MessageTag.addArgument(Object argument) |
void |
ArgumentAware.addArgument(Object argument)
Callback hook for nested spring:argument tags to pass their value
to the parent tag.
|
protected Object[] |
MessageTag.resolveArguments(Object arguments)
Resolve the given arguments Object into an arguments array.
|
void |
Param.setName(String name)
Set the raw name of the parameter.
|
void |
NestedPathTag.setPath(String path)
Set the path that this tag should apply.
|
void |
Param.setValue(String value)
Set the raw value of the parameter.
|
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractCheckedElementTag.autogenerateId()
Return a unique ID for the bound name within the current PageContext.
|
protected String |
AbstractDataBoundFormElementTag.autogenerateId()
Autogenerate the '
id ' attribute value for this tag. |
protected Object |
AbstractFormTag.evaluate(String attributeName,
Object value)
Evaluate the supplied value for the supplied attribute name.
|
protected String |
FormTag.getAcceptCharset()
Get the value of the '
acceptCharset ' attribute. |
protected String |
AbstractHtmlInputElementTag.getAccesskey()
Get the value of the '
accesskey ' attribute. |
protected String |
FormTag.getAction()
Get the value of the '
action ' attribute. |
protected String |
InputTag.getAlt()
Get the value of the '
alt ' attribute. |
protected String |
InputTag.getAutocomplete()
Get the value of the '
autocomplete ' attribute. |
protected String |
FormTag.getAutocomplete()
Get the value of the '
autocomplete ' attribute. |
protected Object |
AbstractDataBoundFormElementTag.getBoundValue()
Get the bound value.
|
protected String |
TextareaTag.getCols()
Get the value of the '
cols ' attribute. |
protected String |
AbstractHtmlElementTag.getCssClass()
Get the value of the '
class ' attribute. |
protected String |
AbstractHtmlElementTag.getCssErrorClass()
The CSS class to use when the field bound to a particular tag has errors.
|
protected String |
AbstractHtmlElementTag.getCssStyle()
Get the value of the '
style ' attribute. |
String |
AbstractMultiCheckedElementTag.getDelimiter()
Return the delimiter to be used between each
'
input type="radio" ' tag. |
protected String |
AbstractHtmlElementTag.getDir()
Get the value of the '
dir ' attribute. |
protected Map<String,Object> |
AbstractHtmlElementTag.getDynamicAttributes()
Get the map of dynamic attributes.
|
PropertyEditor |
AbstractDataBoundFormElementTag.getEditor()
Exposes the
PropertyEditor for EditorAwareTag . |
protected String |
FormTag.getEnctype()
Get the value of the '
enctype ' attribute. |
protected String |
LabelTag.getFor()
Get the value of the '
id ' attribute. |
String |
AbstractDataBoundFormElementTag.getId()
Get the value of the '
id ' attribute. |
protected String |
OptionsTag.getItemLabel()
Get the name of the property mapped to the label (inner text) of the
'
option ' tag. |
protected String |
AbstractMultiCheckedElementTag.getItemLabel()
Get the value to be displayed as part of the
'
input type="checkbox/radio" ' tag. |
protected String |
SelectTag.getItemLabel()
Get the value of the '
itemLabel ' attribute. |
protected Object |
OptionsTag.getItems()
|
protected Object |
AbstractMultiCheckedElementTag.getItems()
Get the
Collection , Map or array of objects
used to generate the 'input type="checkbox/radio" ' tags. |
protected Object |
SelectTag.getItems()
Get the value of the '
items ' attribute. |
protected String |
OptionsTag.getItemValue()
Return the name of the property mapped to the '
value '
attribute of the 'option ' tag. |
protected String |
AbstractMultiCheckedElementTag.getItemValue()
Get the name of the property mapped to the '
value ' attribute
of the 'input type="checkbox/radio" ' tag. |
protected String |
SelectTag.getItemValue()
Get the value of the '
itemValue ' attribute. |
protected String |
OptionTag.getLabel()
Get the text body of the rendered HTML
<option> tag. |
protected Object |
AbstractSingleCheckedElementTag.getLabel()
Get the value of the '
label ' attribute. |
protected String |
AbstractHtmlElementTag.getLang()
Get the value of the '
lang ' attribute. |
protected String |
InputTag.getMaxlength()
Get the value of the '
maxlength ' attribute. |
protected Object |
SelectTag.getMultiple()
Get the value of the HTML '
multiple ' attribute rendered
on the final 'select ' element. |
String |
ButtonTag.getName()
Set the value of the '
name ' attribute. |
protected String |
ErrorsTag.getName()
Get the value for the HTML '
name ' attribute. |
protected String |
AbstractDataBoundFormElementTag.getName()
Get the value for the HTML '
name ' attribute. |
protected String |
FormTag.getName()
Get the value of the '
name ' attribute. |
protected String |
LabelTag.getName()
Overrides
#getName() to always return null ,
because the 'name ' attribute is not supported by the
'label ' tag. |
protected String |
AbstractDataBoundFormElementTag.getNestedPath()
Get the value of the nested path that may have been exposed by the
NestedPathTag . |
protected String |
AbstractHtmlInputElementTag.getOnblur()
Get the value of the '
onblur ' attribute. |
protected String |
AbstractHtmlInputElementTag.getOnchange()
Get the value of the '
onchange ' attribute. |
protected String |
AbstractHtmlElementTag.getOnclick()
Get the value of the '
onclick ' attribute. |
protected String |
AbstractHtmlElementTag.getOndblclick()
Get the value of the '
ondblclick ' attribute. |
protected String |
AbstractHtmlInputElementTag.getOnfocus()
Get the value of the '
onfocus ' attribute. |
protected String |
AbstractHtmlElementTag.getOnkeydown()
Get the value of the '
onkeydown ' attribute. |
protected String |
AbstractHtmlElementTag.getOnkeypress()
Get the value of the '
onkeypress ' attribute. |
protected String |
AbstractHtmlElementTag.getOnkeyup()
Get the value of the '
onkeyup ' attribute. |
protected String |
AbstractHtmlElementTag.getOnmousedown()
Get the value of the '
onmousedown ' attribute. |
protected String |
AbstractHtmlElementTag.getOnmousemove()
Get the value of the '
onmousemove ' attribute. |
protected String |
AbstractHtmlElementTag.getOnmouseout()
Get the value of the '
onmouseout ' attribute. |
protected String |
AbstractHtmlElementTag.getOnmouseover()
Get the value of the '
onmouseover ' attribute. |
protected String |
AbstractHtmlElementTag.getOnmouseup()
Get the value of the '
onmouseup ' attribute. |
protected String |
FormTag.getOnreset()
Get the value of the '
onreset ' attribute. |
protected String |
TextareaTag.getOnselect()
Get the value of the '
onselect ' attribute. |
protected String |
InputTag.getOnselect()
Get the value of the '
onselect ' attribute. |
protected String |
FormTag.getOnsubmit()
Get the value of the '
onsubmit ' attribute. |
protected PropertyEditor |
AbstractDataBoundFormElementTag.getPropertyEditor()
Get the
PropertyEditor , if any, in use for value bound to this tag. |
protected String |
TextareaTag.getRows()
Get the value of the '
rows ' attribute. |
protected String |
FormTag.getServletRelativeAction()
Get the servlet-relative value of the '
action ' attribute. |
protected String |
InputTag.getSize()
Get the value of the '
size ' attribute. |
protected String |
SelectTag.getSize()
Get the value of the '
size ' attribute. |
protected String |
AbstractHtmlElementTag.getTabindex()
Get the value of the '
tabindex ' attribute. |
String |
FormTag.getTarget()
Get the value of the '
target ' attribute. |
protected String |
AbstractHtmlElementTag.getTitle()
Get the value of the '
title ' attribute. |
String |
ButtonTag.getValue()
Get the value of the '
value ' attribute. |
protected Object |
OptionTag.getValue()
Get the 'value' attribute of the rendered HTML
<option> tag. |
protected Object |
AbstractSingleCheckedElementTag.getValue()
Get the value of the '
value ' attribute. |
protected String |
AbstractDataBoundFormElementTag.resolveId()
Determine the '
id ' attribute value for this tag,
autogenerating one if none specified. |
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractDataBoundFormElementTag.convertToDisplayString(Object value)
Get a display String for the given value, converted by a PropertyEditor
that the BindStatus may have registered for the value's Class.
|
protected Object |
AbstractFormTag.evaluate(String attributeName,
Object value)
Evaluate the supplied value for the supplied attribute name.
|
protected String |
AbstractFormTag.getDisplayString(Object value)
Get the display value of the supplied
Object , HTML escaped
as required. |
protected String |
AbstractFormTag.getDisplayString(Object value,
PropertyEditor propertyEditor)
Get the display value of the supplied
Object , HTML escaped
as required. |
protected String |
AbstractFormTag.getDisplayString(Object value,
PropertyEditor propertyEditor)
Get the display value of the supplied
Object , HTML escaped
as required. |
protected String |
AbstractDataBoundFormElementTag.processFieldValue(String name,
String value,
String type)
Process the given form field through a
RequestDataValueProcessor
instance if one is configured or otherwise returns the same value. |
protected void |
AbstractCheckedElementTag.renderFromValue(Object item,
Object value,
TagWriter tagWriter)
Render the '
input(checkbox) ' with the supplied value, marking the
'input ' element as 'checked' if the supplied value matches the
bound value. |
protected void |
AbstractCheckedElementTag.renderFromValue(Object item,
Object value,
TagWriter tagWriter)
Render the '
input(checkbox) ' with the supplied value, marking the
'input ' element as 'checked' if the supplied value matches the
bound value. |
protected void |
AbstractCheckedElementTag.renderFromValue(Object value,
TagWriter tagWriter)
Render the '
input(checkbox) ' with the supplied value, marking the
'input ' element as 'checked' if the supplied value matches the
bound value. |
void |
FormTag.setAction(String action)
Set the value of the '
action ' attribute. |
void |
AbstractDataBoundFormElementTag.setId(String id)
Set the value of the '
id ' attribute. |
void |
SelectTag.setItems(Object items)
|
void |
FormTag.setServletRelativeAction(String servletRelativeAction)
Set the value of the '
action ' attribute through a value
that is to be appended to the current servlet path. |
void |
ButtonTag.setValue(String value)
Set the value of the '
value ' attribute. |
protected void |
AbstractFormTag.writeOptionalAttribute(TagWriter tagWriter,
String attributeName,
String value)
Optionally writes the supplied value under the supplied attribute name into the supplied
TagWriter . |
void |
TagWriter.writeOptionalAttributeValue(String attributeName,
String attributeValue)
Write an HTML attribute if the supplied value is not
null
or zero length. |
Modifier and Type | Method and Description |
---|---|
void |
FixedThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
void |
FixedThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
void |
CookieThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
void |
CookieThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
void |
SessionThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
void |
SessionThemeResolver.setThemeName(HttpServletRequest request,
HttpServletResponse response,
String themeName) |
Modifier and Type | Method and Description |
---|---|
protected View |
AbstractCachingViewResolver.createView(String viewName,
Locale locale)
Create the actual View object.
|
String |
AbstractView.getBeanName()
Return the view's name.
|
ContentNegotiationManager |
ContentNegotiatingViewResolver.getContentNegotiationManager()
Return the
ContentNegotiationManager to use to determine requested media types. |
String |
AbstractView.getContentType()
Return the content type for this view.
|
protected String |
UrlBasedViewResolver.getContentType()
Return the content type for all views, if any.
|
protected Boolean |
UrlBasedViewResolver.getExposeContextBeansAsAttributes() |
protected String[] |
UrlBasedViewResolver.getExposedContextBeanNames() |
protected Boolean |
UrlBasedViewResolver.getExposePathVariables()
Return whether views resolved by this resolver should add path variables to the model or not.
|
String[] |
RedirectView.getHosts()
Return the configured application hosts.
|
protected List<MediaType> |
ContentNegotiatingViewResolver.getMediaTypes(HttpServletRequest request)
Determines the list of
MediaType for the given HttpServletRequest . |
String[] |
UrlBasedViewResolver.getRedirectHosts()
Return the configured application hosts for redirect purposes.
|
String |
AbstractView.getRequestContextAttribute()
Return the name of the RequestContext attribute, if any.
|
protected String |
UrlBasedViewResolver.getRequestContextAttribute()
Return the name of the RequestContext attribute for all views, if any.
|
protected RequestDispatcher |
InternalResourceView.getRequestDispatcher(HttpServletRequest request,
String path)
Obtain the RequestDispatcher to use for the forward/include.
|
String |
AbstractUrlBasedView.getUrl()
Return the URL of the resource that this view wraps.
|
protected Class<?> |
UrlBasedViewResolver.getViewClass()
Return the view class to be used to create views.
|
protected String[] |
UrlBasedViewResolver.getViewNames()
Return the view names (or name patterns) that can be handled by this
ViewResolver . |
protected abstract View |
AbstractCachingViewResolver.loadView(String viewName,
Locale locale)
Subclasses must implement this method, building a View object
for the specified view.
|
View |
BeanNameViewResolver.resolveViewName(String viewName,
Locale locale) |
View |
AbstractCachingViewResolver.resolveViewName(String viewName,
Locale locale) |
View |
ContentNegotiatingViewResolver.resolveViewName(String viewName,
Locale locale) |
View |
ViewResolverComposite.resolveViewName(String viewName,
Locale locale) |
protected String |
DefaultRequestToViewNameTranslator.transformPath(String lookupPath)
Transform the request URI (in the context of the webapp) stripping
slashes and extensions, and replacing the separator as required.
|
Modifier and Type | Method and Description |
---|---|
protected Map<String,Object> |
AbstractView.createMergedOutputModel(Map<String,?> model,
HttpServletRequest request,
HttpServletResponse response)
Creates a combined output Map (never
null ) that includes dynamic values and static attributes. |
protected boolean |
RedirectView.isEligibleProperty(String key,
Object value)
Determine whether the given model element should be exposed
as a query property.
|
protected boolean |
RedirectView.isEligibleValue(Object value)
Determine whether the given model element value is eligible for exposure.
|
void |
AbstractView.render(Map<String,?> model,
HttpServletRequest request,
HttpServletResponse response)
Prepares the view given the specified model, merging it with static
attributes and a RequestContext attribute, if necessary.
|
void |
AbstractView.setAttributesCSV(String propString)
Set static attributes as a CSV string.
|
void |
AbstractView.setAttributesMap(Map<String,?> attributes)
Set static attributes for this view from a Map.
|
void |
UrlBasedViewResolver.setAttributesMap(Map<String,?> attributes)
Set static attributes from a Map, for all views returned by this resolver.
|
void |
AbstractView.setBeanName(String beanName)
Set the view's name.
|
void |
ContentNegotiatingViewResolver.setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
Set the
ContentNegotiationManager to use to determine requested media types. |
void |
AbstractView.setContentType(String contentType)
Set the content type for this view.
|
void |
UrlBasedViewResolver.setContentType(String contentType)
Set the content type for all views.
|
void |
UrlBasedViewResolver.setExposedContextBeanNames(String... exposedContextBeanNames)
Specify the names of beans in the context which are supposed to be exposed.
|
void |
UrlBasedViewResolver.setExposePathVariables(Boolean exposePathVariables)
Specify whether views resolved by this resolver should add path
variables to the model or not.
|
void |
RedirectView.setHosts(String... hosts)
Configure one or more hosts associated with the application.
|
void |
DefaultRequestToViewNameTranslator.setPrefix(String prefix)
Set the prefix to prepend to generated view names.
|
void |
UrlBasedViewResolver.setPrefix(String prefix)
Set the prefix that gets prepended to view names when building a URL.
|
void |
UrlBasedViewResolver.setRedirectHosts(String... redirectHosts)
Configure one or more hosts associated with the application.
|
void |
AbstractView.setRequestContextAttribute(String requestContextAttribute)
Set the name of the RequestContext attribute for this view.
|
void |
UrlBasedViewResolver.setRequestContextAttribute(String requestContextAttribute)
Set the name of the RequestContext attribute for all views.
|
void |
DefaultRequestToViewNameTranslator.setSuffix(String suffix)
Set the suffix to append to generated view names.
|
void |
UrlBasedViewResolver.setSuffix(String suffix)
Set the suffix that gets appended to view names when building a URL.
|
void |
AbstractUrlBasedView.setUrl(String url)
Set the URL of the resource that this view wraps.
|
void |
UrlBasedViewResolver.setViewClass(Class<?> viewClass)
Set the view class that should be used to create views.
|
void |
UrlBasedViewResolver.setViewNames(String... viewNames)
Set the view names (or name patterns) that can be handled by this
ViewResolver . |
Modifier and Type | Method and Description |
---|---|
protected freemarker.template.Configuration |
FreeMarkerView.getConfiguration()
Return the FreeMarker configuration used by this view.
|
protected String |
FreeMarkerView.getEncoding()
Return the encoding for the FreeMarker template.
|
Modifier and Type | Method and Description |
---|---|
void |
FreeMarkerView.setConfiguration(freemarker.template.Configuration configuration)
Set the FreeMarker Configuration to be used by this view.
|
void |
FreeMarkerView.setEncoding(String encoding)
Set the encoding of the FreeMarker template file.
|
Modifier and Type | Method and Description |
---|---|
Set<String> |
MappingJackson2JsonView.getModelKeys()
Return the attributes in the model that should be rendered by this view.
|
Modifier and Type | Method and Description |
---|---|
void |
MappingJackson2JsonView.setModelKeys(Set<String> modelKeys)
Set the attributes in the model that should be rendered by this view.
|
Modifier and Type | Method and Description |
---|---|
Charset |
ScriptTemplateConfig.getCharset()
Return the charset used to read script and template files.
|
Charset |
ScriptTemplateConfigurer.getCharset() |
String |
ScriptTemplateConfig.getContentType()
Return the content type to use for the response.
|
String |
ScriptTemplateConfigurer.getContentType()
Return the content type to use for the response.
|
ScriptEngine |
ScriptTemplateConfig.getEngine()
Return the
ScriptEngine to use by the views. |
ScriptEngine |
ScriptTemplateConfigurer.getEngine() |
String |
ScriptTemplateConfig.getEngineName()
Return the engine name that will be used to instantiate the
ScriptEngine . |
String |
ScriptTemplateConfigurer.getEngineName() |
Supplier<ScriptEngine> |
ScriptTemplateConfig.getEngineSupplier()
Return the engine supplier that will be used to instantiate the
ScriptEngine . |
Supplier<ScriptEngine> |
ScriptTemplateConfigurer.getEngineSupplier() |
String |
ScriptTemplateConfig.getRenderFunction()
Return the render function name (optional).
|
String |
ScriptTemplateConfigurer.getRenderFunction() |
String |
ScriptTemplateConfig.getRenderObject()
Return the object where the render function belongs (optional).
|
String |
ScriptTemplateConfigurer.getRenderObject() |
protected Resource |
ScriptTemplateView.getResource(String location) |
String |
ScriptTemplateConfig.getResourceLoaderPath()
Return the resource loader path(s) via a Spring resource location.
|
String |
ScriptTemplateConfigurer.getResourceLoaderPath() |
String[] |
ScriptTemplateConfig.getScripts()
Return the scripts to be loaded by the script engine (library or user provided).
|
String[] |
ScriptTemplateConfigurer.getScripts() |
Boolean |
ScriptTemplateConfig.isSharedEngine()
Return whether to use a shared engine for all threads or whether to create
thread-local engine instances for each thread.
|
Boolean |
ScriptTemplateConfigurer.isSharedEngine() |
Modifier and Type | Method and Description |
---|---|
void |
ScriptTemplateConfigurer.setCharset(Charset charset)
Set the charset used to read script and template files.
|
void |
ScriptTemplateConfigurer.setContentType(String contentType)
Set the content type to use for the response.
|
void |
ScriptTemplateConfigurer.setEngine(ScriptEngine engine)
Set the
ScriptEngine to use by the view. |
void |
ScriptTemplateConfigurer.setEngineName(String engineName)
Set the engine name that will be used to instantiate the
ScriptEngine . |
void |
ScriptTemplateConfigurer.setEngineSupplier(Supplier<ScriptEngine> engineSupplier)
Set the
ScriptEngine supplier to use by the view, usually used with
ScriptTemplateConfigurer.setSharedEngine(Boolean) set to false . |
void |
ScriptTemplateConfigurer.setRenderFunction(String renderFunction)
Set the render function name (optional).
|
void |
ScriptTemplateConfigurer.setRenderObject(String renderObject)
Set the object where the render function belongs (optional).
|
void |
ScriptTemplateConfigurer.setResourceLoaderPath(String resourceLoaderPath)
Set the resource loader path(s) via a Spring resource location.
|
void |
ScriptTemplateConfigurer.setScripts(String... scriptNames)
Set the scripts to be loaded by the script engine (library or user provided).
|
void |
ScriptTemplateConfigurer.setSharedEngine(Boolean sharedEngine)
When set to
false , use thread-local ScriptEngine instances instead
of one single shared instance. |
Modifier and Type | Method and Description |
---|---|
ApplicationResource |
SpringWildcardServletTilesApplicationContext.getResource(ApplicationResource base,
Locale locale) |
ApplicationResource |
SpringWildcardServletTilesApplicationContext.getResource(String localePath) |
Modifier and Type | Method and Description |
---|---|
protected Object |
MarshallingView.locateToBeMarshalled(Map<String,Object> model)
Locate the object to be marshalled.
|
Modifier and Type | Method and Description |
---|---|
protected Source |
XsltView.locateSource(Map<String,Object> model)
Locate the
Source object in the supplied model,
converting objects as required. |
Modifier and Type | Method and Description |
---|---|
protected TransformerFactory |
XsltView.newTransformerFactory(Class<? extends TransformerFactory> transformerFactoryClass)
Instantiate a new TransformerFactory for this view.
|
void |
XsltView.setErrorListener(ErrorListener errorListener)
Set an implementation of the
ErrorListener
interface for custom handling of transformation errors and warnings. |
Modifier and Type | Method and Description |
---|---|
String |
WebSocketSession.getAcceptedProtocol()
Return the negotiated sub-protocol.
|
String |
WebSocketHttpHeaders.getFirst(String headerName)
Return the first header value for the given header name, if any.
|
InetSocketAddress |
WebSocketSession.getLocalAddress()
Return the address on which the request was received.
|
Principal |
WebSocketSession.getPrincipal()
Return a
Principal instance containing the name
of the authenticated user. |
String |
CloseStatus.getReason()
Return the reason, or
null if none. |
InetSocketAddress |
WebSocketSession.getRemoteAddress()
Return the address of the remote client.
|
String |
WebSocketHttpHeaders.getSecWebSocketAccept()
Returns the value of the
Sec-WebSocket-Accept header. |
String |
WebSocketHttpHeaders.getSecWebSocketKey()
Returns the value of the
Sec-WebSocket-Key header. |
String |
WebSocketHttpHeaders.getSecWebSocketVersion()
Returns the value of the
Sec-WebSocket-Version header. |
URI |
WebSocketSession.getUri()
Return the URI used to open the WebSocket connection.
|
Modifier and Type | Method and Description |
---|---|
void |
WebSocketHttpHeaders.add(String headerName,
String headerValue)
Add the given, single header value under the given name.
|
boolean |
WebSocketHttpHeaders.equals(Object other) |
boolean |
AbstractWebSocketMessage.equals(Object other) |
boolean |
WebSocketExtension.equals(Object other) |
boolean |
CloseStatus.equals(Object other) |
void |
WebSocketHttpHeaders.set(String headerName,
String headerValue)
Set the given, single header value under the given name.
|
void |
WebSocketHttpHeaders.setSecWebSocketAccept(String secWebSocketAccept)
Sets the (new) value of the
Sec-WebSocket-Accept header. |
void |
WebSocketHttpHeaders.setSecWebSocketKey(String secWebSocketKey)
Sets the (new) value of the
Sec-WebSocket-Key header. |
void |
WebSocketHttpHeaders.setSecWebSocketVersion(String secWebSocketVersion)
Sets the (new) value of the
Sec-WebSocket-Version header. |
Constructor and Description |
---|
CloseStatus(int code,
String reason)
Create a new
CloseStatus instance. |
WebSocketExtension(String name,
Map<String,String> parameters)
Create a WebSocketExtension with the given name and parameters.
|
Modifier and Type | Method and Description |
---|---|
<R> R |
AbstractWebSocketSession.getNativeSession(Class<R> requiredType) |
<T> T |
NativeWebSocketSession.getNativeSession(Class<T> requiredType)
Return the underlying native WebSocketSession, if available.
|
Modifier and Type | Method and Description |
---|---|
<R> R |
AbstractWebSocketSession.getNativeSession(Class<R> requiredType) |
<T> T |
NativeWebSocketSession.getNativeSession(Class<T> requiredType)
Return the underlying native WebSocketSession, if available.
|
Constructor and Description |
---|
AbstractWebSocketSession(Map<String,Object> attributes)
Create a new instance and associate the given attributes with it.
|
Modifier and Type | Method and Description |
---|---|
URI |
JettyWebSocketSession.getUri() |
Constructor and Description |
---|
JettyWebSocketSession(Map<String,Object> attributes,
Principal user)
Create a new
JettyWebSocketSession instance associated with the given user. |
Modifier and Type | Method and Description |
---|---|
T |
ConvertingEncoderDecoderSupport.decode(M message)
Decode the message into an object.
|
M |
ConvertingEncoderDecoderSupport.encode(T object)
Encode an object to a message.
|
protected ApplicationContext |
ConvertingEncoderDecoderSupport.getApplicationContext()
Returns the active
ApplicationContext . |
InetSocketAddress |
StandardWebSocketSession.getLocalAddress() |
InetSocketAddress |
StandardWebSocketSession.getRemoteAddress() |
URI |
StandardWebSocketSession.getUri() |
Constructor and Description |
---|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress)
Constructor for a standard WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress)
Constructor for a standard WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress)
Constructor for a standard WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress)
Constructor for a standard WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
Modifier and Type | Method and Description |
---|---|
String |
WebSocketConnectionManager.getOrigin()
Return the configured origin.
|
Modifier and Type | Method and Description |
---|---|
ListenableFuture<WebSocketSession> |
WebSocketClient.doHandshake(WebSocketHandler webSocketHandler,
WebSocketHttpHeaders headers,
URI uri) |
ListenableFuture<WebSocketSession> |
AbstractWebSocketClient.doHandshake(WebSocketHandler webSocketHandler,
WebSocketHttpHeaders headers,
URI uri) |
void |
WebSocketConnectionManager.setOrigin(String origin)
Set the origin to use.
|
Modifier and Type | Method and Description |
---|---|
AsyncListenableTaskExecutor |
JettyWebSocketClient.getTaskExecutor()
Return the configured
TaskExecutor . |
protected Principal |
JettyWebSocketClient.getUser()
Return the user to make available through
WebSocketSession.getPrincipal() . |
Modifier and Type | Method and Description |
---|---|
void |
JettyWebSocketClient.setTaskExecutor(AsyncListenableTaskExecutor taskExecutor)
Set an
AsyncListenableTaskExecutor to use when opening connections. |
Modifier and Type | Method and Description |
---|---|
AsyncListenableTaskExecutor |
StandardWebSocketClient.getTaskExecutor()
Return the configured
TaskExecutor . |
Modifier and Type | Method and Description |
---|---|
void |
StandardWebSocketClient.setTaskExecutor(AsyncListenableTaskExecutor taskExecutor)
Set an
AsyncListenableTaskExecutor to use when opening connections. |
void |
StandardWebSocketClient.setUserProperties(Map<String,Object> userProperties)
The standard Java WebSocket API allows passing "user properties" to the
server via
userProperties . |
Modifier and Type | Method and Description |
---|---|
TaskScheduler |
WebSocketConfigurationSupport.defaultSockJsTaskScheduler()
The default TaskScheduler to use if none is registered explicitly via
SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler) :
@Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myHandler(), "/echo") .withSockJS() .setTaskScheduler(myScheduler()); } // ... |
protected HandshakeHandler |
AbstractWebSocketHandlerRegistration.getHandshakeHandler() |
protected Integer |
WebSocketTransportRegistration.getMessageSizeLimit()
Protected accessor for internal use.
|
protected Integer |
WebSocketTransportRegistration.getSendBufferSizeLimit()
Protected accessor for internal use.
|
protected Integer |
WebSocketTransportRegistration.getSendTimeLimit()
Protected accessor for internal use.
|
protected SockJsServiceRegistration |
AbstractWebSocketHandlerRegistration.getSockJsServiceRegistration()
Expose the
SockJsServiceRegistration -- if SockJS is enabled or
null otherwise -- so that it can be configured with a TaskScheduler
if the application did not provide one. |
protected TaskScheduler |
SockJsServiceRegistration.getTaskScheduler()
Return the TaskScheduler, if configured.
|
protected Integer |
WebSocketTransportRegistration.getTimeToFirstMessage()
Protected accessor for internal use.
|
UrlPathHelper |
ServletWebSocketHandlerRegistry.getUrlPathHelper() |
protected UrlPathHelper |
WebMvcStompEndpointRegistry.getUrlPathHelper() |
Modifier and Type | Method and Description |
---|---|
protected SimpUserRegistry |
WebSocketMessageBrokerConfigurationSupport.createLocalUserRegistry(Integer order) |
WebSocketHandlerRegistration |
AbstractWebSocketHandlerRegistration.setHandshakeHandler(HandshakeHandler handshakeHandler) |
void |
ServletWebSocketHandlerRegistry.setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to configure on the
SimpleUrlHandlerMapping
used to map handshake requests. |
void |
WebMvcStompEndpointRegistry.setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to configure on the
HandlerMapping
used to map handshake requests. |
HandlerMapping |
WebSocketConfigurationSupport.webSocketHandlerMapping(TaskScheduler scheduler) |
WebSocketMessageBrokerStats |
WebSocketMessageBrokerConfigurationSupport.webSocketMessageBrokerStats(AbstractBrokerMessageHandler stompBrokerRelayMessageHandler,
WebSocketHandler subProtocolWebSocketHandler,
TaskExecutor inboundExecutor,
TaskExecutor outboundExecutor,
TaskScheduler scheduler) |
Modifier and Type | Method and Description |
---|---|
URI |
WebSocketSessionDecorator.getUri() |
Constructor and Description |
---|
SessionLimitExceededException(String message,
CloseStatus status) |
Modifier and Type | Method and Description |
---|---|
SubProtocolHandler |
SubProtocolWebSocketHandler.getDefaultProtocolHandler()
Return the default sub-protocol handler to use.
|
StompSubProtocolErrorHandler |
StompSubProtocolHandler.getErrorHandler()
Return the configured error handler.
|
MessageHeaderInitializer |
StompSubProtocolHandler.getHeaderInitializer()
Return the configured header initializer.
|
Principal |
AbstractSubProtocolEvent.getUser()
Return the user for the session associated with the event.
|
SimpUser |
DefaultSimpUserRegistry.getUser(String userName) |
Message<byte[]> |
StompSubProtocolErrorHandler.handleClientMessageProcessingError(Message<byte[]> clientMessage,
Throwable ex) |
Message<P> |
SubProtocolErrorHandler.handleClientMessageProcessingError(Message<P> clientMessage,
Throwable ex)
Handle errors thrown while processing client messages providing an
opportunity to prepare the error message or to prevent one from being sent.
|
Message<byte[]> |
StompSubProtocolErrorHandler.handleErrorMessageToClient(Message<byte[]> errorMessage) |
Message<P> |
SubProtocolErrorHandler.handleErrorMessageToClient(Message<P> errorMessage)
Handle errors sent from the server side to clients, e.g.
|
String |
SubProtocolHandler.resolveSessionId(Message<?> message)
Resolve the session id from the given message or return
null . |
String |
StompSubProtocolHandler.resolveSessionId(Message<?> message) |
Modifier and Type | Method and Description |
---|---|
ListenableFuture<StompSession> |
WebSocketStompClient.connect(String url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler handler,
Object... uriVariables)
An overloaded version of
WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also accepts
WebSocketHttpHeaders to use for the WebSocket handshake and
StompHeaders for the STOMP CONNECT frame. |
ListenableFuture<StompSession> |
WebSocketStompClient.connect(String url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler handler,
Object... uriVariables)
An overloaded version of
WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also accepts
WebSocketHttpHeaders to use for the WebSocket handshake and
StompHeaders for the STOMP CONNECT frame. |
ListenableFuture<StompSession> |
WebSocketStompClient.connect(String url,
WebSocketHttpHeaders handshakeHeaders,
StompSessionHandler handler,
Object... uriVariables)
An overloaded version of
WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also
accepts WebSocketHttpHeaders to use for the WebSocket handshake. |
ListenableFuture<StompSession> |
WebSocketStompClient.connect(URI url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler sessionHandler)
An overloaded version of
WebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully prepared URI . |
ListenableFuture<StompSession> |
WebSocketStompClient.connect(URI url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler sessionHandler)
An overloaded version of
WebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully prepared URI . |
Message<byte[]> |
StompSubProtocolErrorHandler.handleClientMessageProcessingError(Message<byte[]> clientMessage,
Throwable ex) |
Message<P> |
SubProtocolErrorHandler.handleClientMessageProcessingError(Message<P> clientMessage,
Throwable ex)
Handle errors thrown while processing client messages providing an
opportunity to prepare the error message or to prevent one from being sent.
|
protected Message<byte[]> |
StompSubProtocolErrorHandler.handleInternal(StompHeaderAccessor errorHeaderAccessor,
byte[] errorPayload,
Throwable cause,
StompHeaderAccessor clientHeaderAccessor) |
protected Message<byte[]> |
StompSubProtocolErrorHandler.handleInternal(StompHeaderAccessor errorHeaderAccessor,
byte[] errorPayload,
Throwable cause,
StompHeaderAccessor clientHeaderAccessor) |
protected StompHeaders |
WebSocketStompClient.processConnectHeaders(StompHeaders connectHeaders) |
void |
SubProtocolWebSocketHandler.setDefaultProtocolHandler(SubProtocolHandler defaultProtocolHandler)
Set the
SubProtocolHandler to use when the client did not request a
sub-protocol. |
void |
StompSubProtocolHandler.setHeaderInitializer(MessageHeaderInitializer headerInitializer)
Configure a
MessageHeaderInitializer to apply to the headers of all
messages created from decoded STOMP frames and other messages sent to the
client inbound channel. |
void |
WebSocketStompClient.setTaskScheduler(TaskScheduler taskScheduler)
Configure a scheduler to use for heartbeats and for receipt tracking.
|
boolean |
DefaultSimpUserRegistry.supportsSourceType(Class<?> sourceType) |
Constructor and Description |
---|
AbstractSubProtocolEvent(Object source,
Message<byte[]> message,
Principal user)
Create a new AbstractSubProtocolEvent.
|
SessionConnectedEvent(Object source,
Message<byte[]> message,
Principal user) |
SessionConnectEvent(Object source,
Message<byte[]> message,
Principal user) |
SessionDisconnectEvent(Object source,
Message<byte[]> message,
String sessionId,
CloseStatus closeStatus,
Principal user)
Create a new SessionDisconnectEvent.
|
SessionSubscribeEvent(Object source,
Message<byte[]> message,
Principal user) |
SessionUnsubscribeEvent(Object source,
Message<byte[]> message,
Principal user) |
Modifier and Type | Method and Description |
---|---|
void |
HandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception exception)
Invoked after the handshake is done.
|
void |
RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
Perform runtime specific steps to complete the upgrade.
|
void |
RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
Perform runtime specific steps to complete the upgrade.
|
Modifier and Type | Method and Description |
---|---|
void |
JettyRequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
void |
JettyRequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
void |
Jetty10RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler handler,
Map<String,Object> attributes) |
void |
Jetty10RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler handler,
Map<String,Object> attributes) |
Modifier and Type | Method and Description |
---|---|
Long |
ServletServerContainerFactoryBean.getAsyncSendTimeout() |
Integer |
ServletServerContainerFactoryBean.getMaxBinaryMessageBufferSize() |
Long |
ServletServerContainerFactoryBean.getMaxSessionIdleTimeout() |
Integer |
ServletServerContainerFactoryBean.getMaxTextMessageBufferSize() |
ServerContainer |
ServletServerContainerFactoryBean.getObject() |
protected ServerContainer |
ServerEndpointExporter.getServerContainer()
Return the JSR-356
ServerContainer to use for endpoint registration. |
Modifier and Type | Method and Description |
---|---|
void |
ServerEndpointExporter.setServerContainer(ServerContainer serverContainer)
Set the JSR-356
ServerContainer to use for endpoint registration. |
void |
AbstractStandardUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attrs) |
void |
AbstractStandardUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attrs) |
void |
TomcatRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
protected abstract void |
AbstractStandardUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
void |
AbstractTyrusRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> extensions,
Endpoint endpoint) |
void |
WebSphereRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest httpRequest,
ServerHttpResponse httpResponse,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
protected void |
UndertowRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
Modifier and Type | Method and Description |
---|---|
protected Principal |
AbstractHandshakeHandler.determineUser(ServerHttpRequest request,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
A method that can be used to associate a user with the WebSocket session
in the process of being established.
|
protected Object |
WebSocketHandlerMapping.getHandlerInternal(HttpServletRequest request) |
protected String |
AbstractHandshakeHandler.selectProtocol(List<String> requestedProtocols,
WebSocketHandler webSocketHandler)
Perform the sub-protocol negotiation based on requested and supported sub-protocols.
|
Modifier and Type | Method and Description |
---|---|
void |
HttpSessionHandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception ex) |
void |
OriginHandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception exception) |
void |
HandshakeInterceptorChain.applyAfterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
Exception failure) |
void |
WebSocketHttpRequestHandler.setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)
Configure one or more WebSocket handshake request interceptors.
|
Constructor and Description |
---|
HandshakeInterceptorChain(List<HandshakeInterceptor> interceptors,
WebSocketHandler wsHandler) |
Modifier and Type | Method and Description |
---|---|
String |
SockJsException.getSockJsSessionId()
Return the SockJS session id.
|
Modifier and Type | Method and Description |
---|---|
void |
SockJsService.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
String sockJsPath,
WebSocketHandler handler)
Process a SockJS HTTP request.
|
Constructor and Description |
---|
SockJsException(String message,
String sessionId,
Throwable cause)
Constructor for SockJsException.
|
SockJsException(String message,
String sessionId,
Throwable cause)
Constructor for SockJsException.
|
SockJsException(String message,
Throwable cause)
Constructor for SockJsException.
|
SockJsTransportFailureException(String message,
String sessionId,
Throwable cause)
Constructor for SockJsTransportFailureException.
|
SockJsTransportFailureException(String message,
Throwable cause)
Constructor for SockJsTransportFailureException.
|
Modifier and Type | Method and Description |
---|---|
String[] |
SockJsClient.getHttpHeaderNames()
The configured HTTP header names to be copied from the handshake
headers and also included in other HTTP requests.
|
<T> T |
WebSocketClientSockJsSession.getNativeSession(Class<T> requiredType) |
protected Principal |
SockJsClient.getUser()
Return the user to associate with the SockJS session and make available via
WebSocketSession.getPrincipal() . |
Principal |
TransportRequest.getUser()
Return the user associated with the request, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractClientSockJsSession.afterTransportClosed(CloseStatus closeStatus) |
ListenableFuture<WebSocketSession> |
SockJsClient.doHandshake(WebSocketHandler handler,
WebSocketHttpHeaders headers,
URI url) |
String |
AbstractXhrTransport.executeInfoRequest(URI infoUrl,
HttpHeaders headers) |
String |
InfoReceiver.executeInfoRequest(URI infoUrl,
HttpHeaders headers)
Perform an HTTP request to the SockJS "Info" URL.
|
protected ResponseEntity<String> |
JettyXhrTransport.executeRequest(URI url,
org.eclipse.jetty.http.HttpMethod method,
HttpHeaders headers,
String body) |
protected ResponseEntity<String> |
UndertowXhrTransport.executeRequest(URI url,
io.undertow.util.HttpString method,
HttpHeaders headers,
String body) |
<T> T |
WebSocketClientSockJsSession.getNativeSession(Class<T> requiredType) |
void |
SockJsClient.setHttpHeaderNames(String... httpHeaderNames)
The names of HTTP headers that should be copied from the handshake headers
of each call to
SockJsClient.doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI)
and also used with other HTTP requests issued as part of that SockJS
connection, e.g. |
Modifier and Type | Method and Description |
---|---|
String[] |
Jackson2SockJsMessageCodec.decode(String content) |
String[] |
SockJsMessageCodec.decode(String content)
Decode the given SockJS message frame.
|
String[] |
Jackson2SockJsMessageCodec.decodeInputStream(InputStream content) |
String[] |
SockJsMessageCodec.decodeInputStream(InputStream content)
Decode the given SockJS message frame.
|
String |
SockJsFrame.getFrameData()
Return data contained in a SockJS "message" and "close" frames.
|
Modifier and Type | Method and Description |
---|---|
static SockJsFrame |
SockJsFrame.closeFrame(int code,
String reason) |
boolean |
SockJsFrame.equals(Object other) |
Modifier and Type | Method and Description |
---|---|
CorsConfiguration |
AbstractSockJsService.getCorsConfiguration(HttpServletRequest request) |
CorsConfiguration |
SockJsHttpRequestHandler.getCorsConfiguration(HttpServletRequest request) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractSockJsService.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
String sockJsPath,
WebSocketHandler wsHandler)
This method determines the SockJS path and handles SockJS static URLs.
|
Modifier and Type | Method and Description |
---|---|
static TransportType |
TransportType.fromValue(String value) |
Modifier and Type | Method and Description |
---|---|
void |
TransportHandlingSockJsService.setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)
Configure one or more WebSocket handshake request interceptors.
|
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractHttpSendingTransportHandler.getCallbackParam(ServerHttpRequest request) |
protected String[] |
XhrReceivingTransportHandler.readMessages(ServerHttpRequest request) |
protected abstract String[] |
AbstractHttpReceivingTransportHandler.readMessages(ServerHttpRequest request) |
Modifier and Type | Method and Description |
---|---|
String |
AbstractHttpSockJsSession.getAcceptedProtocol()
Return the selected sub-protocol to use.
|
InetSocketAddress |
AbstractHttpSockJsSession.getLocalAddress() |
<T> T |
WebSocketServerSockJsSession.getNativeSession(Class<T> requiredType) |
Principal |
AbstractHttpSockJsSession.getPrincipal() |
InetSocketAddress |
AbstractHttpSockJsSession.getRemoteAddress() |
URI |
WebSocketServerSockJsSession.getUri() |
Modifier and Type | Method and Description |
---|---|
<T> T |
WebSocketServerSockJsSession.getNativeSession(Class<T> requiredType) |
void |
AbstractHttpSockJsSession.setAcceptedProtocol(String protocol)
Unlike WebSocket where sub-protocol negotiation is part of the initial
handshake, in HTTP transports the same negotiation must be emulated and
the selected protocol set through this setter.
|
Constructor and Description |
---|
AbstractSockJsSession(String id,
SockJsServiceConfig config,
WebSocketHandler handler,
Map<String,Object> attributes)
Create a new instance.
|
WebSocketServerSockJsSession(String id,
SockJsServiceConfig config,
WebSocketHandler handler,
Map<String,Object> attributes) |
Modifier and Type | Method and Description |
---|---|
static String |
UriUtils.extractFileExtension(String path)
Extract the file extension from the given URI path.
|
static String |
WebUtils.findParameterValue(Map<String,?> parameters,
String name)
Obtain a named parameter from the given request parameters.
|
static String |
WebUtils.findParameterValue(ServletRequest request,
String name)
Obtain a named parameter from the given request parameters.
|
String |
AbstractUriTemplateHandler.getBaseUrl()
Deprecated.
Return the configured base URL.
|
static Cookie |
WebUtils.getCookie(HttpServletRequest request,
String name)
Retrieve the first cookie with the given name.
|
String |
CookieGenerator.getCookieDomain()
Return the domain for cookies created by this generator, if any.
|
Integer |
CookieGenerator.getCookieMaxAge()
Return the maximum age for cookies created by this generator.
|
String |
CookieGenerator.getCookieName()
Return the given name for cookies created by this generator.
|
static Boolean |
WebUtils.getDefaultHtmlEscape(ServletContext servletContext)
Return whether default HTML escaping is enabled for the web application,
i.e.
|
String |
UriComponents.getFragment()
Return the fragment.
|
String |
ContentCachingResponseWrapper.getHeader(String name) |
abstract String |
UriComponents.getHost()
Return the host.
|
String |
NestedServletException.getMessage()
Return the detail message, including the message from the nested exception
if there is one.
|
static <T> T |
WebUtils.getNativeRequest(ServletRequest request,
Class<T> requiredType)
Return an appropriate request object of the specified type, if available,
unwrapping the given request as far as necessary.
|
static <T> T |
WebUtils.getNativeResponse(ServletResponse response,
Class<T> requiredType)
Return an appropriate response object of the specified type, if available,
unwrapping the given response as far as necessary.
|
abstract String |
UriComponents.getPath()
Return the path.
|
abstract String |
UriComponents.getQuery()
Return the query.
|
static Boolean |
WebUtils.getResponseEncodedHtmlEscape(ServletContext servletContext)
Return whether response encoding should be used when HTML escaping characters,
thus only escaping XML markup significant characters with UTF-* encodings.
|
String |
UriComponents.getScheme()
Return the scheme.
|
abstract String |
UriComponents.getSchemeSpecificPart()
Return the scheme specific part.
|
static Object |
WebUtils.getSessionAttribute(HttpServletRequest request,
String name)
Check the given request for a session attribute of the given name.
|
static String |
WebUtils.getSessionId(HttpServletRequest request)
Determine the session id of the given request, if any.
|
abstract String |
UriComponents.getUserInfo()
Return the user info.
|
Object |
UriComponents.UriTemplateVariables.getValue(String name)
Get the value for the given URI variable name.
|
static InetSocketAddress |
UriComponentsBuilder.parseForwardedFor(HttpRequest request,
InetSocketAddress remoteAddress)
Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to
an
InetSocketAddress representing the address of the client. |
Modifier and Type | Method and Description |
---|---|
static void |
WebUtils.exposeErrorRequestAttributes(HttpServletRequest request,
Throwable ex,
String servletName)
Expose the Servlet spec's error attributes as
HttpServletRequest
attributes under the keys defined in the Servlet 2.3 specification, for error pages that
are rendered directly rather than through the Servlet container's error page resolution:
javax.servlet.error.status_code ,
javax.servlet.error.exception_type ,
javax.servlet.error.message ,
javax.servlet.error.exception ,
javax.servlet.error.request_uri ,
javax.servlet.error.servlet_name . |
UriBuilder |
UriBuilder.fragment(String fragment)
Set the URI fragment.
|
UriComponentsBuilder |
UriComponentsBuilder.fragment(String fragment) |
static Boolean |
WebUtils.getDefaultHtmlEscape(ServletContext servletContext)
Return whether default HTML escaping is enabled for the web application,
i.e.
|
String |
UrlPathHelper.getLookupPathForRequest(HttpServletRequest request,
String name)
Deprecated.
as of 5.3 in favor of using
UrlPathHelper.resolveAndCacheLookupPath(HttpServletRequest) and
UrlPathHelper.getResolvedLookupPath(ServletRequest) . |
static <T> T |
WebUtils.getNativeRequest(ServletRequest request,
Class<T> requiredType)
Return an appropriate request object of the specified type, if available,
unwrapping the given request as far as necessary.
|
static <T> T |
WebUtils.getNativeResponse(ServletResponse response,
Class<T> requiredType)
Return an appropriate response object of the specified type, if available,
unwrapping the given response as far as necessary.
|
static Map<String,Object> |
WebUtils.getParametersStartingWith(ServletRequest request,
String prefix)
Return a map containing all parameters with the given prefix.
|
static Boolean |
WebUtils.getResponseEncodedHtmlEscape(ServletContext servletContext)
Return whether response encoding should be used when HTML escaping characters,
thus only escaping XML markup significant characters with UTF-* encodings.
|
Object |
UriComponents.UriTemplateVariables.getValue(String name)
Get the value for the given URI variable name.
|
UriBuilder |
UriBuilder.host(String host)
Set the URI host which may contain URI template variables, and may also
be
null to clear the host of this builder. |
UriComponentsBuilder |
UriComponentsBuilder.host(String host) |
boolean |
UriTemplate.matches(String uri)
Indicate whether the given URI matches this template.
|
static InetSocketAddress |
UriComponentsBuilder.parseForwardedFor(HttpRequest request,
InetSocketAddress remoteAddress)
Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to
an
InetSocketAddress representing the address of the client. |
UriBuilder |
UriBuilder.port(String port)
Set the URI port .
|
UriComponentsBuilder |
UriComponentsBuilder.port(String port) |
UriComponentsBuilder |
UriComponentsBuilder.query(String query) |
UriBuilder |
UriBuilder.queryParam(String name,
Collection<?> values)
Variant of
UriBuilder.queryParam(String, Object...) with a Collection. |
UriComponentsBuilder |
UriComponentsBuilder.queryParam(String name,
Collection<?> values) |
UriComponentsBuilder |
UriComponentsBuilder.queryParams(MultiValueMap<String,String> params)
Add multiple query parameters and values.
|
UriBuilder |
UriBuilder.replacePath(String path)
Override the current path.
|
UriComponentsBuilder |
UriComponentsBuilder.replacePath(String path) |
UriBuilder |
UriBuilder.replaceQuery(String query)
Clear existing query parameters and then delegate to
UriBuilder.query(String) . |
UriComponentsBuilder |
UriComponentsBuilder.replaceQuery(String query) |
UriBuilder |
UriBuilder.replaceQueryParam(String name,
Collection<?> values)
Variant of
UriBuilder.replaceQueryParam(String, Object...) with a Collection. |
UriComponentsBuilder |
UriComponentsBuilder.replaceQueryParam(String name,
Collection<?> values) |
UriComponentsBuilder |
UriComponentsBuilder.replaceQueryParams(MultiValueMap<String,String> params)
Set the query parameter values after removing all existing ones.
|
UriBuilder |
UriBuilder.scheme(String scheme)
Set the URI scheme which may contain URI template variables,
and may also be
null to clear the scheme of this builder. |
UriComponentsBuilder |
UriComponentsBuilder.scheme(String scheme) |
void |
AbstractUriTemplateHandler.setBaseUrl(String baseUrl)
Deprecated.
Configure a base URL to prepend URI templates with.
|
void |
CookieGenerator.setCookieDomain(String cookieDomain)
Use the given domain for cookies created by this generator.
|
void |
CookieGenerator.setCookieMaxAge(Integer cookieMaxAge)
Use the given maximum age (in seconds) for cookies created by this generator.
|
void |
CookieGenerator.setCookieName(String cookieName)
Use the given name for cookies created by this generator.
|
void |
AbstractUriTemplateHandler.setDefaultUriVariables(Map<String,?> defaultUriVariables)
Deprecated.
Configure default URI variable values to use with every expanded URI
template.
|
void |
DefaultUriBuilderFactory.setDefaultUriVariables(Map<String,?> defaultUriVariables)
Provide default URI variable values to use when expanding URI templates
with a Map of variables.
|
static void |
ServletRequestPathUtils.setParsedRequestPath(RequestPath requestPath,
ServletRequest request)
Set the cached, parsed
RequestPath to the given value. |
static void |
WebUtils.setSessionAttribute(HttpServletRequest request,
String name,
Object value)
Set the session attribute with the given name to the given value.
|
UriBuilder |
UriBuilder.userInfo(String userInfo)
Set the URI user info which may contain URI template variables, and
may also be
null to clear the user info of this builder. |
UriComponentsBuilder |
UriComponentsBuilder.userInfo(String userInfo) |
Constructor and Description |
---|
NestedServletException(String msg,
Throwable cause)
Construct a
NestedServletException with the specified detail message
and nested exception. |
NestedServletException(String msg,
Throwable cause)
Construct a
NestedServletException with the specified detail message
and nested exception. |
UriComponents(String scheme,
String fragment) |
UriComponents(String scheme,
String fragment) |
Modifier and Type | Method and Description |
---|---|
PathPattern.PathMatchInfo |
PathPattern.matchAndExtract(PathContainer pathContainer)
Match this pattern to the given URI path and return extracted URI template
variables as well as path parameters (matrix variables).
|
Map<String,String> |
PathPatternRouteMatcher.matchAndExtract(String pattern,
RouteMatcher.Route route) |
PathPattern.PathRemainingMatchInfo |
PathPattern.matchStartOfPath(PathContainer pathContainer)
Match the beginning of the given path and return the remaining portion
not covered by this pattern.
|
Modifier and Type | Method and Description |
---|---|
int |
PathPattern.compareTo(PathPattern otherPattern)
Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern
is more specific, the same or less specific than the supplied pattern.
|
boolean |
PathPattern.equals(Object other) |