org.apache.juneau.rest

Interface RestInfoProvider

All Known Subinterfaces:

RestInfoProvider.Null

All Known Implementing Classes:

BasicRestInfoProvider

public interface RestInfoProvider

REST resource information provider.

Provides localized Swagger documentation and other related information about a REST resource.

See Also:

• RestContext.REST_infoProvider
• Overview > juneau-rest-server > OPTIONS Pages

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RestInfoProvider.Null Represents no RestInfoProvider.

Method Summary

Modifier and Type	Method and Description
String	getDescription(RestRequest req) Returns the localized description of the REST resource.
String	getMethodDescription(Method method, RestRequest req) Returns the localized description of the specified java method on this servlet.
String	getMethodSummary(Method method, RestRequest req) Returns the localized summary of the specified java method.
String	getSiteName(RestRequest req) Returns the localized site name of the REST resource.
Swagger	getSwagger(RestRequest req) Returns the localized swagger for the REST resource.
String	getTitle(RestRequest req) Returns the localized title of the REST resource.

Method Detail

getSwagger

Swagger getSwagger(RestRequest req)
            throws Exception

Returns the localized swagger for the REST resource.

Parameters:

req - The incoming HTTP request.

Returns:

A new Swagger instance.
Never null.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.

getSiteName

String getSiteName(RestRequest req)
            throws Exception

Returns the localized site name of the REST resource.

Parameters:

req - The current request.

Returns:

The localized site name of the REST resource, or null if none was found.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.

getTitle

String getTitle(RestRequest req)
         throws Exception

Returns the localized title of the REST resource.

Parameters:

req - The current request.

Returns:

The localized title of the REST resource, or null if none was found.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.

getDescription

String getDescription(RestRequest req)
               throws Exception

Returns the localized description of the REST resource.

Parameters:

req - The current request.

Returns:

The localized description of the REST resource, or null if none was found.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.

getMethodSummary

String getMethodSummary(Method method,
                        RestRequest req)
                 throws Exception

Returns the localized summary of the specified java method.

Parameters:

method - The Java method annotated with @RestMethod.

req - The current request.

Returns:

The localized summary of the method, or null if none was found.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.

getMethodDescription

String getMethodDescription(Method method,
                            RestRequest req)
                     throws Exception

Returns the localized description of the specified java method on this servlet.

Parameters:

method - The Java method annotated with @RestMethod.

req - The current request.

Returns:

The localized description of the method, or null if none was was found.

Throws:

Exception - Throw a RestException with a specific HTTP error status or any other exception to cause a SC_INTERNAL_SERVER_ERROR.