@ConstrainedTo
annotation is not present on a JAX-RS provider type declaration, the declared provider may be used in any run-time
context. If such a annotation is present, the JAX-RS runtime will enforce the specified usage restriction.
The following example illustrates restricting a jakarta. provider implementation to
run only as part of a JAX-RS client run-time:
@ConstrainedTo(RuntimeType.CLIENT)
public class MyReader implements MessageBodyReader {
...
}
The following example illustrates restricting a jakarta. provider implementation to
run only as part of a JAX-RS server run-time:
@ConstrainedTo(RuntimeType.SERVER)
public class MyWriterInterceptor implements WriterInterceptor {
...
}
It is a configuration error to constraint a JAX-RS provider implementation to a run-time context in which the provider cannot be applied. In such case a JAX-RS runtime SHOULD inform a user about the issue and ignore the provider implementation in further processing.
For example, the following restriction of a jakarta. to run only as part of a
JAX-RS server run-time would be considered invalid:
// reported as invalid and ignored by JAX-RS runtime
@ConstrainedTo(RuntimeType.SERVER)
public class MyFilter implements ClientRequestFilter {
...
}
| Modifier and Type | Method and Description |
|---|---|
| public RuntimeType | Returns: applicable run-time context.Define the |
| value | back to summary |
|---|---|
| public RuntimeType value() Define the
| |