Package jakarta.ws.rs

Annotation Type ApplicationPath

  • @Documented
@Target(TYPE)
@Retention(RUNTIME)
public @interface ApplicationPath
    Identifies the application path that serves as the base URI for all resource URIs provided by Path. May only be applied to a subclass of Application.

    When published in a Servlet container, the value of the application path may be overridden using a servlet-mapping element in the web.xml.

    Since:
    1.1
    Author:
    Paul Sandoz, Marc Hadley
    See Also:
    Application, Path

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      Defines the base URI for all resource URIs.

    • Element Detail

      • value

        String value
        Defines the base URI for all resource URIs. A trailing '/' character will be automatically appended if one is not present.

        The supplied value is automatically percent encoded to conform to the path production of RFC 3986 section 3.3. Note that percent encoded values are allowed in the value, an implementation will recognize such values and will not double encode the '%' character.

        Returns:
        base URI.