Annotation Type ConstrainedTo

The following example illustrates restricting a MessageBodyReader 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 WriterInterceptor 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 ClientRequestFilter 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 {
      ...
  }