org.apache.camel.swagger.servlet

Class RestSwaggerServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.camel.swagger.servlet.RestSwaggerServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class RestSwaggerServlet
extends javax.servlet.http.HttpServlet

The default Camel swagger servlet to use when exposing the APIs of the rest-dsl using swagger.

This requires Camel version 2.15 or better at runtime (and JMX to be enabled).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestSwaggerServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getApiContextIdPattern()
void	init(javax.servlet.ServletConfig config)
boolean	isApiContextIdListing()
void	setApiContextIdListing(boolean apiContextIdListing) Sets whether listing of all available CamelContext's with REST services in the JVM is enabled.
void	setApiContextIdPattern(String apiContextIdPattern) Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RestSwaggerServlet

public RestSwaggerServlet()

Method Detail

getApiContextIdPattern

public String getApiContextIdPattern()

setApiContextIdPattern

public void setApiContextIdPattern(String apiContextIdPattern)

Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

The pattern uses the rules from EndpointHelper.matchPattern(String, String)

Parameters:

apiContextIdPattern - the pattern

isApiContextIdListing

public boolean isApiContextIdListing()

setApiContextIdListing

public void setApiContextIdListing(boolean apiContextIdListing)

Sets whether listing of all available CamelContext's with REST services in the JVM is enabled. If enabled it allows to discover these contexts, if false then only if there is exactly one CamelContext then its used.

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException