fish.payara.microprofile.openapi.impl

Class OpenApiService

java.lang.Object

fish.payara.microprofile.openapi.impl.OpenApiService

All Implemented Interfaces:

EventListener, org.glassfish.hk2.api.PostConstruct, org.glassfish.hk2.api.PreDestroy, ConfigListener

@Service(name="microprofile-openapi-service")
 @RunLevel(value=10)
public class OpenApiService
extends Object
implements org.glassfish.hk2.api.PostConstruct, org.glassfish.hk2.api.PreDestroy, EventListener, ConfigListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.api.event.EventListener

EventListener.Event<T>

Constructor Summary

Constructors

Constructor and Description
OpenApiService()

Method Summary

Modifier and Type	Method and Description
UnprocessedChangeEvents	changed(PropertyChangeEvent[] event) Listen for OpenAPI config changes.
void	event(EventListener.Event<?> event) Listen for application deployment events.
org.eclipse.microprofile.openapi.models.OpenAPI	getDocument()
static OpenApiService	getInstance()
boolean	isEnabled()
boolean	isSecurityEnabled()
void	postConstruct()
void	preDestroy()
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

postConstruct

public void postConstruct()

Specified by:

postConstruct in interface org.glassfish.hk2.api.PostConstruct

preDestroy

public void preDestroy()

Specified by:

preDestroy in interface org.glassfish.hk2.api.PreDestroy

isEnabled

public boolean isEnabled()

isSecurityEnabled

public boolean isSecurityEnabled()

withCorsHeaders

public boolean withCorsHeaders()

changed

public UnprocessedChangeEvents changed(PropertyChangeEvent[] event)

Listen for OpenAPI config changes.

Specified by:

changed in interface ConfigListener

Parameters:

event - list of changes

Returns:

the list of unprocessed events (requiring a restart) or null if all reconfiguration was processed successfully

event

public void event(EventListener.Event<?> event)

Listen for application deployment events.

Specified by:

event in interface EventListener

getDocument

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

Returns:

the document for the most recently deployed application. Creates one if it hasn't already been created.

Throws:

OpenAPIBuildException - if creating the document failed.

getInstance

public static OpenApiService getInstance()

Returns:

an instance of this service from HK2.