Top Description Methods
jakarta.ws.rs

public @Interface ApplicationPath

extends Annotation
Annotations
@Documented
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target
Identifies the application path that serves as the base URI for all resource URIs provided by jakarta.ws.rs.Path. May only be applied to a subclass of jakarta.ws.rs.core.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.

Authors
Paul Sandoz, Marc Hadley
Since
1.1
See Also
jakarta.ws.rs.core.Application, Path

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

base URI.
value()

Defines the base URI for all resource URIs.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public 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:String

base URI.