Interface PropertiesDelegate

All Known Implementing Classes:
ContainerRequest, InterceptorExecutor, MapPropertiesDelegate, ReaderInterceptorExecutor, ServletPropertiesDelegate, TracingAwarePropertiesDelegate, WriterInterceptorExecutor
public interface PropertiesDelegate
TODO: javadoc.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getProperty(String name)
    Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.
    Collection<String>
    getPropertyNames()
    Returns an immutable collection containing the property names available within the context of the current request/response exchange context.
    void
    removeProperty(String name)
    Removes a property with the given name from the current request/response exchange context.
    void
    setProperty(String name, Object object)
    Binds an object to a given property name in the current request/response exchange context.

  • Method Details

    • getProperty

      Object getProperty(String name)
      Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

      A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

      A list of supported properties can be retrieved using getPropertyNames(). Custom property names should follow the same convention as package names.

      Parameters:
      name - a String specifying the name of the property.
      Returns:
      an Object containing the value of the property, or null if no property exists matching the given name.
      See Also:

    • getPropertyNames

      Collection<String> getPropertyNames()
      Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

      Use the getProperty(String) method with a property name to get the value of a property.

      Returns:
      an immutable collection of property names.
      See Also:

    • setProperty

      void setProperty(String name, Object object)
      Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

      A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

      A list of supported properties can be retrieved using getPropertyNames(). Custom property names should follow the same convention as package names.

      If a null value is passed, the effect is the same as calling the removeProperty(String) method.

      Parameters:
      name - a String specifying the name of the property.
      object - an Object representing the property to be bound.

    • removeProperty

      void removeProperty(String name)
      Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to getProperty(String) to retrieve the property value will return null.
      Parameters:
      name - a String specifying the name of the property to be removed.