org.wildfly.swarm.swagger.internal

Class SwaggerArchiveImpl

java.lang.Object

org.jboss.shrinkwrap.impl.base.AssignableBase<org.jboss.shrinkwrap.impl.base.ArchiveBase<?>>

org.wildfly.swarm.swagger.internal.SwaggerArchiveImpl

All Implemented Interfaces:

org.jboss.shrinkwrap.api.Assignable, SwaggerArchive

public class SwaggerArchiveImpl
extends org.jboss.shrinkwrap.impl.base.AssignableBase<org.jboss.shrinkwrap.impl.base.ArchiveBase<?>>
implements SwaggerArchive

Author:

Lance Ball

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_ACTIVATOR_CLASS_NAME

Fields inherited from interface org.wildfly.swarm.swagger.SwaggerArchive

SWAGGER_CONFIGURATION_PATH

Constructor Summary

Constructors

Constructor and Description
SwaggerArchiveImpl(org.jboss.shrinkwrap.impl.base.ArchiveBase<?> archive)

Method Summary

Modifier and Type	Method and Description
SwaggerConfigurationAsset	getConfigurationAsset()
String[]	getResourcePackages()
boolean	hasContextRoot() Determine if the archive has a context root configured
boolean	hasResourcePackages() Determine if the archive has been configured for scanning
SwaggerArchive	setContact(String contact) Sets the contact information for the application
SwaggerArchive	setContextRoot(String root) Sets the context root, or base path for the API calls.
SwaggerArchive	setDescription(String description) Sets the description for the application being exposed by swagger.json
SwaggerArchive	setHost(String host) Sets the addressable host name and port for the API URLs.
SwaggerArchive	setLicense(String license) Sets the license of the application.
SwaggerArchive	setLicenseUrl(String licenseUrl) Sets the license URL for this application
SwaggerArchive	setPrettyPrint(boolean prettyPrint) Sets whether the swagger.json will be pretty printed.
SwaggerArchive	setResourcePackages(String... packages)
SwaggerArchive	setSchemes(String... schemes) Sets the schemes for the for the API URLs (http, https)
SwaggerArchive	setTermsOfServiceUrl(String url) Sets the url to be displayed for the application's term's of service
SwaggerArchive	setTitle(String title) Sets the title of the application being exposed by swagger.json
SwaggerArchive	setVersion(String version) Sets the version of the API being exposed for this application

Methods inherited from class org.jboss.shrinkwrap.impl.base.AssignableBase

as, getArchive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.shrinkwrap.api.Assignable

as

Field Detail

SERVICE_ACTIVATOR_CLASS_NAME

public static final String SERVICE_ACTIVATOR_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

SwaggerArchiveImpl

public SwaggerArchiveImpl(org.jboss.shrinkwrap.impl.base.ArchiveBase<?> archive)
                   throws IOException

Throws:

IOException

Method Detail

getConfigurationAsset

public SwaggerConfigurationAsset getConfigurationAsset()

setResourcePackages

public SwaggerArchive setResourcePackages(String... packages)

Specified by:

setResourcePackages in interface SwaggerArchive

setTitle

public SwaggerArchive setTitle(String title)

Description copied from interface: SwaggerArchive

Sets the title of the application being exposed by swagger.json

Specified by:

setTitle in interface SwaggerArchive

Parameters:

title - the application's title

Returns:

this

setDescription

public SwaggerArchive setDescription(String description)

Description copied from interface: SwaggerArchive

Sets the description for the application being exposed by swagger.json

Specified by:

setDescription in interface SwaggerArchive

Parameters:

description - the description

Returns:

this

setTermsOfServiceUrl

public SwaggerArchive setTermsOfServiceUrl(String url)

Description copied from interface: SwaggerArchive

Sets the url to be displayed for the application's term's of service

Specified by:

setTermsOfServiceUrl in interface SwaggerArchive

Parameters:

url - the URL string

Returns:

this

setContact

public SwaggerArchive setContact(String contact)

Description copied from interface: SwaggerArchive

Sets the contact information for the application

Specified by:

setContact in interface SwaggerArchive

Parameters:

contact - The contact information string

Returns:

this

setLicense

public SwaggerArchive setLicense(String license)

Description copied from interface: SwaggerArchive

Sets the license of the application.

Specified by:

setLicense in interface SwaggerArchive

Parameters:

license - the license text

Returns:

this

setLicenseUrl

public SwaggerArchive setLicenseUrl(String licenseUrl)

Description copied from interface: SwaggerArchive

Sets the license URL for this application

Specified by:

setLicenseUrl in interface SwaggerArchive

Parameters:

licenseUrl - the license URL as a string

Returns:

this

setVersion

public SwaggerArchive setVersion(String version)

Description copied from interface: SwaggerArchive

Sets the version of the API being exposed for this application

Specified by:

setVersion in interface SwaggerArchive

Parameters:

version - the version string

Returns:

this

setSchemes

public SwaggerArchive setSchemes(String... schemes)

Description copied from interface: SwaggerArchive

Sets the schemes for the for the API URLs (http, https)

Specified by:

setSchemes in interface SwaggerArchive

Parameters:

schemes - One or more strings. Valid values are 'http' and 'https'

Returns:

this

setHost

public SwaggerArchive setHost(String host)

Description copied from interface: SwaggerArchive

Sets the addressable host name and port for the API URLs. Does not include the schemes nor context root.

Specified by:

setHost in interface SwaggerArchive

Parameters:

host - the host name

Returns:

this

setContextRoot

public SwaggerArchive setContextRoot(String root)

Description copied from interface: SwaggerArchive

Sets the context root, or base path for the API calls.

Specified by:

setContextRoot in interface SwaggerArchive

Parameters:

root - the context root

Returns:

this

hasContextRoot

public boolean hasContextRoot()

Description copied from interface: SwaggerArchive

Determine if the archive has a context root configured

Specified by:

hasContextRoot in interface SwaggerArchive

Returns:

true if the context root has been configured

setPrettyPrint

public SwaggerArchive setPrettyPrint(boolean prettyPrint)

Description copied from interface: SwaggerArchive

Sets whether the swagger.json will be pretty printed.

Specified by:

setPrettyPrint in interface SwaggerArchive

Parameters:

prettyPrint - if true swagger.json will be pretty printed

Returns:

this

hasResourcePackages

public boolean hasResourcePackages()

Description copied from interface: SwaggerArchive

Determine if the archive has been configured for scanning

Specified by:

hasResourcePackages in interface SwaggerArchive

Returns:

true if the packages to be scanned have been configured

getResourcePackages

public String[] getResourcePackages()

Specified by:

getResourcePackages in interface SwaggerArchive