org.apache.cxf.jaxrs.swagger

Class AbstractSwaggerFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature

All Implemented Interfaces:

Feature

Direct Known Subclasses:

Swagger2Feature

public abstract class AbstractSwaggerFeature
extends AbstractFeature

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	licenseWasSet

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Constructor Summary

Constructors

Constructor and Description
AbstractSwaggerFeature()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addSwaggerResource(Server server, Bus bus)
protected void	calculateDefaultBasePath(Server server)
String	getBasePath()
String	getContact()
String	getDescription()
String	getFilterClass()
String	getLicense()
String	getLicenseUrl()
String	getResourcePackage()
String	getTermsOfServiceUrl()
String	getTitle()
String	getVersion()
void	initialize(Server server, Bus bus)
boolean	isActivateOnlyIfJaxrsSupported()
boolean	isRunAsFilter()
void	setActivateOnlyIfJaxrsSupported(boolean activateOnlyIfJaxrsSupported)
void	setBasePath(String basePath)
protected abstract 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.AbstractFeature

getActive, getID, initialize, initialize, initialize, initializeProvider

Methods inherited from class javax.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

licenseWasSet

protected boolean licenseWasSet

Constructor Detail

AbstractSwaggerFeature

public AbstractSwaggerFeature()

Method Detail

initialize

public void initialize(Server server,
                       Bus bus)

Specified by:

initialize in interface Feature

Overrides:

initialize in class AbstractFeature

addSwaggerResource

protected abstract void addSwaggerResource(Server server,
                                           Bus bus)

setBasePathByAddress

protected abstract void setBasePathByAddress(String address)

calculateDefaultBasePath

protected 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)