Package org.apache.cxf.jaxrs.swagger

Class AbstractSwaggerFeature<T extends AbstractSwaggerFeature.Portable>

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.feature.DelegatingFeature<T>

org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature<T>

All Implemented Interfaces:

AbstractPortableFeature, Feature

Direct Known Subclasses:

Swagger2Feature

public abstract class AbstractSwaggerFeature<T extends AbstractSwaggerFeature.Portable>
extends DelegatingFeature<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSwaggerFeature.Portable

Field Summary

Fields inherited from class org.apache.cxf.feature.DelegatingFeature

delegate

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSwaggerFeature(T d)

Method Summary

Modifier and Type	Method	Description
void	addSwaggerResource(Server server, Bus bus)
void	calculateDefaultBasePath(Server server)
void	calculateDefaultResourcePackage(Server server)
String	getBasePath()
String	getContact()
String	getDescription()
String	getFilterClass()
String	getLicense()
String	getLicenseUrl()
String	getResourcePackage()
String	getTermsOfServiceUrl()
String	getTitle()
String	getVersion()
boolean	isActivateOnlyIfJaxrsSupported()
boolean	isRunAsFilter()
static boolean	isSwaggerJaxRsAvailable()
void	setActivateOnlyIfJaxrsSupported(boolean activateOnlyIfJaxrsSupported)
void	setBasePath(String basePath)
void	setBasePathByAddress(String address)
void	setContact(String contact)
void	setDescription(String description)
void	setFilterClass(String filterClass)
void	setLicense(String license)
void	setLicenseUrl(String licenseUrl)
void	setResourcePackage(String resourcePackage)
void	setRunAsFilter(boolean runAsFilter)
void	setTermsOfServiceUrl(String termsOfServiceUrl)
void	setTitle(String title)
void	setVersion(String version)

Methods inherited from class org.apache.cxf.feature.DelegatingFeature

getDelegate, initialize, initialize, initialize, initialize, initializeProvider, setDelegate

Methods inherited from class org.apache.cxf.feature.AbstractFeature

doInitializeProvider, getActive, getID, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSwaggerFeature

protected AbstractSwaggerFeature(T d)

Method Detail

isSwaggerJaxRsAvailable

public static boolean isSwaggerJaxRsAvailable()

addSwaggerResource

public void addSwaggerResource(Server server,
                               Bus bus)

setBasePathByAddress

public void setBasePathByAddress(String address)

calculateDefaultResourcePackage

public void calculateDefaultResourcePackage(Server server)

calculateDefaultBasePath

public void calculateDefaultBasePath(Server server)

getResourcePackage

public String getResourcePackage()

setResourcePackage

public void setResourcePackage(String resourcePackage)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getBasePath

public String getBasePath()

setBasePath

public void setBasePath(String basePath)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getContact

public String getContact()

setContact

public void setContact(String contact)

getLicense

public String getLicense()

setLicense

public void setLicense(String license)

getLicenseUrl

public String getLicenseUrl()

setLicenseUrl

public void setLicenseUrl(String licenseUrl)

getTermsOfServiceUrl

public String getTermsOfServiceUrl()

setTermsOfServiceUrl

public void setTermsOfServiceUrl(String termsOfServiceUrl)

getFilterClass

public String getFilterClass()

setFilterClass

public void setFilterClass(String filterClass)

isRunAsFilter

public boolean isRunAsFilter()

setRunAsFilter

public void setRunAsFilter(boolean runAsFilter)

isActivateOnlyIfJaxrsSupported

public boolean isActivateOnlyIfJaxrsSupported()

setActivateOnlyIfJaxrsSupported

public void setActivateOnlyIfJaxrsSupported(boolean activateOnlyIfJaxrsSupported)