org.apache.juneau.rest

Class BasicRestInfoProvider

java.lang.Object

org.apache.juneau.rest.BasicRestInfoProvider

All Implemented Interfaces:

RestInfoProvider

public class BasicRestInfoProvider
extends Object
implements RestInfoProvider

Default implementation of RestInfoProvider.

Subclasses can override these methods to tailor how HTTP REST resources are documented.

• RestContext.REST_infoProvider
• Overview > juneau-rest-server > Swagger

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.rest.RestInfoProvider

RestInfoProvider.Null

Constructor Summary

Constructors

Constructor and Description
BasicRestInfoProvider(RestContext context) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDescription(RestRequest req) Returns the localized description of this 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 on this servlet.
String	getSiteName(RestRequest req) Returns the localized site name of this REST resource.
Swagger	getSwagger(RestRequest req) Returns the localized swagger for this REST resource.
String	getTitle(RestRequest req) Returns the localized title of this REST resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicRestInfoProvider

public BasicRestInfoProvider(RestContext context)

Constructor.

Parameters:

context - The resource context.

Method Detail

getSwagger

public Swagger getSwagger(RestRequest req)
                   throws Exception

Returns the localized swagger for this REST resource.

Subclasses can override this method to customize the Swagger.

Specified by:

getSwagger in interface RestInfoProvider

Parameters:

req - The incoming HTTP request.

Returns:

A new Swagger instance.
Never null.

Throws:

Exception - Error occurred.

getMethodSummary

public String getMethodSummary(Method method,
                               RestRequest req)
                        throws Exception

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

Subclasses can override this method to provide their own summary.

The default implementation returns the value from the following locations (whichever matches first):

1. @RestMethod(summary) annotation.

   Examples:

   // Direct value @RestMethod(summary="Summary of my method") public Object myMethod() {...} // Pulled from some other location @RestMethod(summary="$L{myLocalizedSummary}") public Object myMethod() {...}

2. Localized string from resource bundle identified by @Rest(messages) on the resource class, then any parent classes.
   1. [ClassName].[javaMethodName].summary
   2. [javaMethodName].summary
   
   Value can contain any SVL variables defined on the @RestMethod(summary) annotation.

   Examples:

   // Direct value MyClass.myMethod.summary = Summary of my method. // Pulled from some other location MyClass.myMethod.summary = $C{MyStrings/MyClass.myMethod.summary}

Specified by:

getMethodSummary in interface RestInfoProvider

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 - Error occurred.

getMethodDescription

public String getMethodDescription(Method method,
                                   RestRequest req)
                            throws Exception

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

Subclasses can override this method to provide their own description.

The default implementation returns the value from the following locations (whichever matches first):

1. @RestMethod(description) annotation.

   Examples:

   // Direct value @RestMethod(description="Description of my method") public Object myMethod() {...} // Pulled from some other location @RestMethod(description="$L{myLocalizedDescription}") public Object myMethod() {...}

2. Localized string from resource bundle identified by @Rest(messages) on the resource class, then any parent classes.
   1. [ClassName].[javaMethodName].description
   2. [javaMethodName].description
   
   Value can contain any SVL variables defined on the @RestMethod(description) annotation.

   Examples:

   // Direct value MyClass.myMethod.description = Description of my method. // Pulled from some other location MyClass.myMethod.description = $C{MyStrings/MyClass.myMethod.description}

Specified by:

getMethodDescription in interface RestInfoProvider

Parameters:

method - The Java method annotated with @RestMethod.

req - The current request.

Returns:

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

Throws:

Exception - Error occurred.

getSiteName

public String getSiteName(RestRequest req)
                   throws Exception

Returns the localized site name of this REST resource.

Subclasses can override this method to provide their own site name.

The default implementation returns the value from the following locations (whichever matches first):

1. @Rest(siteName) annotation on this class, and then any parent classes.

   Examples:

   // Direct value @Rest(siteName="My Site") public class MyResource {...} // Pulled from some other location @Rest(siteName="$L{myLocalizedSiteName}") public class MyResource {...}

2. Localized strings from resource bundle identified by @Rest(messages) on the resource class, then any parent classes.
   1. [ClassName].siteName
   2. siteName
   
   Value can contain any SVL variables defined on the @Rest(siteName) annotation.

   Examples:

   // Direct value MyClass.siteName = My Site // Pulled from some other location MyClass.siteName = $C{MyStrings/MyClass.siteName}

Specified by:

getSiteName in interface RestInfoProvider

Parameters:

req - The current request.

Returns:

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

Throws:

Exception - Error occurred.

getTitle

public String getTitle(RestRequest req)
                throws Exception

Returns the localized title of this REST resource.

Subclasses can override this method to provide their own title.

The default implementation returns the value from the following locations (whichever matches first):

1. @Rest(siteName) annotation on this class, and then any parent classes.

   Examples:

   // Direct value @Rest(title="My Resource") public class MyResource {...} // Pulled from some other location @Rest(title="$L{myLocalizedTitle}") public class MyResource {...}

2. Localized strings from resource bundle identified by @Rest(messages) on the resource class, then any parent classes.
   1. [ClassName].title
   2. title
   
   Value can contain any SVL variables defined on the @Rest(title) annotation.

   Examples:

   // Direct value MyClass.title = My Resource // Pulled from some other location MyClass.title = $C{MyStrings/MyClass.title}

3. /info/title entry in swagger file.

Specified by:

getTitle in interface RestInfoProvider

Parameters:

req - The current request.

Returns:

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

Throws:

Exception - Error occurred.

getDescription

public String getDescription(RestRequest req)
                      throws Exception

Returns the localized description of this REST resource.

Subclasses can override this method to provide their own description.

The default implementation returns the value from the following locations (whichever matches first):

1. @Rest(description) annotation on this class, and then any parent classes.

   Examples:

   // Direct value @Rest(description="My Resource") public class MyResource {...} // Pulled from some other location @Rest(description="$L{myLocalizedDescription}") public class MyResource {...}

2. Localized strings from resource bundle identified by @Rest(messages) on the resource class, then any parent classes.
   1. [ClassName].description
   2. description
   
   Value can contain any SVL variables defined on the @Rest(description) annotation.

   Examples:

   // Direct value MyClass.description = My Resource // Pulled from some other location MyClass.description = $C{MyStrings/MyClass.description}

3. /info/description entry in swagger file.

Specified by:

getDescription in interface RestInfoProvider

Parameters:

req - The current request.

Returns:

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

Throws:

Exception - Error occurred.