Package fish.payara.microprofile.openapi.impl

Class OpenApiService

java.lang.Object

fish.payara.microprofile.openapi.impl.OpenApiService

@Service(name="microprofile-openapi-service")
@Singleton
public class OpenApiService
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenApiService()

Method Summary

Modifier and Type	Method	Description
void	deregisterApp(String applicationId)
org.eclipse.microprofile.openapi.models.OpenAPI	getDocument()
static OpenApiService	getInstance()
void	initConfig()
boolean	isEnabled()
boolean	isSecurityEnabled()
void	registerApp(String applicationId, DeploymentContext ctx)
void	resumeApp(String applicationId)
void	setCorsHeaders(boolean withCorsHeaders)
void	setEnabled(boolean enabled)
void	setSecurityEnabled(boolean securityEnabled)
void	suspendApp(String applicationId)
boolean	withCorsHeaders()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiService

public OpenApiService()

Method Detail

initConfig

@PostConstruct
public void initConfig()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isSecurityEnabled

public boolean isSecurityEnabled()

setSecurityEnabled

public void setSecurityEnabled(boolean securityEnabled)

withCorsHeaders

public boolean withCorsHeaders()

setCorsHeaders

public void setCorsHeaders(boolean withCorsHeaders)

registerApp

public void registerApp(String applicationId,
                        DeploymentContext ctx)

deregisterApp

public void deregisterApp(String applicationId)

resumeApp

public void resumeApp(String applicationId)

suspendApp

public void suspendApp(String applicationId)

getDocument

public org.eclipse.microprofile.openapi.models.OpenAPI getDocument()
                                                            throws OpenAPIBuildException,
                                                                   IOException,
                                                                   CloneNotSupportedException

Returns:

the document If multiple application deployed then merge all the documents. Creates one if it hasn't already been created.

Throws:

OpenAPIBuildException - if creating the document failed.

IOException - if source archive not accessible

CloneNotSupportedException

getInstance

public static final OpenApiService getInstance()